{ "openapi": "3.1.0", "info": { "title": "occfin API Reference", "version": "0.1.0", "description": "OCC source API for bluedoor Financial Data.\nClearing-house data for options market structure and contract lifecycle work.\nCoverage: Daily options volume; Open interest; Series and deliverables; Settlements and threshold securities.\nGenerated from the live source contract and representative live API responses on 2026-06-07T01:30:59.456Z." }, "servers": [ { "url": "https://api.occfin.bluedoor.sh", "description": "occfin source API" } ], "externalDocs": { "description": "OCC source API docs", "url": "https://bluedoor.sh/apis/financial-data/sources/occfin" }, "tags": [ { "name": "Options" }, { "name": "Volume" } ], "paths": { "/v1/threshold-securities": { "get": { "parameters": [ { "description": "Recent trading date in YYYYMMDD format.", "in": "query", "name": "date", "required": true, "schema": { "type": "string" } }, { "name": "x-occfin-contact", "in": "header", "required": false, "schema": { "type": "string", "format": "email" }, "description": "Optional contact email for higher public rate limits and support diagnostics." }, { "name": "authorization", "in": "header", "required": false, "schema": { "type": "string", "example": "Bearer " }, "description": "Optional API-key authorization for higher-volume access tiers." } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/occfin_get_threshold_securitiesResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "product": "occfin", "source": "occ", "endpoint_id": "occ.threshold_securities", "route": "/v1/threshold-securities", "path_params": {}, "rate_plan": { "public_request_budget_per_user_rpm": 200 }, "status": "ok" }, "data": { "format": "delimited", "delimiter": "|", "section_count": 1, "row_count": 0, "sections": [ { "title": "File requested does not exist.", "columns": [], "rows": [] } ] } } } } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "401": { "description": "Unauthorized. API-key authenticated tiers use an Authorization bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 401 error", "value": { "ok": false, "error": { "code": "unauthorized", "message": "A valid API key is required for this tier." } } } } } } }, "404": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "405": { "description": "Method not allowed. Source API routes are documented as HTTP GET unless otherwise specified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 405 error", "value": { "ok": false, "error": { "code": "method_not_allowed", "message": "This route does not support the requested HTTP method." } } } } } } }, "429": { "description": "Rate limited. Retry after the limit reset or include the documented contact/API-key headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 429 error", "value": { "ok": false, "error": { "code": "rate_limited", "message": "Too many requests. Retry after the rate-limit reset." } } } } } } }, "502": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "503": { "description": "Service unavailable. The source API or an upstream dependency is temporarily unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 503 error", "value": { "ok": false, "error": { "code": "service_unavailable", "message": "The service is temporarily unavailable." } } } } } } }, "504": { "description": "Upstream timeout. The upstream source did not return within the source API timeout window.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 504 error", "value": { "ok": false, "error": { "code": "upstream_timeout", "message": "The upstream source timed out." } } } } } } } }, "summary": "Threshold securities", "security": [ {}, { "ContactEmail": [] }, { "BearerAuth": [] }, { "OccfinApiKey": [] } ], "operationId": "occfin_get_threshold_securities", "description": "Returns threshold securities with source-native fields and identifiers.", "x-source-api": "occfin", "x-source-name": "OCC", "x-source-upstream": "theocc.com", "x-docs-example-url": "https://api.occfin.bluedoor.sh/v1/threshold-securities?date=20260121", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:33:20.534Z" } }, "/v1/trade-volume": { "get": { "parameters": [ { "description": "Recent trading date in YYYYMMDD format.", "in": "query", "name": "date", "required": true, "schema": { "type": "string" } }, { "name": "x-occfin-contact", "in": "header", "required": false, "schema": { "type": "string", "format": "email" }, "description": "Optional contact email for higher public rate limits and support diagnostics." }, { "name": "authorization", "in": "header", "required": false, "schema": { "type": "string", "example": "Bearer " }, "description": "Optional API-key authorization for higher-volume access tiers." } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/occfin_get_trade_volumeResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "product": "occfin", "source": "occ", "endpoint_id": "occ.trade_volume_xml", "route": "/v1/trade-volume", "path_params": {}, "rate_plan": { "public_request_budget_per_user_rpm": 200 }, "status": "ok" }, "data": { "format": "xml", "row_count": 0, "rows": [] } } } } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "401": { "description": "Unauthorized. API-key authenticated tiers use an Authorization bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 401 error", "value": { "ok": false, "error": { "code": "unauthorized", "message": "A valid API key is required for this tier." } } } } } } }, "404": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "405": { "description": "Method not allowed. Source API routes are documented as HTTP GET unless otherwise specified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 405 error", "value": { "ok": false, "error": { "code": "method_not_allowed", "message": "This route does not support the requested HTTP method." } } } } } } }, "429": { "description": "Rate limited. Retry after the limit reset or include the documented contact/API-key headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 429 error", "value": { "ok": false, "error": { "code": "rate_limited", "message": "Too many requests. Retry after the rate-limit reset." } } } } } } }, "502": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "503": { "description": "Service unavailable. The source API or an upstream dependency is temporarily unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 503 error", "value": { "ok": false, "error": { "code": "service_unavailable", "message": "The service is temporarily unavailable." } } } } } } }, "504": { "description": "Upstream timeout. The upstream source did not return within the source API timeout window.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 504 error", "value": { "ok": false, "error": { "code": "upstream_timeout", "message": "The upstream source timed out." } } } } } } } }, "summary": "Trade volume", "security": [ {}, { "ContactEmail": [] }, { "BearerAuth": [] }, { "OccfinApiKey": [] } ], "operationId": "occfin_get_trade_volume", "description": "Returns trade volume with source-native fields and identifiers.", "x-source-api": "occfin", "x-source-name": "OCC", "x-source-upstream": "theocc.com", "x-docs-example-url": "https://api.occfin.bluedoor.sh/v1/trade-volume?date=20260121", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:33:20.928Z" } }, "/v1/flex/equity-prices": { "get": { "parameters": [ { "description": "FLEX report date in YYYYMMDD format.", "in": "query", "name": "date", "required": true, "schema": { "type": "string" } }, { "name": "x-occfin-contact", "in": "header", "required": false, "schema": { "type": "string", "format": "email" }, "description": "Optional contact email for higher public rate limits and support diagnostics." }, { "name": "authorization", "in": "header", "required": false, "schema": { "type": "string", "example": "Bearer " }, "description": "Optional API-key authorization for higher-volume access tiers." } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/occfin_get_flex_equity_pricesResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "product": "occfin", "source": "occ", "endpoint_id": "occ.flex_equity_price_report", "route": "/v1/flex/equity-prices", "path_params": {}, "rate_plan": { "public_request_budget_per_user_rpm": 200 }, "status": "ok" }, "data": { "format": "occ_flex_price", "row_count": 10208, "rows": [ { "symbol": "1AAL", "call_put": "C", "expiration": "2026-02-13", "strike_price": 18.61, "mark_price": 0.0976 }, { "symbol": "1AAL", "call_put": "C", "expiration": "2026-03-19", "strike_price": 13.18, "mark_price": 2.3536 }, { "symbol": "1AAL", "call_put": "C", "expiration": "2026-05-22", "strike_price": 15.18, "mark_price": 1.6599 } ], "line_count": 11045 } } } } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "401": { "description": "Unauthorized. API-key authenticated tiers use an Authorization bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 401 error", "value": { "ok": false, "error": { "code": "unauthorized", "message": "A valid API key is required for this tier." } } } } } } }, "404": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "405": { "description": "Method not allowed. Source API routes are documented as HTTP GET unless otherwise specified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 405 error", "value": { "ok": false, "error": { "code": "method_not_allowed", "message": "This route does not support the requested HTTP method." } } } } } } }, "429": { "description": "Rate limited. Retry after the limit reset or include the documented contact/API-key headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 429 error", "value": { "ok": false, "error": { "code": "rate_limited", "message": "Too many requests. Retry after the rate-limit reset." } } } } } } }, "502": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "503": { "description": "Service unavailable. The source API or an upstream dependency is temporarily unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 503 error", "value": { "ok": false, "error": { "code": "service_unavailable", "message": "The service is temporarily unavailable." } } } } } } }, "504": { "description": "Upstream timeout. The upstream source did not return within the source API timeout window.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 504 error", "value": { "ok": false, "error": { "code": "upstream_timeout", "message": "The upstream source timed out." } } } } } } } }, "summary": "FLEX equity prices", "security": [ {}, { "ContactEmail": [] }, { "BearerAuth": [] }, { "OccfinApiKey": [] } ], "operationId": "occfin_get_flex_equity_prices", "description": "Returns FLEX equity prices with source-native fields and identifiers.", "x-source-api": "occfin", "x-source-name": "OCC", "x-source-upstream": "theocc.com", "x-docs-example-url": "https://api.occfin.bluedoor.sh/v1/flex/equity-prices?date=20260121", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:33:21.358Z" } }, "/v1/futures/open-interest": { "get": { "parameters": [ { "description": "OCC report date in YYYYMMDD format.", "in": "query", "name": "date", "required": true, "schema": { "type": "string" } }, { "name": "x-occfin-contact", "in": "header", "required": false, "schema": { "type": "string", "format": "email" }, "description": "Optional contact email for higher public rate limits and support diagnostics." }, { "name": "authorization", "in": "header", "required": false, "schema": { "type": "string", "example": "Bearer " }, "description": "Optional API-key authorization for higher-volume access tiers." } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/occfin_get_futures_open_interestResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "product": "occfin", "source": "occ", "endpoint_id": "occ.futures_open_interest", "route": "/v1/futures/open-interest", "path_params": {}, "rate_plan": { "public_request_budget_per_user_rpm": 200 }, "status": "ok" }, "data": { "format": "csv", "delimiter": ",", "section_count": 1, "row_count": 58, "sections": [ { "title": null, "columns": [ "futures_open_interest_total", "410_954" ], "rows": [ { "futures_open_interest_total": null, "410_954": null }, { "futures_open_interest_total": "Clearing Symbol", "410_954": "Contract Expiration" }, { "futures_open_interest_total": "IBHY", "410_954": 202603 } ] } ] } } } } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "401": { "description": "Unauthorized. API-key authenticated tiers use an Authorization bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 401 error", "value": { "ok": false, "error": { "code": "unauthorized", "message": "A valid API key is required for this tier." } } } } } } }, "404": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "405": { "description": "Method not allowed. Source API routes are documented as HTTP GET unless otherwise specified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 405 error", "value": { "ok": false, "error": { "code": "method_not_allowed", "message": "This route does not support the requested HTTP method." } } } } } } }, "429": { "description": "Rate limited. Retry after the limit reset or include the documented contact/API-key headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 429 error", "value": { "ok": false, "error": { "code": "rate_limited", "message": "Too many requests. Retry after the rate-limit reset." } } } } } } }, "502": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "503": { "description": "Service unavailable. The source API or an upstream dependency is temporarily unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 503 error", "value": { "ok": false, "error": { "code": "service_unavailable", "message": "The service is temporarily unavailable." } } } } } } }, "504": { "description": "Upstream timeout. The upstream source did not return within the source API timeout window.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 504 error", "value": { "ok": false, "error": { "code": "upstream_timeout", "message": "The upstream source timed out." } } } } } } } }, "summary": "Futures open interest", "security": [ {}, { "ContactEmail": [] }, { "BearerAuth": [] }, { "OccfinApiKey": [] } ], "operationId": "occfin_get_futures_open_interest", "description": "Returns futures open interest with contract, root, settlement, or market fields from the upstream data shape.", "x-source-api": "occfin", "x-source-name": "OCC", "x-source-upstream": "theocc.com", "x-docs-example-url": "https://api.occfin.bluedoor.sh/v1/futures/open-interest?date=20260121", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:33:21.740Z" } }, "/v1/open-interest/daily": { "get": { "parameters": [ { "description": "OCC open-interest report date in MM/DD/YYYY format.", "in": "query", "name": "date", "required": true, "schema": { "type": "string" } }, { "name": "x-occfin-contact", "in": "header", "required": false, "schema": { "type": "string", "format": "email" }, "description": "Optional contact email for higher public rate limits and support diagnostics." }, { "name": "authorization", "in": "header", "required": false, "schema": { "type": "string", "example": "Bearer " }, "description": "Optional API-key authorization for higher-volume access tiers." } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/occfin_get_open_interest_dailyResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "product": "occfin", "source": "occ", "endpoint_id": "occ.daily_open_interest", "route": "/v1/open-interest/daily", "path_params": {}, "rate_plan": { "public_request_budget_per_user_rpm": 200 }, "status": "ok" }, "data": { "format": "csv", "delimiter": ",", "section_count": 1, "row_count": 21, "sections": [ { "title": "Daily Open Interest - January 2026", "columns": [ "date", "equity", "field" ], "rows": [ { "date": null, "equity": "Calls", "field": "Total", "index_other": "Calls", "debt": "Calls", "futures": "Total", "occ_total": null }, { "date": "01/30/2026", "equity": 282844569, "field": 0, "index_other": 18398679, "debt": 0, "futures": 393090, "occ_total": 532641829 }, { "date": "01/29/2026", "equity": 293060007, "field": 0, "index_other": 18330979, "debt": 0, "futures": 387602, "occ_total": 551289209 } ] } ] } } } } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "401": { "description": "Unauthorized. API-key authenticated tiers use an Authorization bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 401 error", "value": { "ok": false, "error": { "code": "unauthorized", "message": "A valid API key is required for this tier." } } } } } } }, "404": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "405": { "description": "Method not allowed. Source API routes are documented as HTTP GET unless otherwise specified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 405 error", "value": { "ok": false, "error": { "code": "method_not_allowed", "message": "This route does not support the requested HTTP method." } } } } } } }, "429": { "description": "Rate limited. Retry after the limit reset or include the documented contact/API-key headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 429 error", "value": { "ok": false, "error": { "code": "rate_limited", "message": "Too many requests. Retry after the rate-limit reset." } } } } } } }, "502": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "503": { "description": "Service unavailable. The source API or an upstream dependency is temporarily unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 503 error", "value": { "ok": false, "error": { "code": "service_unavailable", "message": "The service is temporarily unavailable." } } } } } } }, "504": { "description": "Upstream timeout. The upstream source did not return within the source API timeout window.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 504 error", "value": { "ok": false, "error": { "code": "upstream_timeout", "message": "The upstream source timed out." } } } } } } } }, "summary": "Open interest", "security": [ {}, { "ContactEmail": [] }, { "BearerAuth": [] }, { "OccfinApiKey": [] } ], "operationId": "occfin_get_open_interest_daily", "description": "Returns open interest with source-native fields and identifiers.", "x-source-api": "occfin", "x-source-name": "OCC", "x-source-upstream": "theocc.com", "x-docs-example-url": "https://api.occfin.bluedoor.sh/v1/open-interest/daily?date=01%2F21%2F2026", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:33:22.131Z" } }, "/v1/options/deliverables": { "get": { "parameters": [ { "description": "OCC product type, defaults to EU.", "in": "query", "name": "prodType", "required": false, "schema": { "type": "string" } }, { "description": "Semicolon-separated OCC field selection.", "in": "query", "name": "downloadFields", "required": false, "schema": { "type": "string" } }, { "name": "x-occfin-contact", "in": "header", "required": false, "schema": { "type": "string", "format": "email" }, "description": "Optional contact email for higher public rate limits and support diagnostics." }, { "name": "authorization", "in": "header", "required": false, "schema": { "type": "string", "example": "Bearer " }, "description": "Optional API-key authorization for higher-volume access tiers." } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/occfin_get_options_deliverablesResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "product": "occfin", "source": "occ", "endpoint_id": "occ.deliverable_download_equity", "route": "/v1/options/deliverables", "path_params": {}, "rate_plan": { "public_request_budget_per_user_rpm": 200 }, "status": "ok" }, "data": { "format": "occ_deliverables", "row_count": 6216, "rows": [ { "occ_symbol": "A", "underlying_symbol": "A", "security_name": "AGILENT TECHNOLOGIES, INC.", "exchange_codes": "ABCDEHIJLMPQRTUWXZ", "position_limit": 25000000 }, { "occ_symbol": "AA", "underlying_symbol": "AA", "security_name": "Alcoa Corporation", "exchange_codes": "ABCDEHIJLMPQRTUWXZ", "position_limit": 25000000 }, { "occ_symbol": "AAAU", "underlying_symbol": "AAAU", "security_name": "GOLDMAN SACHS PHYSICAL GOLD ETF", "exchange_codes": "CDEHIJLMQRTWXZ", "position_limit": 25000000 } ], "line_count": 6216 } } } } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "401": { "description": "Unauthorized. API-key authenticated tiers use an Authorization bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 401 error", "value": { "ok": false, "error": { "code": "unauthorized", "message": "A valid API key is required for this tier." } } } } } } }, "404": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "405": { "description": "Method not allowed. Source API routes are documented as HTTP GET unless otherwise specified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 405 error", "value": { "ok": false, "error": { "code": "method_not_allowed", "message": "This route does not support the requested HTTP method." } } } } } } }, "429": { "description": "Rate limited. Retry after the limit reset or include the documented contact/API-key headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 429 error", "value": { "ok": false, "error": { "code": "rate_limited", "message": "Too many requests. Retry after the rate-limit reset." } } } } } } }, "502": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "503": { "description": "Service unavailable. The source API or an upstream dependency is temporarily unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 503 error", "value": { "ok": false, "error": { "code": "service_unavailable", "message": "The service is temporarily unavailable." } } } } } } }, "504": { "description": "Upstream timeout. The upstream source did not return within the source API timeout window.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 504 error", "value": { "ok": false, "error": { "code": "upstream_timeout", "message": "The upstream source timed out." } } } } } } } }, "summary": "Deliverables", "security": [ {}, { "ContactEmail": [] }, { "BearerAuth": [] }, { "OccfinApiKey": [] } ], "operationId": "occfin_get_options_deliverables", "description": "Returns deliverables with contract, chain, volume, open-interest, or strategy fields where available.", "tags": [ "Options" ], "x-source-api": "occfin", "x-source-name": "OCC", "x-source-upstream": "theocc.com", "x-docs-example-url": "https://api.occfin.bluedoor.sh/v1/options/deliverables", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:33:22.573Z" } }, "/v1/options/position-limits": { "get": { "parameters": [ { "description": "Recent trading date in YYYYMMDD format.", "in": "query", "name": "date", "required": true, "schema": { "type": "string" } }, { "name": "x-occfin-contact", "in": "header", "required": false, "schema": { "type": "string", "format": "email" }, "description": "Optional contact email for higher public rate limits and support diagnostics." }, { "name": "authorization", "in": "header", "required": false, "schema": { "type": "string", "example": "Bearer " }, "description": "Optional API-key authorization for higher-volume access tiers." } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/occfin_get_options_position_limitsResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "product": "occfin", "source": "occ", "endpoint_id": "occ.position_limits", "route": "/v1/options/position-limits", "path_params": {}, "rate_plan": { "public_request_budget_per_user_rpm": 200 }, "status": "ok" }, "data": { "format": "csv", "delimiter": ",", "section_count": 1, "row_count": 0, "sections": [ { "title": "File requested does not exist.", "columns": [], "rows": [] } ] } } } } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "401": { "description": "Unauthorized. API-key authenticated tiers use an Authorization bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 401 error", "value": { "ok": false, "error": { "code": "unauthorized", "message": "A valid API key is required for this tier." } } } } } } }, "404": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "405": { "description": "Method not allowed. Source API routes are documented as HTTP GET unless otherwise specified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 405 error", "value": { "ok": false, "error": { "code": "method_not_allowed", "message": "This route does not support the requested HTTP method." } } } } } } }, "429": { "description": "Rate limited. Retry after the limit reset or include the documented contact/API-key headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 429 error", "value": { "ok": false, "error": { "code": "rate_limited", "message": "Too many requests. Retry after the rate-limit reset." } } } } } } }, "502": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "503": { "description": "Service unavailable. The source API or an upstream dependency is temporarily unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 503 error", "value": { "ok": false, "error": { "code": "service_unavailable", "message": "The service is temporarily unavailable." } } } } } } }, "504": { "description": "Upstream timeout. The upstream source did not return within the source API timeout window.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 504 error", "value": { "ok": false, "error": { "code": "upstream_timeout", "message": "The upstream source timed out." } } } } } } } }, "summary": "Position limits", "security": [ {}, { "ContactEmail": [] }, { "BearerAuth": [] }, { "OccfinApiKey": [] } ], "operationId": "occfin_get_options_position_limits", "description": "Returns position limits with contract, chain, volume, open-interest, or strategy fields where available.", "tags": [ "Options" ], "x-source-api": "occfin", "x-source-name": "OCC", "x-source-upstream": "theocc.com", "x-docs-example-url": "https://api.occfin.bluedoor.sh/v1/options/position-limits?date=20260121", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:33:22.963Z" } }, "/v1/settlements/equity-special": { "get": { "parameters": [ { "description": "Recent trading date in YYYYMMDD format.", "in": "query", "name": "date", "required": true, "schema": { "type": "string" } }, { "name": "x-occfin-contact", "in": "header", "required": false, "schema": { "type": "string", "format": "email" }, "description": "Optional contact email for higher public rate limits and support diagnostics." }, { "name": "authorization", "in": "header", "required": false, "schema": { "type": "string", "example": "Bearer " }, "description": "Optional API-key authorization for higher-volume access tiers." } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/occfin_get_settlements_equity_specialResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "product": "occfin", "source": "occ", "endpoint_id": "occ.equity_special_settlements", "route": "/v1/settlements/equity-special", "path_params": {}, "rate_plan": { "public_request_budget_per_user_rpm": 200 }, "status": "ok" }, "data": { "format": "occ_special_settlements", "row_count": 525, "rows": [ { "rec_id": "0706", "product_id": "ABNY1", "package_kind_id": "OSTK", "strike_currency": "USD", "option_group": "EU", "component_total": "01", "component_number": "01", "security_id": "ABNY", "unit_quantity": 20, "settlement_method": "CNS", "strike_percent": 100, "fixed_amount": 0, "process_date": "20260121", "settlement_date": "00000000" }, { "rec_id": "0706", "product_id": "ACB1", "package_kind_id": "OSTK", "strike_currency": "USD", "option_group": "EU", "component_total": "01", "component_number": "01", "security_id": "ACB", "unit_quantity": 10, "settlement_method": "CNS", "strike_percent": 100, "fixed_amount": 0, "process_date": "20260121", "settlement_date": "20260120" }, { "rec_id": "0706", "product_id": "ACET1", "package_kind_id": "OSTK", "strike_currency": "USD", "option_group": "EU", "component_total": "02", "component_number": "01", "security_id": "ACET", "unit_quantity": 6, "settlement_method": "CNS", "strike_percent": 100, "fixed_amount": 0, "process_date": "20260121", "settlement_date": "20260120" } ], "line_count": 570 } } } } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "401": { "description": "Unauthorized. API-key authenticated tiers use an Authorization bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 401 error", "value": { "ok": false, "error": { "code": "unauthorized", "message": "A valid API key is required for this tier." } } } } } } }, "404": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "405": { "description": "Method not allowed. Source API routes are documented as HTTP GET unless otherwise specified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 405 error", "value": { "ok": false, "error": { "code": "method_not_allowed", "message": "This route does not support the requested HTTP method." } } } } } } }, "429": { "description": "Rate limited. Retry after the limit reset or include the documented contact/API-key headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 429 error", "value": { "ok": false, "error": { "code": "rate_limited", "message": "Too many requests. Retry after the rate-limit reset." } } } } } } }, "502": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "503": { "description": "Service unavailable. The source API or an upstream dependency is temporarily unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 503 error", "value": { "ok": false, "error": { "code": "service_unavailable", "message": "The service is temporarily unavailable." } } } } } } }, "504": { "description": "Upstream timeout. The upstream source did not return within the source API timeout window.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 504 error", "value": { "ok": false, "error": { "code": "upstream_timeout", "message": "The upstream source timed out." } } } } } } } }, "summary": "Special settlements", "security": [ {}, { "ContactEmail": [] }, { "BearerAuth": [] }, { "OccfinApiKey": [] } ], "operationId": "occfin_get_settlements_equity_special", "description": "Returns special settlements with source-native fields and identifiers.", "x-source-api": "occfin", "x-source-name": "OCC", "x-source-upstream": "theocc.com", "x-docs-example-url": "https://api.occfin.bluedoor.sh/v1/settlements/equity-special?date=20260121", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:33:23.364Z" } }, "/v1/volume/daily": { "get": { "parameters": [ { "description": "OCC report date in YYYYMMDD format.", "in": "query", "name": "date", "required": true, "schema": { "type": "string" } }, { "name": "x-occfin-contact", "in": "header", "required": false, "schema": { "type": "string", "format": "email" }, "description": "Optional contact email for higher public rate limits and support diagnostics." }, { "name": "authorization", "in": "header", "required": false, "schema": { "type": "string", "example": "Bearer " }, "description": "Optional API-key authorization for higher-volume access tiers." } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/occfin_get_volume_dailyResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "product": "occfin", "source": "occ", "endpoint_id": "occ.daily_volume_statistics", "route": "/v1/volume/daily", "path_params": {}, "rate_plan": { "public_request_budget_per_user_rpm": 200 }, "status": "ok" }, "data": { "format": "csv", "delimiter": ",", "section_count": 2, "row_count": 48, "sections": [ { "title": "Daily OCC Contract Volume - January 2026", "columns": [ "date", "equity", "index_others" ], "rows": [ { "date": "01/30/2026", "equity": 80071276, "index_others": 6002707, "debt": 0, "futures": 242160, "occ_total": 86316143 }, { "date": "01/29/2026", "equity": 73730662, "index_others": 6710584, "debt": 0, "futures": 300276, "occ_total": 80741522 }, { "date": "01/28/2026", "equity": 53374741, "index_others": 4332509, "debt": 0, "futures": 175236, "occ_total": 57882486 } ] }, { "title": "Daily Futures Contract Volume -January 2026", "columns": [ "date", "equity", "index_others" ], "rows": [ { "date": "01/30/2026", "equity": 0, "index_others": 242140, "oof": 20, "occ_total": 242160 }, { "date": "01/29/2026", "equity": 0, "index_others": 300249, "oof": 27, "occ_total": 300276 }, { "date": "01/28/2026", "equity": 0, "index_others": 175193, "oof": 43, "occ_total": 175236 } ] } ] } } } } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "401": { "description": "Unauthorized. API-key authenticated tiers use an Authorization bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 401 error", "value": { "ok": false, "error": { "code": "unauthorized", "message": "A valid API key is required for this tier." } } } } } } }, "404": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "405": { "description": "Method not allowed. Source API routes are documented as HTTP GET unless otherwise specified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 405 error", "value": { "ok": false, "error": { "code": "method_not_allowed", "message": "This route does not support the requested HTTP method." } } } } } } }, "429": { "description": "Rate limited. Retry after the limit reset or include the documented contact/API-key headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 429 error", "value": { "ok": false, "error": { "code": "rate_limited", "message": "Too many requests. Retry after the rate-limit reset." } } } } } } }, "502": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "503": { "description": "Service unavailable. The source API or an upstream dependency is temporarily unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 503 error", "value": { "ok": false, "error": { "code": "service_unavailable", "message": "The service is temporarily unavailable." } } } } } } }, "504": { "description": "Upstream timeout. The upstream source did not return within the source API timeout window.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 504 error", "value": { "ok": false, "error": { "code": "upstream_timeout", "message": "The upstream source timed out." } } } } } } } }, "summary": "Daily contract volume", "security": [ {}, { "ContactEmail": [] }, { "BearerAuth": [] }, { "OccfinApiKey": [] } ], "operationId": "occfin_get_volume_daily", "description": "Returns daily contract volume with source-native fields and identifiers.", "tags": [ "Volume" ], "x-source-api": "occfin", "x-source-name": "OCC", "x-source-upstream": "theocc.com", "x-docs-example-url": "https://api.occfin.bluedoor.sh/v1/volume/daily?date=20260102", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:33:23.748Z" } }, "/v1/volume/exchanges": { "get": { "parameters": [ { "description": "OCC report date in YYYYMMDD format.", "in": "query", "name": "date", "required": true, "schema": { "type": "string" } }, { "description": "OCC instrument type, usually options or futures.", "in": "query", "name": "instrumentType", "required": false, "schema": { "type": "string" } }, { "description": "OCC report type, defaults to D.", "in": "query", "name": "reportType", "required": false, "schema": { "type": "string" } }, { "name": "x-occfin-contact", "in": "header", "required": false, "schema": { "type": "string", "format": "email" }, "description": "Optional contact email for higher public rate limits and support diagnostics." }, { "name": "authorization", "in": "header", "required": false, "schema": { "type": "string", "example": "Bearer " }, "description": "Optional API-key authorization for higher-volume access tiers." } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/occfin_get_volume_exchangesResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "product": "occfin", "source": "occ", "endpoint_id": "occ.exchange_volume_options_daily", "route": "/v1/volume/exchanges", "path_params": {}, "rate_plan": { "public_request_budget_per_user_rpm": 200 }, "status": "ok" }, "data": { "format": "occ_exchange_volume", "row_count": 18, "rows": [ { "exchange": "AMEX", "equity_volume": 6347110, "equity_market_share": 0.0935, "index_other_volume": 0, "index_other_market_share": 0, "other_volume": 0, "other_market_share": 0, "exchange_total_volume": 6347110, "exchange_total_market_share": 0.08449999999999999 }, { "exchange": "ARCA", "equity_volume": 7264209, "equity_market_share": 0.107, "index_other_volume": 0, "index_other_market_share": 0, "other_volume": 0, "other_market_share": 0, "exchange_total_volume": 7264209, "exchange_total_market_share": 0.0967 }, { "exchange": "BATS", "equity_volume": 2465670, "equity_market_share": 0.0363, "index_other_volume": 2983, "index_other_market_share": 0.0004, "other_volume": 0, "other_market_share": 0, "exchange_total_volume": 2468653, "exchange_total_market_share": 0.032799999999999996 } ], "line_count": 24 } } } } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "401": { "description": "Unauthorized. API-key authenticated tiers use an Authorization bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 401 error", "value": { "ok": false, "error": { "code": "unauthorized", "message": "A valid API key is required for this tier." } } } } } } }, "404": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "405": { "description": "Method not allowed. Source API routes are documented as HTTP GET unless otherwise specified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 405 error", "value": { "ok": false, "error": { "code": "method_not_allowed", "message": "This route does not support the requested HTTP method." } } } } } } }, "429": { "description": "Rate limited. Retry after the limit reset or include the documented contact/API-key headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 429 error", "value": { "ok": false, "error": { "code": "rate_limited", "message": "Too many requests. Retry after the rate-limit reset." } } } } } } }, "502": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "503": { "description": "Service unavailable. The source API or an upstream dependency is temporarily unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 503 error", "value": { "ok": false, "error": { "code": "service_unavailable", "message": "The service is temporarily unavailable." } } } } } } }, "504": { "description": "Upstream timeout. The upstream source did not return within the source API timeout window.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 504 error", "value": { "ok": false, "error": { "code": "upstream_timeout", "message": "The upstream source timed out." } } } } } } } }, "summary": "Exchange volume", "security": [ {}, { "ContactEmail": [] }, { "BearerAuth": [] }, { "OccfinApiKey": [] } ], "operationId": "occfin_get_volume_exchanges", "description": "Returns exchange volume with source-native fields and identifiers.", "tags": [ "Volume" ], "x-source-api": "occfin", "x-source-name": "OCC", "x-source-upstream": "theocc.com", "x-docs-example-url": "https://api.occfin.bluedoor.sh/v1/volume/exchanges?date=20260121", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:33:24.132Z" } }, "/v1/volume/monthly": { "get": { "parameters": [ { "description": "Month-end OCC report date in YYYYMMDD format.", "in": "query", "name": "date", "required": true, "schema": { "type": "string" } }, { "description": "OCC report type, defaults to options.", "in": "query", "name": "reportType", "required": false, "schema": { "type": "string" } }, { "description": "OCC report class, defaults to equity.", "in": "query", "name": "reportClass", "required": false, "schema": { "type": "string" } }, { "name": "x-occfin-contact", "in": "header", "required": false, "schema": { "type": "string", "format": "email" }, "description": "Optional contact email for higher public rate limits and support diagnostics." }, { "name": "authorization", "in": "header", "required": false, "schema": { "type": "string", "example": "Bearer " }, "description": "Optional API-key authorization for higher-volume access tiers." } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/occfin_get_volume_monthlyResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "product": "occfin", "source": "occ", "endpoint_id": "occ.monthly_volume_options_equity", "route": "/v1/volume/monthly", "path_params": {}, "rate_plan": { "public_request_budget_per_user_rpm": 200 }, "status": "ok" }, "data": { "format": "csv", "delimiter": ",", "section_count": 20, "row_count": 834, "sections": [ { "title": "Calls", "columns": [ "exchange", "cleared_contracts", "cleared_transactions" ], "rows": [ { "exchange": "AMEX", "cleared_contracts": 26388792, "cleared_transactions": 4435991, "total_premiums": "$10787956409", "avg_premium_per_contract": "$408.81", "avg_daily_contracts": 1319440, "avg_contracts_per_transaction": 5.95, "of_total_contracts": "5.83%" }, { "exchange": "AMEX-FLEX", "cleared_contracts": 7546953, "cleared_transactions": 3214, "total_premiums": "$8584940842", "avg_premium_per_contract": "$1137.54", "avg_daily_contracts": 377348, "avg_contracts_per_transaction": 2348.15, "of_total_contracts": "1.67%" }, { "exchange": "AMEX-TOTL", "cleared_contracts": 33935745, "cleared_transactions": 4439205, "total_premiums": "$19372897251", "avg_premium_per_contract": "$570.87", "avg_daily_contracts": 1696787, "avg_contracts_per_transaction": 7.64, "of_total_contracts": "7.50%" } ] }, { "title": "Puts", "columns": [ "exchange", "cleared_contracts", "cleared_transactions" ], "rows": [ { "exchange": "AMEX", "cleared_contracts": 14111841, "cleared_transactions": 2530840, "total_premiums": "$5499169653", "avg_premium_per_contract": "$389.68", "avg_daily_contracts": 705592, "avg_contracts_per_transaction": 5.58, "of_total_contracts": "5.63%" }, { "exchange": "AMEX-FLEX", "cleared_contracts": 8318380, "cleared_transactions": 3069, "total_premiums": "$7008005214", "avg_premium_per_contract": "$842.47", "avg_daily_contracts": 415919, "avg_contracts_per_transaction": 2710.45, "of_total_contracts": "3.32%" }, { "exchange": "AMEX-TOTL", "cleared_contracts": 22430221, "cleared_transactions": 2533909, "total_premiums": "$12507174867", "avg_premium_per_contract": "$557.60", "avg_daily_contracts": 1121511, "avg_contracts_per_transaction": 8.85, "of_total_contracts": "8.94%" } ] }, { "title": "Combined", "columns": [ "exchange", "cleared_contracts", "cleared_transactions" ], "rows": [ { "exchange": "AMEX", "cleared_contracts": 40500633, "cleared_transactions": 6966831, "total_premiums": "$16287126061", "avg_premium_per_contract": "$402.14", "avg_daily_contracts": 2025032, "avg_contracts_per_transaction": 5.81, "of_total_contracts": "5.76%" }, { "exchange": "AMEX-FLEX", "cleared_contracts": 15865333, "cleared_transactions": 6283, "total_premiums": "$15592946056", "avg_premium_per_contract": "$982.83", "avg_daily_contracts": 793267, "avg_contracts_per_transaction": 2525.12, "of_total_contracts": "2.25%" }, { "exchange": "AMEX -TOTL", "cleared_contracts": 56365966, "cleared_transactions": 6973114, "total_premiums": "$31880072117", "avg_premium_per_contract": "$565.59", "avg_daily_contracts": 2818298, "avg_contracts_per_transaction": 8.08, "of_total_contracts": "8.01%" } ] } ] } } } } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "401": { "description": "Unauthorized. API-key authenticated tiers use an Authorization bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 401 error", "value": { "ok": false, "error": { "code": "unauthorized", "message": "A valid API key is required for this tier." } } } } } } }, "404": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "405": { "description": "Method not allowed. Source API routes are documented as HTTP GET unless otherwise specified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 405 error", "value": { "ok": false, "error": { "code": "method_not_allowed", "message": "This route does not support the requested HTTP method." } } } } } } }, "429": { "description": "Rate limited. Retry after the limit reset or include the documented contact/API-key headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 429 error", "value": { "ok": false, "error": { "code": "rate_limited", "message": "Too many requests. Retry after the rate-limit reset." } } } } } } }, "502": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "503": { "description": "Service unavailable. The source API or an upstream dependency is temporarily unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 503 error", "value": { "ok": false, "error": { "code": "service_unavailable", "message": "The service is temporarily unavailable." } } } } } } }, "504": { "description": "Upstream timeout. The upstream source did not return within the source API timeout window.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 504 error", "value": { "ok": false, "error": { "code": "upstream_timeout", "message": "The upstream source timed out." } } } } } } } }, "summary": "Monthly volume", "security": [ {}, { "ContactEmail": [] }, { "BearerAuth": [] }, { "OccfinApiKey": [] } ], "operationId": "occfin_get_volume_monthly", "description": "Returns monthly volume with source-native fields and identifiers.", "tags": [ "Volume" ], "x-source-api": "occfin", "x-source-name": "OCC", "x-source-upstream": "theocc.com", "x-docs-example-url": "https://api.occfin.bluedoor.sh/v1/volume/monthly?date=20260121", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:33:24.522Z" } }, "/v1/options/series/{symbol}": { "get": { "parameters": [ { "description": "Underlying symbol, for example IBM.", "in": "path", "name": "symbol", "required": true, "schema": { "type": "string" } }, { "name": "x-occfin-contact", "in": "header", "required": false, "schema": { "type": "string", "format": "email" }, "description": "Optional contact email for higher public rate limits and support diagnostics." }, { "name": "authorization", "in": "header", "required": false, "schema": { "type": "string", "example": "Bearer " }, "description": "Optional API-key authorization for higher-volume access tiers." } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/occfin_get_options_series_symbolResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "product": "occfin", "source": "occ", "endpoint_id": "occ.series_search_underlying", "route": "/v1/options/series/{symbol}", "path_params": { "symbol": "AAPL" }, "rate_plan": { "public_request_budget_per_user_rpm": 200 }, "status": "ok" }, "data": { "format": "occ_series_search", "row_count": 2066, "rows": [ { "product_symbol": "AAPL", "expiration": "2026-06-05", "strike": 110, "call_put_flags": "C P", "call_open_interest": 0, "put_open_interest": 175, "position_limit": 25000000 }, { "product_symbol": "AAPL", "expiration": "2026-06-05", "strike": 120, "call_put_flags": "C P", "call_open_interest": 0, "put_open_interest": 1, "position_limit": 25000000 }, { "product_symbol": "AAPL", "expiration": "2026-06-05", "strike": 125, "call_put_flags": "C P", "call_open_interest": 0, "put_open_interest": 3, "position_limit": 25000000 } ], "line_count": 2071 } } } } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "401": { "description": "Unauthorized. API-key authenticated tiers use an Authorization bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 401 error", "value": { "ok": false, "error": { "code": "unauthorized", "message": "A valid API key is required for this tier." } } } } } } }, "404": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "405": { "description": "Method not allowed. Source API routes are documented as HTTP GET unless otherwise specified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 405 error", "value": { "ok": false, "error": { "code": "method_not_allowed", "message": "This route does not support the requested HTTP method." } } } } } } }, "429": { "description": "Rate limited. Retry after the limit reset or include the documented contact/API-key headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 429 error", "value": { "ok": false, "error": { "code": "rate_limited", "message": "Too many requests. Retry after the rate-limit reset." } } } } } } }, "502": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "object" }, "meta": { "type": "object" } }, "type": "object" } } }, "description": "JSON envelope" }, "503": { "description": "Service unavailable. The source API or an upstream dependency is temporarily unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 503 error", "value": { "ok": false, "error": { "code": "service_unavailable", "message": "The service is temporarily unavailable." } } } } } } }, "504": { "description": "Upstream timeout. The upstream source did not return within the source API timeout window.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 504 error", "value": { "ok": false, "error": { "code": "upstream_timeout", "message": "The upstream source timed out." } } } } } } } }, "summary": "Series", "security": [ {}, { "ContactEmail": [] }, { "BearerAuth": [] }, { "OccfinApiKey": [] } ], "operationId": "occfin_get_options_series_symbol", "description": "Returns series with contract, chain, volume, open-interest, or strategy fields where available.", "tags": [ "Options" ], "x-source-api": "occfin", "x-source-name": "OCC", "x-source-upstream": "theocc.com", "x-docs-example-url": "https://api.occfin.bluedoor.sh/v1/options/series/AAPL", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:33:24.926Z" } } }, "components": { "securitySchemes": { "ContactEmail": { "type": "apiKey", "in": "header", "name": "X-Occfin-Contact" }, "BearerAuth": { "type": "http", "scheme": "bearer", "description": "API keys are available by emailing sam@bluedoor.sh." }, "OccfinApiKey": { "type": "apiKey", "in": "header", "name": "X-Occfin-Key" } }, "schemas": { "ErrorEnvelope": { "type": "object", "additionalProperties": true, "properties": { "ok": { "type": "boolean", "example": false }, "error": { "type": "object", "additionalProperties": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": true } } }, "occfin_get_threshold_securitiesResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "product": { "type": "string" }, "source": { "type": "string" }, "endpoint_id": { "type": "string" }, "route": { "type": "string" }, "path_params": { "type": "object", "additionalProperties": true, "properties": {} }, "rate_plan": { "type": "object", "additionalProperties": true, "properties": { "public_request_budget_per_user_rpm": { "type": "integer" } }, "required": [ "public_request_budget_per_user_rpm" ] }, "status": { "type": "string" } }, "required": [ "endpoint_id", "path_params", "product", "rate_plan", "route", "source", "status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "format": { "type": "string" }, "delimiter": { "type": "string" }, "section_count": { "type": "integer" }, "row_count": { "type": "integer" }, "sections": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "title": { "type": "string" }, "columns": { "type": "array", "items": {} }, "rows": { "type": "array", "items": {} } }, "required": [ "columns", "rows", "title" ] } } }, "required": [ "delimiter", "format", "row_count", "section_count", "sections" ] } }, "required": [ "data", "meta" ] }, "occfin_get_trade_volumeResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "product": { "type": "string" }, "source": { "type": "string" }, "endpoint_id": { "type": "string" }, "route": { "type": "string" }, "path_params": { "type": "object", "additionalProperties": true, "properties": {} }, "rate_plan": { "type": "object", "additionalProperties": true, "properties": { "public_request_budget_per_user_rpm": { "type": "integer" } }, "required": [ "public_request_budget_per_user_rpm" ] }, "status": { "type": "string" } }, "required": [ "endpoint_id", "path_params", "product", "rate_plan", "route", "source", "status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "format": { "type": "string" }, "row_count": { "type": "integer" }, "rows": { "type": "array", "items": {} } }, "required": [ "format", "row_count", "rows" ] } }, "required": [ "data", "meta" ] }, "occfin_get_flex_equity_pricesResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "product": { "type": "string" }, "source": { "type": "string" }, "endpoint_id": { "type": "string" }, "route": { "type": "string" }, "path_params": { "type": "object", "additionalProperties": true, "properties": {} }, "rate_plan": { "type": "object", "additionalProperties": true, "properties": { "public_request_budget_per_user_rpm": { "type": "integer" } }, "required": [ "public_request_budget_per_user_rpm" ] }, "status": { "type": "string" } }, "required": [ "endpoint_id", "path_params", "product", "rate_plan", "route", "source", "status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "format": { "type": "string" }, "row_count": { "type": "integer" }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "symbol": { "type": "string" }, "call_put": { "type": "string" }, "expiration": { "type": "string" }, "strike_price": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "mark_price": { "type": "number" } }, "required": [ "call_put", "expiration", "mark_price", "strike_price", "symbol" ] } }, "line_count": { "type": "integer" } }, "required": [ "format", "line_count", "row_count", "rows" ] } }, "required": [ "data", "meta" ] }, "occfin_get_futures_open_interestResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "product": { "type": "string" }, "source": { "type": "string" }, "endpoint_id": { "type": "string" }, "route": { "type": "string" }, "path_params": { "type": "object", "additionalProperties": true, "properties": {} }, "rate_plan": { "type": "object", "additionalProperties": true, "properties": { "public_request_budget_per_user_rpm": { "type": "integer" } }, "required": [ "public_request_budget_per_user_rpm" ] }, "status": { "type": "string" } }, "required": [ "endpoint_id", "path_params", "product", "rate_plan", "route", "source", "status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "format": { "type": "string" }, "delimiter": { "type": "string" }, "section_count": { "type": "integer" }, "row_count": { "type": "integer" }, "sections": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "title": { "nullable": true }, "columns": { "type": "array", "items": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "futures_open_interest_total": { "oneOf": [ { "nullable": true }, { "type": "string" } ] }, "410_954": { "oneOf": [ { "nullable": true }, { "type": "string" }, { "type": "integer" } ] } }, "required": [ "410_954", "futures_open_interest_total" ] } } }, "required": [ "columns", "rows", "title" ] } } }, "required": [ "delimiter", "format", "row_count", "section_count", "sections" ] } }, "required": [ "data", "meta" ] }, "occfin_get_open_interest_dailyResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "product": { "type": "string" }, "source": { "type": "string" }, "endpoint_id": { "type": "string" }, "route": { "type": "string" }, "path_params": { "type": "object", "additionalProperties": true, "properties": {} }, "rate_plan": { "type": "object", "additionalProperties": true, "properties": { "public_request_budget_per_user_rpm": { "type": "integer" } }, "required": [ "public_request_budget_per_user_rpm" ] }, "status": { "type": "string" } }, "required": [ "endpoint_id", "path_params", "product", "rate_plan", "route", "source", "status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "format": { "type": "string" }, "delimiter": { "type": "string" }, "section_count": { "type": "integer" }, "row_count": { "type": "integer" }, "sections": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "title": { "type": "string" }, "columns": { "type": "array", "items": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "date": { "oneOf": [ { "nullable": true }, { "type": "string" } ] }, "equity": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "field": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "index_other": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "debt": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "futures": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "occ_total": { "oneOf": [ { "nullable": true }, { "type": "integer" } ] } }, "required": [ "date", "debt", "equity", "field", "futures", "index_other", "occ_total" ] } } }, "required": [ "columns", "rows", "title" ] } } }, "required": [ "delimiter", "format", "row_count", "section_count", "sections" ] } }, "required": [ "data", "meta" ] }, "occfin_get_options_deliverablesResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "product": { "type": "string" }, "source": { "type": "string" }, "endpoint_id": { "type": "string" }, "route": { "type": "string" }, "path_params": { "type": "object", "additionalProperties": true, "properties": {} }, "rate_plan": { "type": "object", "additionalProperties": true, "properties": { "public_request_budget_per_user_rpm": { "type": "integer" } }, "required": [ "public_request_budget_per_user_rpm" ] }, "status": { "type": "string" } }, "required": [ "endpoint_id", "path_params", "product", "rate_plan", "route", "source", "status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "format": { "type": "string" }, "row_count": { "type": "integer" }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "occ_symbol": { "type": "string" }, "underlying_symbol": { "type": "string" }, "security_name": { "type": "string" }, "exchange_codes": { "type": "string" }, "position_limit": { "type": "integer" } }, "required": [ "exchange_codes", "occ_symbol", "position_limit", "security_name", "underlying_symbol" ] } }, "line_count": { "type": "integer" } }, "required": [ "format", "line_count", "row_count", "rows" ] } }, "required": [ "data", "meta" ] }, "occfin_get_options_position_limitsResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "product": { "type": "string" }, "source": { "type": "string" }, "endpoint_id": { "type": "string" }, "route": { "type": "string" }, "path_params": { "type": "object", "additionalProperties": true, "properties": {} }, "rate_plan": { "type": "object", "additionalProperties": true, "properties": { "public_request_budget_per_user_rpm": { "type": "integer" } }, "required": [ "public_request_budget_per_user_rpm" ] }, "status": { "type": "string" } }, "required": [ "endpoint_id", "path_params", "product", "rate_plan", "route", "source", "status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "format": { "type": "string" }, "delimiter": { "type": "string" }, "section_count": { "type": "integer" }, "row_count": { "type": "integer" }, "sections": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "title": { "type": "string" }, "columns": { "type": "array", "items": {} }, "rows": { "type": "array", "items": {} } }, "required": [ "columns", "rows", "title" ] } } }, "required": [ "delimiter", "format", "row_count", "section_count", "sections" ] } }, "required": [ "data", "meta" ] }, "occfin_get_settlements_equity_specialResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "product": { "type": "string" }, "source": { "type": "string" }, "endpoint_id": { "type": "string" }, "route": { "type": "string" }, "path_params": { "type": "object", "additionalProperties": true, "properties": {} }, "rate_plan": { "type": "object", "additionalProperties": true, "properties": { "public_request_budget_per_user_rpm": { "type": "integer" } }, "required": [ "public_request_budget_per_user_rpm" ] }, "status": { "type": "string" } }, "required": [ "endpoint_id", "path_params", "product", "rate_plan", "route", "source", "status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "format": { "type": "string" }, "row_count": { "type": "integer" }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "rec_id": { "type": "string" }, "product_id": { "type": "string" }, "package_kind_id": { "type": "string" }, "strike_currency": { "type": "string" }, "option_group": { "type": "string" }, "component_total": { "type": "string" }, "component_number": { "type": "string" }, "security_id": { "type": "string" }, "unit_quantity": { "type": "integer" }, "settlement_method": { "type": "string" }, "strike_percent": { "type": "integer" }, "fixed_amount": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "process_date": { "type": "string" }, "settlement_date": { "type": "string" } }, "required": [ "component_number", "component_total", "fixed_amount", "option_group", "package_kind_id", "process_date", "product_id", "rec_id", "security_id", "settlement_date", "settlement_method", "strike_currency", "strike_percent", "unit_quantity" ] } }, "line_count": { "type": "integer" } }, "required": [ "format", "line_count", "row_count", "rows" ] } }, "required": [ "data", "meta" ] }, "occfin_get_volume_dailyResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "product": { "type": "string" }, "source": { "type": "string" }, "endpoint_id": { "type": "string" }, "route": { "type": "string" }, "path_params": { "type": "object", "additionalProperties": true, "properties": {} }, "rate_plan": { "type": "object", "additionalProperties": true, "properties": { "public_request_budget_per_user_rpm": { "type": "integer" } }, "required": [ "public_request_budget_per_user_rpm" ] }, "status": { "type": "string" } }, "required": [ "endpoint_id", "path_params", "product", "rate_plan", "route", "source", "status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "format": { "type": "string" }, "delimiter": { "type": "string" }, "section_count": { "type": "integer" }, "row_count": { "type": "integer" }, "sections": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "title": { "type": "string" }, "columns": { "type": "array", "items": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "date": { "type": "string" }, "equity": { "type": "integer" }, "index_others": { "type": "integer" }, "debt": { "type": "integer" }, "futures": { "type": "integer" }, "occ_total": { "type": "integer" }, "oof": { "type": "integer" } }, "required": [ "date", "debt", "equity", "futures", "index_others", "occ_total", "oof" ] } } }, "required": [ "columns", "rows", "title" ] } } }, "required": [ "delimiter", "format", "row_count", "section_count", "sections" ] } }, "required": [ "data", "meta" ] }, "occfin_get_volume_exchangesResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "product": { "type": "string" }, "source": { "type": "string" }, "endpoint_id": { "type": "string" }, "route": { "type": "string" }, "path_params": { "type": "object", "additionalProperties": true, "properties": {} }, "rate_plan": { "type": "object", "additionalProperties": true, "properties": { "public_request_budget_per_user_rpm": { "type": "integer" } }, "required": [ "public_request_budget_per_user_rpm" ] }, "status": { "type": "string" } }, "required": [ "endpoint_id", "path_params", "product", "rate_plan", "route", "source", "status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "format": { "type": "string" }, "row_count": { "type": "integer" }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "exchange": { "type": "string" }, "equity_volume": { "type": "integer" }, "equity_market_share": { "type": "number" }, "index_other_volume": { "type": "integer" }, "index_other_market_share": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "other_volume": { "type": "integer" }, "other_market_share": { "type": "integer" }, "exchange_total_volume": { "type": "integer" }, "exchange_total_market_share": { "type": "number" } }, "required": [ "equity_market_share", "equity_volume", "exchange", "exchange_total_market_share", "exchange_total_volume", "index_other_market_share", "index_other_volume", "other_market_share", "other_volume" ] } }, "line_count": { "type": "integer" } }, "required": [ "format", "line_count", "row_count", "rows" ] } }, "required": [ "data", "meta" ] }, "occfin_get_volume_monthlyResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "product": { "type": "string" }, "source": { "type": "string" }, "endpoint_id": { "type": "string" }, "route": { "type": "string" }, "path_params": { "type": "object", "additionalProperties": true, "properties": {} }, "rate_plan": { "type": "object", "additionalProperties": true, "properties": { "public_request_budget_per_user_rpm": { "type": "integer" } }, "required": [ "public_request_budget_per_user_rpm" ] }, "status": { "type": "string" } }, "required": [ "endpoint_id", "path_params", "product", "rate_plan", "route", "source", "status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "format": { "type": "string" }, "delimiter": { "type": "string" }, "section_count": { "type": "integer" }, "row_count": { "type": "integer" }, "sections": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "title": { "type": "string" }, "columns": { "type": "array", "items": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "exchange": { "type": "string" }, "cleared_contracts": { "type": "integer" }, "cleared_transactions": { "type": "integer" }, "total_premiums": { "type": "string" }, "avg_premium_per_contract": { "type": "string" }, "avg_daily_contracts": { "type": "integer" }, "avg_contracts_per_transaction": { "type": "number" }, "of_total_contracts": { "type": "string" }, "customer_accounts": { "type": "integer" }, "of_total": { "type": "string" }, "firm_accounts": { "type": "integer" }, "market_maker_specialist_accounts": { "type": "integer" }, "total_contracts": { "type": "integer" }, "field": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "cleared_contract_volume_current_month": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "cleared_contract_volume_record": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "exercised_volume": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "open_interest": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] } }, "required": [ "avg_contracts_per_transaction", "avg_daily_contracts", "avg_premium_per_contract", "cleared_contract_volume_current_month", "cleared_contract_volume_record", "cleared_contracts", "cleared_transactions", "customer_accounts", "exchange", "exercised_volume", "field", "firm_accounts", "market_maker_specialist_accounts", "of_total", "of_total_contracts", "open_interest", "total_contracts", "total_premiums" ] } } }, "required": [ "columns", "rows", "title" ] } } }, "required": [ "delimiter", "format", "row_count", "section_count", "sections" ] } }, "required": [ "data", "meta" ] }, "occfin_get_options_series_symbolResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "product": { "type": "string" }, "source": { "type": "string" }, "endpoint_id": { "type": "string" }, "route": { "type": "string" }, "path_params": { "type": "object", "additionalProperties": true, "properties": { "symbol": { "type": "string" } }, "required": [ "symbol" ] }, "rate_plan": { "type": "object", "additionalProperties": true, "properties": { "public_request_budget_per_user_rpm": { "type": "integer" } }, "required": [ "public_request_budget_per_user_rpm" ] }, "status": { "type": "string" } }, "required": [ "endpoint_id", "path_params", "product", "rate_plan", "route", "source", "status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "format": { "type": "string" }, "row_count": { "type": "integer" }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "product_symbol": { "type": "string" }, "expiration": { "type": "string" }, "strike": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "call_put_flags": { "type": "string" }, "call_open_interest": { "type": "integer" }, "put_open_interest": { "type": "integer" }, "position_limit": { "type": "integer" } }, "required": [ "call_open_interest", "call_put_flags", "expiration", "position_limit", "product_symbol", "put_open_interest", "strike" ] } }, "line_count": { "type": "integer" } }, "required": [ "format", "line_count", "row_count", "rows" ] } }, "required": [ "data", "meta" ] } } }, "x-generated-at": "2026-06-07T01:30:59.456Z", "x-source-api": "occfin", "x-source-base-url": "https://api.occfin.bluedoor.sh" }