API Reference

Get Settlement Client Exchange Trades Report

Get client's exchange trades (fills) report in CSV or JSON format. The report supports two data coverage options based on the client's input: 1 hour or 24 hours.
The Client Exchange Trades Report provides a detailed overview of all trades executed on the exchange. This report is useful for clients and platform administrators to monitor trading activity, reconcile accounts, and evaluate trading performance.

Sample Settlement Exchange Trades Report (CSV )

Field NameDescriptionTypeExample
Exchange Trade Date TimeThe date and time that the trade was executed on the exchangeTimestamp2023-03-22T04:00:21.000Z
User UUIDA unique identifier assigned to the user who executed the tradeString29ffc2ce-9936-4f9b-9b56-c1e1d22906e1
UserThe name or username associated with the user who executed the tradeStringtester1@osl.com
Account GroupThe name of the group of accounts associated with the tradeStringDefault
Account Group UUIDA unique identifier assigned to the account group associated with the tradeString29ffc2ce-9936-4f9b-9b56-c1e1d22906e1
Site GroupThe group or team associated with the user who executed the tradeStringOSLLC_GROUP
Proxy UserA user who has been authorized to execute trades on behalf of another userStringtester1@osl.com
Trade ReferenceA reference number or identifier associated with the tradeStringCNUAZR
Buy/SellIndicates whether the trade was a `Buy`or `Sell`StringSell
Traded CurrencyThe currency in which the trade was executedStringETH
Traded AmountThe quantity or value of assets involved in the tradeNumeric0.2
Executed PriceThe price at which the trade was executedNumeric1,120.00
FeeThe fee charged for executing the tradeNumeric0.784
Settlement CurrencyThe currency in which the trade was settledStringUSD
Settlement AmountThe quantity or value of assets settled for the tradeNumeric223.216
TagA label or category assigned to the tradeString
IdA unique identifier assigned to the tradeStringa794fbef-aa56-498c-88c0-69cbca22d866
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.
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

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