Sign in

v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB
Subaccounts

Fetches a set of filtered transactions allocations

Permissions required: Subaccount or Read Subaccount

Retrieves a filtered set of transactions that are connected to funding allocations.

get/subaccounts/transactions/allocations

Query parameters

subaccountIdsstring[]

Array of Unique Identifiers for the subaccount

startDatestring date

The start date (inclusive) in YYYY-MM-DD format. The earliest valid start date is '2017-01-01`. Dates are always in UTC RFC 3339 'full-date'.

endDatestring date

The end date (inclusive) in YYYY-MM-DD format. The latest valid end date is the current date. Dates are always in UTC RFC 3339 'full-date'.

transactionsTypesstring[]

Filters by DEPOSITs, WITHDRAWALs or both (default)

afterIdstring

When paginating this is used to provide the starting point for the page to fetch (retrieved from the previous response body)

limitinteger

Maximum number of results to return per query

Response

A list of transactions

Example response

{
  "data": [
    {
      "transactionId": "c4c4652f-0c07-472c-a7f8-955fbe07775d",
      "subaccounts": [
        {
          "subaccountId": "ec761b5e-fd2c-497a-a9a0-f8738ac97bdf",
          "balances": [
            {
              "assetType": "BTC",
              "hold": "1000.00",
              "pending": "1000.00",
              "posted": "1000.00"
            }
          ]
        }
      ],
      "status": "POSTED",
      "createdAt": "2019-01-02T12:34:56.000Z",
      "endedAt": "2019-01-03T12:34:56.000Z",
      "transactionType": "WITHDRAWAL"
    }
  ],
  "page": {
    "next": "<next page url>"
  }
}