Skip to main content
GET
/
users
/
{id}
/
transactions
/users/{id}/transactions
curl --request GET \
  --url http://localhost:8080/users/{id}/transactions \
  --header 'Authorization: Bearer <token>'
{
  "total": 82,
  "page": 1,
  "size": 50,
  "transactions": [
    {
      "transaction_id": "c7318ff7-257c-490e-8242-03a815b223b7",
      "account_id": "acc_6Tef269B6ZArSVpYrxtjBV",
      "amount": 384.05,
      "type": "debit",
      "currency": "USD",
      "date": "2023-02-16T00:00:00",
      "datetime": "2023-02-16T09:14:11",
      "description": "Regina's Mulberry",
      "raw_description": "Regina's Mulberry #1402 T48999-84",
      "pending": true,
      "category": "food_and_drinks.restaurants"
    }
  ],
  "accounts": {}
}
curl -i -X GET \
  'http://localhost:8080/users/{id}/transactions?transaction_type=credit&category=string&account_id=string&institution_id=string&page=1&size=50&start_date=string&end_date=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'moneykit-version: 2023-02-18'

{
  "total": 82,
  "page": 1,
  "size": 50,
  "transactions": [
    {
      "transaction_id": "c7318ff7-257c-490e-8242-03a815b223b7",
      "account_id": "a3ba443a-257c-490e-8242-03a84789d39f",
      "amount": 384.05,
      "type": "debit",
      "currency": "USD",
      "date": "2023-02-16T00:00:00",
      "datetime": "2023-02-16T09:14:11",
      "description": "Regina's Mulberry",
      "raw_description": "Regina's Mulberry #1402 T48999-84",
      "pending": true,
      "category": "food_and_drinks.restaurants"
    }
  ],
  "accounts": {
    "account_id1": {
      "name": "Premier Checking",
      "last_synced_at": "2023-02-16T09:14:11",
      "institution_id": "string",
      "link_id": "string"
    },
    "account_id2": {
      "name": "Premier Checking",
      "last_synced_at": "2023-02-16T09:14:11",
      "institution_id": "string",
      "link_id": "string"
    }
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
moneykit-version
string
default:2023-02-18

Path Parameters

​
id
string
required

The unique ID for this user. This is the same ID provided in the call to /link-session to create any link for this user.

Query Parameters

​
transaction_type
enum<string>[]
​
category
string[]
​
account_id
string[]

If present, filters results to transactions in accounts matching the given IDs.

​
institution_id
string[]

If present, filters results to transactions at institutions matching the given IDs.

​
page
integer
default:1

The page number to return.

Required range: x >= 1
​
size
integer
default:50

The number of items to return per page.

Required range: 1 <= x <= 100
​
start_date
string

The earliest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to 90 days before the end_date. If you want to retrieve all transactions, use 1900-01-01.

​
end_date
string

The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today.

Response

Successful Response

​
total
integer
required

The total number of results for this query.

Example:

82

​
page
integer
required

The page number corresponding to this batch of results.

Example:

1

​
size
integer
required

The number of results in this batch.

Example:

50

​
transactions
Transaction · object[]
required
​
accounts
object
required

The set of accounts belonging to this batch of results.