API Reference

Get Settlement Client Transaction Report

post
https://trade-hk.oslsandbox.com/api/3/settlement/transactions

Get client's Transactions report in CSV or JSON format. Supported data coverage of the report: 1hour or 24 hours based on client's input.
The Client Transactions report provides a detailed overview of all transactions executed. This report is useful for clients and platform administrators to monitor trading activity, reconcile accounts, and ensure compliance with regulatory requirements.

Body Params
int64
required

The current Unix time in microseconds.

string
Defaults to daily

Specify the period for data inclusion in the report. Default to daily. Takes precedence over start/end_datetime.
Valid values:daily: include data for the last 24h, e.g. running 'daily' report at 11:15AM would return data from 11:00AM the day before untill 11:00AM of the current day.
hourly : include data for the past hour, e.g. running 'hourly' report at 11:15AM would return data from 10:00AM to 11:00AM of the current day.

date

Specify adhoc report starting time in UTC in format: YYYY-MM-dd hh:mm:ssZ (e.g. 2023-01-30 23:59:59Z ). Value gets ignored if report_period is set. Default to 24h prior to the current hour. e.g. if current time is 11:15AM, the default start_datetime would be 11:00AM the previous day
Use this to generate report with non standard period of data coverage.

date

Specify adhoc report end time in UTC in format: YYYY-MM-dd hh:mm:ssZ (e.g. 2023-01-31 11:59:59Z ). Value gets ignored if report_period is set. Default to the current hour. e.g. if current time is 11:15AM, the default end_datetime would be 11:00AM the current day
Use this to generate report with non standard period of data coverage.

Headers
string
Defaults to application/json

The format of report to return. Default toapplication/json
Valid values:application/json: return report in JSON format.
text/csv: return report in CSV format.

Responses

Updated 10 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago