Skip to main content
GET
Level 1 Quotes

Authorizations

x-api-key
string
header
required

Query Parameters

currency
string
default:IBIT
required

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

instrument
string

[Optional] Users can pass a single instrument in order to retrieve a time series of data for it. [Examples] IBIT-20DEC24-50-C

isAtm
boolean

[Optional] Users can pass an isAtm flag in order to return only ATM (at-the-money) options [Examples] TRUE | FALSE

startDate
string<date-time>

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

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

expiration
string

[Optional] The option instrument subset with a given expiration date. [Examples] 2027-01-15

strike
integer<int32>

[Optional] The option instrument subset with a given strike price. [Examples] 50 | 100

putCall
string

[Optional] The option instrument subset that's either a call (C) or put (P). [Examples] P | C

timeInterval
string

[Optional] Time interval of data frequency for the selected date range. [Examples] minute | hour | day [Note] Due to the density of data historical date ranges are limited to 60x 1-minute or 24x 1 hour intervals, per call.

timeFormat
string
default:hr

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

minStrike
integer

[Optional] The option with strikes at or above the minStrike. [Examples] 50 | 100

maxStrike
integer

[Optional] The option with strikes at or below the maxStrike. [Examples] 50 | 100

minDaysToExpiration
integer

[Optional] The option with days to expiration at or above the minDaysToExpiration. [Examples] 50 | 100

maxDaysToExpiration
integer

[Optional] The option with days to expiration at or below the maxDaysToExpiration. [Examples] 50 | 100

Response

200

status
integer
title
string
description
string
payload
object