POST
/
api
/
orders
/
export
Export orders as CSV
curl --request POST \
  --url https://app.sandbox.rio.trade/api/orders/export \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "email": "user@example.com",
  "id": "b49f4084b96e4fb76f5a496e",
  "userId": "b49f4084b96e4fb76f5a496e",
  "brokerId": "b49f4084b96e4fb76f5a496e",
  "startDate": "2024-01-01T00:00:00.000Z",
  "endDate": "2024-01-31T23:59:59.999Z",
  "fiat": "MXN",
  "crypto": "BTC",
  "side": "Buy",
  "status": "completed",
  "country": "Mexico",
  "minOrderSize": 100,
  "maxOrderSize": 10000,
  "orderStatusGroups": [
    "completed",
    "processing"
  ]
}'

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
email
string<email>
required

Email address to send the CSV file to

Example:

"user@example.com"

​
id
string

Order id by which you want to filter

Example:

"b49f4084b96e4fb76f5a496e"

​
userId
string

User id by which you want to filter

Example:

"b49f4084b96e4fb76f5a496e"

​
brokerId
string

Broker id by which you want to filter

Example:

"b49f4084b96e4fb76f5a496e"

​
startDate
string<date-time>

Start date for filtering orders

Example:

"2024-01-01T00:00:00.000Z"

​
endDate
string<date-time>

End date for filtering orders

Example:

"2024-01-31T23:59:59.999Z"

​
fiat
string

Fiat currency by which you want to filter

Example:

"MXN"

​
crypto
string

Crypto currency by which you want to filter

Example:

"BTC"

​
side
enum<string>

Order side by which you want to filter

Available options:
Buy,
Sell
​
status
string

Order status by which you want to filter

Example:

"completed"

​
country
string

Country by which you want to filter

Example:

"Mexico"

​
minOrderSize
number

Minimum order size to filter by

Required range: x >= 0
Example:

100

​
maxOrderSize
number

Maximum order size to filter by

Required range: x >= 0
Example:

10000

​
orderStatusGroups
string[]

Array of order status groups to filter by

Example:
["completed", "processing"]

Response

Export request accepted. CSV will be sent to the provided email.