Skip to main content
GET
Delta Surface Floating

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

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

daysToExpirationStart
integer<int32>

[Optional] Users can pass a days to expiration filter lower bound, to return only a subset of the delta surface. [Examples] 0 | 7 | 60

daysToExpirationEnd
integer<int32>

[Optional] Users can pass a days to expiration filter upper bound, to return only a subset of the delta surface. [Examples] 1 | 30 | 180

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

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

Response

200

status
integer
title
string
description
string
payload
object