{ "openapi": "3.1.0", "info": { "title": "cbfin API Reference", "version": "0.1.0", "description": "Cboe source API for bluedoor Financial Data.\nCboe-owned option, index, futures, and delayed-market structure data.\nCoverage: Delayed quotes; Options roots and chains; Futures and index definitions; Historical and intraday chart data.\nGenerated from the live source contract and representative live API responses on 2026-06-07T01:30:59.456Z." }, "servers": [ { "url": "https://api.cbfin.bluedoor.sh", "description": "cbfin source API" } ], "externalDocs": { "description": "Cboe source API docs", "url": "https://bluedoor.sh/apis/financial-data/sources/cbfin" }, "tags": [ { "name": "Delayed Quotes" }, { "name": "Equities" }, { "name": "FX" }, { "name": "Futures" }, { "name": "Index Settlement" }, { "name": "Indices" }, { "name": "Notices" }, { "name": "Options" } ], "paths": { "/v1/market-data-services": { "get": { "summary": "Market data services", "operationId": "cbfin_get_market_data_services", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_market_data_servicesResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.market_data_services.api.cboe.com.market.data.services.data.32", "route": "market_data_services", "family": "market_data_services", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:18.892Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 387, "content_type": "application/json" }, "data": { "vendorData": [ { "name": "AboveNet", "provider_type": [ "telco_carrier" ], "geographic_region": [], "url": "mailto:enquiries@above.net", "contact": [ [ "eu", "enquiries@above.net", null ] ], "has_html_description": true, "description": "

AboveNet is revolutionising the approach to building metropolitan, global and IP Networks and is the leading provider of fibre optic connectivity solutions for businesses and carriers. AboveNet operates metropolitan fibre networks in and between London and 14 cities in the US, as well as a global Tier-1 IP Transit n...", "logo": "above.png", "twitter": null, "slug_name": "abovenet", "filters": [ "telco_carrier" ], "logo_url": "https://cdn.cboe.com/service_provider_logos/above.png" }, { "name": "ACCREDITEX Technologies Inc.", "provider_type": [ "software" ], "geographic_region": [ "global" ], "url": "https://www.accreditex.com/", "contact": [ [ "any", "info@accreditex.com", "" ] ], "has_html_description": false, "description": "ACCCREDITEX is a real-time intelligence platform that transforms raw regulatory filings into living, searchable insight — mapping every meaningful relationship across the capital markets.", "logo": "20251024134229122516-accreditex-brand-cboe.png", "twitter": null, "slug_name": "accreditex-technologies-inc", "filters": [ "software", "north_america", "emea" ], "logo_url": "https://cdn.cboe.com/service_provider_logos/20251024134229122516-accreditex-brand-cboe.png" }, { "name": "Advanced Technology Solutions", "provider_type": [ "software" ], "geographic_region": [ "global" ], "url": "http://www.atscom.it/sito/EN/index.php", "contact": [ [ "eu", null, null ] ], "has_html_description": true, "description": "

Since 1993 ATS-Advanced Technology Solutions provides ICT solutions for financial markets.

ATS's competence is strongly expressed in the Front Office and Middle Office area. Our offering is based on a sophisticated combination of solutions and products that meet the needs of all financial operators:

EXP...", "logo": "advanced-technology-solutions.png", "twitter": null, "slug_name": "advanced-technology-solutions", "filters": [ "software", "north_america", "emea" ], "logo_url": "https://cdn.cboe.com/service_provider_logos/advanced-technology-solutions.png" } ], "marketTotals": { "fx": 56119933333.333336, "usOptions": 15452584.272727273 }, "marketShare": [ { "venue": "Cboe Europe", "total": 25.44631579914024 }, { "venue": "Euronext", "total": 23.368491289287167 }, { "venue": "Xetra", "total": 12.30977309006915 } ], "vix": [ [ "2026-06-05T15:00:16.308000-05:00", 20.2 ], [ "2026-06-05T15:00:31.308000-05:00", 20.26 ], [ "2026-06-05T15:00:46.308000-05:00", 20.24 ] ] } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns market data services with source-native fields and identifiers.", "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "market", "in": "query", "required": false, "schema": { "type": "string" }, "example": "us", "description": "Query parameter `market`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/market-data-services?market=us", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:19.345Z" } }, "/v1/tradable-products": { "get": { "summary": "Tradable products", "operationId": "cbfin_get_tradable_products", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_tradable_productsResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.tradable_products.api.cboe.com.tradable.products.data.34", "route": "tradable_products", "family": "tradable_products", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:21.213Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 281, "content_type": "application/json" }, "data": { "data": { "equity": [ { "underlying_root": "SPX", "trading_dt": "2026-06-05", "volume": 7784725, "open_interest": 24534511, "title": "S&P 500 Index Options", "display": "full" }, { "underlying_root": "XSP", "trading_dt": "2026-06-05", "volume": 281417, "open_interest": 780051, "title": "Mini S&P 500 Index Options", "display": "full" }, { "underlying_root": "RUT", "trading_dt": "2026-06-05", "volume": 89611, "open_interest": 718529, "title": "Russell 2000 Index Options", "display": "full" } ], "volatility": [ { "underlying_root": "VIX", "trading_dt": "2026-06-05", "volume": 1406194, "open_interest": 12578072, "title": "VIX Options", "display": "full" }, { "underlying_root": "VX", "trading_dt": "2026-06-05", "volume": 439840, "open_interest": 426129, "title": "VIX Futures", "display": "full" }, { "underlying_root": "VXM", "trading_dt": "2026-06-05", "volume": 17825, "open_interest": 7023, "title": "Mini VIX Futures", "display": "full" } ], "credit_interest": [ { "underlying_root": "IBHY", "trading_dt": "2026-06-05", "volume": 540, "open_interest": 7028, "title": "iBoxx© iShares© $ High Yield Corporate Bond Futures", "display": "full" }, { "underlying_root": "IBIG", "trading_dt": "2026-06-05", "volume": 213, "open_interest": 4411, "title": "iBoxx© iShares© $ Investment Grade Corporate Bond Futures", "display": "full" }, { "underlying_root": "IEMD", "trading_dt": "2026-06-05", "volume": 898, "open_interest": 1811, "title": "Cboe® iBoxx® $ Emerging Market Bond Index (IEMD) Futures", "display": "full" } ], "international_equity": [ { "underlying_root": "MXEF", "trading_dt": "2026-06-05", "volume": 0, "open_interest": 18914, "title": "MSCI Emerging Market Index Options", "display": "full" }, { "underlying_root": "MXEA", "trading_dt": "2026-06-05", "volume": 0, "open_interest": 996, "title": "MSCI EAFE Index Options", "display": "full" } ], "crypto": [ { "underlying_root": "CBTX", "trading_dt": "2026-06-05", "volume": 19, "open_interest": 16391, "title": "Cboe Bitcoin U.S. ETF Index", "display": "full" }, { "underlying_root": "MBTX", "trading_dt": "2026-06-05", "volume": 5, "open_interest": 20, "title": "Cboe Mini Bitcoin U.S. ETF Index", "display": "full" }, { "underlying_root": "XBTF", "title": "Cboe FTSE Bitcoin Index (XBTF) Futures", "display": "short", "category": "crypto" } ] } } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns tradable products with source-native fields and identifiers.", "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/tradable-products", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:21.489Z" } }, "/v1/delayed-quotes/futures-roots": { "get": { "summary": "Futures roots", "operationId": "cbfin_get_delayed_quotes_futures_roots", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_delayed_quotes_futures_rootsResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.delayed_quotes_symbol_master.cdn.cboe.com.api.global.delayed.quotes.symbol.book.futures.roots.04", "route": "delayed_quotes_futures_roots", "family": "delayed_quotes_symbol_master", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:22.682Z", "freshness": { "ttl_seconds": 300, "stale_seconds": 3600 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 310, "content_type": "application/json" }, "data": { "timestamp": "2020-11-03", "data": [ { "future_root": "IBHY", "underlying": "^IBHY", "family": "IBHY", "sort_order": 1, "name": "Cboe iBoxx iShares High Yield Corporate Bond Index Futures" }, { "future_root": "IBIG", "underlying": "^IBIG", "family": "IBIG", "sort_order": 1, "name": "Cboe iBoxx iShares Investment Grade Corporate Bond Index Futures" }, { "future_root": "IEMD", "underlying": "^IEMD", "family": "IEMD", "sort_order": 2, "name": "Cboe iBoxx $ Emerging Market Bond Index" } ] } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns futures roots with source-native fields and identifiers.", "tags": [ "Delayed Quotes" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/delayed-quotes/futures-roots", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:22.949Z" } }, "/v1/delayed-quotes/option-roots": { "get": { "summary": "Option roots", "operationId": "cbfin_get_delayed_quotes_option_roots", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_delayed_quotes_option_rootsResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.delayed_quotes_symbol_master.cdn.cboe.com.api.global.delayed.quotes.symbol.book.option.roots.03", "route": "delayed_quotes_option_roots", "family": "delayed_quotes_symbol_master", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:24.194Z", "freshness": { "ttl_seconds": 300, "stale_seconds": 3600 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 319, "content_type": "application/json" }, "data": { "timestamp": "2026-06-05 20:00:10", "data": [ { "symbol": "A", "root": "A" }, { "symbol": "AA", "root": "AA" }, { "symbol": "AAAU", "root": "AAAU" } ], "symbol": "option-roots" } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns option roots with source-native fields and identifiers.", "tags": [ "Delayed Quotes" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/delayed-quotes/option-roots", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:24.678Z" } }, "/v1/delayed-quotes/servertime": { "get": { "summary": "Server time", "operationId": "cbfin_get_delayed_quotes_servertime", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_delayed_quotes_servertimeResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.delayed_quotes_config.www.cboe.com.delayed.quote.api.servertime.18", "route": "delayed_quotes_servertime", "family": "delayed_quotes_config", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:25.997Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 440, "content_type": "application/json" }, "data": { "server utc time": "2026-06-07T01:31:25.949172" } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns server time with source-native fields and identifiers.", "tags": [ "Delayed Quotes" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/delayed-quotes/servertime", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:26.240Z" } }, "/v1/delayed-quotes/symbol-book": { "get": { "summary": "Symbol book", "operationId": "cbfin_get_delayed_quotes_symbol_book", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_delayed_quotes_symbol_bookResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.delayed_quotes_symbol_master.cdn.cboe.com.api.global.delayed.quotes.symbol.book.symbol.book.02", "route": "delayed_quotes_symbol_book", "family": "delayed_quotes_symbol_master", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:27.569Z", "freshness": { "ttl_seconds": 300, "stale_seconds": 3600 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 340, "content_type": "application/json" }, "data": { "timestamp": "2026-06-05 20:00:09", "data": [ { "name": "A", "company_name": "Agilent Technologies Inc" }, { "name": "A2RZ1", "company_name": "Adjusted Interest Rate Russell 2000 Total Return Futures" }, { "name": "A2RZ2", "company_name": "Adjusted Interest Rate Russell 2000 Total Return Futures" } ], "symbol": "symbol-book" } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns symbol book with source-native fields and identifiers.", "tags": [ "Delayed Quotes" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "symbol", "in": "query", "required": false, "schema": { "type": "string" }, "example": "AAPL", "description": "Query parameter `symbol`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/delayed-quotes/symbol-book?symbol=AAPL", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:28.658Z" } }, "/v1/delayed-quotes/ttl-rules": { "get": { "summary": "TTL rules", "operationId": "cbfin_get_delayed_quotes_ttl_rules", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_delayed_quotes_ttl_rulesResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.delayed_quotes_config.cdn.cboe.com.api.global.delayed.quotes.ttl.rules.01", "route": "delayed_quotes_ttl_rules", "family": "delayed_quotes_config", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:29.824Z", "freshness": { "ttl_seconds": 300, "stale_seconds": 3600 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 280, "content_type": "application/json" }, "data": { "ttlRules": { "enabled": false, "data": [ { "data_type": "quote", "rules": [ { "filter": "type", "value": "equities", "days": "M-F", "start": "09:30", "end": "16:30", "ttl": 60, "assume": "fresh" }, { "filter": "type", "value": "indices", "days": "M-F", "start": "01:00", "end": "23:30", "ttl": 60, "assume": "fresh" } ] }, { "data_type": "option/montage", "rules": [ { "filter": "type", "value": "equities", "days": "M-F", "start": "09:30", "end": "16:30", "ttl": 300, "assume": "stale" }, { "filter": "type", "value": "indices", "days": "M-F", "start": "09:30", "end": "16:30", "ttl": 300, "assume": "stale" }, { "filter": "symbol", "value": "SPX,VIX,", "days": "M-F", "start": "03:00", "end": "16:30", "ttl": 300, "assume": "fresh" } ] }, { "data_type": "charts/intraday", "rules": [ { "filter": "type", "value": "equities", "days": "M-F", "start": "09:30", "end": "16:30", "ttl": 600, "assume": "fresh" }, { "filter": "type", "value": "indices", "days": "M-F", "start": "01:00", "end": "23:30", "ttl": 600, "assume": "fresh" } ] } ] } } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns TTL rules with source-native fields and identifiers.", "tags": [ "Delayed Quotes" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/delayed-quotes/ttl-rules", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:30.079Z" } }, "/v1/fx/adv-30-day": { "get": { "summary": "30-day ADV", "operationId": "cbfin_get_fx_adv_30_day", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_fx_adv_30_dayResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.fx_market_statistics.cdn.cboe.com.fx.adv30day.29", "route": "fx_adv_30_day", "family": "fx_market_statistics", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:31.464Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 521, "content_type": "binary/octet-stream" }, "data": { "SPOT": { "NY": { "ecn_anonymous_firm_usdqty": 19292931972.36652, "ecn_semidisclosed_firm_usdqty": 15336457.856956521, "ecn_anonymous_nonfirm_usdqty": 13699800198.338696, "ecn_semidisclosed_nonfirm_usdqty": 599694200.5695652, "fa_anonymous_nonfirm_usdqty": 10062743489.649565, "fa_semidisclosed_nonfirm_usdqty": 703774275.6530435, "otheradv_anonymous_usdqty": 41444330.33565217, "otheradv_semidisclosed_usdqty": 0, "ecn_firm_total": 19308268430.223476, "ecn_nonfirm_total": 14299494398.90826, "fa_nonfirm_total": 10766517765.302608, "otheradv_total": 41444330.33565217 }, "LDN": { "ecn_anonymous_firm_usdqty": 1388944084.987826, "ecn_semidisclosed_firm_usdqty": 0, "ecn_anonymous_nonfirm_usdqty": 5183414613.610435, "ecn_semidisclosed_nonfirm_usdqty": 224205252.0395652, "fa_anonymous_nonfirm_usdqty": 3621977323.4891305, "fa_semidisclosed_nonfirm_usdqty": 1679382591.0934782, "otheradv_anonymous_usdqty": 0, "otheradv_semidisclosed_usdqty": 0, "ecn_firm_total": 1388944084.987826, "ecn_nonfirm_total": 5407619865.65, "fa_nonfirm_total": 5301359914.582609, "otheradv_total": 0 }, "TOTAL": { "ecn_anonymous_firm_usdqty": 20681876057.354347, "ecn_semidisclosed_firm_usdqty": 15336457.856956521, "ecn_anonymous_nonfirm_usdqty": 18883214811.94913, "ecn_semidisclosed_nonfirm_usdqty": 823899452.6091304, "fa_anonymous_nonfirm_usdqty": 13684720813.138695, "fa_semidisclosed_nonfirm_usdqty": 2383156866.746522, "otheradv_anonymous_usdqty": 41444330.33565217, "otheradv_semidisclosed_usdqty": 0, "ecn_firm_total": 20697212515.211304, "ecn_nonfirm_total": 19707114264.558258, "fa_nonfirm_total": 16067877679.885218, "otheradv_total": 41444330.33565217 } }, "NDF": { "NY": { "ecn_anonymous_firm_usdqty": 926391269.7826087, "ecn_semidisclosed_firm_usdqty": 0, "ecn_anonymous_nonfirm_usdqty": 2832315297.9565215, "ecn_semidisclosed_nonfirm_usdqty": 0, "fa_anonymous_nonfirm_usdqty": 699719963.2173913, "fa_semidisclosed_nonfirm_usdqty": 0, "otheradv_anonymous_usdqty": 0, "otheradv_semidisclosed_usdqty": 0, "ecn_firm_total": 926391269.7826087, "ecn_nonfirm_total": 2832315297.9565215, "fa_nonfirm_total": 699719963.2173913, "otheradv_total": 0 }, "LDN": { "ecn_anonymous_firm_usdqty": 78443266.26086956, "ecn_semidisclosed_firm_usdqty": 0, "ecn_anonymous_nonfirm_usdqty": 501657184.3913044, "ecn_semidisclosed_nonfirm_usdqty": 0, "fa_anonymous_nonfirm_usdqty": 0, "fa_semidisclosed_nonfirm_usdqty": 0, "otheradv_anonymous_usdqty": 0, "otheradv_semidisclosed_usdqty": 0, "ecn_firm_total": 78443266.26086956, "ecn_nonfirm_total": 501657184.3913044, "fa_nonfirm_total": 0, "otheradv_total": 0 }, "TOTAL": { "ecn_anonymous_firm_usdqty": 1004834536.0434783, "ecn_semidisclosed_firm_usdqty": 0, "ecn_anonymous_nonfirm_usdqty": 3333972482.347826, "ecn_semidisclosed_nonfirm_usdqty": 0, "fa_anonymous_nonfirm_usdqty": 699719963.2173913, "fa_semidisclosed_nonfirm_usdqty": 0, "otheradv_anonymous_usdqty": 0, "otheradv_semidisclosed_usdqty": 0, "ecn_firm_total": 1004834536.0434783, "ecn_nonfirm_total": 3333972482.347826, "fa_nonfirm_total": 699719963.2173913, "otheradv_total": 0 } } } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns 30-day ADV with currency, rate, and date fields from the upstream data shape.", "tags": [ "FX" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/fx/adv-30-day", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:31.708Z" } }, "/v1/fx/adv-30-day-card": { "get": { "summary": "30-day ADV card", "operationId": "cbfin_get_fx_adv_30_day_card", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_fx_adv_30_day_cardResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.fx_market_statistics.cdn.cboe.com.fx.adv30daycard.30", "route": "fx_adv_30_day_card", "family": "fx_market_statistics", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:33.156Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 545, "content_type": "binary/octet-stream" }, "data": { "SPOT": { "TOTAL": 56513648789.99043, "PCT": 6.096705101990934, "FIRM_TOTAL": 20697212515.211304, "FIRM_PCT": 2.3503396177394134, "FA_TOTAL": 16067877679.885218, "FA_PCT": 4.534967961052774, "METALS_TOTAL": 3183606656.8643475, "METALS_PCT": 12.560503050145622, "CCYPAIR_TOTAL": 53330042133.12608, "CCYPAIR_PCT": 5.734241103620157 }, "NDF": { "TOTAL": 5038526981.608695, "PCT": 27.17341619775973, "FIRM_TOTAL": 1004834536.0434783, "FIRM_PCT": 25.893248218923304, "FA_TOTAL": 699719963.2173913, "FA_PCT": 26.88959764378252 }, "COMBINED": { "TOTAL": 61552175771.59913, "PCT": 7.555857834388088, "FIRM_TOTAL": 21702047051.254784, "FIRM_PCT": 3.2442986329649965, "FA_TOTAL": 16767597643.10261, "FA_PCT": 5.309182139007502 } } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns 30-day ADV card with currency, rate, and date fields from the upstream data shape.", "tags": [ "FX" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/fx/adv-30-day-card", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:33.577Z" } }, "/v1/fx/sef-volume": { "get": { "summary": "SEF volume", "operationId": "cbfin_get_fx_sef_volume", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_fx_sef_volumeResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.fx_market_statistics.cdn.cboe.com.fx.sefvolume.31", "route": "fx_sef_volume", "family": "fx_market_statistics", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:34.813Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 350, "content_type": "binary/octet-stream" }, "data": { "daily": [ { "trade-date": "Jun 05, 2026", "volume": "$6,717" }, { "trade-date": "Jun 04, 2026", "volume": "$4,784" }, { "trade-date": "Jun 03, 2026", "volume": "$4,005" } ], "daily_vols_trailing_month": [ { "trade-date": "May 25, 2026", "volume": "$2,533" }, { "trade-date": "May 22, 2026", "volume": "$5,186" }, { "trade-date": "May 21, 2026", "volume": "$5,503" } ], "monthly": [ { "trading-days": "5", "avg-daily-volume": "$4,990", "volume": "$24,954", "month": "June-2026" }, { "trading-days": "21", "avg-daily-volume": "$4,753", "volume": "$99,819", "month": "May-2026" }, { "trading-days": "22", "avg-daily-volume": "$4,026", "volume": "$88,587", "month": "April-2026" } ], "quarterly": [ { "trading-days": "48", "volume": "$213,361", "quarter": "Q2 2026", "avg-daily-volume": "$4,445" }, { "trading-days": "63", "volume": "$275,470", "quarter": "Q1 2026", "avg-daily-volume": "$4,372" }, { "trading-days": "65", "volume": "$213,415", "quarter": "Q4 2025", "avg-daily-volume": "$3,283" } ] } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns SEF volume with currency, rate, and date fields from the upstream data shape.", "tags": [ "FX" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/fx/sef-volume", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:35.018Z" } }, "/v1/market-data-services/most-active": { "get": { "summary": "Most-active services", "operationId": "cbfin_get_market_data_services_most_active", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_market_data_services_most_activeResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.market_data_services.api.cboe.com.market.data.services.data.most.active.33", "route": "market_data_services_most_active", "family": "market_data_services", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:36.112Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 233, "content_type": "application/json" }, "data": { "mostActive": [ { "symbol": "SOXS", "last_price": "6.9550", "volume": "41398742" }, { "symbol": "IBIT", "last_price": "34.4800", "volume": "9091360" }, { "symbol": "NOTV", "last_price": "0.1520", "volume": "9062646" } ] } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns most-active services with source-native fields and identifiers.", "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "market", "in": "query", "required": false, "schema": { "type": "string" }, "example": "us", "description": "Query parameter `market`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/market-data-services/most-active?market=us", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:36.366Z" } }, "/v1/options/market-share": { "get": { "summary": "Market share", "operationId": "cbfin_get_options_market_share", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_options_market_shareResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.options_market_statistics.api.cboe.com.us.options.market.share.market.data.35", "route": "options_market_share", "family": "options_market_statistics", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:37.858Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 491, "content_type": "application/json" }, "data": { "reload": 0, "data": { "top": [], "stats": { "integrated": [ { "avg_weighting": 0, "mktshare": 0.291958231063813, "value": 18772281, "weighting": 0, "data": [], "mktname": "chicagoboardoptionsexchangecwez", "mkthtml": "Chicago Board Options Exchange (C,W,E,Z)", "data_count": 0 }, { "avg_weighting": 0, "mktshare": 0.27296790151443834, "value": 17551244, "weighting": 0, "data": [], "mktname": "nasdaqqtxhij", "mkthtml": "NASDAQ (Q,T,X,H,I,J)", "data_count": 0 }, { "avg_weighting": 0, "mktshare": 0.18376641663075696, "value": 11815782, "weighting": 0, "data": [], "mktname": "nysean", "mkthtml": "NYSE (A,N)", "data_count": 0 } ], "integrated_count": 6 }, "totals": { "normal": [], "integrated": [], "normal_count": 0, "integrated_count": 0 }, "total": { "normal": [ 64297831, 1 ], "integrated": [ 64297831, 1 ], "normal_count": 2, "integrated_count": 2 }, "avg_totals": { "normal": [], "integrated": [], "normal_count": 0, "integrated_count": 0 }, "avg_total": { "normal": [ 63041580, 1 ], "integrated": [ 63041580, 1 ], "normal_count": 2, "integrated_count": 2 }, "comp_stats": { "data": [], "data_count": 0 }, "type": "market", "end_ts": "17:00 04/05/2026", "disclaimer": "", "disabled": [], "top_count": 0, "disabled_count": 0 }, "success": true, "statusText": "", "statusCode": "200", "status": "200: " } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns market share with contract, chain, volume, open-interest, or strategy fields where available.", "tags": [ "Options" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "bias", "in": "query", "required": false, "schema": { "type": "string" }, "example": "Volume", "description": "Query parameter `bias`." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10", "description": "Query parameter `limit`." }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2026-05-04", "description": "Query parameter `date`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/options/market-share?bias=Volume&limit=10&date=2026-05-04", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:38.152Z" } }, "/v1/options/most-active": { "get": { "summary": "Most active", "operationId": "cbfin_get_options_most_active", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_options_most_activeResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.options_market_statistics.api.cboe.com.us.options.market.statistics.most.active.data.36", "route": "options_most_active", "family": "options_market_statistics", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:39.801Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 803, "content_type": "application/json; charset=utf-8" }, "data": { "limit": 10, "description": "The current, most actively traded options on the Cboe Options Exchange.", "categories": [ { "category": "all", "display": "All Options", "calls": [ { "symbol": "RUTW", "expires": "2026-06-26", "strike": 3105, "volume": 19100 }, { "symbol": "RUTW", "expires": "2026-06-26", "strike": 2670, "volume": 10100 }, { "symbol": "MRUT", "expires": "2026-07-31", "strike": 284, "volume": 9000 } ], "puts": [ { "symbol": "XSP", "expires": "2026-06-22", "strike": 779, "volume": 18700 }, { "symbol": "VIXW", "expires": "2026-07-08", "strike": 24, "volume": 12600 }, { "symbol": "VIXW", "expires": "2026-06-24", "strike": 20, "volume": 9700 } ] }, { "category": "index", "display": "Index Options", "calls": [ { "symbol": "RUTW", "expires": "2026-06-26", "strike": 3105, "volume": 19100 }, { "symbol": "RUTW", "expires": "2026-06-26", "strike": 2670, "volume": 10100 }, { "symbol": "MRUT", "expires": "2026-07-31", "strike": 284, "volume": 9000 } ], "puts": [ { "symbol": "XSP", "expires": "2026-06-22", "strike": 779, "volume": 18700 }, { "symbol": "VIXW", "expires": "2026-07-08", "strike": 24, "volume": 12600 }, { "symbol": "VIXW", "expires": "2026-06-24", "strike": 20, "volume": 9700 } ] }, { "category": "equity", "display": "Equity Options", "calls": [ { "symbol": "M", "expires": "2026-07-17", "strike": 26, "volume": 2800 }, { "symbol": "XOM", "expires": "2026-06-12", "strike": 148, "volume": 2200 }, { "symbol": "NFLX", "expires": "2026-07-10", "strike": 76, "volume": 2000 } ], "puts": [ { "symbol": "M", "expires": "2026-07-24", "strike": 19.5, "volume": 3000 }, { "symbol": "M", "expires": "2026-07-24", "strike": 21, "volume": 2900 }, { "symbol": "M", "expires": "2026-07-17", "strike": 26, "volume": 2800 } ] } ], "dt": "2026-06-06T21:31:39.742985-04:00" } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns most active with contract, chain, volume, open-interest, or strategy fields where available.", "tags": [ "Options" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "market_code", "in": "query", "required": false, "schema": { "type": "string" }, "example": "cone", "description": "Query parameter `market_code`." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10", "description": "Query parameter `limit`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/options/most-active?market_code=cone&limit=10", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:40.031Z" } }, "/v1/delayed-quotes/history/{symbol}": { "get": { "summary": "History", "operationId": "cbfin_get_delayed_quotes_history_symbol", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_delayed_quotes_history_symbolResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.delayed_quotes_history.cdn.cboe.com.api.global.delayed.quotes.historical.data.symbol.12", "route": "delayed_quotes_history_symbol", "family": "delayed_quotes_history", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:42.801Z", "freshness": { "ttl_seconds": 300, "stale_seconds": 3600 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 517, "content_type": "application/json" }, "data": { "timestamp": "2026-06-06 12:45:48", "data": { "symbol": "AAPL", "annual_high": 316.94000244140625, "hv30_annual_high": 31.316699981689453, "hv60_annual_high": 50.469600677490234, "hv90_annual_high": 44.4390983581543, "iv30_annual_high": 32.38100051879883, "iv60_annual_high": 32.172000885009766, "iv90_annual_high": 31.226999282836914, "annual_low": 195.07000732421875, "hv30_annual_low": 10.286499977111816, "hv60_annual_low": 14.057600021362305, "hv90_annual_low": 17.853700637817383, "iv30_annual_low": 17.025999069213867, "iv60_annual_low": 21.541000366210938, "iv90_annual_low": 21.892000198364258 }, "symbol": "AAPL" } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns history with source-native fields and identifiers.", "tags": [ "Delayed Quotes" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter `symbol`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/delayed-quotes/history/AAPL", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:43.114Z" } }, "/v1/delayed-quotes/options/{underlying_symbol}": { "get": { "summary": "Options", "operationId": "cbfin_get_delayed_quotes_options_underlying_symbol", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_delayed_quotes_options_underlying_symbolResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.options_chain.cdn.cboe.com.api.global.delayed.quotes.options.underlying.symbol.16", "route": "delayed_quotes_options_underlying_symbol", "family": "options_chain", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:44.912Z", "freshness": { "ttl_seconds": 300, "stale_seconds": 3600 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 871, "content_type": "application/json" }, "data": { "timestamp": "2026-06-06 03:44:44", "data": { "options": [ { "option": "AAPL260605C00110000", "bid": 196, "bid_size": 5, "ask": 199.6, "ask_size": 1, "iv": 0, "open_interest": 2, "volume": 2, "delta": 1, "gamma": 0, "vega": 0, "theta": 0, "rho": 0, "theo": 197.4656, "change": -1.22, "open": 200.16, "high": 200.28, "low": 200.16, "tick": "up", "last_trade_price": 200.28, "last_trade_time": "2026-06-05T14:55:24", "percent_change": -0.605459, "prev_day_close": 201.5 }, { "option": "AAPL260605P00110000", "bid": 0, "bid_size": 0, "ask": 0.01, "ask_size": 1000, "iv": 0, "open_interest": 101, "volume": 74, "delta": 0, "gamma": 0, "vega": 0, "theta": 0, "rho": 0, "theo": 0, "change": 0.005, "open": 0.01, "high": 0.01, "low": 0.01, "tick": "no_change", "last_trade_price": 0.01, "last_trade_time": "2026-06-05T10:03:29", "percent_change": 100, "prev_day_close": 0.00499999988824129 }, { "option": "AAPL260605C00120000", "bid": 186.55, "bid_size": 5, "ask": 189.2, "ask_size": 5, "iv": 0, "open_interest": 43, "volume": 7, "delta": 1, "gamma": 0, "vega": 0, "theta": -0.0001, "rho": 0, "theo": 187.4656, "change": -1.175, "open": 193.22, "high": 193.22, "low": 190.17, "tick": "up", "last_trade_price": 190.3, "last_trade_time": "2026-06-05T14:55:24", "percent_change": -0.613656, "prev_day_close": 191.474998474121 } ], "symbol": "AAPL", "security_type": "stock", "exchange_id": 2, "current_price": 307.78, "price_change": -3.89, "price_change_percent": -1.2657, "bid": 307.65, "ask": 307.78, "bid_size": 80, "ask_size": 40, "open": 312.98, "high": 315.17, "low": 307.15, "close": 307.34, "prev_day_close": 307.34, "volume": 65310502, "iv30": 24.511, "iv30_change": 0, "iv30_change_percent": 0, "seqno": 49210592470, "last_trade_time": "2026-06-05T16:00:00", "tick": "up" }, "symbol": "AAPL" } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns options with source-native fields and identifiers.", "tags": [ "Delayed Quotes" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "underlying_symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter `underlying_symbol`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/delayed-quotes/options/AAPL", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:45.652Z" } }, "/v1/delayed-quotes/quotes/{symbol}": { "get": { "summary": "Quote", "operationId": "cbfin_get_delayed_quotes_quotes_symbol", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_delayed_quotes_quotes_symbolResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.delayed_quotes_snapshot.cdn.cboe.com.api.global.delayed.quotes.quotes.symbol.05", "route": "delayed_quotes_quotes_symbol", "family": "delayed_quotes_snapshot", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:46.832Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 306, "content_type": "application/json" }, "data": { "timestamp": "2026-06-06 18:35:42", "data": { "symbol": "AAPL", "security_type": "stock", "exchange_id": 2, "current_price": 307.78, "price_change": -3.89, "price_change_percent": -1.2657, "bid": 307.65, "ask": 307.78, "bid_size": 80, "ask_size": 40, "open": 312.98, "high": 315.17, "low": 307.15, "close": 307.34, "prev_day_close": 307.34, "volume": 65310502, "iv30": 24.387, "iv30_change": 0, "iv30_change_percent": 0, "seqno": 0, "last_trade_time": "2026-06-05T16:00:00", "tick": "up" }, "symbol": "AAPL" } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns quote with source-native fields and identifiers.", "tags": [ "Delayed Quotes" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter `symbol`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/delayed-quotes/quotes/AAPL", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:47.103Z" } }, "/v1/delayed-quotes/quotes/all-us-indices": { "get": { "summary": "US indices", "operationId": "cbfin_get_delayed_quotes_quotes_all_us_indices", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_delayed_quotes_quotes_all_us_indicesResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.delayed_quotes_snapshot.cdn.cboe.com.api.global.delayed.quotes.quotes.all.us.indices.06", "route": "delayed_quotes_quotes_all_us_indices", "family": "delayed_quotes_snapshot", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:48.599Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 564, "content_type": "application/json" }, "data": { "timestamp": "2026-06-07 01:30:52", "data": [ { "symbol": "^AAVE100", "security_type": "index", "exchange_id": 5, "current_price": 62.3012, "price_change": -8.6588, "price_change_percent": -13.8986, "bid": 62.185, "ask": 62.4174, "bid_size": 1, "ask_size": 1, "open": 69.81, "high": 69.8929, "low": 59.2675, "close": 62.3012, "prev_day_close": 62.3, "volume": 0, "iv30": 0, "iv30_change": 0, "iv30_change_percent": null, "seqno": 0, "last_trade_time": "2026-06-05T20:00:02", "tick": "up" }, { "symbol": "^AAVE10RP", "security_type": "index", "exchange_id": 5, "current_price": 62.2881, "price_change": -8.6719, "price_change_percent": -13.9218, "bid": 62.1926, "ask": 62.3836, "bid_size": 1, "ask_size": 1, "open": 69.8072, "high": 69.8861, "low": 59.2701, "close": 62.2881, "prev_day_close": 62.29, "volume": 0, "iv30": 0, "iv30_change": 0, "iv30_change_percent": null, "seqno": 0, "last_trade_time": "2026-06-05T20:00:02", "tick": "up" }, { "symbol": "^AAVE25RP", "security_type": "index", "exchange_id": 5, "current_price": 62.285, "price_change": -8.675, "price_change_percent": -13.929, "bid": 62.1877, "ask": 62.3823, "bid_size": 1, "ask_size": 1, "open": 69.804, "high": 69.88, "low": 59.269, "close": 62.285, "prev_day_close": 62.28, "volume": 0, "iv30": 0, "iv30_change": 0, "iv30_change_percent": null, "seqno": 0, "last_trade_time": "2026-06-05T20:00:02", "tick": "up" } ], "symbol": "all_us_indices" } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns US indices with source-native fields and identifiers.", "tags": [ "Delayed Quotes" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/delayed-quotes/quotes/all-us-indices", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:49.020Z" } }, "/v1/delayed-quotes/quotes/all-us-indices-icp": { "get": { "summary": "US indices ICP", "operationId": "cbfin_get_delayed_quotes_quotes_all_us_indices_icp", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_delayed_quotes_quotes_all_us_indices_icpResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.delayed_quotes_snapshot.cdn.cboe.com.api.global.delayed.quotes.quotes.all.us.indices.from.icp.07", "route": "delayed_quotes_quotes_all_us_indices_icp", "family": "delayed_quotes_snapshot", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:50.619Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 690, "content_type": "application/json" }, "data": { "timestamp": "2026-06-07 01:28:26", "data": [ { "high": 0, "exchange_id": 115, "current_price": 1191.7621, "close": 1191.7621, "iv30_change_percent": 0, "prev_day_close": 1191.7621, "open": 0, "security_type": "index", "low": 0, "ask_size": 0, "symbol": "^.MSDXUTPU", "index": ".MSDXUTPU", "bid_size": 0, "iv30_change": 0, "iv30": 0, "seqno": 0, "bid": 0, "volume": 0, "ask": 0, "tick": "", "price_change_percent": 0, "price_change": 0, "last_trade_time": "2024-05-06T00:00:00-05:00" }, { "high": 0, "exchange_id": 115, "current_price": 160.78, "close": 160.78, "iv30_change_percent": 0, "prev_day_close": 160.78, "open": 0, "security_type": "index", "low": 0, "ask_size": 0, "symbol": "^AVCHQYLD", "index": "AVCHQYLD", "bid_size": 0, "iv30_change": 0, "iv30": 0, "seqno": 0, "bid": 0, "volume": 0, "ask": 0, "tick": "", "price_change_percent": 0, "price_change": 0, "last_trade_time": "2026-06-05T00:00:00-05:00" }, { "high": 0, "exchange_id": 115, "current_price": 3968.33, "close": 3968.33, "iv30_change_percent": 0, "prev_day_close": 3968.33, "open": 0, "security_type": "index", "low": 0, "ask_size": 0, "symbol": "^AVFOCGRW", "index": "AVFOCGRW", "bid_size": 0, "iv30_change": 0, "iv30": 0, "seqno": 0, "bid": 0, "volume": 0, "ask": 0, "tick": "", "price_change_percent": 0, "price_change": 0, "last_trade_time": "2026-06-05T00:00:00-05:00" } ], "symbol": "all_us_indices_from_icp" } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns US indices ICP with source-native fields and identifiers.", "tags": [ "Delayed Quotes" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/delayed-quotes/quotes/all-us-indices-icp", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:51.206Z" } }, "/v1/equities/au/today-activity": { "get": { "summary": "Australia activity", "operationId": "cbfin_get_equities_au_today_activity", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_equities_au_today_activityResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.equities_market_statistics.api.cboe.com.au.equities.today.activity.data.43", "route": "equities_au_today_activity", "family": "equities_market_statistics", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:53.483Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 1397, "content_type": "application/json" }, "data": { "data": [ { "id": "equities", "label": "Equities", "summary": [ { "title": "CONTINUOUS TRADING", "subtext": "Value AUD:", "value": "$979,059,021", "subtitle": "Volume", "subtitlevalue": "1,097,173,248" }, { "title": "TRADE REPORTING", "subtext": "Value AUD:", "value": "$469,733,704", "subtitle": "Volume", "subtitlevalue": "102,307,802" }, { "title": "SYMBOLS TRADED", "subtext": "", "value": "1,742", "subtitle": "", "subtitlevalue": "" } ], "url": "/au/equities/support/reference_data/" }, { "id": "cash", "label": "Cash", "summary": [ { "title": "CONTINUOUS TRADING", "subtext": "Value AUD:", "value": "$991,601,309", "subtitle": "Volume", "subtitlevalue": "1,098,929,775" }, { "title": "TRADE REPORTING", "subtext": "Value AUD:", "value": "$469,940,715", "subtitle": "Volume", "subtitlevalue": "102,328,396" }, { "title": "SYMBOLS TRADED", "subtext": "", "value": "1,848", "subtitle": "", "subtitlevalue": "" } ], "url": "" }, { "id": "warrants", "label": "Warrants", "summary": [ { "title": "CONTINUOUS TRADING", "subtext": "Value AUD:", "value": "$3,194,024", "subtitle": "Volume", "subtitlevalue": "774,584" }, { "title": "TRADE REPORTING", "subtext": "Value AUD:", "value": "$0", "subtitle": "Volume", "subtitlevalue": "0" }, { "title": "SYMBOLS TRADED", "subtext": "", "value": "79", "subtitle": "", "subtitlevalue": "" } ], "url": "/au/warrants/" } ], "retrieved_at": "June 05, 2026 | 04:08:17 PM", "display": "tabs", "success": true } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns australia activity with source-native fields and identifiers.", "tags": [ "Equities" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/equities/au/today-activity", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:54.152Z" } }, "/v1/equities/ca/listing-directory": { "get": { "summary": "Canada listings", "operationId": "cbfin_get_equities_ca_listing_directory", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_equities_ca_listing_directoryResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.listing_directory.api.cboe.com.ca.equities.listing.directory.data.42", "route": "equities_ca_listing_directory", "family": "listing_directory", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:55.830Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 783, "content_type": "application/json" }, "data": { "data": [ { "symbol": "CTUH.U", "name": "CIBC 2030 U.S. INVESTMENT GRADE BOND FUND", "currency": "USD", "security": "etf", "security_sub_type": "etf", "marketcap": 1192200, "last": 0, "changepcnt": "", "volume": 5700 }, { "symbol": "CTUI.U", "name": "CIBC 2031 U.S. INVESTMENT GRADE BOND FUND", "currency": "USD", "security": "etf", "security_sub_type": "etf", "marketcap": 1191000, "last": 0, "changepcnt": "", "volume": 0 }, { "symbol": "ZGSB", "name": "BMO GLOBAL STRATEGIC BOND FUND", "currency": "CAD", "security": "etf", "security_sub_type": "etf", "marketcap": 13444400, "last": 0, "changepcnt": "", "volume": 1 } ] } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns canada listings with source-native fields and identifiers.", "tags": [ "Equities" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/equities/ca/listing-directory", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:56.149Z" } }, "/v1/equities/ca/market-totals": { "get": { "summary": "Canada market totals", "operationId": "cbfin_get_equities_ca_market_totals", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_equities_ca_market_totalsResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.equities_market_statistics.api.cboe.com.ca.equities.market.totals.40", "route": "equities_ca_market_totals", "family": "equities_market_statistics", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:57.228Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 223, "content_type": "application/json" }, "data": { "data": [ { "total_volume": "0.0", "total_value": "0.0", "trade_count": 0, "ts": "2026-06-06 21:31:56" } ] } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns canada market totals with source-native fields and identifiers.", "tags": [ "Equities" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "market", "in": "query", "required": false, "schema": { "type": "string" }, "example": "us", "description": "Query parameter `market`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/equities/ca/market-totals?market=us", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:57.463Z" } }, "/v1/equities/ca/symbol-totals": { "get": { "summary": "Canada symbol totals", "operationId": "cbfin_get_equities_ca_symbol_totals", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_equities_ca_symbol_totalsResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.equities_market_statistics.api.cboe.com.ca.equities.symbol.totals.41", "route": "equities_ca_symbol_totals", "family": "equities_market_statistics", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:31:58.532Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 183, "content_type": "application/json" }, "data": { "data": [ { "advancers": 0, "decliners": 0, "unchanged": 0 } ] } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns canada symbol totals with source-native fields and identifiers.", "tags": [ "Equities" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "symbol", "in": "query", "required": false, "schema": { "type": "string" }, "example": "AAPL", "description": "Query parameter `symbol`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/equities/ca/symbol-totals?symbol=AAPL", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:31:58.807Z" } }, "/v1/equities/ca/top-ten-volume": { "get": { "summary": "Canada top volume", "operationId": "cbfin_get_equities_ca_top_ten_volume", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_equities_ca_top_ten_volumeResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.equities_market_statistics.api.cboe.com.ca.equities.top.ten.volume.39", "route": "equities_ca_top_ten_volume", "family": "equities_market_statistics", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:00.037Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 368, "content_type": "application/json" }, "data": { "data": [ { "name": "VRNO", "bats_name": "VRNO", "company_name": "VERANO HOLDINGS CORP.", "last_price": "0.0", "percent_change": "0.0", "vol": 1915693, "trade_time": "", "ts": "2026-06-06 21:31:59" }, { "name": "MAXQ", "bats_name": "MAXQ", "company_name": "MARITIME LAUNCH SERVICES INC.", "last_price": "0.0", "percent_change": "0.0", "vol": 1905059, "trade_time": "", "ts": "2026-06-06 21:31:59" }, { "name": "SOXL", "bats_name": "SOXL", "company_name": "BETAPRO 3X SEMICONDUCTOR DAILY LEVERAGED BULL ALTERNATIVE ETF", "last_price": "0.0", "percent_change": "0.0", "vol": 1614385, "trade_time": "", "ts": "2026-06-06 21:31:59" } ] } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns canada top volume with source-native fields and identifiers.", "tags": [ "Equities" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "string" }, "example": "listed", "description": "Query parameter `filter`." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10", "description": "Query parameter `limit`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/equities/ca/top-ten-volume?filter=listed&limit=10", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:00.248Z" } }, "/v1/equities/europe/most-active": { "get": { "summary": "Europe most active", "operationId": "cbfin_get_equities_europe_most_active", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_equities_europe_most_activeResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.equities_market_statistics.api.cboe.com.europe.equities.market.statistics.most.active.data.limit.38", "route": "equities_europe_most_active", "family": "equities_market_statistics", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:03.112Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 1985, "content_type": "application/json" }, "data": { "success": "True", "ttl": 121377014.092, "ts": "2026-06-06 21:32:02", "data": { "cxe": [] }, "mo": false } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns europe most active with source-native fields and identifiers.", "tags": [ "Equities" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "market_codes", "in": "query", "required": false, "schema": { "type": "string" }, "example": "cxe", "description": "Query parameter `market_codes`." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10", "description": "Query parameter `limit`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/equities/europe/most-active?market_codes=cxe&limit=10", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:03.346Z" } }, "/v1/equities/us/halts.csv": { "get": { "summary": "US halts CSV", "operationId": "cbfin_get_equities_us_halts_csv", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_equities_us_halts_csvResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.equities_download.www.cboe.com.us.equities.market.statistics.halts.downloads.batshaltsyear.60", "route": "equities_us_halts_csv", "family": "equities_download", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:04.350Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 130, "content_type": "text/csv" }, "data": "Symbol,Company Name,Market,Halt Date,Halt Time,Reason,Resume Date,Quote Time,Resume Time\r\nQBER,TrueShares Quarterly Bear Hedge ETF,BZX,2025-12-30,9:34:27,Volatility Pause,2025-12-30,9:34:27,9:39:27\r\nTETH,21Shares Ethereum ETF,BZX,2025-12-19,9:30:15,Volatility Pause,2025-12-19,9:30:15,9:35:15\r\nETHV,VanEck Ethereum ETF,B..." } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns US halts CSV with source-native fields and identifiers.", "tags": [ "Equities" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "year", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "2025", "description": "Query parameter `year`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/equities/us/halts.csv?year=2025", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:04.578Z" } }, "/v1/equities/us/most-active": { "get": { "summary": "US most active", "operationId": "cbfin_get_equities_us_most_active", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_equities_us_most_activeResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.equities_market_statistics.api.cboe.com.us.equities.market.statistics.most.active.data.limit.37", "route": "equities_us_most_active", "family": "equities_market_statistics", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:06.056Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 613, "content_type": "application/json" }, "data": { "success": "True", "ttl": 109674030.96800001, "ts": "2026-06-06 21:32:05", "data": { "bzx": [ [ "IXUS", "136744", "97.06000000" ], [ "EXC", "132895", "44.64000000" ], [ "UVXY", "129568", "27.84000000" ] ] }, "mo": false } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns US most active with source-native fields and identifiers.", "tags": [ "Equities" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "market_codes", "in": "query", "required": false, "schema": { "type": "string" }, "example": "bzx", "description": "Query parameter `market_codes`." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10", "description": "Query parameter `limit`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/equities/us/most-active?market_codes=bzx&limit=10", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:06.303Z" } }, "/v1/equities/us/short-sale-circuit-breakers.csv": { "get": { "summary": "US short-sale circuit breakers CSV", "operationId": "cbfin_get_equities_us_short_sale_circuit_breakers_csv", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_equities_us_short_sale_circuit_breakers_csvResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.equities_download.www.cboe.com.us.equities.market.statistics.short.sale.circuit.breakers.downloads.61", "route": "equities_us_short_sale_circuit_breakers_csv", "family": "equities_download", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:07.274Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 66, "content_type": "text/csv" }, "data": "Primary Listing Exchange,Symbol,Security Name,Trigger Date,Trigger Time,End Date,End Time,Rescinded Date,Rescinded Time\r\nBZX,TSLT,T-Rex 2X Long Tesla Daily Target ETF,2025-01-02,9:33:41,2025-01-06,1:26:02,,\r\nBZX,MSTZ,T-Rex 2X Inverse MSTR Daily Target ETF,2025-01-02,9:43:17,2025-01-03,10:42:47,,\r\nBZX,BTCZ,T-Rex 2X Inve..." } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns US short-sale circuit breakers CSV with source-native fields and identifiers.", "tags": [ "Equities" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "year", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "2025", "description": "Query parameter `year`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/equities/us/short-sale-circuit-breakers.csv?year=2025", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:07.707Z" } }, "/v1/futures/data/{root_symbol}": { "get": { "summary": "Contract data", "operationId": "cbfin_get_futures_data_root_symbol", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_futures_data_root_symbolResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.futures_quotes.api.cboe.com.us.futures.api.data.27", "route": "futures_data_root_symbol", "family": "futures_quotes", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:08.960Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 386, "content_type": "application/json" }, "data": { "data": [ { "symbol_id": "000nih", "symbol": "VX23/M6", "expiration": "06/10/2026", "open": 0, "last_price": 0, "high": 13.75, "low": 0, "prev_close": 0, "settlement": 19.1698, "prev_settlement": 16.997, "change": 2.1728, "volume": 0, "prev_open_int": 0, "current_open_int": 0, "current_volume": 0, "root_symbol": false }, { "symbol_id": "000jyc", "symbol": "VX/M6", "expiration": "06/17/2026", "open": 17.1, "last_price": 19.65, "high": 19.75, "low": 17, "prev_close": 17.11, "settlement": 19.1698, "prev_settlement": 16.997, "change": 2.1728, "volume": 202659, "prev_open_int": 154967, "current_open_int": 143326, "current_volume": 183637, "root_symbol": false }, { "symbol_id": "000oHA", "symbol": "VX25/M6", "expiration": "06/24/2026", "open": 0, "last_price": 0, "high": 12.75, "low": 0, "prev_close": 0, "settlement": 19.1698, "prev_settlement": 16.997, "change": 2.1728, "volume": 0, "prev_open_int": 0, "current_open_int": 0, "current_volume": 0, "root_symbol": false } ], "lastUpdate": "2026-06-06T20:32:08.910805-05:00" } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns contract data with contract, root, settlement, or market fields from the upstream data shape.", "tags": [ "Futures" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "root_symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter `root_symbol`." }, { "name": "symbol", "in": "query", "required": false, "schema": { "type": "string" }, "example": "VX", "description": "Query parameter `symbol`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/futures/data/VX?symbol=VX", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:09.225Z" } }, "/v1/futures/quotes/combined": { "get": { "summary": "Combined quotes", "operationId": "cbfin_get_futures_quotes_combined", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_futures_quotes_combinedResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.futures_quotes.www.cboe.com.us.futures.api.get.quotes.combined.25", "route": "futures_quotes_combined", "family": "futures_quotes", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:10.754Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 393, "content_type": "application/json" }, "data": { "data": [ { "symbol": "IBHY", "expiration": "-", "open": "", "close": "", "high": 181.24, "low": 181.24, "last_price": 181.91, "prev_open_int": "", "current_open_int": "", "current_volume": "", "settlement": "-", "prev_settlement": "", "change": -0.67, "volume": "-", "root_symbol": true }, { "symbol_id": "000lbg", "symbol": "IBHY/U6", "expiration": "09/01/2026", "open": 183.21, "last_price": 182.65, "high": 183.54, "low": 182.43, "prev_close": 183.47, "settlement": 182.585, "prev_settlement": 183.445, "change": -0.86, "volume": 451, "prev_open_int": 6670, "current_open_int": 6701, "current_volume": 451, "root_symbol": false }, { "symbol_id": "000nCH", "symbol": "IBHY/Z6", "expiration": "12/01/2026", "open": 184.75, "last_price": 183.95, "high": 184.84, "low": 183.72, "prev_close": 184.74, "settlement": 183.9, "prev_settlement": 184.725, "change": -0.825, "volume": 89, "prev_open_int": 309, "current_open_int": 327, "current_volume": 89, "root_symbol": false } ], "lastUpdate": "2026-06-06T20:32:10.704465-05:00" } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns combined quotes with contract, root, settlement, or market fields from the upstream data shape.", "tags": [ "Futures" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "future_symbol", "in": "query", "required": false, "schema": { "type": "string" }, "example": "IBHY", "description": "Query parameter `future_symbol`." }, { "name": "root_symbol", "in": "query", "required": false, "schema": { "type": "string" }, "example": "IBHY", "description": "Query parameter `root_symbol`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/futures/quotes/combined?future_symbol=IBHY&root_symbol=IBHY", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:10.997Z" } }, "/v1/futures/settlement/daily.csv": { "get": { "summary": "Daily settlement CSV", "operationId": "cbfin_get_futures_settlement_daily_csv", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_futures_settlement_daily_csvResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.futures_settlement_download.api.cboe.com.us.futures.market.statistics.settlement.56", "route": "futures_settlement_daily_csv", "family": "futures_settlement_download", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:12.472Z", "freshness": { "ttl_seconds": 30, "stale_seconds": 360 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 617, "content_type": "text/csv" }, "data": "Product,Symbol,Expiration Date,Price\r\nVX,VX18/K6,2026-05-06,19.9531\r\nVX,VX19/K6,2026-05-13,19.9531\r\nVX,VX/K6,2026-05-19,19.9531\r\nVX,VX21/K6,2026-05-27,19.9531\r\nVX,VX22/M6,2026-06-02,19.9531\r\nVX,VX23/M6,2026-06-10,19.9531\r\nVX,VX/M6,2026-06-17,21.045\r\nVX,VX/N6,2026-07-22,21.8578\r\nVX,VX/Q6,2026-08-19,22.125\r\nVX,VX/U6,2026..." } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns daily settlement CSV with contract, root, settlement, or market fields from the upstream data shape.", "tags": [ "Futures" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "date", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2026-05-04", "description": "Query parameter `date`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/futures/settlement/daily.csv?date=2026-05-04", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:12.709Z" } }, "/v1/futures/settlement/final-prices": { "get": { "summary": "Final prices", "operationId": "cbfin_get_futures_settlement_final_prices", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_futures_settlement_final_pricesResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.futures_settlement.api.cboe.com.us.futures.market.statistics.final.settlement.prices.values.futures.50", "route": "futures_settlement_final_prices", "family": "futures_settlement", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:18.662Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 5011, "content_type": "application/json" }, "data": { "selectedYear": 2025, "yearList": [ 2013, 2014, 2015 ], "data": [ { "product": "FBT - Financially Settled Bitcoin (FBT) Futures", "weekly_settlement_prices": [], "monthly_settlement_prices": [ { "symbol_name": "FBT/Z5", "expire_date": "2025-12-26", "price": 86950, "delta": "0.00", "exercise_price": null, "settlement_var": null, "calculation_method": "F" }, { "symbol_name": "FBT/X5", "expire_date": "2025-11-28", "price": 92505, "delta": "0.00", "exercise_price": null, "settlement_var": null, "calculation_method": "F" }, { "symbol_name": "FBT/V5", "expire_date": "2025-10-31", "price": 110082, "delta": "0.00", "exercise_price": null, "settlement_var": null, "calculation_method": "F" } ], "option_settlement_prices": [] }, { "product": "FET - Financially Settled Ethereum (FET) Futures", "weekly_settlement_prices": [], "monthly_settlement_prices": [ { "symbol_name": "FET/Z5", "expire_date": "2025-12-26", "price": 2915.5, "delta": "0.00", "exercise_price": null, "settlement_var": null, "calculation_method": "F" }, { "symbol_name": "FET/X5", "expire_date": "2025-11-28", "price": 3075.2, "delta": "0.00", "exercise_price": null, "settlement_var": null, "calculation_method": "F" }, { "symbol_name": "FET/V5", "expire_date": "2025-10-31", "price": 3853.9, "delta": "0.00", "exercise_price": null, "settlement_var": null, "calculation_method": "F" } ], "option_settlement_prices": [] }, { "product": "IBHY - Cboe High Yield Corporate Bond Index (IBHY) Futures", "weekly_settlement_prices": [], "monthly_settlement_prices": [ { "symbol_name": "IBHY/Z5", "expire_date": "2025-12-01", "price": 177.76, "delta": "0.00", "exercise_price": null, "settlement_var": null, "calculation_method": "O" }, { "symbol_name": "IBHY/U5", "expire_date": "2025-09-02", "price": 175.07, "delta": "0.00", "exercise_price": null, "settlement_var": null, "calculation_method": "O" }, { "symbol_name": "IBHY/M5", "expire_date": "2025-06-02", "price": 169.68, "delta": "0.00", "exercise_price": null, "settlement_var": null, "calculation_method": "O" } ], "option_settlement_prices": [] } ] } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns final prices with contract, root, settlement, or market fields from the upstream data shape.", "tags": [ "Futures" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "year", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "2025", "description": "Query parameter `year`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/futures/settlement/final-prices?year=2025", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:18.936Z" } }, "/v1/futures/settlement/final-prices.csv": { "get": { "summary": "Final prices CSV", "operationId": "cbfin_get_futures_settlement_final_prices_csv", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_futures_settlement_final_prices_csvResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.futures_settlement_download.api.cboe.com.us.futures.market.statistics.final.settlement.prices.55", "route": "futures_settlement_final_prices_csv", "family": "futures_settlement_download", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:24.944Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 5146, "content_type": "text/csv" }, "data": "Product,Symbol,Duration Type,Expiration Date,Price\r\nVX,VX/K6,Monthly,2026-05-19,17.81\r\nVX,VX/J6,Monthly,2026-04-15,17.38\r\nVX,VX/H6,Monthly,2026-03-18,22.89\r\nVX,VX/G6,Monthly,2026-02-18,19.69\r\nVX,VX/F6,Monthly,2026-01-21,18.82\r\nVX,VX/Z5,Monthly,2025-12-17,16.01\r\nVX,VX/X5,Monthly,2025-11-19,23.90\r\nVX,VX/V5,Monthly,2025-1..." } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns final prices CSV with contract, root, settlement, or market fields from the upstream data shape.", "tags": [ "Futures" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "year", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "2025", "description": "Query parameter `year`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/futures/settlement/final-prices.csv?year=2025", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:25.202Z" } }, "/v1/index-settlement/years/{settlement_type}": { "get": { "summary": "Years", "operationId": "cbfin_get_index_settlement_years_settlement_type", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_index_settlement_years_settlement_typeResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.index_settlement.www.cboe.com.index.settlement.values.getyears.settlement.type.48", "route": "index_settlement_years_settlement_type", "family": "index_settlement", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:26.385Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 327, "content_type": "application/json" }, "data": { "data": [ 2026, 2025, 2024 ] } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns years with source-native fields and identifiers.", "tags": [ "Index Settlement" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "settlement_type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter `settlement_type`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/index-settlement/years/S", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:26.654Z" } }, "/v1/indices/europe/definitions": { "get": { "summary": "Europe definitions", "operationId": "cbfin_get_indices_europe_definitions", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_indices_europe_definitionsResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.index_definitions.cdn.cboe.com.api.global.european.indices.definitions.all.definitions.09", "route": "indices_europe_definitions", "family": "index_definitions", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:28.228Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 652, "content_type": "application/json" }, "data": { "timestamp": "16:30:04", "data": [ { "timestamp": "16:30:04", "index": { "symbol": "BAT20P", "short_name": "Cboe Austria 20", "long_name": "Cboe Austria 20", "currency": "EUR", "isin": "DE000SLA22E0", "region": "Austria" }, "constituents": [ { "index_symbol": "BAT20P", "constituent_symbol": "ANDRv" }, { "index_symbol": "BAT20P", "constituent_symbol": "ATSv" }, { "index_symbol": "BAT20P", "constituent_symbol": "BGv" } ] }, { "timestamp": "16:30:04", "index": { "symbol": "BBE20P", "short_name": "Cboe Belgium 20", "long_name": "Cboe Belgium 20", "currency": "EUR", "isin": "DE000SLA22G5", "region": "Belgium" }, "constituents": [ { "index_symbol": "BBE20P", "constituent_symbol": "ABIb" }, { "index_symbol": "BBE20P", "constituent_symbol": "ACKBb" }, { "index_symbol": "BBE20P", "constituent_symbol": "AEDb" } ] }, { "timestamp": "16:30:04", "index": { "symbol": "BCH20P", "short_name": "Cboe Switzerland 20", "long_name": "Cboe Switzerland 20", "currency": "CHF", "isin": "DE000SLA2QD9", "region": "Switzerland" }, "constituents": [ { "index_symbol": "BCH20P", "constituent_symbol": "ABBNz" }, { "index_symbol": "BCH20P", "constituent_symbol": "ALCz" }, { "index_symbol": "BCH20P", "constituent_symbol": "AMRZz" } ] } ] } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns europe definitions with index, constituent, weight, or comparison fields from the upstream data shape.", "tags": [ "Indices" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/indices/europe/definitions", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:28.774Z" } }, "/v1/indices/europe/quotes": { "get": { "summary": "Europe quotes", "operationId": "cbfin_get_indices_europe_quotes", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_indices_europe_quotesResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.index_quotes.cdn.cboe.com.api.global.european.indices.index.quotes.all.indices.10", "route": "indices_europe_quotes", "family": "index_quotes", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:30.174Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 390, "content_type": "application/json" }, "data": { "timestamp": "16:59:56", "data": [ { "high": 21428.6562, "exchange_id": 115, "current_price": 21153.7922, "close": 21153.7922, "iv30_change_percent": 0, "prev_day_close": 21218.3521, "open": 0, "security_type": "index", "low": 21153.2996, "ask_size": 0, "symbol": "^BAT20P-SL", "index": "BAT20P", "bid_size": 0, "iv30_change": 0, "iv30": 0, "seqno": 153001, "bid": 0, "volume": 0, "ask": 0, "tick": "", "price_change_percent": -0.3043, "price_change": -64.5599, "last_trade_time": "2026-06-05T15:30:01.155000+00:00", "status": "C" }, { "high": 24615.732, "exchange_id": 115, "current_price": 24605.1085, "close": 24605.1085, "iv30_change_percent": 0, "prev_day_close": 24315.3833, "open": 0, "security_type": "index", "low": 24248.7862, "ask_size": 0, "symbol": "^BBE20P-SL", "index": "BBE20P", "bid_size": 0, "iv30_change": 0, "iv30": 0, "seqno": 153003, "bid": 0, "volume": 0, "ask": 0, "tick": "", "price_change_percent": 1.1915, "price_change": 289.7252, "last_trade_time": "2026-06-05T15:30:03.349000+00:00", "status": "C" }, { "high": 1439.6113, "exchange_id": 115, "current_price": 1434.187, "close": 1434.187, "iv30_change_percent": 0, "prev_day_close": 1432.0811, "open": 0, "security_type": "index", "low": 1426.8768, "ask_size": 0, "symbol": "^BCH20P-SL", "index": "BCH20P", "bid_size": 0, "iv30_change": 0, "iv30": 0, "seqno": 153003, "bid": 0, "volume": 0, "ask": 0, "tick": "", "price_change_percent": 0.1471, "price_change": 2.1059, "last_trade_time": "2026-06-05T15:30:03.349000+00:00", "status": "C" } ] } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns europe quotes with index, constituent, weight, or comparison fields from the upstream data shape.", "tags": [ "Indices" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/indices/europe/quotes", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:30.511Z" } }, "/v1/indices/us/definitions": { "get": { "summary": "US definitions", "operationId": "cbfin_get_indices_us_definitions", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_indices_us_definitionsResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.index_definitions.cdn.cboe.com.api.global.us.indices.definitions.all.indices.08", "route": "indices_us_definitions", "family": "index_definitions", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:31.566Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 133, "content_type": "application/json" }, "data": [ { "calc_end_time": "15:00:00", "calc_start_time": "15:00:00", "currency": "USD", "description": "Cboe 100 Aave / US Dollar RealPrice Index", "display": true, "display_override_auto_hide": false, "featured": false, "featured_order": 0, "index_family": null, "index_family_relationship": null, "index_launch_date": null, "index_symbol": "AAVE100", "mkt_data_delay": 15, "name": "Cboe 100 Aave / US Dollar RealPrice Index", "show_intraday_chart": true, "source": "index_definition", "tick_days": "EveryDay", "tick_frequency": "U", "tick_interval_seconds": null, "tick_period": "Regular", "time_zone": "America/Chicago" }, { "calc_end_time": "15:00:00", "calc_start_time": "15:00:00", "currency": "USD", "description": "Cboe 10 Aave / US Dollar RealPrice Index", "display": true, "display_override_auto_hide": false, "featured": false, "featured_order": 0, "index_family": null, "index_family_relationship": null, "index_launch_date": null, "index_symbol": "AAVE10RP", "mkt_data_delay": 15, "name": "Cboe 10 Aave / US Dollar RealPrice Index", "show_intraday_chart": true, "source": "index_definition", "tick_days": "EveryDay", "tick_frequency": "U", "tick_interval_seconds": null, "tick_period": "Regular", "time_zone": "America/Chicago" }, { "calc_end_time": "15:00:00", "calc_start_time": "15:00:00", "currency": "USD", "description": "Cboe 25 Aave / US Dollar RealPrice Index", "display": true, "display_override_auto_hide": false, "featured": false, "featured_order": 0, "index_family": null, "index_family_relationship": null, "index_launch_date": null, "index_symbol": "AAVE25RP", "mkt_data_delay": 15, "name": "Cboe 25 Aave / US Dollar RealPrice Index", "show_intraday_chart": true, "source": "index_definition", "tick_days": "EveryDay", "tick_frequency": "U", "tick_interval_seconds": null, "tick_period": "Regular", "time_zone": "America/Chicago" } ] } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns US definitions with index, constituent, weight, or comparison fields from the upstream data shape.", "tags": [ "Indices" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/indices/us/definitions", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:32.264Z" } }, "/v1/delayed-quotes/charts/historical/{symbol}": { "get": { "summary": "Historical chart", "operationId": "cbfin_get_delayed_quotes_charts_historical_symbol", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_delayed_quotes_charts_historical_symbolResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.delayed_quotes_chart.cdn.cboe.com.api.global.delayed.quotes.charts.historical.symbol.15", "route": "delayed_quotes_charts_historical_symbol", "family": "delayed_quotes_chart", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:33.512Z", "freshness": { "ttl_seconds": 15, "stale_seconds": 315 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 317, "content_type": "application/json" }, "data": { "timestamp": "11:00:26", "data": [ { "date": "2004-01-02", "volume": 2024993600, "open": 0.39, "high": 0.39, "low": 0.38, "close": 0.38 }, { "date": "2004-01-05", "volume": 5530257600, "open": 0.38, "high": 0.4, "low": 0.38, "close": 0.4 }, { "date": "2004-01-06", "volume": 7130872000, "open": 0.4, "high": 0.4, "low": 0.39, "close": 0.4 } ], "symbol": "AAPL" } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns historical chart with source-native fields and identifiers.", "tags": [ "Delayed Quotes" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter `symbol`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/delayed-quotes/charts/historical/AAPL", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:34.172Z" } }, "/v1/delayed-quotes/charts/intraday/{symbol}": { "get": { "summary": "Intraday chart", "operationId": "cbfin_get_delayed_quotes_charts_intraday_symbol", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_delayed_quotes_charts_intraday_symbolResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.delayed_quotes_chart.cdn.cboe.com.api.global.delayed.quotes.charts.intraday.symbol.13", "route": "delayed_quotes_charts_intraday_symbol", "family": "delayed_quotes_chart", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:35.614Z", "freshness": { "ttl_seconds": 15, "stale_seconds": 315 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 310, "content_type": "application/json" }, "data": { "timestamp": "2026-06-05 21:33:24", "data": [ { "datetime": "2026-06-05T09:31:00", "sequence_number": 222281843, "price": { "open": 312.86, "high": 313.63, "low": 312.65, "close": 312.8 }, "volume": { "stock_volume": 747549, "calls_volume": 17114, "puts_volume": 7158, "total_options_volume": 24272 } }, { "datetime": "2026-06-05T09:32:00", "sequence_number": 222372967, "price": { "open": 312.815, "high": 314.08, "low": 312.4, "close": 313.96 }, "volume": { "stock_volume": 350670, "calls_volume": 20008, "puts_volume": 3974, "total_options_volume": 23982 } }, { "datetime": "2026-06-05T09:33:00", "sequence_number": 222464118, "price": { "open": 313.92, "high": 314.1773, "low": 313.68, "close": 314.09 }, "volume": { "stock_volume": 261473, "calls_volume": 24366, "puts_volume": 2995, "total_options_volume": 27361 } } ], "symbol": "AAPL" } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns intraday chart with source-native fields and identifiers.", "tags": [ "Delayed Quotes" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter `symbol`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/delayed-quotes/charts/intraday/AAPL", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:35.980Z" } }, "/v1/delayed-quotes/charts/one-month/{symbol}": { "get": { "summary": "One-month chart", "operationId": "cbfin_get_delayed_quotes_charts_one_month_symbol", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_delayed_quotes_charts_one_month_symbolResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.delayed_quotes_chart.cdn.cboe.com.api.global.delayed.quotes.charts.one.month.symbol.14", "route": "delayed_quotes_charts_one_month_symbol", "family": "delayed_quotes_chart", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:37.185Z", "freshness": { "ttl_seconds": 15, "stale_seconds": 315 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 274, "content_type": "application/json" }, "data": { "timestamp": "2026-06-05 20:15:05", "data": [ { "datetime": "2026-05-06T09:40:00", "sequence_number": 0, "price": { "open": 281.91, "high": 283.15, "low": 281.07, "close": 282.95 }, "volume": { "stock_volume": 2806882, "calls_volume": 52197, "puts_volume": 14469, "total_options_volume": 66666 } }, { "datetime": "2026-05-06T09:50:00", "sequence_number": 0, "price": { "open": 282.992, "high": 284.63, "low": 282.24, "close": 284.52 }, "volume": { "stock_volume": 1579559, "calls_volume": 52843, "puts_volume": 16092, "total_options_volume": 68935 } }, { "datetime": "2026-05-06T10:00:00", "sequence_number": 0, "price": { "open": 284.53, "high": 286.249, "low": 283.83, "close": 286.14 }, "volume": { "stock_volume": 2026788, "calls_volume": 119269, "puts_volume": 24202, "total_options_volume": 143471 } } ], "symbol": "AAPL" } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns one-month chart with source-native fields and identifiers.", "tags": [ "Delayed Quotes" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter `symbol`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/delayed-quotes/charts/one-month/AAPL", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:37.582Z" } }, "/v1/equities/au/book-viewer/symbols": { "get": { "summary": "Australia book symbols", "operationId": "cbfin_get_equities_au_book_viewer_symbols", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_equities_au_book_viewer_symbolsResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.book_viewer.ww2.cboe.com.au.equities.market.statistics.book.viewer.2.symbol.lookup.data.44", "route": "equities_au_book_viewer_symbols", "family": "book_viewer", "cache": "kv", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:38.505Z", "freshness": { "ttl_seconds": 600, "stale_seconds": 7200 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 406, "content_type": "application/json" }, "data": { "symbolsLookupData": [ { "name": "10X", "company_name": "EXULTANT FPO [10X]" }, { "name": "14D", "company_name": "1414DEGREE FPO [14D]" }, { "name": "1AD", "company_name": "ADALTA FPO [1AD]" } ] } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns australia book symbols with source-native fields and identifiers.", "tags": [ "Equities" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "market_code", "in": "query", "required": false, "schema": { "type": "string" }, "example": "cxa", "description": "Query parameter `market_code`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/equities/au/book-viewer/symbols?market_code=cxa", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:38.526Z" } }, "/v1/equities/europe/market-share/range": { "get": { "summary": "Europe market share range", "operationId": "cbfin_get_equities_europe_market_share_range", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_equities_europe_market_share_rangeResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.europe_market_share.www.cboe.com.europe.equities.market.share.market.venue.data.46", "route": "equities_europe_market_share_range", "family": "europe_market_share", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:39.448Z", "freshness": { "ttl_seconds": 30, "stale_seconds": 360 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 54, "content_type": "text/plain; charset=utf-8" }, "data": "daterange,market,venue,category,subcategory,subvenue,notional,trade_count,volume\n2026-05-05,amsterdam,cboe-europe,displayed,displayed-,cboe-europe-bxe-book,1954260.30367521,200.0,127720.0\n2026-05-05,amsterdam,cboe-europe,non-displayed,non-displayed-,cboe-europe-bxe-book,3187638.82,487.0,77296.0\n2026-05-05,amsterdam,cbo..." } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns europe market share range with source-native fields and identifiers.", "tags": [ "Equities" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2026-05-05", "description": "Query parameter `start_date`." }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2026-05-05", "description": "Query parameter `end_date`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/equities/europe/market-share/range?start_date=2026-05-05&end_date=2026-05-05", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:39.745Z" } }, "/v1/equities/europe/market-share/trailing": { "get": { "summary": "Europe trailing market share", "operationId": "cbfin_get_equities_europe_market_share_trailing", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_equities_europe_market_share_trailingResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.europe_market_share.www.cboe.com.europe.equities.market.share.market.venue.data.47", "route": "equities_europe_market_share_trailing", "family": "europe_market_share", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:40.661Z", "freshness": { "ttl_seconds": 30, "stale_seconds": 360 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 52, "content_type": "text/plain; charset=utf-8" }, "data": "daterange,market,venue,category,subcategory,subvenue,notional,trade_count,volume\nall,amsterdam,cboe-europe,displayed,displayed-,cboe-europe-bxe-book,1181390.7660975,123.4,93695.6\nall,amsterdam,cboe-europe,non-displayed,non-displayed-,cboe-europe-bxe-book,2503602.338,384.4,67095.8\nall,amsterdam,cboe-europe,auctions,auct..." } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns europe trailing market share with source-native fields and identifiers.", "tags": [ "Equities" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2026-05-05", "description": "Query parameter `end_date`." }, { "name": "trading_day_count", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "5", "description": "Query parameter `trading_day_count`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/equities/europe/market-share/trailing?end_date=2026-05-05&trading_day_count=5", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:41.051Z" } }, "/v1/futures/data/www/{root_symbol}": { "get": { "summary": "Web contract data", "operationId": "cbfin_get_futures_data_www_root_symbol", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_futures_data_www_root_symbolResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.futures_quotes.www.cboe.com.us.futures.api.data.26", "route": "futures_data_www_root_symbol", "family": "futures_quotes", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:42.274Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 379, "content_type": "application/json" }, "data": { "data": [ { "symbol_id": "000nih", "symbol": "VX23/M6", "expiration": "06/10/2026", "open": 0, "last_price": 0, "high": 13.75, "low": 0, "prev_close": 0, "settlement": 19.1698, "prev_settlement": 16.997, "change": 2.1728, "volume": 0, "prev_open_int": 0, "current_open_int": 0, "current_volume": 0, "root_symbol": false }, { "symbol_id": "000jyc", "symbol": "VX/M6", "expiration": "06/17/2026", "open": 17.1, "last_price": 19.65, "high": 19.75, "low": 17, "prev_close": 17.11, "settlement": 19.1698, "prev_settlement": 16.997, "change": 2.1728, "volume": 202659, "prev_open_int": 154967, "current_open_int": 143326, "current_volume": 183637, "root_symbol": false }, { "symbol_id": "000oHA", "symbol": "VX25/M6", "expiration": "06/24/2026", "open": 0, "last_price": 0, "high": 12.75, "low": 0, "prev_close": 0, "settlement": 19.1698, "prev_settlement": 16.997, "change": 2.1728, "volume": 0, "prev_open_int": 0, "current_open_int": 0, "current_volume": 0, "root_symbol": false } ], "lastUpdate": "2026-06-06T20:32:42.223219-05:00" } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns web contract data with contract, root, settlement, or market fields from the upstream data shape.", "tags": [ "Futures" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "root_symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter `root_symbol`." }, { "name": "symbol", "in": "query", "required": false, "schema": { "type": "string" }, "example": "VX", "description": "Query parameter `symbol`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/futures/data/www/VX?symbol=VX", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:42.490Z" } }, "/v1/index-settlement/values/{settlement_type}/{year}": { "get": { "summary": "Values", "operationId": "cbfin_get_index_settlement_values_settlement_type_year", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_index_settlement_values_settlement_type_yearResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.index_settlement.www.cboe.com.index.settlement.values.get.sv.data.settlement.type.year.49", "route": "index_settlement_values_settlement_type_year", "family": "index_settlement", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:43.685Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 317, "content_type": "application/json" }, "data": { "data": [ { "description": "VIX Options (VRO)", "trading_symbol": "VIX", "expiration_date": "2026-05-19", "settlement_symbol": "VRO", "settlement_value": 17.81, "display_order": 53 }, { "description": "Cboe Bitcoin U.S. ETF Index AM", "trading_symbol": "CBTX", "expiration_date": "2026-05-15", "settlement_symbol": "CBTXS", "settlement_value": 1887.19, "display_order": 6 }, { "description": "Cboe Mini Bitcoin U.S. ETF Index AM", "trading_symbol": "MBTX", "expiration_date": "2026-05-15", "settlement_symbol": "MBTXS", "settlement_value": 188.72, "display_order": 11 } ] } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns values with source-native fields and identifiers.", "tags": [ "Index Settlement" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "settlement_type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter `settlement_type`." }, { "name": "year", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter `year`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/index-settlement/values/S/2026", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:43.947Z" } }, "/v1/indices/us/governance/consultations": { "get": { "summary": "US consultations", "operationId": "cbfin_get_indices_us_governance_consultations", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_indices_us_governance_consultationsResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.index_governance.cdn.cboe.com.api.global.us.indices.governance.data.us.consultation.11", "route": "indices_us_governance_consultations", "family": "index_governance", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:45.336Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 521, "content_type": "application/json" }, "data": { "us_consultation": [ { "name": "Consultation Regarding the Cessation of the Cboe 20 Year Treasury Bond ETF Volatility Basis Point Index (VIXTLT)", "description": "Consultation Regarding the Cessation of the Cboe 20 Year Treasury Bond ETF Volatility Basis Point Index (VIXTLT)", "active": true, "status": 1, "link": "https://cdn.cboe.com/api/global/us_indices/governance/Consultation_Regarding_the_Cessation_of_the_Cboe_20_Year_Treasury_Bond_ETF_Volatility_Basis_Point_Index_VIXTLT.pdf", "linkResult": " ", "linkResultTitle": " ", "startDate": "06/02/2026", "endDate": "06/26/2026", "questionIDs": "", "id": "C2026060200" }, { "name": "Update on Consultation Regarding Methodology Changes for the Cboe Fixed Income ETF BuyWrite Indices", "description": "Update on Consultation Regarding Methodology Changes for the Cboe Fixed Income ETF BuyWrite Indices", "active": true, "status": 2, "link": "https://cdn.cboe.com/api/global/us_indices/governance/Updated-Consultation-Regarding-Methodology-Changes-for-the-Cboe-Fixed-Income-ETF-BuyWrite-Indices.pdf", "linkResult": " ", "linkResultTitle": " ", "startDate": "10/23/2025", "endDate": "11/14/2025", "questionIDs": "", "id": "C2025102300" }, { "name": "Consultation Results Regarding Potential Changes to the Eligibility Criteria for Cboe Europe Indices", "description": "Consultation Results Regarding Potential Changes to the Eligibility Criteria for Cboe Europe Indices", "active": true, "status": 2, "link": "https://cdn.cboe.com/api/global/us_indices/governance/Consultation-Results-Regarding-Potential-Changes-to-the-Eligibility-Criteria-for-Cboe-Europe-Indices.pdf", "linkResult": " ", "linkResultTitle": " ", "startDate": "08/18/2025", "endDate": "08/11/2025", "questionIDs": "", "id": "C2025081800" } ] } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns US consultations with index, constituent, weight, or comparison fields from the upstream data shape.", "tags": [ "Indices" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/indices/us/governance/consultations", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:45.747Z" } }, "/v1/notices/au/system/{year}": { "get": { "summary": "Australia system notices", "operationId": "cbfin_get_notices_au_system_year", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_notices_au_system_yearResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.notices.www.cboe.com.au.equities.notices.data.system.year.57", "route": "notices_au_system_year", "family": "notices", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:48.191Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 1582, "content_type": "application/json" }, "data": { "ttl": 205332106.675, "alerts": [], "display_name": "System Status", "year_list": [ 2022, 2023, 2024 ], "success": true, "statusText": "success", "statusCode": "200", "status": "200: success", "alerts_count": 0, "year_list_count": 5 } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns australia system notices with source-native fields and identifiers.", "tags": [ "Notices" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "year", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter `year`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/notices/au/system/2026", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:48.411Z" } }, "/v1/notices/ca/system/{year}": { "get": { "summary": "Canada system notices", "operationId": "cbfin_get_notices_ca_system_year", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_notices_ca_system_yearResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.notices.www.cboe.com.ca.equities.notices.data.system.year.58", "route": "notices_ca_system_year", "family": "notices", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:49.712Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 429, "content_type": "application/json" }, "data": { "ttl": 120430702.705, "alerts": [ { "subject": "Cboe Canada System Status Update - Order Handler Failover Complete", "message_ts": "February 03, 2026 09:55:58", "message": "

Please be advised that Cboe Canada completed the failover of the failed order handler in the NEO Environment at 8:54:26 ET. All customers that experienced a disconnect due to this issue may now reconnect to their FIX/BOE ports.

\n\n

Cboe Canada Trade Desk
Phone: 416.933.5950
E-Mail: tradedeskca@cboe.com
...", "type": "mstatus", "id": 168, "message_rss_ts": "Tue, 03 Feb 2026 09:55:58 -0500" }, { "subject": "Cboe Canada System Status Update - OH Failover", "message_ts": "February 03, 2026 09:54:35", "message": "

Please be advised that the Cboe Canada has experienced a hardware failure in the NEO environment on a FIX/BOE order handler host that impacted a subset of FIX/BOE connections. The order handler is being failed over to a backup server. Customers on the impacted host should be able to reconnect momentarily with no cha...", "type": "mstatus", "id": 167, "message_rss_ts": "Tue, 03 Feb 2026 09:54:35 -0500" }, { "subject": "Cboe Canada has revoked self-help against Nasdaq CXC (CHIX)", "message_ts": "January 30, 2026 07:53:04", "message": "

Cboe Canada has revoked self-help against Nasdaq CXC (CHIX). Nasdaq CXC (CHIX) has been reinstated to Cboe Canada's NBBO calculation.

\n\n

All Cboe systems are currently operating normally.

\n\n

You can view Cboe Canada status online at https://www.cboe.com/ca/equities/notices/system/

\n\n

Cboe Canada Trad...", "type": "mstatus", "id": 166, "message_rss_ts": "Fri, 30 Jan 2026 07:53:04 -0500" } ], "display_name": "System Status", "year_list": [ 2021, 2022, 2023 ], "success": true, "statusText": "success", "statusCode": "200", "status": "200: success", "alerts_count": 8, "year_list_count": 6 } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns canada system notices with source-native fields and identifiers.", "tags": [ "Notices" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "year", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter `year`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/notices/ca/system/2026", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:49.945Z" } }, "/v1/notices/europe/trf-system/{year}": { "get": { "summary": "Europe TRF system notices", "operationId": "cbfin_get_notices_europe_trf_system_year", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cbfin_get_notices_europe_trf_system_yearResponse" }, "examples": { "live": { "summary": "Live response", "value": { "meta": { "provider": "cboe", "endpoint": "cboe.notices.www.cboe.com.europe.equities.notices.data.trf.system.year.59", "route": "notices_europe_trf_system_year", "family": "notices", "cache": "miss", "identity_tier": "contact", "generated_at": "2026-06-07T01:32:51.639Z", "freshness": { "ttl_seconds": 5, "stale_seconds": 305 }, "status": "ok", "upstream_status": 200, "upstream_elapsed_ms": 773, "content_type": "application/json" }, "data": { "ttl": 123428976.794, "alerts": [ { "subject": "Cboe Europe Symbol Reference Data File Change", "message_ts": "April 15, 2026 07:29:49", "message": "

Dear Cboe Europe Equities Participants,

\n\n

Please be advised that a change has been made to DXE, TRF, SIS symbol reference data files after 07:00 UK time.

\n\n

Participants are advised to download the updated Symbol Reference files.

\n\n

The updated Symbol Reference Data Files are available on our website...", "type": "tstatus", "id": 218493, "message_rss_ts": "Wed, 15 Apr 2026 07:29:49 +0100" }, { "subject": " Cboe Europe LD4 Equinix Chiller Issue: Update", "message_ts": "April 09, 2026 06:46:36", "message": "

Dear Cboe Europe Participants,

\n\n

Further to the previous notice, please be advised that all Cboe Europe systems continue to operate normally. Cboe Europe plans to open at normal times on 9 April 2026: the Cboe UK & NL APA at 07:15 UK time, and the BXE, CXE, DXE, and BIDS LIS markets at 08:00 UK time.

\n\n

C...", "type": "tstatus", "id": 218456, "message_rss_ts": "Thu, 09 Apr 2026 06:46:36 +0100" }, { "subject": " Cboe Europe LD4 Equinix Chiller Issue", "message_ts": "April 08, 2026 22:03:29", "message": "

Dear Cboe Europe Participants, 

\n\n

Please be advised Cboe Europe has received an update from Equinix regarding an ongoing chiller issue in the LD4 data centre.

\n\n

At this time, all Cboe Europe systems are functioning normally, and no issues are anticipated for Cboe UK/NL APA TRF & SI  (07:15 UK t...", "type": "tstatus", "id": 218453, "message_rss_ts": "Wed, 08 Apr 2026 22:03:29 +0100" } ], "display_name": "TRF System Status", "year_list": [ 2013, 2014, 2015 ], "success": true, "statusText": "success", "statusCode": "200", "status": "200: success", "alerts_count": 5, "year_list_count": 14 } } } } } } }, "400": { "description": "Bad request. A required parameter is missing, malformed, or outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 400 error", "value": { "ok": false, "error": { "code": "bad_request", "message": "Required query parameter is missing or invalid." } } } } } } }, "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": { "description": "Not found. The requested route, resource, or symbol could not be resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 404 error", "value": { "ok": false, "error": { "code": "not_found", "message": "The requested resource was not found." } } } } } } }, "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": { "description": "Upstream source error. The source service rejected or failed the upstream request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "examples": { "default": { "summary": "HTTP 502 error", "value": { "ok": false, "error": { "code": "upstream_error", "message": "The upstream source returned an error." } } } } } } }, "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." } } } } } } } }, "description": "Returns europe TRF system notices with source-native fields and identifiers.", "tags": [ "Notices" ], "x-source-api": "cbfin", "x-source-name": "Cboe", "x-source-upstream": "cboe.com", "parameters": [ { "name": "year", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Path parameter `year`." }, { "name": "x-cbfin-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." } ], "x-docs-example-url": "https://api.cbfin.bluedoor.sh/v1/notices/europe/trf-system/2026", "x-docs-example-status": 200, "x-docs-captured-at": "2026-06-07T01:32:51.890Z" } } }, "components": { "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 } } }, "cbfin_get_market_data_servicesResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "vendorData": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string" }, "provider_type": { "type": "array", "items": { "type": "string" } }, "geographic_region": { "type": "array", "items": { "type": "string" } }, "url": { "oneOf": [ { "type": "string" }, { "nullable": true } ] }, "contact": { "type": "array", "items": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "nullable": true } ] } } }, "has_html_description": { "type": "boolean" }, "description": { "type": "string" }, "logo": { "type": "string" }, "twitter": { "oneOf": [ { "nullable": true }, { "type": "string" } ] }, "slug_name": { "type": "string" }, "filters": { "type": "array", "items": { "type": "string" } }, "logo_url": { "type": "string" } }, "required": [ "contact", "description", "filters", "geographic_region", "has_html_description", "logo", "logo_url", "name", "provider_type", "slug_name", "twitter", "url" ] } }, "marketTotals": { "type": "object", "additionalProperties": true, "properties": { "fx": { "type": "number" }, "usOptions": { "type": "number" } }, "required": [ "fx", "usOptions" ] }, "marketShare": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "venue": { "type": "string" }, "total": { "type": "number" } }, "required": [ "total", "venue" ] } }, "vix": { "type": "array", "items": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" } ] } } } }, "required": [ "marketShare", "marketTotals", "vendorData", "vix" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_tradable_productsResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "data": { "type": "object", "additionalProperties": true, "properties": { "equity": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "underlying_root": { "type": "string" }, "trading_dt": { "type": "string" }, "volume": { "type": "integer" }, "open_interest": { "type": "integer" }, "title": { "type": "string" }, "display": { "type": "string" }, "category": { "type": "string" } }, "required": [ "category", "display", "open_interest", "title", "trading_dt", "underlying_root", "volume" ] } }, "volatility": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "underlying_root": { "type": "string" }, "trading_dt": { "type": "string" }, "volume": { "type": "integer" }, "open_interest": { "type": "integer" }, "title": { "type": "string" }, "display": { "type": "string" }, "category": { "type": "string" } }, "required": [ "category", "display", "open_interest", "title", "trading_dt", "underlying_root", "volume" ] } }, "credit_interest": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "underlying_root": { "type": "string" }, "trading_dt": { "type": "string" }, "volume": { "type": "integer" }, "open_interest": { "type": "integer" }, "title": { "type": "string" }, "display": { "type": "string" } }, "required": [ "display", "open_interest", "title", "trading_dt", "underlying_root", "volume" ] } }, "international_equity": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "underlying_root": { "type": "string" }, "trading_dt": { "type": "string" }, "volume": { "type": "integer" }, "open_interest": { "type": "integer" }, "title": { "type": "string" }, "display": { "type": "string" } }, "required": [ "display", "open_interest", "title", "trading_dt", "underlying_root", "volume" ] } }, "crypto": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "underlying_root": { "type": "string" }, "trading_dt": { "type": "string" }, "volume": { "type": "integer" }, "open_interest": { "type": "integer" }, "title": { "type": "string" }, "display": { "type": "string" }, "category": { "type": "string" } }, "required": [ "category", "display", "open_interest", "title", "trading_dt", "underlying_root", "volume" ] } } }, "required": [ "credit_interest", "crypto", "equity", "international_equity", "volatility" ] } }, "required": [ "data" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_delayed_quotes_futures_rootsResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "timestamp": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "future_root": { "type": "string" }, "underlying": { "type": "string" }, "family": { "type": "string" }, "sort_order": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "family", "future_root", "name", "sort_order", "underlying" ] } } }, "required": [ "data", "timestamp" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_delayed_quotes_option_rootsResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "timestamp": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "symbol": { "type": "string" }, "root": { "type": "string" } }, "required": [ "root", "symbol" ] } }, "symbol": { "type": "string" } }, "required": [ "data", "symbol", "timestamp" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_delayed_quotes_servertimeResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "server utc time": { "type": "string" } }, "required": [ "server utc time" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_delayed_quotes_symbol_bookResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "timestamp": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string" }, "company_name": { "type": "string" } }, "required": [ "company_name", "name" ] } }, "symbol": { "type": "string" } }, "required": [ "data", "symbol", "timestamp" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_delayed_quotes_ttl_rulesResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "ttlRules": { "type": "object", "additionalProperties": true, "properties": { "enabled": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "data_type": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "filter": { "type": "string" }, "value": { "type": "string" }, "days": { "type": "string" }, "start": { "type": "string" }, "end": { "type": "string" }, "ttl": { "type": "integer" }, "assume": { "type": "string" } }, "required": [ "assume", "days", "end", "filter", "start", "ttl", "value" ] } } }, "required": [ "data_type", "rules" ] } } }, "required": [ "data", "enabled" ] } }, "required": [ "ttlRules" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_fx_adv_30_dayResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "SPOT": { "type": "object", "additionalProperties": true, "properties": { "NY": { "type": "object", "additionalProperties": true, "properties": { "ecn_anonymous_firm_usdqty": { "type": "number" }, "ecn_semidisclosed_firm_usdqty": { "type": "number" }, "ecn_anonymous_nonfirm_usdqty": { "type": "number" }, "ecn_semidisclosed_nonfirm_usdqty": { "type": "number" }, "fa_anonymous_nonfirm_usdqty": { "type": "number" }, "fa_semidisclosed_nonfirm_usdqty": { "type": "number" }, "otheradv_anonymous_usdqty": { "type": "number" }, "otheradv_semidisclosed_usdqty": { "type": "integer" }, "ecn_firm_total": { "type": "number" }, "ecn_nonfirm_total": { "type": "number" }, "fa_nonfirm_total": { "type": "number" }, "otheradv_total": { "type": "number" } }, "required": [ "ecn_anonymous_firm_usdqty", "ecn_anonymous_nonfirm_usdqty", "ecn_firm_total", "ecn_nonfirm_total", "ecn_semidisclosed_firm_usdqty", "ecn_semidisclosed_nonfirm_usdqty", "fa_anonymous_nonfirm_usdqty", "fa_nonfirm_total", "fa_semidisclosed_nonfirm_usdqty", "otheradv_anonymous_usdqty", "otheradv_semidisclosed_usdqty", "otheradv_total" ] }, "LDN": { "type": "object", "additionalProperties": true, "properties": { "ecn_anonymous_firm_usdqty": { "type": "number" }, "ecn_semidisclosed_firm_usdqty": { "type": "integer" }, "ecn_anonymous_nonfirm_usdqty": { "type": "number" }, "ecn_semidisclosed_nonfirm_usdqty": { "type": "number" }, "fa_anonymous_nonfirm_usdqty": { "type": "number" }, "fa_semidisclosed_nonfirm_usdqty": { "type": "number" }, "otheradv_anonymous_usdqty": { "type": "integer" }, "otheradv_semidisclosed_usdqty": { "type": "integer" }, "ecn_firm_total": { "type": "number" }, "ecn_nonfirm_total": { "type": "number" }, "fa_nonfirm_total": { "type": "number" }, "otheradv_total": { "type": "integer" } }, "required": [ "ecn_anonymous_firm_usdqty", "ecn_anonymous_nonfirm_usdqty", "ecn_firm_total", "ecn_nonfirm_total", "ecn_semidisclosed_firm_usdqty", "ecn_semidisclosed_nonfirm_usdqty", "fa_anonymous_nonfirm_usdqty", "fa_nonfirm_total", "fa_semidisclosed_nonfirm_usdqty", "otheradv_anonymous_usdqty", "otheradv_semidisclosed_usdqty", "otheradv_total" ] }, "TOTAL": { "type": "object", "additionalProperties": true, "properties": { "ecn_anonymous_firm_usdqty": { "type": "number" }, "ecn_semidisclosed_firm_usdqty": { "type": "number" }, "ecn_anonymous_nonfirm_usdqty": { "type": "number" }, "ecn_semidisclosed_nonfirm_usdqty": { "type": "number" }, "fa_anonymous_nonfirm_usdqty": { "type": "number" }, "fa_semidisclosed_nonfirm_usdqty": { "type": "number" }, "otheradv_anonymous_usdqty": { "type": "number" }, "otheradv_semidisclosed_usdqty": { "type": "integer" }, "ecn_firm_total": { "type": "number" }, "ecn_nonfirm_total": { "type": "number" }, "fa_nonfirm_total": { "type": "number" }, "otheradv_total": { "type": "number" } }, "required": [ "ecn_anonymous_firm_usdqty", "ecn_anonymous_nonfirm_usdqty", "ecn_firm_total", "ecn_nonfirm_total", "ecn_semidisclosed_firm_usdqty", "ecn_semidisclosed_nonfirm_usdqty", "fa_anonymous_nonfirm_usdqty", "fa_nonfirm_total", "fa_semidisclosed_nonfirm_usdqty", "otheradv_anonymous_usdqty", "otheradv_semidisclosed_usdqty", "otheradv_total" ] } }, "required": [ "LDN", "NY", "TOTAL" ] }, "NDF": { "type": "object", "additionalProperties": true, "properties": { "NY": { "type": "object", "additionalProperties": true, "properties": { "ecn_anonymous_firm_usdqty": { "type": "number" }, "ecn_semidisclosed_firm_usdqty": { "type": "integer" }, "ecn_anonymous_nonfirm_usdqty": { "type": "number" }, "ecn_semidisclosed_nonfirm_usdqty": { "type": "integer" }, "fa_anonymous_nonfirm_usdqty": { "type": "number" }, "fa_semidisclosed_nonfirm_usdqty": { "type": "integer" }, "otheradv_anonymous_usdqty": { "type": "integer" }, "otheradv_semidisclosed_usdqty": { "type": "integer" }, "ecn_firm_total": { "type": "number" }, "ecn_nonfirm_total": { "type": "number" }, "fa_nonfirm_total": { "type": "number" }, "otheradv_total": { "type": "integer" } }, "required": [ "ecn_anonymous_firm_usdqty", "ecn_anonymous_nonfirm_usdqty", "ecn_firm_total", "ecn_nonfirm_total", "ecn_semidisclosed_firm_usdqty", "ecn_semidisclosed_nonfirm_usdqty", "fa_anonymous_nonfirm_usdqty", "fa_nonfirm_total", "fa_semidisclosed_nonfirm_usdqty", "otheradv_anonymous_usdqty", "otheradv_semidisclosed_usdqty", "otheradv_total" ] }, "LDN": { "type": "object", "additionalProperties": true, "properties": { "ecn_anonymous_firm_usdqty": { "type": "number" }, "ecn_semidisclosed_firm_usdqty": { "type": "integer" }, "ecn_anonymous_nonfirm_usdqty": { "type": "number" }, "ecn_semidisclosed_nonfirm_usdqty": { "type": "integer" }, "fa_anonymous_nonfirm_usdqty": { "type": "integer" }, "fa_semidisclosed_nonfirm_usdqty": { "type": "integer" }, "otheradv_anonymous_usdqty": { "type": "integer" }, "otheradv_semidisclosed_usdqty": { "type": "integer" }, "ecn_firm_total": { "type": "number" }, "ecn_nonfirm_total": { "type": "number" }, "fa_nonfirm_total": { "type": "integer" }, "otheradv_total": { "type": "integer" } }, "required": [ "ecn_anonymous_firm_usdqty", "ecn_anonymous_nonfirm_usdqty", "ecn_firm_total", "ecn_nonfirm_total", "ecn_semidisclosed_firm_usdqty", "ecn_semidisclosed_nonfirm_usdqty", "fa_anonymous_nonfirm_usdqty", "fa_nonfirm_total", "fa_semidisclosed_nonfirm_usdqty", "otheradv_anonymous_usdqty", "otheradv_semidisclosed_usdqty", "otheradv_total" ] }, "TOTAL": { "type": "object", "additionalProperties": true, "properties": { "ecn_anonymous_firm_usdqty": { "type": "number" }, "ecn_semidisclosed_firm_usdqty": { "type": "integer" }, "ecn_anonymous_nonfirm_usdqty": { "type": "number" }, "ecn_semidisclosed_nonfirm_usdqty": { "type": "integer" }, "fa_anonymous_nonfirm_usdqty": { "type": "number" }, "fa_semidisclosed_nonfirm_usdqty": { "type": "integer" }, "otheradv_anonymous_usdqty": { "type": "integer" }, "otheradv_semidisclosed_usdqty": { "type": "integer" }, "ecn_firm_total": { "type": "number" }, "ecn_nonfirm_total": { "type": "number" }, "fa_nonfirm_total": { "type": "number" }, "otheradv_total": { "type": "integer" } }, "required": [ "ecn_anonymous_firm_usdqty", "ecn_anonymous_nonfirm_usdqty", "ecn_firm_total", "ecn_nonfirm_total", "ecn_semidisclosed_firm_usdqty", "ecn_semidisclosed_nonfirm_usdqty", "fa_anonymous_nonfirm_usdqty", "fa_nonfirm_total", "fa_semidisclosed_nonfirm_usdqty", "otheradv_anonymous_usdqty", "otheradv_semidisclosed_usdqty", "otheradv_total" ] } }, "required": [ "LDN", "NY", "TOTAL" ] } }, "required": [ "NDF", "SPOT" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_fx_adv_30_day_cardResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "SPOT": { "type": "object", "additionalProperties": true, "properties": { "TOTAL": { "type": "number" }, "PCT": { "type": "number" }, "FIRM_TOTAL": { "type": "number" }, "FIRM_PCT": { "type": "number" }, "FA_TOTAL": { "type": "number" }, "FA_PCT": { "type": "number" }, "METALS_TOTAL": { "type": "number" }, "METALS_PCT": { "type": "number" }, "CCYPAIR_TOTAL": { "type": "number" }, "CCYPAIR_PCT": { "type": "number" } }, "required": [ "CCYPAIR_PCT", "CCYPAIR_TOTAL", "FA_PCT", "FA_TOTAL", "FIRM_PCT", "FIRM_TOTAL", "METALS_PCT", "METALS_TOTAL", "PCT", "TOTAL" ] }, "NDF": { "type": "object", "additionalProperties": true, "properties": { "TOTAL": { "type": "number" }, "PCT": { "type": "number" }, "FIRM_TOTAL": { "type": "number" }, "FIRM_PCT": { "type": "number" }, "FA_TOTAL": { "type": "number" }, "FA_PCT": { "type": "number" } }, "required": [ "FA_PCT", "FA_TOTAL", "FIRM_PCT", "FIRM_TOTAL", "PCT", "TOTAL" ] }, "COMBINED": { "type": "object", "additionalProperties": true, "properties": { "TOTAL": { "type": "number" }, "PCT": { "type": "number" }, "FIRM_TOTAL": { "type": "number" }, "FIRM_PCT": { "type": "number" }, "FA_TOTAL": { "type": "number" }, "FA_PCT": { "type": "number" } }, "required": [ "FA_PCT", "FA_TOTAL", "FIRM_PCT", "FIRM_TOTAL", "PCT", "TOTAL" ] } }, "required": [ "COMBINED", "NDF", "SPOT" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_fx_sef_volumeResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "daily": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "trade-date": { "type": "string" }, "volume": { "type": "string" } }, "required": [ "trade-date", "volume" ] } }, "daily_vols_trailing_month": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "trade-date": { "type": "string" }, "volume": { "type": "string" } }, "required": [ "trade-date", "volume" ] } }, "monthly": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "trading-days": { "type": "string" }, "avg-daily-volume": { "type": "string" }, "volume": { "type": "string" }, "month": { "type": "string" } }, "required": [ "avg-daily-volume", "month", "trading-days", "volume" ] } }, "quarterly": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "trading-days": { "type": "string" }, "volume": { "type": "string" }, "quarter": { "type": "string" }, "avg-daily-volume": { "type": "string" } }, "required": [ "avg-daily-volume", "quarter", "trading-days", "volume" ] } } }, "required": [ "daily", "daily_vols_trailing_month", "monthly", "quarterly" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_market_data_services_most_activeResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "mostActive": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "symbol": { "type": "string" }, "last_price": { "type": "string" }, "volume": { "type": "string" } }, "required": [ "last_price", "symbol", "volume" ] } } }, "required": [ "mostActive" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_options_market_shareResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "reload": { "type": "integer" }, "data": { "type": "object", "additionalProperties": true, "properties": { "top": { "type": "array", "items": {} }, "stats": { "type": "object", "additionalProperties": true, "properties": { "integrated": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "avg_weighting": { "type": "integer" }, "mktshare": { "type": "number" }, "value": { "type": "integer" }, "weighting": { "type": "integer" }, "data": { "type": "array", "items": {} }, "mktname": { "type": "string" }, "mkthtml": { "type": "string" }, "data_count": { "type": "integer" } }, "required": [ "avg_weighting", "data", "data_count", "mkthtml", "mktname", "mktshare", "value", "weighting" ] } }, "integrated_count": { "type": "integer" } }, "required": [ "integrated", "integrated_count" ] }, "totals": { "type": "object", "additionalProperties": true, "properties": { "normal": { "type": "array", "items": {} }, "integrated": { "type": "array", "items": {} }, "normal_count": { "type": "integer" }, "integrated_count": { "type": "integer" } }, "required": [ "integrated", "integrated_count", "normal", "normal_count" ] }, "total": { "type": "object", "additionalProperties": true, "properties": { "normal": { "type": "array", "items": { "type": "integer" } }, "integrated": { "type": "array", "items": { "type": "integer" } }, "normal_count": { "type": "integer" }, "integrated_count": { "type": "integer" } }, "required": [ "integrated", "integrated_count", "normal", "normal_count" ] }, "avg_totals": { "type": "object", "additionalProperties": true, "properties": { "normal": { "type": "array", "items": {} }, "integrated": { "type": "array", "items": {} }, "normal_count": { "type": "integer" }, "integrated_count": { "type": "integer" } }, "required": [ "integrated", "integrated_count", "normal", "normal_count" ] }, "avg_total": { "type": "object", "additionalProperties": true, "properties": { "normal": { "type": "array", "items": { "type": "integer" } }, "integrated": { "type": "array", "items": { "type": "integer" } }, "normal_count": { "type": "integer" }, "integrated_count": { "type": "integer" } }, "required": [ "integrated", "integrated_count", "normal", "normal_count" ] }, "comp_stats": { "type": "object", "additionalProperties": true, "properties": { "data": { "type": "array", "items": {} }, "data_count": { "type": "integer" } }, "required": [ "data", "data_count" ] }, "type": { "type": "string" }, "end_ts": { "type": "string" }, "disclaimer": { "type": "string" }, "disabled": { "type": "array", "items": {} }, "top_count": { "type": "integer" }, "disabled_count": { "type": "integer" } }, "required": [ "avg_total", "avg_totals", "comp_stats", "disabled", "disabled_count", "disclaimer", "end_ts", "stats", "top", "top_count", "total", "totals", "type" ] }, "success": { "type": "boolean" }, "statusText": { "type": "string" }, "statusCode": { "type": "string" }, "status": { "type": "string" } }, "required": [ "data", "reload", "status", "statusCode", "statusText", "success" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_options_most_activeResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "limit": { "type": "integer" }, "description": { "type": "string" }, "categories": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "category": { "type": "string" }, "display": { "type": "string" }, "calls": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "symbol": { "type": "string" }, "expires": { "type": "string" }, "strike": { "type": "integer" }, "volume": { "type": "integer" } }, "required": [ "expires", "strike", "symbol", "volume" ] } }, "puts": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "symbol": { "type": "string" }, "expires": { "type": "string" }, "strike": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "volume": { "type": "integer" } }, "required": [ "expires", "strike", "symbol", "volume" ] } } }, "required": [ "calls", "category", "display", "puts" ] } }, "dt": { "type": "string" } }, "required": [ "categories", "description", "dt", "limit" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_delayed_quotes_history_symbolResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "timestamp": { "type": "string" }, "data": { "type": "object", "additionalProperties": true, "properties": { "symbol": { "type": "string" }, "annual_high": { "type": "number" }, "hv30_annual_high": { "type": "number" }, "hv60_annual_high": { "type": "number" }, "hv90_annual_high": { "type": "number" }, "iv30_annual_high": { "type": "number" }, "iv60_annual_high": { "type": "number" }, "iv90_annual_high": { "type": "number" }, "annual_low": { "type": "number" }, "hv30_annual_low": { "type": "number" }, "hv60_annual_low": { "type": "number" }, "hv90_annual_low": { "type": "number" }, "iv30_annual_low": { "type": "number" }, "iv60_annual_low": { "type": "number" }, "iv90_annual_low": { "type": "number" } }, "required": [ "annual_high", "annual_low", "hv30_annual_high", "hv30_annual_low", "hv60_annual_high", "hv60_annual_low", "hv90_annual_high", "hv90_annual_low", "iv30_annual_high", "iv30_annual_low", "iv60_annual_high", "iv60_annual_low", "iv90_annual_high", "iv90_annual_low", "symbol" ] }, "symbol": { "type": "string" } }, "required": [ "data", "symbol", "timestamp" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_delayed_quotes_options_underlying_symbolResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "timestamp": { "type": "string" }, "data": { "type": "object", "additionalProperties": true, "properties": { "options": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "option": { "type": "string" }, "bid": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "bid_size": { "type": "integer" }, "ask": { "type": "number" }, "ask_size": { "type": "integer" }, "iv": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "open_interest": { "type": "integer" }, "volume": { "type": "integer" }, "delta": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "gamma": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "vega": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "theta": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "rho": { "type": "integer" }, "theo": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "change": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "open": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "high": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "low": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "tick": { "type": "string" }, "last_trade_price": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "last_trade_time": { "oneOf": [ { "type": "string" }, { "nullable": true } ] }, "percent_change": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "prev_day_close": { "type": "number" } }, "required": [ "ask", "ask_size", "bid", "bid_size", "change", "delta", "gamma", "high", "iv", "last_trade_price", "last_trade_time", "low", "open", "open_interest", "option", "percent_change", "prev_day_close", "rho", "theo", "theta", "tick", "vega", "volume" ] } }, "symbol": { "type": "string" }, "security_type": { "type": "string" }, "exchange_id": { "type": "integer" }, "current_price": { "type": "number" }, "price_change": { "type": "number" }, "price_change_percent": { "type": "number" }, "bid": { "type": "number" }, "ask": { "type": "number" }, "bid_size": { "type": "integer" }, "ask_size": { "type": "integer" }, "open": { "type": "number" }, "high": { "type": "number" }, "low": { "type": "number" }, "close": { "type": "number" }, "prev_day_close": { "type": "number" }, "volume": { "type": "integer" }, "iv30": { "type": "number" }, "iv30_change": { "type": "integer" }, "iv30_change_percent": { "type": "integer" }, "seqno": { "type": "integer" }, "last_trade_time": { "type": "string" }, "tick": { "type": "string" } }, "required": [ "ask", "ask_size", "bid", "bid_size", "close", "current_price", "exchange_id", "high", "iv30", "iv30_change", "iv30_change_percent", "last_trade_time", "low", "open", "options", "prev_day_close", "price_change", "price_change_percent", "security_type", "seqno", "symbol", "tick", "volume" ] }, "symbol": { "type": "string" } }, "required": [ "data", "symbol", "timestamp" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_delayed_quotes_quotes_symbolResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "timestamp": { "type": "string" }, "data": { "type": "object", "additionalProperties": true, "properties": { "symbol": { "type": "string" }, "security_type": { "type": "string" }, "exchange_id": { "type": "integer" }, "current_price": { "type": "number" }, "price_change": { "type": "number" }, "price_change_percent": { "type": "number" }, "bid": { "type": "number" }, "ask": { "type": "number" }, "bid_size": { "type": "integer" }, "ask_size": { "type": "integer" }, "open": { "type": "number" }, "high": { "type": "number" }, "low": { "type": "number" }, "close": { "type": "number" }, "prev_day_close": { "type": "number" }, "volume": { "type": "integer" }, "iv30": { "type": "number" }, "iv30_change": { "type": "integer" }, "iv30_change_percent": { "type": "integer" }, "seqno": { "type": "integer" }, "last_trade_time": { "type": "string" }, "tick": { "type": "string" } }, "required": [ "ask", "ask_size", "bid", "bid_size", "close", "current_price", "exchange_id", "high", "iv30", "iv30_change", "iv30_change_percent", "last_trade_time", "low", "open", "prev_day_close", "price_change", "price_change_percent", "security_type", "seqno", "symbol", "tick", "volume" ] }, "symbol": { "type": "string" } }, "required": [ "data", "symbol", "timestamp" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_delayed_quotes_quotes_all_us_indicesResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "timestamp": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "symbol": { "type": "string" }, "security_type": { "type": "string" }, "exchange_id": { "type": "integer" }, "current_price": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "price_change": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "price_change_percent": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "bid": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "ask": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "bid_size": { "type": "integer" }, "ask_size": { "type": "integer" }, "open": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "high": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "low": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "close": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "prev_day_close": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "volume": { "type": "integer" }, "iv30": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "iv30_change": { "type": "integer" }, "iv30_change_percent": { "oneOf": [ { "nullable": true }, { "type": "integer" } ] }, "seqno": { "type": "integer" }, "last_trade_time": { "type": "string" }, "tick": { "type": "string" } }, "required": [ "ask", "ask_size", "bid", "bid_size", "close", "current_price", "exchange_id", "high", "iv30", "iv30_change", "iv30_change_percent", "last_trade_time", "low", "open", "prev_day_close", "price_change", "price_change_percent", "security_type", "seqno", "symbol", "tick", "volume" ] } }, "symbol": { "type": "string" } }, "required": [ "data", "symbol", "timestamp" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_delayed_quotes_quotes_all_us_indices_icpResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "timestamp": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "high": { "type": "integer" }, "exchange_id": { "type": "integer" }, "current_price": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "close": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "iv30_change_percent": { "type": "integer" }, "prev_day_close": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "open": { "type": "integer" }, "security_type": { "type": "string" }, "low": { "type": "integer" }, "ask_size": { "type": "integer" }, "symbol": { "type": "string" }, "index": { "type": "string" }, "bid_size": { "type": "integer" }, "iv30_change": { "type": "integer" }, "iv30": { "type": "integer" }, "seqno": { "type": "integer" }, "bid": { "type": "integer" }, "volume": { "type": "integer" }, "ask": { "type": "integer" }, "tick": { "type": "string" }, "price_change_percent": { "type": "integer" }, "price_change": { "type": "integer" }, "last_trade_time": { "type": "string" } }, "required": [ "ask", "ask_size", "bid", "bid_size", "close", "current_price", "exchange_id", "high", "index", "iv30", "iv30_change", "iv30_change_percent", "last_trade_time", "low", "open", "prev_day_close", "price_change", "price_change_percent", "security_type", "seqno", "symbol", "tick", "volume" ] } }, "symbol": { "type": "string" } }, "required": [ "data", "symbol", "timestamp" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_equities_au_today_activityResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "summary": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "title": { "type": "string" }, "subtext": { "type": "string" }, "value": { "type": "string" }, "subtitle": { "type": "string" }, "subtitlevalue": { "type": "string" } }, "required": [ "subtext", "subtitle", "subtitlevalue", "title", "value" ] } }, "url": { "type": "string" } }, "required": [ "id", "label", "summary", "url" ] } }, "retrieved_at": { "type": "string" }, "display": { "type": "string" }, "success": { "type": "boolean" } }, "required": [ "data", "display", "retrieved_at", "success" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_equities_ca_listing_directoryResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "symbol": { "type": "string" }, "name": { "type": "string" }, "currency": { "type": "string" }, "security": { "type": "string" }, "security_sub_type": { "type": "string" }, "marketcap": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "last": { "type": "integer" }, "changepcnt": { "type": "string" }, "volume": { "type": "integer" } }, "required": [ "changepcnt", "currency", "last", "marketcap", "name", "security", "security_sub_type", "symbol", "volume" ] } } }, "required": [ "data" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_equities_ca_market_totalsResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "total_volume": { "type": "string" }, "total_value": { "type": "string" }, "trade_count": { "type": "integer" }, "ts": { "type": "string" } }, "required": [ "total_value", "total_volume", "trade_count", "ts" ] } } }, "required": [ "data" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_equities_ca_symbol_totalsResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "advancers": { "type": "integer" }, "decliners": { "type": "integer" }, "unchanged": { "type": "integer" } }, "required": [ "advancers", "decliners", "unchanged" ] } } }, "required": [ "data" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_equities_ca_top_ten_volumeResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string" }, "bats_name": { "type": "string" }, "company_name": { "type": "string" }, "last_price": { "type": "string" }, "percent_change": { "type": "string" }, "vol": { "type": "integer" }, "trade_time": { "type": "string" }, "ts": { "type": "string" } }, "required": [ "bats_name", "company_name", "last_price", "name", "percent_change", "trade_time", "ts", "vol" ] } } }, "required": [ "data" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_equities_europe_most_activeResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "string" }, "ttl": { "type": "number" }, "ts": { "type": "string" }, "data": { "type": "object", "additionalProperties": true, "properties": { "cxe": { "type": "array", "items": {} } }, "required": [ "cxe" ] }, "mo": { "type": "boolean" } }, "required": [ "data", "mo", "success", "ts", "ttl" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_equities_us_halts_csvResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "string" } }, "required": [ "data", "meta" ] }, "cbfin_get_equities_us_most_activeResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "success": { "type": "string" }, "ttl": { "type": "number" }, "ts": { "type": "string" }, "data": { "type": "object", "additionalProperties": true, "properties": { "bzx": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } }, "required": [ "bzx" ] }, "mo": { "type": "boolean" } }, "required": [ "data", "mo", "success", "ts", "ttl" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_equities_us_short_sale_circuit_breakers_csvResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "string" } }, "required": [ "data", "meta" ] }, "cbfin_get_futures_data_root_symbolResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "symbol_id": { "type": "string" }, "symbol": { "type": "string" }, "expiration": { "type": "string" }, "open": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "last_price": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "high": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "low": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "prev_close": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "settlement": { "type": "number" }, "prev_settlement": { "type": "number" }, "change": { "type": "number" }, "volume": { "type": "integer" }, "prev_open_int": { "type": "integer" }, "current_open_int": { "type": "integer" }, "current_volume": { "type": "integer" }, "root_symbol": { "type": "boolean" } }, "required": [ "change", "current_open_int", "current_volume", "expiration", "high", "last_price", "low", "open", "prev_close", "prev_open_int", "prev_settlement", "root_symbol", "settlement", "symbol", "symbol_id", "volume" ] } }, "lastUpdate": { "type": "string" } }, "required": [ "data", "lastUpdate" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_futures_quotes_combinedResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "symbol": { "type": "string" }, "expiration": { "type": "string" }, "open": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" } ] }, "close": { "type": "string" }, "high": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "low": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "last_price": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "prev_open_int": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "current_open_int": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "current_volume": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "settlement": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "prev_settlement": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "change": { "type": "number" }, "volume": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "root_symbol": { "type": "boolean" }, "symbol_id": { "type": "string" }, "prev_close": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] } }, "required": [ "change", "close", "current_open_int", "current_volume", "expiration", "high", "last_price", "low", "open", "prev_close", "prev_open_int", "prev_settlement", "root_symbol", "settlement", "symbol", "symbol_id", "volume" ] } }, "lastUpdate": { "type": "string" } }, "required": [ "data", "lastUpdate" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_futures_settlement_daily_csvResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "string" } }, "required": [ "data", "meta" ] }, "cbfin_get_futures_settlement_final_pricesResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "selectedYear": { "type": "integer" }, "yearList": { "type": "array", "items": { "type": "integer" } }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "product": { "type": "string" }, "weekly_settlement_prices": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "symbol_name": { "type": "string" }, "expire_date": { "type": "string" }, "price": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "delta": { "type": "string" }, "exercise_price": { "nullable": true }, "settlement_var": { "nullable": true }, "calculation_method": { "type": "string" } }, "required": [ "calculation_method", "delta", "exercise_price", "expire_date", "price", "settlement_var", "symbol_name" ] } }, "monthly_settlement_prices": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "symbol_name": { "type": "string" }, "expire_date": { "type": "string" }, "price": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "delta": { "type": "string" }, "exercise_price": { "nullable": true }, "settlement_var": { "nullable": true }, "calculation_method": { "type": "string" } }, "required": [ "calculation_method", "delta", "exercise_price", "expire_date", "price", "settlement_var", "symbol_name" ] } }, "option_settlement_prices": { "type": "array", "items": {} } }, "required": [ "monthly_settlement_prices", "option_settlement_prices", "product", "weekly_settlement_prices" ] } } }, "required": [ "data", "selectedYear", "yearList" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_futures_settlement_final_prices_csvResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "string" } }, "required": [ "data", "meta" ] }, "cbfin_get_index_settlement_years_settlement_typeResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "data": { "type": "array", "items": { "type": "integer" } } }, "required": [ "data" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_indices_europe_definitionsResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "timestamp": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "timestamp": { "type": "string" }, "index": { "type": "object", "additionalProperties": true, "properties": { "symbol": { "type": "string" }, "short_name": { "type": "string" }, "long_name": { "type": "string" }, "currency": { "type": "string" }, "isin": { "type": "string" }, "region": { "type": "string" } }, "required": [ "currency", "isin", "long_name", "region", "short_name", "symbol" ] }, "constituents": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "index_symbol": { "type": "string" }, "constituent_symbol": { "type": "string" } }, "required": [ "constituent_symbol", "index_symbol" ] } } }, "required": [ "constituents", "index", "timestamp" ] } } }, "required": [ "data", "timestamp" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_indices_europe_quotesResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "timestamp": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "high": { "type": "number" }, "exchange_id": { "type": "integer" }, "current_price": { "type": "number" }, "close": { "type": "number" }, "iv30_change_percent": { "type": "integer" }, "prev_day_close": { "type": "number" }, "open": { "type": "integer" }, "security_type": { "type": "string" }, "low": { "type": "number" }, "ask_size": { "type": "integer" }, "symbol": { "type": "string" }, "index": { "type": "string" }, "bid_size": { "type": "integer" }, "iv30_change": { "type": "integer" }, "iv30": { "type": "integer" }, "seqno": { "type": "integer" }, "bid": { "type": "integer" }, "volume": { "type": "integer" }, "ask": { "type": "integer" }, "tick": { "type": "string" }, "price_change_percent": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "price_change": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "last_trade_time": { "type": "string" }, "status": { "type": "string" } }, "required": [ "ask", "ask_size", "bid", "bid_size", "close", "current_price", "exchange_id", "high", "index", "iv30", "iv30_change", "iv30_change_percent", "last_trade_time", "low", "open", "prev_day_close", "price_change", "price_change_percent", "security_type", "seqno", "status", "symbol", "tick", "volume" ] } } }, "required": [ "data", "timestamp" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_indices_us_definitionsResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "calc_end_time": { "type": "string" }, "calc_start_time": { "type": "string" }, "currency": { "type": "string" }, "description": { "type": "string" }, "display": { "type": "boolean" }, "display_override_auto_hide": { "type": "boolean" }, "featured": { "type": "boolean" }, "featured_order": { "type": "integer" }, "index_family": { "oneOf": [ { "nullable": true }, { "type": "string" } ] }, "index_family_relationship": { "oneOf": [ { "nullable": true }, { "type": "string" } ] }, "index_launch_date": { "oneOf": [ { "nullable": true }, { "type": "string" } ] }, "index_symbol": { "type": "string" }, "mkt_data_delay": { "type": "integer" }, "name": { "type": "string" }, "show_intraday_chart": { "type": "boolean" }, "source": { "type": "string" }, "tick_days": { "type": "string" }, "tick_frequency": { "type": "string" }, "tick_interval_seconds": { "oneOf": [ { "nullable": true }, { "type": "string" } ] }, "tick_period": { "type": "string" }, "time_zone": { "type": "string" } }, "required": [ "calc_end_time", "calc_start_time", "currency", "description", "display", "display_override_auto_hide", "featured", "featured_order", "index_family", "index_family_relationship", "index_launch_date", "index_symbol", "mkt_data_delay", "name", "show_intraday_chart", "source", "tick_days", "tick_frequency", "tick_interval_seconds", "tick_period", "time_zone" ] } } }, "required": [ "data", "meta" ] }, "cbfin_get_delayed_quotes_charts_historical_symbolResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "timestamp": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "date": { "type": "string" }, "volume": { "type": "integer" }, "open": { "type": "number" }, "high": { "type": "number" }, "low": { "type": "number" }, "close": { "type": "number" } }, "required": [ "close", "date", "high", "low", "open", "volume" ] } }, "symbol": { "type": "string" } }, "required": [ "data", "symbol", "timestamp" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_delayed_quotes_charts_intraday_symbolResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "timestamp": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "datetime": { "type": "string" }, "sequence_number": { "type": "integer" }, "price": { "type": "object", "additionalProperties": true, "properties": { "open": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "high": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "low": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "close": { "type": "number" } }, "required": [ "close", "high", "low", "open" ] }, "volume": { "type": "object", "additionalProperties": true, "properties": { "stock_volume": { "type": "integer" }, "calls_volume": { "type": "integer" }, "puts_volume": { "type": "integer" }, "total_options_volume": { "type": "integer" } }, "required": [ "calls_volume", "puts_volume", "stock_volume", "total_options_volume" ] } }, "required": [ "datetime", "price", "sequence_number", "volume" ] } }, "symbol": { "type": "string" } }, "required": [ "data", "symbol", "timestamp" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_delayed_quotes_charts_one_month_symbolResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "timestamp": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "datetime": { "type": "string" }, "sequence_number": { "type": "integer" }, "price": { "type": "object", "additionalProperties": true, "properties": { "open": { "type": "number" }, "high": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "low": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "close": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] } }, "required": [ "close", "high", "low", "open" ] }, "volume": { "type": "object", "additionalProperties": true, "properties": { "stock_volume": { "type": "integer" }, "calls_volume": { "type": "integer" }, "puts_volume": { "type": "integer" }, "total_options_volume": { "type": "integer" } }, "required": [ "calls_volume", "puts_volume", "stock_volume", "total_options_volume" ] } }, "required": [ "datetime", "price", "sequence_number", "volume" ] } }, "symbol": { "type": "string" } }, "required": [ "data", "symbol", "timestamp" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_equities_au_book_viewer_symbolsResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "symbolsLookupData": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string" }, "company_name": { "type": "string" } }, "required": [ "company_name", "name" ] } } }, "required": [ "symbolsLookupData" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_equities_europe_market_share_rangeResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "string" } }, "required": [ "data", "meta" ] }, "cbfin_get_equities_europe_market_share_trailingResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "string" } }, "required": [ "data", "meta" ] }, "cbfin_get_futures_data_www_root_symbolResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "symbol_id": { "type": "string" }, "symbol": { "type": "string" }, "expiration": { "type": "string" }, "open": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "last_price": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "high": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "low": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "prev_close": { "oneOf": [ { "type": "integer" }, { "type": "number" } ] }, "settlement": { "type": "number" }, "prev_settlement": { "type": "number" }, "change": { "type": "number" }, "volume": { "type": "integer" }, "prev_open_int": { "type": "integer" }, "current_open_int": { "type": "integer" }, "current_volume": { "type": "integer" }, "root_symbol": { "type": "boolean" } }, "required": [ "change", "current_open_int", "current_volume", "expiration", "high", "last_price", "low", "open", "prev_close", "prev_open_int", "prev_settlement", "root_symbol", "settlement", "symbol", "symbol_id", "volume" ] } }, "lastUpdate": { "type": "string" } }, "required": [ "data", "lastUpdate" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_index_settlement_values_settlement_type_yearResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "description": { "type": "string" }, "trading_symbol": { "type": "string" }, "expiration_date": { "type": "string" }, "settlement_symbol": { "type": "string" }, "settlement_value": { "oneOf": [ { "type": "number" }, { "type": "integer" } ] }, "display_order": { "type": "integer" } }, "required": [ "description", "display_order", "expiration_date", "settlement_symbol", "settlement_value", "trading_symbol" ] } } }, "required": [ "data" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_indices_us_governance_consultationsResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "us_consultation": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "active": { "type": "boolean" }, "status": { "type": "integer" }, "link": { "type": "string" }, "linkResult": { "type": "string" }, "linkResultTitle": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "questionIDs": { "type": "string" }, "id": { "type": "string" } }, "required": [ "active", "description", "endDate", "id", "link", "linkResult", "linkResultTitle", "name", "questionIDs", "startDate", "status" ] } } }, "required": [ "us_consultation" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_notices_au_system_yearResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "ttl": { "type": "number" }, "alerts": { "type": "array", "items": {} }, "display_name": { "type": "string" }, "year_list": { "type": "array", "items": { "type": "integer" } }, "success": { "type": "boolean" }, "statusText": { "type": "string" }, "statusCode": { "type": "string" }, "status": { "type": "string" }, "alerts_count": { "type": "integer" }, "year_list_count": { "type": "integer" } }, "required": [ "alerts", "alerts_count", "display_name", "status", "statusCode", "statusText", "success", "ttl", "year_list", "year_list_count" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_notices_ca_system_yearResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "ttl": { "type": "number" }, "alerts": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "subject": { "type": "string" }, "message_ts": { "type": "string" }, "message": { "type": "string" }, "type": { "type": "string" }, "id": { "type": "integer" }, "message_rss_ts": { "type": "string" } }, "required": [ "id", "message", "message_rss_ts", "message_ts", "subject", "type" ] } }, "display_name": { "type": "string" }, "year_list": { "type": "array", "items": { "type": "integer" } }, "success": { "type": "boolean" }, "statusText": { "type": "string" }, "statusCode": { "type": "string" }, "status": { "type": "string" }, "alerts_count": { "type": "integer" }, "year_list_count": { "type": "integer" } }, "required": [ "alerts", "alerts_count", "display_name", "status", "statusCode", "statusText", "success", "ttl", "year_list", "year_list_count" ] } }, "required": [ "data", "meta" ] }, "cbfin_get_notices_europe_trf_system_yearResponse": { "type": "object", "additionalProperties": true, "properties": { "meta": { "type": "object", "additionalProperties": true, "properties": { "provider": { "type": "string" }, "endpoint": { "type": "string" }, "route": { "type": "string" }, "family": { "type": "string" }, "cache": { "type": "string" }, "identity_tier": { "type": "string" }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "additionalProperties": true, "properties": { "ttl_seconds": { "type": "integer" }, "stale_seconds": { "type": "integer" } }, "required": [ "stale_seconds", "ttl_seconds" ] }, "status": { "type": "string" }, "upstream_status": { "type": "integer" }, "upstream_elapsed_ms": { "type": "integer" }, "content_type": { "type": "string" } }, "required": [ "cache", "content_type", "endpoint", "family", "freshness", "generated_at", "identity_tier", "provider", "route", "status", "upstream_elapsed_ms", "upstream_status" ] }, "data": { "type": "object", "additionalProperties": true, "properties": { "ttl": { "type": "number" }, "alerts": { "type": "array", "items": { "type": "object", "additionalProperties": true, "properties": { "subject": { "type": "string" }, "message_ts": { "type": "string" }, "message": { "type": "string" }, "type": { "type": "string" }, "id": { "type": "integer" }, "message_rss_ts": { "type": "string" } }, "required": [ "id", "message", "message_rss_ts", "message_ts", "subject", "type" ] } }, "display_name": { "type": "string" }, "year_list": { "type": "array", "items": { "type": "integer" } }, "success": { "type": "boolean" }, "statusText": { "type": "string" }, "statusCode": { "type": "string" }, "status": { "type": "string" }, "alerts_count": { "type": "integer" }, "year_list_count": { "type": "integer" } }, "required": [ "alerts", "alerts_count", "display_name", "status", "statusCode", "statusText", "success", "ttl", "year_list", "year_list_count" ] } }, "required": [ "data", "meta" ] } } }, "x-generated-at": "2026-06-07T01:30:59.456Z", "x-source-api": "cbfin", "x-source-base-url": "https://api.cbfin.bluedoor.sh" }