Get balance histories

GET

https://api.t-dx.com/api/rest/v1/balances/:balanceId/history

GET

/api/rest/v1/balances/:balanceId/history

curl -G https://api.t-dx.com/api/rest/v1/balances/cc452f44-718c-46ab-8fd7-682363d1ef04/history \
     -H "Authorization: Bearer <token>" \
     -d cursor=eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ \
     -d query=instrument_id \
     -d query=exclude_zero_balances \
     -d subAccountId=subAccountId

{
  "result": [
    {
      "id": "1f814b12-5012-45e3-8b55-dc723a93c33f",
      "balanceId": "cc452f44-718c-46ab-8fd7-682363d1ef04",
      "clientAccountId": "8aee564e-2eb1-4a57-b686-05476c2cfd93",
      "subAccountId": "7376524e-6b6b-4137-9719-7e07a7709804",
      "instrumentId": "7a3fae7e-5a17-4931-821c-54b021f643da",
      "available": "100.0",
      "ordersReserved": "10.0",
      "withdrawalsReserved": "10.0",
      "credit": "0.0",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "exposureOverdraft": "0.0",
      "exposureReserved": "0.0"
    }
  ],
  "pagination": {
    "cursors": {
      "self": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ==",
      "first": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ==",
      "last": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ==",
      "next": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ==",
      "previous": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ=="
    }
  },
  "sortingKeys": [
    {
      "key": "created_at-asc",
      "dir": "asc",
      "label": "key.deposits.sorts.created_at-asc",
      "fieldKey": "created_at"
    }
  ],
  "filters": [
    {
      "key": "instrument_id",
      "label": "key.deposits.filters.instrument_id",
      "range": {
        "min": "1",
        "max": "5000"
      },
      "values": [
        {
          "key": "STATUS_NEW",
          "label": "key.deposits.filters.status.fields.new"
        }
      ],
      "filterType": "FILTER_TYPE_VALUES",
      "valueType": "VALUE_TYPE_STRING"
    }
  ],
  "query": [
    "string"
  ]
}

This endpoint returns the history of a given balance which represents the movements that have altered the total of the balance.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

balanceIdstringRequiredformat: "uuid"

The unique identifier for the balance.

Query parameters

sortstringOptionalformat: "(created_at-asc|created_at-desc)"Defaults to created_at-asc

Optionally sort the results

limitstringOptionalformat: "uint64"Defaults to 20

Optionally limit the number of results (between 1 and 500)

querylist of stringsOptional

Optionally filter the results

cursorstringOptionalformat: "base64"

Optionally provide a cursor to paginate over pages of results

subAccountIdstringRequiredformat: "uuid"

The unique identifier of the sub-account the balances belong to.

Response

A successful response.

resultlist of objects

paginationobject

sortingKeyslist of objectsOptional

filterslist of objectsOptional

querylist of stringsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error