Skip to main content
GET
Decorated Trades

Authorizations

x-api-key
string
header
required

Headers

Accept-Encoding
string
default:gzip

Query Parameters

exchange
string
default:deribit
required

[Required] The exchange for which to retrieve the listed option level 1 quotes. [Examples] deribit | okex | bybit

currency
string
default:BTC
required

[Required] The underlying currency for which there are listed option instruments. [Examples] BTC | SOL_USDC Note: inverse options have underlying currencies formatted as (BTC, ETH) while linear option currency formats include the stable coin in the same (SOL_USDC)

expiration
string<date-time>

[Optional] Filter records based on the specified expiration date. [Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

instrument
string

[Optional] Users can pass a single instrument in order to retrieve trade data for only the specified instrument. [Examples] BTC-26APR24-100000-C

putCall
string

[Optional] The option type [Examples] C | P

startDate
string<date-time>
default:2024-05-01T00:00:00

[Optional] Payload only includes data after this date (inclusive). [Formats] seconds | milliseconds | iso8601 [Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

endDate
string<date-time>
default:2024-05-01T01:00:00

[Optional] Payload only includes data before this date (exclusive). [Formats] seconds | milliseconds | iso8601 [Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

strike
integer<int32>

[Optional] The option instrument subset with a given strike price. [Examples] 100000 | 3500

timeFormat
string

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

blockTradeId
boolean

[Optional] This flag enables users to filter for only blockTrade or non-blockTrades. If the user wants everything returned they can choose to leave the parameter blank.

Response

Successful request

status
integer
default:0
Example:

200

title
string
Example:

"OK"

description
string
Example:

"Successful request"

payload
object