Skip to main content
GET
Decorated Trades

Authorizations

x-api-key
string
header
required

Headers

Accept-Encoding
string
default:gzip

Query Parameters

currency
string
default:IBIT
required

[Required] The underlying currency for which there are listed option instruments. [Examples] IBIT | COIN

expiration
string<date-time>

[Optional] Filter records based on the specified expiration date. [Examples] 1578531600 | 1578531600000 | 2026-01-16

instrument
string

[Optional] Users can pass a single instrument in order to retrieve trade data for only the specified instrument. [Examples] IBIT-16JAN26-100-C

startDate
string<date-time>
default:2024-11-21T15:00:00.000Z

[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-11-21T16:00:00.000Z

[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] 100 | 35

timeFormat
string
default:hr

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

tradeAmountMinimum
string

[Optional] This endpoint allows users to filter trades that meet a select trade size criteria.

tradeAmountMaximum
string

[Optional] This endpoint allows users to filter trades that do not exceed a select trade size criteria.

Response

200

status
integer
title
string
description
string
payload
object