Transaction report
POST/v1/reports/transactions_report
Returns transaction report using the specified criteria
Request
- application/json
Body
Requested trade date period start
Requested trade date period end If not specified considered as the current date by default
Filters by an array of instruments of requested trades, base currency first
Possible values: >= 6 characters and <= 6 characters
["USDBRL","USDCNY"]Responses
- 200
- 401
- 403
- 409
- 500
Your request has been successfully processed
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Trading operation date/time
Trade ID provided by the liquidity provider, displayOrderId
Buy/Sell
Possible values: [BUY, SELL]
BUYTrade amount
Currency sold (to sell)
Possible values: >= 3 characters and <= 3 characters
BRLAmount sold (to sell)
Possible values: >= 3 characters and <= 3 characters
USDCurrency bought (to buy)
100000.00Amount sold (to sell)
100000.00Trade rate
100.00Trade value date
Type of order (limit_order, market_order, rfq, rfs)
User-friendly representation of the current state of the trade View OMS states REST status states for providing the correct status value
Liquidity provided that the trade was made with
Comment (order notes) added by user
Trade ABX order ID
Trader’s ID
Trade instrument
Possible values: >= 6 characters and <= 6 characters
USDBRL[
{
"trade_date": "2024-07-29T15:51:28.071Z",
"trade_id": "string",
"trade_side": "BUY",
"trade_amount": 0,
"buy_currency": "BRL",
"sell_currency": "USD",
"buy_amount": "100000.00",
"sell_amount": "100000.00",
"rate": "100.00",
"value_date": "2024-07-29T15:51:28.071Z",
"order_type": "string",
"status": "string",
"vendor": "string",
"order_notes": "string",
"order_id": "string",
"user_id": "string",
"user_email": "[email protected]",
"instrument": "USDBRL"
}
]
Authentication token is required for this action that was not provided, expired or invalid.
- application/json
- Schema
- Example (from schema)
Schema
Links error message to a specific event in the system.
The code for the error that has occurred.
The text for the error that has occurred.
An optional parameter name related to the error. Usually present for input validation errors.
An optional parameter value related to the error. Set to input value of named parameter.
{
"errorId": "string",
"code": "string",
"text": "string",
"parameter_name": "string",
"parameter_value": {}
}
Not authorized for the requested action.
- application/json
- Schema
- Example (from schema)
Schema
Links error message to a specific event in the system.
The code for the error that has occurred.
The text for the error that has occurred.
An optional parameter name related to the error. Usually present for input validation errors.
An optional parameter value related to the error. Set to input value of named parameter.
{
"errorId": "string",
"code": "string",
"text": "string",
"parameter_name": "string",
"parameter_value": {}
}
Action could not be completed because of conflict.
- application/json
- Schema
- Example (from schema)
Schema
Links error message to a specific event in the system.
The code for the error that has occurred.
The text for the error that has occurred.
An optional parameter name related to the error. Usually present for input validation errors.
An optional parameter value related to the error. Set to input value of named parameter.
{
"errorId": "string",
"code": "string",
"text": "string",
"parameter_name": "string",
"parameter_value": {}
}
Internal server error.
- application/json
- Schema
- Example (from schema)
Schema
Links error message to a specific event in the system.
The code for the error that has occurred.
The text for the error that has occurred.
An optional parameter name related to the error. Usually present for input validation errors.
An optional parameter value related to the error. Set to input value of named parameter.
{
"errorId": "string",
"code": "string",
"text": "string",
"parameter_name": "string",
"parameter_value": {}
}