Skip to main content
GET
/
v1
/
stats
/
orders
Orders
curl --request GET \
  --url https://{defaultHost}/v1/stats/orders \
  --header 'Authorization: Bearer <token>'
{
  "object": "stats",
  "query": {
    "currency": "usd",
    "end_at": 1771459199,
    "interval": "day",
    "live_mode": true,
    "start_at": 1770768000
  },
  "data": [
    {
      "interval_at": 1770768000,
      "amount": 0,
      "average_amount": 0,
      "count": 0
    },
    {
      "interval_at": 1770854400,
      "amount": 0,
      "average_amount": 0,
      "count": 0
    },
    {
      "interval_at": 1770940800,
      "amount": 0,
      "average_amount": 0,
      "count": 0
    },
    {
      "interval_at": 1771027200,
      "amount": 0,
      "average_amount": 0,
      "count": 0
    },
    {
      "interval_at": 1771113600,
      "amount": 0,
      "average_amount": 0,
      "count": 0
    },
    {
      "interval_at": 1771200000,
      "amount": 0,
      "average_amount": 0,
      "count": 0
    },
    {
      "interval_at": 1771286400,
      "amount": 0,
      "average_amount": 0,
      "count": 0
    },
    {
      "interval_at": 1771372800,
      "amount": 8700,
      "average_amount": 2900,
      "count": 3
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
currency[]
string[]

Only return objects that have the given currencies.

​
end_at
string
required

The end of the date range to query.

​
interval
string
required

The interval to group statistics on – one of hour, day, week, month, or year.

​
live_mode
boolean

Only return objects that are live mode or test mode.

​
start_at
string
required

The start of the date range to query.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
query
object
​
data
array

An array of objects.