{"name":"cbfin","provider":"Cboe","version":"0.1.0","shipped_rest_contracts":49,"identity":{"anonymous":"no auth header - capped at 600 client req/min and 10 cache-miss origin req/min per IP","contact":"set X-Cbfin-Contact: you@example.com - 3000 client req/min, 120 origin req/min","key":"Authorization: Bearer <api-key> - 15000 client req/min, 600 origin req/min"},"endpoints":[{"id":"cboe.delayed_quotes_config.cdn.cboe.com.api.global.delayed.quotes.ttl.rules.01","name":"delayed_quotes_ttl_rules","path":"/v1/delayed-quotes/ttl-rules","method":"GET","family":"delayed_quotes_config","description":"Cboe delayed quote configuration and clock metadata.","assets":["equities","indices","options","futures"],"body_type":"json","cache_ttl_seconds":300,"stale_seconds":3600,"implementation_status":"live","source_policy_status":"public_page_terms_noted","sample_shape_paths":["${}","ttlRules{}","ttlRules.enabled:bool","ttlRules.data[]","ttlRules.data[]{}","ttlRules.data[].data_type:str","ttlRules.data[].rules[]","ttlRules.data[].rules[]{}","ttlRules.data[].rules[].filter:str","ttlRules.data[].rules[].value:str","ttlRules.data[].rules[].days:str","ttlRules.data[].rules[].start:str","ttlRules.data[].rules[].end:str","ttlRules.data[].rules[].ttl:int","ttlRules.data[].rules[].assume:str"]},{"id":"cboe.delayed_quotes_symbol_master.cdn.cboe.com.api.global.delayed.quotes.symbol.book.symbol.book.02","name":"delayed_quotes_symbol_book","path":"/v1/delayed-quotes/symbol-book","method":"GET","family":"delayed_quotes_symbol_master","description":"Cboe delayed quote symbol/root master data.","assets":["equities","indices","options","futures"],"body_type":"json","cache_ttl_seconds":300,"stale_seconds":3600,"implementation_status":"live","source_policy_status":"public_page_terms_noted","sample_shape_paths":["${}","timestamp:str","data[]","data[]{}","data[].name:str","data[].company_name:str","symbol:str"]},{"id":"cboe.delayed_quotes_symbol_master.cdn.cboe.com.api.global.delayed.quotes.symbol.book.option.roots.03","name":"delayed_quotes_option_roots","path":"/v1/delayed-quotes/option-roots","method":"GET","family":"delayed_quotes_symbol_master","description":"Cboe delayed quote symbol/root master data.","assets":["options"],"body_type":"json","cache_ttl_seconds":300,"stale_seconds":3600,"implementation_status":"live","source_policy_status":"public_page_terms_noted","sample_shape_paths":["${}","timestamp:str","data[]","data[]{}","data[].symbol:str","data[].root:str","symbol:str"]},{"id":"cboe.delayed_quotes_symbol_master.cdn.cboe.com.api.global.delayed.quotes.symbol.book.futures.roots.04","name":"delayed_quotes_futures_roots","path":"/v1/delayed-quotes/futures-roots","method":"GET","family":"delayed_quotes_symbol_master","description":"Cboe delayed quote symbol/root master data.","assets":["futures"],"body_type":"json","cache_ttl_seconds":300,"stale_seconds":3600,"implementation_status":"live","source_policy_status":"public_page_terms_noted","sample_shape_paths":["${}","timestamp:str","data[]","data[]{}","data[].future_root:str","data[].underlying:str","data[].family:str","data[].sort_order:int","data[].name:str"]},{"id":"cboe.delayed_quotes_snapshot.cdn.cboe.com.api.global.delayed.quotes.quotes.symbol.05","name":"delayed_quotes_quotes_symbol","path":"/v1/delayed-quotes/quotes/{symbol}","method":"GET","family":"delayed_quotes_snapshot","description":"Cboe delayed quote snapshot payloads.","assets":["equities","indices","futures"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"public_page_terms_noted","sample_shape_paths":["${}","timestamp:str","data{}","data.symbol:str","data.security_type:str","data.exchange_id:int","data.current_price:float","data.price_change:float","data.price_change_percent:float","data.bid:float","data.ask:float","data.bid_size:int","data.ask_size:int","data.open:float","data.high:float","data.low:float","data.close:float","data.prev_day_close:float","data.volume:int","data.iv30:float","data.iv30_change:float","data.iv30_change_percent:float","data.seqno:int","data.last_trade_time:str","data.tick:str","symbol:str"]},{"id":"cboe.delayed_quotes_snapshot.cdn.cboe.com.api.global.delayed.quotes.quotes.all.us.indices.06","name":"delayed_quotes_quotes_all_us_indices","path":"/v1/delayed-quotes/quotes/all-us-indices","method":"GET","family":"delayed_quotes_snapshot","description":"Cboe delayed quote snapshot payloads.","assets":["indices"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"public_page_terms_noted","sample_shape_paths":["${}","timestamp:str","data[]","data[]{}","data[].symbol:str","data[].security_type:str","data[].exchange_id:int","data[].current_price:float","data[].price_change:float","data[].price_change_percent:float","data[].bid:float","data[].ask:float","data[].bid_size:int","data[].ask_size:int","data[].open:float","data[].high:float","data[].low:float","data[].close:float","data[].prev_day_close:float","data[].volume:int","data[].iv30:float","data[].iv30_change:float","data[].iv30_change_percent:NoneType","data[].seqno:int","data[].last_trade_time:str","data[].tick:str","symbol:str"]},{"id":"cboe.delayed_quotes_snapshot.cdn.cboe.com.api.global.delayed.quotes.quotes.all.us.indices.from.icp.07","name":"delayed_quotes_quotes_all_us_indices_icp","path":"/v1/delayed-quotes/quotes/all-us-indices-icp","method":"GET","family":"delayed_quotes_snapshot","description":"Cboe delayed quote snapshot payloads.","assets":["indices"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"public_page_terms_noted","sample_shape_paths":["${}","timestamp:str","data[]","data[]{}","data[].high:float","data[].exchange_id:int","data[].current_price:float","data[].close:float","data[].iv30_change_percent:int","data[].prev_day_close:float","data[].open:float","data[].security_type:str","data[].low:float","data[].ask_size:int","data[].symbol:str","data[].index:str","data[].bid_size:int","data[].iv30_change:float","data[].iv30:float","data[].seqno:int","data[].bid:float","data[].volume:int","data[].ask:float","data[].tick:str","data[].price_change_percent:float","data[].price_change:float","data[].last_trade_time:str","symbol:str"]},{"id":"cboe.index_definitions.cdn.cboe.com.api.global.us.indices.definitions.all.indices.08","name":"indices_us_definitions","path":"/v1/indices/us/definitions","method":"GET","family":"index_definitions","description":"Cboe index definition/reference data.","assets":["indices"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["$[]","$[]{}","$[].calc_end_time:str","$[].calc_start_time:str","$[].currency:str","$[].description:str","$[].display:bool","$[].display_override_auto_hide:bool","$[].featured:bool","$[].featured_order:int","$[].index_family:NoneType","$[].index_family_relationship:NoneType","$[].index_launch_date:NoneType","$[].index_symbol:str","$[].mkt_data_delay:int","$[].name:str","$[].show_intraday_chart:bool","$[].source:str","$[].tick_days:str","$[].tick_frequency:str","$[].tick_interval_seconds:NoneType","$[].tick_period:str","$[].time_zone:str"]},{"id":"cboe.index_definitions.cdn.cboe.com.api.global.european.indices.definitions.all.definitions.09","name":"indices_europe_definitions","path":"/v1/indices/europe/definitions","method":"GET","family":"index_definitions","description":"Cboe index definition/reference data.","assets":["indices"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","timestamp:str","data[]","data[]{}","data[].timestamp:str","data[].index{}","data[].index.symbol:str","data[].index.short_name:str","data[].index.long_name:str","data[].index.currency:str","data[].index.isin:str","data[].index.region:str","data[].constituents[]","data[].constituents[]{}","data[].constituents[].index_symbol:str","data[].constituents[].constituent_symbol:str"]},{"id":"cboe.index_quotes.cdn.cboe.com.api.global.european.indices.index.quotes.all.indices.10","name":"indices_europe_quotes","path":"/v1/indices/europe/quotes","method":"GET","family":"index_quotes","description":"Cboe European index quote snapshots.","assets":["indices"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","timestamp:str","data[]","data[]{}","data[].high:float","data[].exchange_id:int","data[].current_price:float","data[].close:float","data[].iv30_change_percent:int","data[].prev_day_close:float","data[].open:int","data[].security_type:str","data[].low:float","data[].ask_size:int","data[].symbol:str","data[].index:str","data[].bid_size:int","data[].iv30_change:float","data[].iv30:float","data[].seqno:int","data[].bid:float","data[].volume:int","data[].ask:float","data[].tick:str","data[].price_change_percent:float","data[].price_change:float","data[].last_trade_time:str","data[].status:str"]},{"id":"cboe.index_governance.cdn.cboe.com.api.global.us.indices.governance.data.us.consultation.11","name":"indices_us_governance_consultations","path":"/v1/indices/us/governance/consultations","method":"GET","family":"index_governance","description":"Cboe index governance and consultation data.","assets":["indices"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","us_consultation[]","us_consultation[]{}","us_consultation[].name:str","us_consultation[].description:str","us_consultation[].active:bool","us_consultation[].status:int","us_consultation[].link:str","us_consultation[].linkResult:str","us_consultation[].linkResultTitle:str","us_consultation[].startDate:str","us_consultation[].endDate:str","us_consultation[].questionIDs:str","us_consultation[].id:str"]},{"id":"cboe.delayed_quotes_history.cdn.cboe.com.api.global.delayed.quotes.historical.data.symbol.12","name":"delayed_quotes_history_symbol","path":"/v1/delayed-quotes/history/{symbol}","method":"GET","family":"delayed_quotes_history","description":"Cboe delayed quote historical-detail payloads.","assets":["equities","indices"],"body_type":"json","cache_ttl_seconds":300,"stale_seconds":3600,"implementation_status":"live","source_policy_status":"public_page_terms_noted","sample_shape_paths":["${}","timestamp:str","data{}","data.symbol:str","data.annual_high:float","data.hv30_annual_high:float","data.hv60_annual_high:float","data.hv90_annual_high:float","data.iv30_annual_high:float","data.iv60_annual_high:float","data.iv90_annual_high:float","data.annual_low:float","data.hv30_annual_low:float","data.hv60_annual_low:float","data.hv90_annual_low:float","data.iv30_annual_low:float","data.iv60_annual_low:float","data.iv90_annual_low:float","symbol:str"]},{"id":"cboe.delayed_quotes_chart.cdn.cboe.com.api.global.delayed.quotes.charts.intraday.symbol.13","name":"delayed_quotes_charts_intraday_symbol","path":"/v1/delayed-quotes/charts/intraday/{symbol}","method":"GET","family":"delayed_quotes_chart","description":"Cboe delayed quote chart series.","assets":["equities","indices"],"body_type":"json","cache_ttl_seconds":15,"stale_seconds":315,"implementation_status":"live","source_policy_status":"public_page_terms_noted","sample_shape_paths":["${}","timestamp:str","data[]","data[]{}","data[].datetime:str","data[].sequence_number:int","data[].price{}","data[].price.open:float","data[].price.high:float","data[].price.low:float","data[].price.close:float","data[].volume{}","data[].volume.stock_volume:int","data[].volume.calls_volume:int","data[].volume.puts_volume:int","data[].volume.total_options_volume:int","symbol:str"]},{"id":"cboe.delayed_quotes_chart.cdn.cboe.com.api.global.delayed.quotes.charts.one.month.symbol.14","name":"delayed_quotes_charts_one_month_symbol","path":"/v1/delayed-quotes/charts/one-month/{symbol}","method":"GET","family":"delayed_quotes_chart","description":"Cboe delayed quote chart series.","assets":["equities","indices"],"body_type":"json","cache_ttl_seconds":15,"stale_seconds":315,"implementation_status":"live","source_policy_status":"public_page_terms_noted","sample_shape_paths":["${}","timestamp:str","data[]","data[]{}","data[].datetime:str","data[].sequence_number:int","data[].price{}","data[].price.open:float","data[].price.high:float","data[].price.low:float","data[].price.close:float","data[].volume{}","data[].volume.stock_volume:int","data[].volume.calls_volume:int","data[].volume.puts_volume:int","data[].volume.total_options_volume:int","symbol:str"]},{"id":"cboe.delayed_quotes_chart.cdn.cboe.com.api.global.delayed.quotes.charts.historical.symbol.15","name":"delayed_quotes_charts_historical_symbol","path":"/v1/delayed-quotes/charts/historical/{symbol}","method":"GET","family":"delayed_quotes_chart","description":"Cboe delayed quote chart series.","assets":["equities","indices"],"body_type":"json","cache_ttl_seconds":15,"stale_seconds":315,"implementation_status":"live","source_policy_status":"public_page_terms_noted","sample_shape_paths":["${}","timestamp:str","data[]","data[]{}","data[].date:str","data[].volume:int","data[].open:float","data[].high:float","data[].low:float","data[].close:float","symbol:str"]},{"id":"cboe.options_chain.cdn.cboe.com.api.global.delayed.quotes.options.underlying.symbol.16","name":"delayed_quotes_options_underlying_symbol","path":"/v1/delayed-quotes/options/{underlying_symbol}","method":"GET","family":"options_chain","description":"Cboe delayed options chain payloads.","assets":["options"],"body_type":"json","cache_ttl_seconds":300,"stale_seconds":3600,"implementation_status":"live","source_policy_status":"public_page_terms_noted","sample_shape_paths":["${}","timestamp:str","data{}","data.options[]","data.options[]{}","data.options[].option:str","data.options[].bid:float","data.options[].bid_size:float","data.options[].ask:float","data.options[].ask_size:float","data.options[].iv:float","data.options[].open_interest:float","data.options[].volume:float","data.options[].delta:float","data.options[].gamma:float","data.options[].vega:float","data.options[].theta:float","data.options[].rho:float","data.options[].theo:float","data.options[].change:float","data.options[].open:float","data.options[].high:float","data.options[].low:float","data.options[].tick:str","data.options[].last_trade_price:float","data.options[].last_trade_time:str","data.options[].percent_change:float","data.options[].prev_day_close:float","data.symbol:str","data.security_type:str","data.exchange_id:int","data.current_price:float","data.price_change:float","data.price_change_percent:float","data.bid:float","data.ask:float","data.bid_size:int","data.ask_size:int","data.open:float","data.high:float","data.low:float","data.close:float","data.prev_day_close:float","data.volume:int","data.iv30:float","data.iv30_change:float","data.iv30_change_percent:float","data.seqno:int","data.last_trade_time:str","data.tick:str","symbol:str"]},{"id":"cboe.delayed_quotes_config.www.cboe.com.delayed.quote.api.servertime.18","name":"delayed_quotes_servertime","path":"/v1/delayed-quotes/servertime","method":"GET","family":"delayed_quotes_config","description":"Cboe delayed quote configuration and clock metadata.","assets":["equities","indices","options","futures"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"public_page_terms_noted","sample_shape_paths":["${}","server utc time:str"]},{"id":"cboe.futures_quotes.www.cboe.com.us.futures.api.get.quotes.combined.25","name":"futures_quotes_combined","path":"/v1/futures/quotes/combined","method":"GET","family":"futures_quotes","description":"Cboe futures quote/product data.","assets":["futures"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","data[]","data[]{}","data[].symbol:str","data[].expiration:str","data[].open:str","data[].close:str","data[].high:float","data[].low:float","data[].last_price:float","data[].prev_open_int:str","data[].current_open_int:str","data[].current_volume:str","data[].settlement:str","data[].prev_settlement:str","data[].change:float","data[].volume:str","data[].root_symbol:bool","lastUpdate:str"]},{"id":"cboe.futures_quotes.www.cboe.com.us.futures.api.data.26","name":"futures_data_www_root_symbol","path":"/v1/futures/data/www/{root_symbol}","method":"GET","family":"futures_quotes","description":"Cboe futures quote/product data.","assets":["futures"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","data[]","data[]{}","data[].symbol_id:str","data[].symbol:str","data[].expiration:str","data[].open:float","data[].last_price:float","data[].high:float","data[].low:float","data[].prev_close:float","data[].settlement:float","data[].prev_settlement:float","data[].change:NoneType","data[].volume:int","data[].prev_open_int:int","data[].current_open_int:int","data[].current_volume:int","data[].root_symbol:bool","lastUpdate:str"]},{"id":"cboe.futures_quotes.api.cboe.com.us.futures.api.data.27","name":"futures_data_root_symbol","path":"/v1/futures/data/{root_symbol}","method":"GET","family":"futures_quotes","description":"Cboe futures quote/product data.","assets":["futures"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","data[]","data[]{}","data[].symbol_id:str","data[].symbol:str","data[].expiration:str","data[].open:float","data[].last_price:float","data[].high:float","data[].low:float","data[].prev_close:float","data[].settlement:float","data[].prev_settlement:float","data[].change:NoneType","data[].volume:int","data[].prev_open_int:int","data[].current_open_int:int","data[].current_volume:int","data[].root_symbol:bool","lastUpdate:str"]},{"id":"cboe.system_status.cdn.cboe.com.api.global.system.status.system.status.28","name":"system_status","path":"/v1/system/status","method":"GET","family":"system_status","description":"Cboe global system status data.","assets":["equities","options","futures","fx"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","markets[]","markets[]{}","markets[].market:str","markets[].status:bool","markets[].message:NoneType","markets[].messageTranslations{}","markets[].asOfDateTime:str","markets[].exchange:str","markets[].exchangeLong:str","markets[].type:str","markets[].location:str","asOfDateTime:str"]},{"id":"cboe.fx_market_statistics.cdn.cboe.com.fx.adv30day.29","name":"fx_adv_30_day","path":"/v1/fx/adv-30-day","method":"GET","family":"fx_market_statistics","description":"Cboe FX volume and market statistics.","assets":["fx"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","SPOT{}","SPOT.LDN{}","SPOT.LDN.ecn_anonymous_firm_usdqty:float","SPOT.LDN.ecn_semidisclosed_firm_usdqty:float","SPOT.LDN.ecn_anonymous_nonfirm_usdqty:float","SPOT.LDN.ecn_semidisclosed_nonfirm_usdqty:float","SPOT.LDN.fa_anonymous_nonfirm_usdqty:float","SPOT.LDN.fa_semidisclosed_nonfirm_usdqty:float","SPOT.LDN.otheradv_anonymous_usdqty:float","SPOT.LDN.otheradv_semidisclosed_usdqty:float","SPOT.LDN.ecn_firm_total:float","SPOT.LDN.ecn_nonfirm_total:float","SPOT.LDN.fa_nonfirm_total:float","SPOT.LDN.otheradv_total:float","SPOT.NY{}","SPOT.NY.ecn_anonymous_firm_usdqty:float","SPOT.NY.ecn_semidisclosed_firm_usdqty:float","SPOT.NY.ecn_anonymous_nonfirm_usdqty:float","SPOT.NY.ecn_semidisclosed_nonfirm_usdqty:float","SPOT.NY.fa_anonymous_nonfirm_usdqty:float","SPOT.NY.fa_semidisclosed_nonfirm_usdqty:float","SPOT.NY.otheradv_anonymous_usdqty:float","SPOT.NY.otheradv_semidisclosed_usdqty:float","SPOT.NY.ecn_firm_total:float","SPOT.NY.ecn_nonfirm_total:float","SPOT.NY.fa_nonfirm_total:float","SPOT.NY.otheradv_total:float","SPOT.TOTAL{}","SPOT.TOTAL.ecn_anonymous_firm_usdqty:float","SPOT.TOTAL.ecn_semidisclosed_firm_usdqty:float","SPOT.TOTAL.ecn_anonymous_nonfirm_usdqty:float","SPOT.TOTAL.ecn_semidisclosed_nonfirm_usdqty:float","SPOT.TOTAL.fa_anonymous_nonfirm_usdqty:float","SPOT.TOTAL.fa_semidisclosed_nonfirm_usdqty:float","SPOT.TOTAL.otheradv_anonymous_usdqty:float","SPOT.TOTAL.otheradv_semidisclosed_usdqty:float","SPOT.TOTAL.ecn_firm_total:float","SPOT.TOTAL.ecn_nonfirm_total:float","SPOT.TOTAL.fa_nonfirm_total:float","SPOT.TOTAL.otheradv_total:float","NDF{}","NDF.LDN{}","NDF.LDN.ecn_anonymous_firm_usdqty:float","NDF.LDN.ecn_semidisclosed_firm_usdqty:float","NDF.LDN.ecn_anonymous_nonfirm_usdqty:float","NDF.LDN.ecn_semidisclosed_nonfirm_usdqty:float","NDF.LDN.fa_anonymous_nonfirm_usdqty:float","NDF.LDN.fa_semidisclosed_nonfirm_usdqty:float","NDF.LDN.otheradv_anonymous_usdqty:float","NDF.LDN.otheradv_semidisclosed_usdqty:float","NDF.LDN.ecn_firm_total:float","NDF.LDN.ecn_nonfirm_total:float","NDF.LDN.fa_nonfirm_total:float","NDF.LDN.otheradv_total:float","NDF.NY{}","NDF.NY.ecn_anonymous_firm_usdqty:float","NDF.NY.ecn_semidisclosed_firm_usdqty:float","NDF.NY.ecn_anonymous_nonfirm_usdqty:float","NDF.NY.ecn_semidisclosed_nonfirm_usdqty:float","NDF.NY.fa_anonymous_nonfirm_usdqty:float","NDF.NY.fa_semidisclosed_nonfirm_usdqty:float","NDF.NY.otheradv_anonymous_usdqty:float","NDF.NY.otheradv_semidisclosed_usdqty:float","NDF.NY.ecn_firm_total:float","NDF.NY.ecn_nonfirm_total:float","NDF.NY.fa_nonfirm_total:float","NDF.NY.otheradv_total:float","NDF.TOTAL{}","NDF.TOTAL.ecn_anonymous_firm_usdqty:float","NDF.TOTAL.ecn_semidisclosed_firm_usdqty:float","NDF.TOTAL.ecn_anonymous_nonfirm_usdqty:float","NDF.TOTAL.ecn_semidisclosed_nonfirm_usdqty:float","NDF.TOTAL.fa_anonymous_nonfirm_usdqty:float","NDF.TOTAL.fa_semidisclosed_nonfirm_usdqty:float","NDF.TOTAL.otheradv_anonymous_usdqty:float","NDF.TOTAL.otheradv_semidisclosed_usdqty:float","NDF.TOTAL.ecn_firm_total:float","NDF.TOTAL.ecn_nonfirm_total:float","NDF.TOTAL.fa_nonfirm_total:float","NDF.TOTAL.otheradv_total:float"]},{"id":"cboe.fx_market_statistics.cdn.cboe.com.fx.adv30daycard.30","name":"fx_adv_30_day_card","path":"/v1/fx/adv-30-day-card","method":"GET","family":"fx_market_statistics","description":"Cboe FX volume and market statistics.","assets":["fx"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","SPOT{}","SPOT.TOTAL:float","SPOT.PCT:float","SPOT.METALS_TOTAL:float","SPOT.METALS_PCT:float","SPOT.CCYPAIR_TOTAL:float","SPOT.CCYPAIR_PCT:float","NDF{}","NDF.TOTAL:float","NDF.PCT:float","COMBINED{}","COMBINED.TOTAL:float","COMBINED.PCT:float"]},{"id":"cboe.fx_market_statistics.cdn.cboe.com.fx.sefvolume.31","name":"fx_sef_volume","path":"/v1/fx/sef-volume","method":"GET","family":"fx_market_statistics","description":"Cboe FX volume and market statistics.","assets":["fx"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","daily[]","daily[]{}","daily[].trade-date:str","daily[].volume:str","daily_vols_trailing_month[]","daily_vols_trailing_month[]{}","daily_vols_trailing_month[].trade-date:str","daily_vols_trailing_month[].volume:str","monthly[]","monthly[]{}","monthly[].trading-days:str","monthly[].avg-daily-volume:str","monthly[].volume:str","monthly[].month:str","quarterly[]","quarterly[]{}","quarterly[].trading-days:str","quarterly[].volume:str","quarterly[].quarter:str","quarterly[].avg-daily-volume:str"]},{"id":"cboe.market_data_services.api.cboe.com.market.data.services.data.32","name":"market_data_services","path":"/v1/market-data-services","method":"GET","family":"market_data_services","description":"Cboe market data services catalog data.","assets":["equities","options","futures","fx","indices"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","vendorData[]","vendorData[]{}","vendorData[].name:str","vendorData[].provider_type[]","vendorData[].provider_type[]:str","vendorData[].geographic_region[]","vendorData[].url:str","vendorData[].contact[]","vendorData[].contact[][]","vendorData[].contact[][]:str","vendorData[].has_html_description:bool","vendorData[].description:str","vendorData[].logo:str","vendorData[].twitter:NoneType","vendorData[].slug_name:str","vendorData[].filters[]","vendorData[].filters[]:str","vendorData[].logo_url:str","marketTotals{}","marketTotals.fx:float","marketTotals.usOptions:float","marketShare[]","marketShare[]{}","marketShare[].venue:str","marketShare[].total:float","vix[]","vix[][]","vix[][]:str"]},{"id":"cboe.market_data_services.api.cboe.com.market.data.services.data.most.active.33","name":"market_data_services_most_active","path":"/v1/market-data-services/most-active","method":"GET","family":"market_data_services","description":"Cboe market data services catalog data.","assets":["equities","options","futures","indices"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","mostActive[]","mostActive[]{}","mostActive[].symbol:str","mostActive[].last_price:str","mostActive[].volume:str"]},{"id":"cboe.tradable_products.api.cboe.com.tradable.products.data.34","name":"tradable_products","path":"/v1/tradable-products","method":"GET","family":"tradable_products","description":"Cboe tradable products catalog data.","assets":["equities","options","futures","indices"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","data{}","data.equity[]","data.equity[]{}","data.equity[].underlying_root:str","data.equity[].trading_dt:str","data.equity[].volume:int","data.equity[].open_interest:int","data.equity[].title:str","data.equity[].display:str","data.volatility[]","data.volatility[]{}","data.volatility[].underlying_root:str","data.volatility[].trading_dt:str","data.volatility[].volume:int","data.volatility[].open_interest:int","data.volatility[].title:str","data.volatility[].display:str","data.credit_interest[]","data.credit_interest[]{}","data.credit_interest[].underlying_root:str","data.credit_interest[].trading_dt:str","data.credit_interest[].volume:int","data.credit_interest[].open_interest:int","data.credit_interest[].title:str","data.credit_interest[].display:str","data.international_equity[]","data.international_equity[]{}","data.international_equity[].underlying_root:str","data.international_equity[].trading_dt:str","data.international_equity[].volume:int","data.international_equity[].open_interest:int","data.international_equity[].title:str","data.international_equity[].display:str","data.crypto[]","data.crypto[]{}","data.crypto[].underlying_root:str","data.crypto[].trading_dt:str","data.crypto[].volume:int","data.crypto[].open_interest:int","data.crypto[].title:str","data.crypto[].display:str"]},{"id":"cboe.options_market_statistics.api.cboe.com.us.options.market.share.market.data.35","name":"options_market_share","path":"/v1/options/market-share","method":"GET","family":"options_market_statistics","description":"Cboe US options market statistics.","assets":["options"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","reload:int","data{}","data.top[]","data.stats{}","data.stats.integrated[]","data.stats.integrated[]{}","data.stats.integrated[].avg_weighting:int","data.stats.integrated[].mktshare:float","data.stats.integrated[].value:float","data.stats.integrated[].weighting:int","data.stats.integrated[].data[]","data.stats.integrated[].mktname:str","data.stats.integrated[].mkthtml:str","data.stats.integrated[].data_count:int","data.stats.integrated_count:int","data.totals{}","data.totals.normal[]","data.totals.integrated[]","data.totals.normal_count:int","data.totals.integrated_count:int","data.total{}","data.total.normal[]","data.total.normal[]:float","data.total.integrated[]","data.total.integrated[]:float","data.total.normal_count:int","data.total.integrated_count:int","data.avg_totals{}","data.avg_totals.normal[]","data.avg_totals.integrated[]","data.avg_totals.normal_count:int","data.avg_totals.integrated_count:int","data.avg_total{}","data.avg_total.normal[]","data.avg_total.normal[]:float","data.avg_total.integrated[]","data.avg_total.integrated[]:float","data.avg_total.normal_count:int","data.avg_total.integrated_count:int","data.comp_stats{}","data.comp_stats.data[]","data.comp_stats.data_count:int","data.type:str","data.end_ts:str","data.disclaimer:str","data.disabled[]","data.top_count:int","data.disabled_count:int","success:bool","statusText:str","statusCode:str","status:str"]},{"id":"cboe.options_market_statistics.api.cboe.com.us.options.market.statistics.most.active.data.36","name":"options_most_active","path":"/v1/options/most-active","method":"GET","family":"options_market_statistics","description":"Cboe US options market statistics.","assets":["options"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","limit:int","description:str","categories[]","categories[]{}","categories[].category:str","categories[].display:str","categories[].calls[]","categories[].calls[]{}","categories[].calls[].symbol:str","categories[].calls[].expires:str","categories[].calls[].strike:float","categories[].calls[].volume:int","categories[].puts[]","categories[].puts[]{}","categories[].puts[].symbol:str","categories[].puts[].expires:str","categories[].puts[].strike:float","categories[].puts[].volume:int","dt:str"]},{"id":"cboe.equities_market_statistics.api.cboe.com.us.equities.market.statistics.most.active.data.limit.37","name":"equities_us_most_active","path":"/v1/equities/us/most-active","method":"GET","family":"equities_market_statistics","description":"Cboe equities market statistics.","assets":["equities"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","success:str","ttl:int","ts:str","data{}","data.bzx[]","data.bzx[][]","data.bzx[][]:str","mo:bool"]},{"id":"cboe.equities_market_statistics.api.cboe.com.europe.equities.market.statistics.most.active.data.limit.38","name":"equities_europe_most_active","path":"/v1/equities/europe/most-active","method":"GET","family":"equities_market_statistics","description":"Cboe equities market statistics.","assets":["equities"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","success:str","ttl:float","ts:str","data{}","data.cxe[]","data.cxe[][]","data.cxe[][]:str","mo:bool"]},{"id":"cboe.equities_market_statistics.api.cboe.com.ca.equities.top.ten.volume.39","name":"equities_ca_top_ten_volume","path":"/v1/equities/ca/top-ten-volume","method":"GET","family":"equities_market_statistics","description":"Cboe equities market statistics.","assets":["equities"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","data[]","data[]{}","data[].name:str","data[].bats_name:str","data[].company_name:str","data[].last_price:str","data[].percent_change:str","data[].vol:int","data[].trade_time:str","data[].ts:str"]},{"id":"cboe.equities_market_statistics.api.cboe.com.ca.equities.market.totals.40","name":"equities_ca_market_totals","path":"/v1/equities/ca/market-totals","method":"GET","family":"equities_market_statistics","description":"Cboe equities market statistics.","assets":["equities"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","data[]","data[]{}","data[].total_volume:str","data[].total_value:str","data[].trade_count:int","data[].ts:str"]},{"id":"cboe.equities_market_statistics.api.cboe.com.ca.equities.symbol.totals.41","name":"equities_ca_symbol_totals","path":"/v1/equities/ca/symbol-totals","method":"GET","family":"equities_market_statistics","description":"Cboe equities market statistics.","assets":["equities"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","data[]","data[]{}","data[].advancers:int","data[].decliners:int","data[].unchanged:int"]},{"id":"cboe.listing_directory.api.cboe.com.ca.equities.listing.directory.data.42","name":"equities_ca_listing_directory","path":"/v1/equities/ca/listing-directory","method":"GET","family":"listing_directory","description":"Cboe listing directory data.","assets":["equities"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","data[]","data[]{}","data[].symbol:str","data[].name:str","data[].currency:str","data[].security:str","data[].security_sub_type:str","data[].marketcap:float","data[].last:float","data[].changepcnt:float","data[].volume:int"]},{"id":"cboe.equities_market_statistics.api.cboe.com.au.equities.today.activity.data.43","name":"equities_au_today_activity","path":"/v1/equities/au/today-activity","method":"GET","family":"equities_market_statistics","description":"Cboe equities market statistics.","assets":["equities"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","data[]","data[]{}","data[].id:str","data[].label:str","data[].summary[]","data[].summary[]{}","data[].summary[].title:str","data[].summary[].subtext:str","data[].summary[].value:str","data[].summary[].subtitle:str","data[].summary[].subtitlevalue:str","data[].url:str","retrieved_at:str","display:str","success:bool"]},{"id":"cboe.book_viewer.ww2.cboe.com.au.equities.market.statistics.book.viewer.2.symbol.lookup.data.44","name":"equities_au_book_viewer_symbols","path":"/v1/equities/au/book-viewer/symbols","method":"GET","family":"book_viewer","description":"Cboe book-viewer lookup and depth data.","assets":["equities"],"body_type":"json","cache_ttl_seconds":600,"stale_seconds":7200,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","symbolsLookupData[]","symbolsLookupData[]{}","symbolsLookupData[].name:str","symbolsLookupData[].company_name:str"]},{"id":"cboe.europe_market_share.www.cboe.com.europe.equities.market.share.market.venue.data.46","name":"equities_europe_market_share_range","path":"/v1/equities/europe/market-share/range","method":"GET","family":"europe_market_share","description":"Cboe Europe venue market-share data.","assets":["equities"],"body_type":"csv","cache_ttl_seconds":30,"stale_seconds":360,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":[]},{"id":"cboe.europe_market_share.www.cboe.com.europe.equities.market.share.market.venue.data.47","name":"equities_europe_market_share_trailing","path":"/v1/equities/europe/market-share/trailing","method":"GET","family":"europe_market_share","description":"Cboe Europe venue market-share data.","assets":["equities"],"body_type":"csv","cache_ttl_seconds":30,"stale_seconds":360,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":[]},{"id":"cboe.index_settlement.www.cboe.com.index.settlement.values.getyears.settlement.type.48","name":"index_settlement_years_settlement_type","path":"/v1/index-settlement/years/{settlement_type}","method":"GET","family":"index_settlement","description":"Cboe index settlement value metadata and history.","assets":["options","indices"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","data[]","data[]:int"]},{"id":"cboe.index_settlement.www.cboe.com.index.settlement.values.get.sv.data.settlement.type.year.49","name":"index_settlement_values_settlement_type_year","path":"/v1/index-settlement/values/{settlement_type}/{year}","method":"GET","family":"index_settlement","description":"Cboe index settlement value metadata and history.","assets":["options","indices"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","data[]","data[]{}","data[].description:str","data[].trading_symbol:str","data[].expiration_date:str","data[].settlement_symbol:str","data[].settlement_value:float","data[].display_order:int"]},{"id":"cboe.futures_settlement.api.cboe.com.us.futures.market.statistics.final.settlement.prices.values.futures.50","name":"futures_settlement_final_prices","path":"/v1/futures/settlement/final-prices","method":"GET","family":"futures_settlement","description":"Cboe futures settlement values.","assets":["futures"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","selectedYear:int","yearList[]","yearList[]:int","data[]","data[]{}","data[].product:str","data[].weekly_settlement_prices[]","data[].monthly_settlement_prices[]","data[].monthly_settlement_prices[]{}","data[].monthly_settlement_prices[].symbol_name:str","data[].monthly_settlement_prices[].expire_date:str","data[].monthly_settlement_prices[].price:float","data[].monthly_settlement_prices[].delta:str","data[].monthly_settlement_prices[].exercise_price:NoneType","data[].monthly_settlement_prices[].settlement_var:NoneType","data[].monthly_settlement_prices[].calculation_method:str","data[].option_settlement_prices[]"]},{"id":"cboe.futures_settlement_download.api.cboe.com.us.futures.market.statistics.final.settlement.prices.55","name":"futures_settlement_final_prices_csv","path":"/v1/futures/settlement/final-prices.csv","method":"GET","family":"futures_settlement_download","description":"Cboe futures settlement CSV downloads.","assets":["futures"],"body_type":"csv","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":[]},{"id":"cboe.futures_settlement_download.api.cboe.com.us.futures.market.statistics.settlement.56","name":"futures_settlement_daily_csv","path":"/v1/futures/settlement/daily.csv","method":"GET","family":"futures_settlement_download","description":"Cboe futures settlement CSV downloads.","assets":["futures"],"body_type":"csv","cache_ttl_seconds":30,"stale_seconds":360,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":[]},{"id":"cboe.notices.www.cboe.com.au.equities.notices.data.system.year.57","name":"notices_au_system_year","path":"/v1/notices/au/system/{year}","method":"GET","family":"notices","description":"Cboe exchange notice feeds.","assets":["equities"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","ttl:int","alerts[]","year_list[]","year_list[]:int","success:bool","statusText:str","statusCode:str","status:str","alerts_count:int","year_list_count:int"]},{"id":"cboe.notices.www.cboe.com.ca.equities.notices.data.system.year.58","name":"notices_ca_system_year","path":"/v1/notices/ca/system/{year}","method":"GET","family":"notices","description":"Cboe exchange notice feeds.","assets":["equities"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","ttl:int","alerts[]","alerts[]{}","alerts[].subject:str","alerts[].message_ts:str","alerts[].message:str","alerts[].type:str","alerts[].id:int","alerts[].message_rss_ts:str","year_list[]","year_list[]:int","success:bool","statusText:str","statusCode:str","status:str","alerts_count:int","year_list_count:int"]},{"id":"cboe.notices.www.cboe.com.europe.equities.notices.data.trf.system.year.59","name":"notices_europe_trf_system_year","path":"/v1/notices/europe/trf-system/{year}","method":"GET","family":"notices","description":"Cboe exchange notice feeds.","assets":["equities"],"body_type":"json","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":["${}","ttl:float","alerts[]","alerts[]{}","alerts[].subject:str","alerts[].message_ts:str","alerts[].message:str","alerts[].type:str","alerts[].id:int","alerts[].message_rss_ts:str","year_list[]","year_list[]:int","success:bool","statusText:str","statusCode:str","status:str","alerts_count:int","year_list_count:int"]},{"id":"cboe.equities_download.www.cboe.com.us.equities.market.statistics.halts.downloads.batshaltsyear.60","name":"equities_us_halts_csv","path":"/v1/equities/us/halts.csv","method":"GET","family":"equities_download","description":"Cboe equities CSV downloads.","assets":["equities"],"body_type":"csv","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":[]},{"id":"cboe.equities_download.www.cboe.com.us.equities.market.statistics.short.sale.circuit.breakers.downloads.61","name":"equities_us_short_sale_circuit_breakers_csv","path":"/v1/equities/us/short-sale-circuit-breakers.csv","method":"GET","family":"equities_download","description":"Cboe equities CSV downloads.","assets":["equities"],"body_type":"csv","cache_ttl_seconds":5,"stale_seconds":305,"implementation_status":"live","source_policy_status":"standard_public_web","sample_shape_paths":[]}]}