API status
  • Balances

Positions

All positions related paths.

get

List positions

List of account positions

offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format
int32
Min
0
limitint

Use the limit argument to specify the maximum number of items returned.

Format
int32
Default
100
Min
0
Max
1000

Responses

Response examples

Response

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "account_id": "c5161455-4d27-4781-bc74-f05532e49a77",
      "instrument": {
        "isin": "US0378331005",
        "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321"
      },
      "quantity": "10.4",
      "locked_for_trading": "5",
      "pending_settlement": "0",
      "available_for_trading": "5.4"
    }
  ]
}
get

Retrieve position

Retrieve an account position

instrument_idOne Of

required

Instrument unique identifier.

Must match one of

International securities identification number defined by ISO 6166, prefixed with a 'isin:' URN scheme.

Pattern
^(urn:)?isin:[A-Z]{2}[A-Z0-9]{9}[0-9]$
account_idstring

required

Account unique identifier.

Format
uuid

Responses

Response examples

Response

{
  "account_id": "c5161455-4d27-4781-bc74-f05532e49a77",
  "instrument": {
    "isin": "US0378331005",
    "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321"
  },
  "quantity": "10.4",
  "locked_for_trading": "5",
  "pending_settlement": "0",
  "available_for_trading": "5.4"
}
webhook

Positions events

idstring

required

Event unique identifier

Format
uuid
created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format
date-time
typestring

required

Event type

Default
"POSITION.UPDATED"
Enum
  • POSITION.UPDATED
objectobject

required

account_idstring

required

Account unique identifier.

Format
uuid
instrumentobject

required

quantitystring

required

Pattern
^-?[0-9]{0,63}(\.[0-9]{1,27})?$
locked_for_tradingstring

required

Pattern
^[0-9]{0,63}(\.[0-9]{1,27})?$
pending_settlementstring

required

Pattern
^[0-9]{0,63}(\.[0-9]{1,27})?$
available_for_tradingstring

required

Pattern
^-?[0-9]{0,63}(\.[0-9]{1,27})?$
webhook_idstring

required

Webhook unique identifier.

Format
uuid

Responses

Request examples

{
  "id": "8962b496-8d42-4560-bfab-10490dd1a724",
  "created_at": "2021-07-21T14:10:00.00Z",
  "type": "POSITION.UPDATED",
  "object": {
    "account_id": "c5161455-4d27-4781-bc74-f05532e49a77",
    "instrument": {
      "isin": "US0378331005",
      "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321"
    },
    "quantity": "10.4",
    "locked_for_trading": "5",
    "pending_settlement": "0",
    "available_for_trading": "5.4"
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?