GET List Cash Transfers

GET{account code}/transfers
GET{account codes}

Query cash transfers (deposits, withdrawals etc.) for a period of time on an account or multiple accounts. This includes transfers made manually as well as transfers that are a result of a position update (e.g. PnL settlement) and commissions.

// Request

Empty request

Authorization header should be included in case of basic authentication

// Path Parameters

account code - unique code assigned to an account (see Account Code)

// Query Parameters

The following parameters are supported to query orders for multiple accounts:

account codes (optional) - comma-separated list of unique codes assigned to an account (see Account Code)
limit (optional) - maximum number of transfers to be returned. Maximum possible value is server-configured; if a larger value is specified, the maximum value is used.
start-from (optional) - indicates the starting index of a transfer in a response to return. Default value is 0. To use paging set the limit and start-from parameters. Ex. for the limit=10&start-from=100 query the results page will contain transfers from 101st to 110th.
of-type (optional) - specifies a filter for transfer reasons. Accepts comma-separated list of reasons:










Multiple reasons are treated as "or" – a transfer that has any of these reasons is returned.

time-from, time-to (optional) - a filter for the transfer timestamp in UTC (see Dates and Times). Filter is inclusive.
If only time-from is specified, all transfers from this time until now are returned. If only time-to is specified, all transfers from the very first transfer on an account until the specified time are returned.
period (optional) - a shortcut filter for transfer date. A set of predefined values to query transfers:
today – lists all transfers for the current business day.
previous-day – lists all transfers for the previous day.
week – lists all transfers for this trading week.
previous-week – lists all transfers for previous trading week.

// Response

A list of cash transfers that match the request

The ETag header is sent.

// Errors 

Common errors

API is not permitted for the user

Status code: 404 Not Found
Error code: 2
Description: Entity not found at server

Last updated