Get Ledgers
Header Parameters
Bearer token issued for your trading account.
Query Parameters
Start of the time range.
End of the time range.
Entry type to filter by: SWAP, COMMISSION, DEPOSIT, WITHDRAWAL, CREDIT_IN, CREDIT_OUT, CLOSE_POSITION, or AGENT_COMMISSION. Repeat the parameter for several types; omit it to return all of them. An unsupported value returns 400 error://trader-api/ledger-type-invalid.
SWAPCOMMISSIONDEPOSITWITHDRAWALCREDIT_INCREDIT_OUTCLOSE_POSITIONAGENT_COMMISSIONMaximum number of entries to return. Defaults to 100, maximum 500.
Response
OK
Response Attributes
Cash-flow entries within the requested range.
Show child attributes
error://trader-api/ledger-type-invalid
Response Attributes
The request path with the actual identifiers filled in, without query parameters.
The HTTP status code, the same as the response status.
A stable identifier of the kind of error, in the form error://trader-api/{code}. Base your error handling on this field, not on title or detail.
error://trader-api/ledger-type-invalidA short, human-readable name of the error. Several types can share the same title.
A description of this particular occurrence. The wording can change, so never parse it or base logic on it.
Extra information as key-value pairs.
error://trader-api/unauthorized
Response Attributes
The request path with the actual identifiers filled in, without query parameters.
The HTTP status code, the same as the response status.
A stable identifier of the kind of error, in the form error://trader-api/{code}. Base your error handling on this field, not on title or detail.
error://trader-api/unauthorizedA short, human-readable name of the error. Several types can share the same title.
A description of this particular occurrence. The wording can change, so never parse it or base logic on it.
Extra information as key-value pairs.
error://trader-api/forbidden
Response Attributes
The request path with the actual identifiers filled in, without query parameters.
The HTTP status code, the same as the response status.
A stable identifier of the kind of error, in the form error://trader-api/{code}. Base your error handling on this field, not on title or detail.
error://trader-api/forbiddenA short, human-readable name of the error. Several types can share the same title.
A description of this particular occurrence. The wording can change, so never parse it or base logic on it.
Extra information as key-value pairs.
Response