Skip to main content
Error

Authorizations

X-API-KEY
string
header
required

HMAC-SHA256 authentication. Sign every request and send X-API-KEY, X-API-SIGNATURE, X-API-TIMESTAMP and X-API-NONCE (see the Authentication guide). Each route also requires a specific claim on your API key (e.g. read:orders, write:orders, read:account, read:market-data).

Query Parameters

product_ids
string[]

Repeat or comma-separate (e.g. ?product_ids=BTC-USD,ETH-USD).

Example:
statuses
enum<string>[]

Filter by status. Accepts repeated keys or comma-separated. Values are uppercased on transform.

Available options:
CANCELLED,
EXPIRED,
FAILED,
FILLED
Example:
type
enum<string>

Filter by order type (LIMIT, MARKET, STOP_LIMIT). Omit to return all types.

Available options:
LIMIT,
MARKET,
STOP_LIMIT
Example:

"LIMIT"

side
enum<string>

Filter by order side.

Available options:
BUY,
SELL
Example:

"BUY"

start_date
string<date-time>

ISO 8601 timestamp (inclusive lower bound).

Example:

"2025-12-01T00:00:00Z"

end_date
string<date-time>

ISO 8601 timestamp (inclusive upper bound, must be ≥ start_date).

Example:

"2025-12-09T23:59:59Z"

Response

statusCode
number
required

HTTP status code echoed in the body.

Example:

200

success
boolean
required

True for success responses.

Example:

true

message
string

Human-readable status message.

Example:

"Request processed successfully"

data
object[]