Skip to main content
GET
Trade Frequency

Authorizations

x-api-key
string
header
required

Query Parameters

exchange
string
default:gdax

[Optional] The exchange for which to retrieve listed spot instruments. [Examples] gdax | okex | binance | binanceus

pair
string
default:btc_usd
required

[Required] The currency pair for the spot instrument. [Examples] btc_usd | btc_usdc | eth_usd

fuzzyMatch
boolean
default:false
required

[Required] This parameter allows users to return either a specific pair, such as btc_usd, when set to FALSE, or return every pair related to an underlying asset, such as BTC, when set to TRUE (ex: btc_eur, btc_usd, btc_usdt, etc)

orderSizeCategoryUsd
string
default:All

[Optional] Users can specify to return all aggregated trades or only trades that fit a specific size threshold (0-1k, 1k-10k, 10k-100k, 100k+, ALL). Users can specify by passing the lower threshold flag 0 | 1k | 10k | 100k | All

startDate
string
default:2025-05-01

[Optional] Payload only includes data after this date (inclusive). [Formats] seconds | milliseconds | iso8601 [Examples] 1578531600 | 1578531600000 | 2025-02-27

endDate
string
default:2025-05-01

[Optional] Payload only includes data up to this date. [Formats] seconds | milliseconds | iso8601 [Examples] 1578531600 | 1578531600000 | 2025-02-28

timeFormat
string
default:hr

[Optional] Time format of the timestamps in the return payload. [Defaults] milliseconds | ms* | iso | iso8601 | hr | human_readable

timeInterval
string
default:day

[Optional] Time interval of data frequency for the selected date range. [Examples] minute | hour | day

Response

200 - application/json

200

status
integer
Example:

200

title
string
Example:

"OK"

description
string
Example:

"Successful request"

payload
object