Sway Charts API Documentation
  • REST API Specification
    • Getting Started
      • Introduction
      • Errors
      • API Versioning
      • Conditional Requests & Updates
      • Entity Versioning
      • Data Types and Formats
      • Rate Limits & Throttling
    • Authentication & Authorization
      • HMAC Authentication
      • POST Create Session Token
      • POST Ping
      • POST Logout
    • Trading
      • POST Place Order
      • PUT Modify Order
      • DELETE Cancel Order
    • Reference Data
      • GET List Instruments
      • List Instrument Details
    • Users and Accounts
      • GET Get Users
      • GET List Account Portfolio
      • GET List Open Positions
      • GET List Open Orders
      • GET List Cash Transfers
      • GET POST List Orders
      • GET List Account Metrics
      • GET List Account Events
    • Market Data
      • POST Request Market Data
    • Conversion Rates
      • POST Get Conversion Rates
    • Cash Transaction
      • Single Order Request
      • Order Group Request
      • Order Response
      • Instrument
      • Instrument Details
      • Trading Session
      • Limit Value
      • Margin Rate
      • Margin Tier
      • User Details
      • Account Details
      • Account Portfolio
      • Balance
      • Position
      • Order
      • Order Leg
      • Execution
      • Cash Transfer
      • Historic Order List
      • Account Metrics
      • Position Metrics
      • Currency Metrics
      • Account Event
      • Market Data Request
      • Market Data Event Type
      • Market Data List
      • Quote
      • Candle
      • Conversion Rate
    • Revision History
Powered by GitBook
On this page
  1. REST API Specification
  2. Users and Accounts

GET List Cash Transfers

GET https://api.swaycharts.io/dxsca-web/accounts/{account code}/transfers
GET https://api.swaycharts.io/dxsca-web/accounts/transfers?accounts={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:
COMMISSION

FINANCING

DEPOSIT

WITHDRAWAL

COST

SETTLEMENT

EX_DIVIDEND

REBATE

NEGATIVE_BALANCE_CORRECTION

BUST

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
PreviousGET List Open OrdersNextGET POST List Orders

Last updated 1 year ago