Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Movements

List movements

Retrieves the history of each itemized movement that has been applied to all account(s) that the requesting platform has access to. Results are limited to the last 2 months

get/movements

Query parameters

pagenumber
Example:1

Page number for pagination (starts at 1).

page_sizenumber
Example:15

Number of items per page for pagination. Default and maximum is 100

parent_link_idstring

Filters for movements that are tagged with a specific parent_link_id.

movement_type'initial_margin' | 'deposit' | 'execution_fee' | 'final_settlement' | 'final_settlement_default' | 'final_settlement_default_fallback' | 'final_settlement_default_partial' | 'final_settlement_outstanding' | 'interest_payment' | 'collateralize_loan' | 'loan_collateral_return' | 'network_fee' | 'otc_final_settlement' | 'principal_swap' | 'repayment' | 'transfer' | 'variation_margin' | 'variation_margin_call' | 'withdrawal' | 'withdrawal_confirmed' | 'withdrawal_pending' | 'commission' | 'bank_fee' | 'transaction_fee'

The type of movement

Example:final_settlement

The type of the movement

transfer_type'trade_allocation' | 'commission_allocation' | 'commission_correction' | 'revenue_capture' | 'fund' | 'pay' | 'prefunded'
Example:prefunded

Filters for movements with a specific transfer_type.

account_idstring

This parameter enables the filtering of movements based on the associated account_id.

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

Paginated list of movements for the accounts the requesting platform has access to. Results are limited to the last 2 months.

pagenumber
total_pagesnumber

Example response

{
  "message": [
    {
      "movement_timestamp": 1554395972174,
      "account_id": "ce819fe8-b1d7-43bb-961c-e09ede0988d3",
      "movement_id": "ab938734-0aa6-4378-baa1-2cc56aeee757",
      "movement_type": "final_settlement",
      "deposit_reference_id": "3ad29e08-8b4f-435b-89aa-17b7a298b350",
      "withdrawal_request_id": "3ad29e08-8b4f-435b-89aa-17b7a298b350",
      "transfer_id": "78",
      "parent_link_id": "3ad29e08-8b4f-435b-89aa-17b7a298b350",
      "trade_id": "3ad29e08-8b4f-435b-89aa-17b7a298b350",
      "change": "10000",
      "origin": "rest_api"
    }
  ],
  "page": 1,
  "total_pages": 1
}