Skip to main content
GET
Bid Ask Spread

Authorizations

x-api-key
string
header
required

Query Parameters

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 controls how the provided trading pair symbol is interpreted. When set to FALSE, it returns data only for the exact pair specified (e.g., btc_usd). When set to TRUE, it enables fuzzy matching—users can then pass just the base asset (e.g., btc) returns all pairs with that base (e.g., btc_eur, btc_usd, btc_usdt, etc.), while passing a full pair like btc_usd returns all pairs with the same base and similar USD-related quote assets (e.g., btc_usd, btc_usdt, btc_usdc, etc.).

exchange
string

[Optional] The exchange for the associated bid ask spread. [Examples] gdax | okex | binance | binanceus

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-02

[Optional] Payload only includes data up to this date (exclusive). [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

Response

200

status
integer
Example:

200

title
string
Example:

"OK"

description
string
Example:

"Successful request"

payload
object