API: Options chain & OPEX
Per-expiry summary
Per-expiry IV / skew / PCR / OI / GEX (with OPEX enrichment). One row per active expiry with the metrics most useful for chain-wide screening:…
GET
/
options
/
expiry-summary
Per-expiry IV / skew / PCR / OI / GEX (with OPEX enrichment)
curl --request GET \
--url https://api.example.com/options/expiry-summary \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.example.com/options/expiry-summary"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.example.com/options/expiry-summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/options/expiry-summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/options/expiry-summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/options/expiry-summary")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/options/expiry-summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"expiries": [
{
"expiry": "<string>",
"type": "daily",
"is_anchor": true,
"dte": 123,
"atm_iv": 123,
"skew_25d": 123,
"put_25d_iv": 123,
"call_25d_iv": 123,
"pcr": 123,
"call_oi": 123,
"put_oi": 123,
"total_oi": 123,
"net_gex": 123,
"expiry_date": "<string>",
"notional_oi_usd": 123,
"max_pain": {
"strike": 123,
"value": 123
},
"by_venue": {},
"by_venue_unattributed": {
"call_oi": 123,
"put_oi": 123,
"total_oi": 123,
"notional_oi_usd": 123
}
}
],
"anchor_count": 123,
"type_counts": {
"daily": 0,
"weekly": 0,
"monthly": 0,
"quarterly": 0
}
},
"meta": {
"version": "2.0",
"timestamp": "<string>",
"request_id": "<string>",
"symbol": "<string>",
"spot_price": 123,
"computed_at": "<string>",
"freshness_seconds": 123,
"source": [
"<string>"
],
"exchanges_filtered": [
"<string>"
],
"rate_limit": {},
"extra": {}
},
"success": true
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
},
"meta": {
"version": "2.0",
"timestamp": "2026-04-29T12:00:00Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"version": "2.0",
"timestamp": "<string>",
"request_id": "<string>",
"symbol": "<string>",
"spot_price": 123,
"computed_at": "<string>",
"freshness_seconds": 123,
"source": [
"<string>"
],
"exchanges_filtered": [
"<string>"
],
"rate_limit": {},
"extra": {}
},
"success": false
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": {
"errors": []
}
},
"meta": {
"version": "2.0",
"timestamp": "2026-04-29T12:00:00Z"
}
}{
"success": false,
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Rate limit exceeded. Try again later."
},
"meta": {
"version": "2.0",
"timestamp": "2026-04-29T12:00:00Z"
}
}One row per active expiry with ATM IV, 25Δ skew, PCR, OI, net GEX, plus
OPEX enrichment (
See Venue coverage for which venues feed the blend.
type, is_anchor, expiry_date, notional_oi_usd,
max_pain).
OI and notional
| Field | Unit |
|---|---|
call_oi / put_oi / total_oi | Coin of underlying (multi-venue sum) |
notional_oi_usd | total_oi × spot_price when spot is present |
See also
OPEX calendar
OI by expiry
IV suite
Authorizations
Your BackQuant API key (same key as v1)
Headers
Query Parameters
Trading symbol: BTCUSDT, ETHUSDT, SOLUSDT, or HYPEUSDT.
Available options:
BTCUSDT, ETHUSDT, SOLUSDT, HYPEUSDT Response
Successful Response
Show child attributes
Show child attributes
The meta block returned alongside every v2 response.
Every field after version/timestamp is optional because endpoints
attach different combinations - e.g. /v2/status skips symbol, the
chain endpoint sets extra.filter_hash, etc. Listing them here means
SDKs get a typed accessor for each instead of a generic meta: dict.
Show child attributes
Show child attributes
⌘I
Per-expiry IV / skew / PCR / OI / GEX (with OPEX enrichment)
curl --request GET \
--url https://api.example.com/options/expiry-summary \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.example.com/options/expiry-summary"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.example.com/options/expiry-summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/options/expiry-summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/options/expiry-summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/options/expiry-summary")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/options/expiry-summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"expiries": [
{
"expiry": "<string>",
"type": "daily",
"is_anchor": true,
"dte": 123,
"atm_iv": 123,
"skew_25d": 123,
"put_25d_iv": 123,
"call_25d_iv": 123,
"pcr": 123,
"call_oi": 123,
"put_oi": 123,
"total_oi": 123,
"net_gex": 123,
"expiry_date": "<string>",
"notional_oi_usd": 123,
"max_pain": {
"strike": 123,
"value": 123
},
"by_venue": {},
"by_venue_unattributed": {
"call_oi": 123,
"put_oi": 123,
"total_oi": 123,
"notional_oi_usd": 123
}
}
],
"anchor_count": 123,
"type_counts": {
"daily": 0,
"weekly": 0,
"monthly": 0,
"quarterly": 0
}
},
"meta": {
"version": "2.0",
"timestamp": "<string>",
"request_id": "<string>",
"symbol": "<string>",
"spot_price": 123,
"computed_at": "<string>",
"freshness_seconds": 123,
"source": [
"<string>"
],
"exchanges_filtered": [
"<string>"
],
"rate_limit": {},
"extra": {}
},
"success": true
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
},
"meta": {
"version": "2.0",
"timestamp": "2026-04-29T12:00:00Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"meta": {
"version": "2.0",
"timestamp": "<string>",
"request_id": "<string>",
"symbol": "<string>",
"spot_price": 123,
"computed_at": "<string>",
"freshness_seconds": 123,
"source": [
"<string>"
],
"exchanges_filtered": [
"<string>"
],
"rate_limit": {},
"extra": {}
},
"success": false
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": {
"errors": []
}
},
"meta": {
"version": "2.0",
"timestamp": "2026-04-29T12:00:00Z"
}
}{
"success": false,
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Rate limit exceeded. Try again later."
},
"meta": {
"version": "2.0",
"timestamp": "2026-04-29T12:00:00Z"
}
}