{"components":{"schemas":{"Error":{"properties":{"error":{"type":"string"},"estimated_bytes":{"type":"integer"},"export_url":{"type":"string"},"limit_bytes":{"type":"integer"},"message":{"type":"string"},"plan":{"type":"string"},"retry_after_seconds":{"type":"integer"}},"required":["error","message"],"type":"object"},"Plan":{"properties":{"export":{"type":"boolean"},"history":{"type":"boolean"},"id":{"enum":["free","pro","enterprise"],"type":"string"},"max_history_days":{"type":["integer","null"]},"name":{"type":"string"},"requests_per_minute":{"type":"integer"},"websocket":{"type":"boolean"}},"type":"object"},"market_quotes_row":{"properties":{"as_of":{"format":"date","type":["string","null"]},"change":{"format":"double","type":["number","null"]},"change_pct":{"format":"double","type":["number","null"]},"cik":{"format":"int64","type":["integer","null"]},"city":{"type":["string","null"]},"fetched_at":{"format":"date-time","type":["string","null"]},"high_price":{"format":"double","type":["number","null"]},"homepage_url":{"type":["string","null"]},"list_date":{"format":"date","type":["string","null"]},"locale":{"type":["string","null"]},"low_price":{"format":"double","type":["number","null"]},"market_cap":{"format":"double","type":["number","null"]},"name":{"type":["string","null"]},"open_price":{"format":"double","type":["number","null"]},"prev_close":{"format":"double","type":["number","null"]},"price":{"format":"double","type":["number","null"]},"primary_exchange":{"type":["string","null"]},"sector":{"type":["string","null"]},"sic_code":{"type":["string","null"]},"sic_description":{"type":["string","null"]},"state":{"type":["string","null"]},"ticker":{"type":["string","null"]},"total_employees":{"format":"int32","type":["integer","null"]},"type":{"type":["string","null"]},"updated_at":{"format":"date-time","type":["string","null"]},"volume":{"format":"double","type":["number","null"]},"vwap":{"format":"double","type":["number","null"]},"weighted_shares_outstanding":{"format":"int64","type":["integer","null"]}},"required":["ticker","as_of","price","open_price","high_price","low_price","prev_close","change","change_pct","volume","vwap","updated_at","fetched_at","name","type","primary_exchange","cik","market_cap","sic_code","sic_description","locale","city","state","total_employees","list_date","weighted_shares_outstanding","homepage_url","sector"],"type":"object"},"market_snapshots_row":{"properties":{"change_pct":{"format":"double","type":["number","null"]},"cik":{"format":"int64","type":["integer","null"]},"city":{"type":["string","null"]},"close_price":{"format":"double","type":["number","null"]},"high_price":{"format":"double","type":["number","null"]},"homepage_url":{"type":["string","null"]},"inserted_at":{"format":"date-time","type":["string","null"]},"list_date":{"format":"date","type":["string","null"]},"locale":{"type":["string","null"]},"low_price":{"format":"double","type":["number","null"]},"market_cap":{"format":"double","type":["number","null"]},"name":{"type":["string","null"]},"open_price":{"format":"double","type":["number","null"]},"primary_exchange":{"type":["string","null"]},"sector":{"type":["string","null"]},"sic_code":{"type":["string","null"]},"sic_description":{"type":["string","null"]},"state":{"type":["string","null"]},"ticker":{"type":["string","null"]},"total_employees":{"format":"int32","type":["integer","null"]},"trading_day":{"format":"date","type":["string","null"]},"transaction_count":{"format":"int32","type":["integer","null"]},"type":{"type":["string","null"]},"volume":{"format":"double","type":["number","null"]},"vwap":{"format":"double","type":["number","null"]},"weighted_shares_outstanding":{"format":"int64","type":["integer","null"]}},"required":["ticker","trading_day","open_price","high_price","low_price","close_price","change_pct","volume","vwap","transaction_count","inserted_at","name","type","primary_exchange","cik","market_cap","sic_code","sic_description","locale","city","state","total_employees","list_date","weighted_shares_outstanding","homepage_url","sector"],"type":"object"},"market_ticker_details_row":{"properties":{"as_of":{"format":"date","type":["string","null"]},"city":{"type":["string","null"]},"description":{"type":["string","null"]},"homepage_url":{"type":["string","null"]},"list_date":{"format":"date","type":["string","null"]},"locale":{"type":["string","null"]},"market_cap":{"format":"double","type":["number","null"]},"share_class_shares_outstanding":{"format":"int64","type":["integer","null"]},"sic_code":{"type":["string","null"]},"sic_description":{"type":["string","null"]},"state":{"type":["string","null"]},"ticker":{"type":["string","null"]},"total_employees":{"format":"int32","type":["integer","null"]},"updated_at":{"format":"date-time","type":["string","null"]},"weighted_shares_outstanding":{"format":"int64","type":["integer","null"]}},"required":["ticker","market_cap","sic_code","sic_description","locale","total_employees","list_date","share_class_shares_outstanding","weighted_shares_outstanding","description","homepage_url","city","state","as_of","updated_at"],"type":"object"},"market_tickers_row":{"properties":{"active":{"type":["boolean","null"]},"as_of":{"format":"date","type":["string","null"]},"cik":{"format":"int64","type":["integer","null"]},"composite_figi":{"type":["string","null"]},"delisted_utc":{"format":"date-time","type":["string","null"]},"last_updated_utc":{"format":"date-time","type":["string","null"]},"market":{"type":["string","null"]},"name":{"type":["string","null"]},"primary_exchange":{"type":["string","null"]},"share_class_figi":{"type":["string","null"]},"ticker":{"type":["string","null"]},"type":{"type":["string","null"]},"updated_at":{"format":"date-time","type":["string","null"]}},"required":["ticker","name","type","market","primary_exchange","cik","composite_figi","share_class_figi","active","delisted_utc","last_updated_utc","as_of","updated_at"],"type":"object"},"news_articles_row":{"properties":{"badge":{"type":["string","null"]},"company_name":{"type":["string","null"]},"date_added":{"format":"date","type":["string","null"]},"datetime":{"format":"date-time","type":["string","null"]},"description":{"type":["string","null"]},"id":{"format":"int32","type":["integer","null"]},"keyword":{"type":["string","null"]},"natural_key":{"type":["string","null"]},"quote_as_of":{"format":"date","type":["string","null"]},"quote_change_pct":{"format":"double","type":["number","null"]},"quote_high":{"format":"double","type":["number","null"]},"quote_low":{"format":"double","type":["number","null"]},"quote_open":{"format":"double","type":["number","null"]},"quote_prev_close":{"format":"double","type":["number","null"]},"quote_price":{"format":"double","type":["number","null"]},"quote_updated_at":{"format":"date-time","type":["string","null"]},"quote_volume":{"format":"double","type":["number","null"]},"quote_vwap":{"format":"double","type":["number","null"]},"release_period":{"type":["string","null"]},"sentiment_compound":{"format":"double","type":["number","null"]},"sentiment_neg":{"format":"double","type":["number","null"]},"sentiment_neu":{"format":"double","type":["number","null"]},"sentiment_pos":{"format":"double","type":["number","null"]},"source":{"type":["string","null"]},"ticker":{"type":["string","null"]},"title":{"type":["string","null"]},"url":{"type":["string","null"]}},"required":["id","datetime","source","ticker","company_name","title","description","url","keyword","badge","release_period","sentiment_compound","sentiment_pos","sentiment_neg","sentiment_neu","natural_key","date_added"],"type":"object"},"options_flow_row":{"properties":{"avg_volume_20d":{"format":"double","type":["number","null"]},"contract":{"type":["string","null"]},"contract_type":{"type":["string","null"]},"delta":{"format":"double","type":["number","null"]},"dollar_premium":{"format":"double","type":["number","null"]},"expiration":{"format":"date","type":["string","null"]},"id":{"format":"int64","type":["integer","null"]},"inserted_at":{"format":"date-time","type":["string","null"]},"is_block":{"type":["boolean","null"]},"is_sweep":{"type":["boolean","null"]},"iv":{"format":"double","type":["number","null"]},"open_interest":{"format":"double","type":["number","null"]},"otm_pct":{"format":"double","type":["number","null"]},"quote_as_of":{"format":"date","type":["string","null"]},"quote_change_pct":{"format":"double","type":["number","null"]},"quote_high":{"format":"double","type":["number","null"]},"quote_low":{"format":"double","type":["number","null"]},"quote_open":{"format":"double","type":["number","null"]},"quote_prev_close":{"format":"double","type":["number","null"]},"quote_price":{"format":"double","type":["number","null"]},"quote_updated_at":{"format":"date-time","type":["string","null"]},"quote_volume":{"format":"double","type":["number","null"]},"quote_vwap":{"format":"double","type":["number","null"]},"reason":{"type":["string","null"]},"strike":{"format":"double","type":["number","null"]},"ticker":{"type":["string","null"]},"trading_day":{"format":"date","type":["string","null"]},"vol_oi_ratio":{"format":"double","type":["number","null"]},"vol_ratio":{"format":"double","type":["number","null"]},"volume":{"format":"double","type":["number","null"]}},"required":["id","ticker","contract","trading_day","contract_type","strike","expiration","volume","avg_volume_20d","vol_ratio","open_interest","vol_oi_ratio","dollar_premium","otm_pct","iv","delta","is_block","is_sweep","reason","inserted_at"],"type":"object"},"rates_sofr_row":{"properties":{"avg_180d":{"format":"double","type":["number","null"]},"avg_30d":{"format":"double","type":["number","null"]},"avg_90d":{"format":"double","type":["number","null"]},"date":{"format":"date","type":["string","null"]},"date_added":{"format":"date","type":["string","null"]},"id":{"format":"int32","type":["integer","null"]},"percentile_1":{"format":"double","type":["number","null"]},"percentile_25":{"format":"double","type":["number","null"]},"percentile_75":{"format":"double","type":["number","null"]},"percentile_99":{"format":"double","type":["number","null"]},"rate":{"format":"double","type":["number","null"]},"volume_billions":{"format":"double","type":["number","null"]}},"required":["id","date","rate","percentile_1","percentile_25","percentile_75","percentile_99","volume_billions","avg_30d","avg_90d","avg_180d","date_added"],"type":"object"},"rates_yield_curve_row":{"properties":{"date":{"format":"date","type":["string","null"]},"five_year":{"format":"double","type":["number","null"]},"id":{"format":"int32","type":["integer","null"]},"seven_year":{"format":"double","type":["number","null"]},"ten_year":{"format":"double","type":["number","null"]},"thirty_year":{"format":"double","type":["number","null"]},"twenty_year":{"format":"double","type":["number","null"]}},"required":["id","date","five_year","seven_year","ten_year","twenty_year","thirty_year"],"type":"object"},"research_clinical_trials_row":{"properties":{"added_at":{"format":"date-time","type":["string","null"]},"adverse_events":{},"brief_title":{"type":["string","null"]},"collaborators":{},"completion_date":{"format":"date","type":["string","null"]},"conditions":{},"id":{"format":"int32","type":["integer","null"]},"interventions":{},"key_secondary_outcomes":{},"lead_sponsor":{"type":["string","null"]},"nct_id":{"type":["string","null"]},"overall_status":{"type":["string","null"]},"participant_flow":{},"primary_outcomes":{},"results_posted_date":{"format":"date","type":["string","null"]},"start_date":{"format":"date","type":["string","null"]}},"required":["id","nct_id","brief_title","overall_status","start_date","completion_date","results_posted_date","lead_sponsor","collaborators","conditions","interventions","primary_outcomes","key_secondary_outcomes","adverse_events","participant_flow","added_at"],"type":"object"},"research_patents_row":{"properties":{"contributors":{"type":["string","null"]},"creator":{"type":["string","null"]},"date_added":{"format":"date","type":["string","null"]},"description":{"type":["string","null"]},"id":{"format":"int32","type":["integer","null"]},"identifier1":{"type":["string","null"]},"identifier2":{"type":["string","null"]},"link":{"type":["string","null"]},"pub_date":{"format":"date-time","type":["string","null"]},"title":{"type":["string","null"]}},"required":["id","title","link","description","pub_date","creator","contributors","identifier1","identifier2","date_added"],"type":"object"},"sec_13f_filings_row":{"properties":{"accepted_at":{"format":"date-time","type":["string","null"]},"accession_number":{"type":["string","null"]},"amendment_type":{"type":["string","null"]},"filer_cik":{"format":"int64","type":["integer","null"]},"filer_city":{"type":["string","null"]},"filer_name":{"type":["string","null"]},"filer_state":{"type":["string","null"]},"filing_date":{"format":"date","type":["string","null"]},"form_type":{"type":["string","null"]},"holdings_count":{"format":"int32","type":["integer","null"]},"holdings_value":{"format":"double","type":["number","null"]},"inserted_at":{"format":"date-time","type":["string","null"]},"is_amendment":{"type":["boolean","null"]},"is_confidential_omitted":{"type":["boolean","null"]},"other_managers_count":{"format":"int32","type":["integer","null"]},"period_of_report":{"format":"date","type":["string","null"]},"report_type":{"type":["string","null"]}},"required":["accession_number","filing_date","accepted_at","form_type","filer_cik","filer_name","period_of_report","report_type","is_amendment","amendment_type","other_managers_count","holdings_count","holdings_value","is_confidential_omitted","filer_city","filer_state","inserted_at"],"type":"object"},"sec_13f_holdings_row":{"properties":{"accession_number":{"type":["string","null"]},"cusip":{"type":["string","null"]},"filer_cik":{"format":"int64","type":["integer","null"]},"filer_name":{"type":["string","null"]},"filing_date":{"format":"date","type":["string","null"]},"id":{"format":"int64","type":["integer","null"]},"investment_discretion":{"type":["string","null"]},"name_of_issuer":{"type":["string","null"]},"period_of_report":{"format":"date","type":["string","null"]},"put_call":{"type":["string","null"]},"quote_as_of":{"format":"date","type":["string","null"]},"quote_change_pct":{"format":"double","type":["number","null"]},"quote_high":{"format":"double","type":["number","null"]},"quote_low":{"format":"double","type":["number","null"]},"quote_open":{"format":"double","type":["number","null"]},"quote_prev_close":{"format":"double","type":["number","null"]},"quote_price":{"format":"double","type":["number","null"]},"quote_updated_at":{"format":"date-time","type":["string","null"]},"quote_volume":{"format":"double","type":["number","null"]},"quote_vwap":{"format":"double","type":["number","null"]},"seq":{"format":"int32","type":["integer","null"]},"shares":{"format":"double","type":["number","null"]},"shares_type":{"type":["string","null"]},"ticker":{"type":["string","null"]},"title_of_class":{"type":["string","null"]},"value_usd":{"format":"double","type":["number","null"]},"voting_none":{"format":"double","type":["number","null"]},"voting_shared":{"format":"double","type":["number","null"]},"voting_sole":{"format":"double","type":["number","null"]}},"required":["id","accession_number","filing_date","filer_name","filer_cik","period_of_report","seq","name_of_issuer","title_of_class","cusip","ticker","value_usd","shares","shares_type","put_call","investment_discretion","voting_sole","voting_shared","voting_none"],"type":"object"},"sec_filings_row":{"properties":{"accepted_at":{"format":"date-time","type":["string","null"]},"accession_number":{"type":["string","null"]},"cik":{"format":"int64","type":["integer","null"]},"company_name":{"type":["string","null"]},"filing_date":{"format":"date","type":["string","null"]},"form_type":{"type":["string","null"]},"index_url":{"type":["string","null"]},"inserted_at":{"format":"date-time","type":["string","null"]},"quote_as_of":{"format":"date","type":["string","null"]},"quote_change_pct":{"format":"double","type":["number","null"]},"quote_high":{"format":"double","type":["number","null"]},"quote_low":{"format":"double","type":["number","null"]},"quote_open":{"format":"double","type":["number","null"]},"quote_prev_close":{"format":"double","type":["number","null"]},"quote_price":{"format":"double","type":["number","null"]},"quote_updated_at":{"format":"date-time","type":["string","null"]},"quote_volume":{"format":"double","type":["number","null"]},"quote_vwap":{"format":"double","type":["number","null"]},"source":{"type":["string","null"]},"ticker":{"type":["string","null"]}},"required":["accession_number","filing_date","accepted_at","form_type","company_name","ticker","cik","index_url","source","inserted_at"],"type":"object"},"sec_insider_filings_row":{"properties":{"accession_number":{"type":["string","null"]},"aff_10b5_one":{"type":["boolean","null"]},"document_type":{"type":["string","null"]},"filing_date":{"format":"date","type":["string","null"]},"inserted_at":{"format":"date-time","type":["string","null"]},"issuer_cik":{"format":"int64","type":["integer","null"]},"issuer_name":{"type":["string","null"]},"owners":{"type":["string","null"]},"period_of_report":{"format":"date","type":["string","null"]},"quote_as_of":{"format":"date","type":["string","null"]},"quote_change_pct":{"format":"double","type":["number","null"]},"quote_high":{"format":"double","type":["number","null"]},"quote_low":{"format":"double","type":["number","null"]},"quote_open":{"format":"double","type":["number","null"]},"quote_prev_close":{"format":"double","type":["number","null"]},"quote_price":{"format":"double","type":["number","null"]},"quote_updated_at":{"format":"date-time","type":["string","null"]},"quote_volume":{"format":"double","type":["number","null"]},"quote_vwap":{"format":"double","type":["number","null"]},"shares_acquired":{"format":"double","type":["number","null"]},"shares_disposed":{"format":"double","type":["number","null"]},"source":{"type":["string","null"]},"ticker":{"type":["string","null"]},"trans_codes":{"type":["string","null"]},"transactions":{"format":"int64","type":["integer","null"]}},"required":["accession_number","filing_date","document_type","period_of_report","issuer_name","ticker","issuer_cik","owners","transactions","shares_acquired","shares_disposed","trans_codes","aff_10b5_one","source","inserted_at"],"type":"object"},"sec_insider_transactions_row":{"properties":{"accession_number":{"type":["string","null"]},"conv_exercise_price":{"format":"double","type":["number","null"]},"direct_indirect_ownership":{"type":["string","null"]},"document_type":{"type":["string","null"]},"exercise_date":{"format":"date","type":["string","null"]},"expiration_date":{"format":"date","type":["string","null"]},"filing_date":{"format":"date","type":["string","null"]},"footnote_ids":{"type":["string","null"]},"id":{"format":"int64","type":["integer","null"]},"issuer_cik":{"format":"int64","type":["integer","null"]},"issuer_name":{"type":["string","null"]},"nature_of_ownership":{"type":["string","null"]},"quote_as_of":{"format":"date","type":["string","null"]},"quote_change_pct":{"format":"double","type":["number","null"]},"quote_high":{"format":"double","type":["number","null"]},"quote_low":{"format":"double","type":["number","null"]},"quote_open":{"format":"double","type":["number","null"]},"quote_prev_close":{"format":"double","type":["number","null"]},"quote_price":{"format":"double","type":["number","null"]},"quote_updated_at":{"format":"date-time","type":["string","null"]},"quote_volume":{"format":"double","type":["number","null"]},"quote_vwap":{"format":"double","type":["number","null"]},"security_title":{"type":["string","null"]},"shares_owned_following":{"format":"double","type":["number","null"]},"table_type":{"type":["string","null"]},"ticker":{"type":["string","null"]},"trans_acquired_disposed_cd":{"type":["string","null"]},"trans_code":{"type":["string","null"]},"trans_date":{"format":"date","type":["string","null"]},"trans_price_per_share":{"format":"double","type":["number","null"]},"trans_shares":{"format":"double","type":["number","null"]},"trans_total_value":{"format":"double","type":["number","null"]},"underlying_security_shares":{"format":"double","type":["number","null"]},"underlying_security_title":{"type":["string","null"]},"value_owned_following":{"format":"double","type":["number","null"]}},"required":["id","accession_number","filing_date","document_type","issuer_name","ticker","issuer_cik","table_type","security_title","trans_date","trans_code","trans_shares","trans_price_per_share","trans_total_value","trans_acquired_disposed_cd","shares_owned_following","value_owned_following","direct_indirect_ownership","nature_of_ownership","conv_exercise_price","exercise_date","expiration_date","underlying_security_title","underlying_security_shares","footnote_ids"],"type":"object"}},"securitySchemes":{"bearerAuth":{"description":"Account API key","scheme":"bearer","type":"http"},"queryApiKey":{"in":"query","name":"apikey","type":"apiKey"}}},"info":{"description":"Read API and realtime feed. Every `/today` endpoint returns the last 24 hours of data (date-keyed categories include today and yesterday). Generated at startup from route registrations and category metadata. Plain query dates use America/New_York; date/time bounds are inclusive. Authenticated requests are rate limited by plan. GET routes also accept HEAD.","title":"ALPHASATURN API","version":"0.1.0"},"openapi":"3.1.0","paths":{"/openapi.json":{"get":{"parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Success"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[],"summary":"OpenAPI document","tags":["metadata"]}},"/v1/categories":{"get":{"parameters":[],"responses":{"200":{"content":{"application/json":{"example":{"categories":[{"columns":[{"name":"id","type":"int32"},{"name":"datetime","type":"timestamp"},{"name":"source","type":"text"},{"name":"ticker","type":"text"},{"name":"company_name","type":"text"},{"name":"title","type":"text"},{"name":"description","type":"text"},{"name":"url","type":"text"},{"name":"keyword","type":"text"},{"name":"badge","type":"text"},{"name":"release_period","type":"text"},{"name":"sentiment_compound","type":"float64"},{"name":"sentiment_pos","type":"float64"},{"name":"sentiment_neg","type":"float64"},{"name":"sentiment_neu","type":"float64"},{"name":"natural_key","type":"text"},{"name":"date_added","type":"date"}],"endpoint":"/v1/news/articles","enrich_columns":[{"name":"quote_price","type":"float64"},{"name":"quote_change_pct","type":"float64"},{"name":"quote_prev_close","type":"float64"},{"name":"quote_open","type":"float64"},{"name":"quote_high","type":"float64"},{"name":"quote_low","type":"float64"},{"name":"quote_vwap","type":"float64"},{"name":"quote_volume","type":"float64"},{"name":"quote_as_of","type":"date"},{"name":"quote_updated_at","type":"timestamptz"}],"enrich_data":true,"fetch":"/v1/news/articles/{id}","filters":[{"column":"ticker","list":true,"match":"exact","param":"ticker"},{"column":"source","list":false,"match":"prefix","param":"source"},{"column":"source","list":true,"match":"exclude","param":"exclude_source"},{"column":"title","list":false,"match":"contains","param":"title"},{"column":"release_period","list":true,"match":"exact","param":"release_period"}],"history":true,"key":["id"],"path":"news/articles","ticker":"ticker","time":"datetime","websocket":true},{"columns":[{"name":"ticker","type":"text"},{"name":"trading_day","type":"date"},{"name":"open_price","type":"float64"},{"name":"high_price","type":"float64"},{"name":"low_price","type":"float64"},{"name":"close_price","type":"float64"},{"name":"change_pct","type":"float64"},{"name":"volume","type":"float64"},{"name":"vwap","type":"float64"},{"name":"transaction_count","type":"int32"},{"name":"inserted_at","type":"timestamptz"},{"name":"name","type":"text"},{"name":"type","type":"text"},{"name":"primary_exchange","type":"text"},{"name":"cik","type":"int64"},{"name":"market_cap","type":"float64"},{"name":"sic_code","type":"text"},{"name":"sic_description","type":"text"},{"name":"locale","type":"text"},{"name":"city","type":"text"},{"name":"state","type":"text"},{"name":"total_employees","type":"int32"},{"name":"list_date","type":"date"},{"name":"weighted_shares_outstanding","type":"int64"},{"name":"homepage_url","type":"text"},{"name":"sector","type":"text"}],"endpoint":"/v1/market/snapshots","enrich_columns":[],"enrich_data":false,"fetch":null,"filters":[{"column":"ticker","list":true,"match":"exact","param":"ticker"},{"column":"type","list":true,"match":"exact","param":"type"},{"column":"primary_exchange","list":true,"match":"exact","param":"primary_exchange"},{"column":"sector","list":true,"match":"exact","param":"sector"},{"column":"sic_description","list":true,"match":"exact","param":"sic_description"},{"column":"name","list":false,"match":"contains","param":"name"}],"history":true,"key":["ticker","trading_day"],"path":"market/snapshots","ticker":"ticker","time":"trading_day","websocket":false},{"columns":[{"name":"ticker","type":"text"},{"name":"as_of","type":"date"},{"name":"price","type":"float64"},{"name":"open_price","type":"float64"},{"name":"high_price","type":"float64"},{"name":"low_price","type":"float64"},{"name":"prev_close","type":"float64"},{"name":"change","type":"float64"},{"name":"change_pct","type":"float64"},{"name":"volume","type":"float64"},{"name":"vwap","type":"float64"},{"name":"updated_at","type":"timestamptz"},{"name":"fetched_at","type":"timestamptz"},{"name":"name","type":"text"},{"name":"type","type":"text"},{"name":"primary_exchange","type":"text"},{"name":"cik","type":"int64"},{"name":"market_cap","type":"float64"},{"name":"sic_code","type":"text"},{"name":"sic_description","type":"text"},{"name":"locale","type":"text"},{"name":"city","type":"text"},{"name":"state","type":"text"},{"name":"total_employees","type":"int32"},{"name":"list_date","type":"date"},{"name":"weighted_shares_outstanding","type":"int64"},{"name":"homepage_url","type":"text"},{"name":"sector","type":"text"}],"endpoint":"/v1/market/quotes","enrich_columns":[],"enrich_data":false,"fetch":"/v1/market/quotes/{ticker}","filters":[{"column":"ticker","list":true,"match":"exact","param":"ticker"},{"column":"type","list":true,"match":"exact","param":"type"},{"column":"primary_exchange","list":true,"match":"exact","param":"primary_exchange"},{"column":"sector","list":true,"match":"exact","param":"sector"},{"column":"sic_description","list":true,"match":"exact","param":"sic_description"},{"column":"name","list":false,"match":"contains","param":"name"}],"history":false,"key":["ticker"],"path":"market/quotes","ticker":"ticker","time":"as_of","websocket":false},{"columns":[{"name":"ticker","type":"text"},{"name":"name","type":"text"},{"name":"type","type":"text"},{"name":"market","type":"text"},{"name":"primary_exchange","type":"text"},{"name":"cik","type":"int64"},{"name":"composite_figi","type":"text"},{"name":"share_class_figi","type":"text"},{"name":"active","type":"bool"},{"name":"delisted_utc","type":"timestamptz"},{"name":"last_updated_utc","type":"timestamptz"},{"name":"as_of","type":"date"},{"name":"updated_at","type":"timestamptz"}],"endpoint":"/v1/market/tickers","enrich_columns":[],"enrich_data":false,"fetch":"/v1/market/tickers/{ticker}","filters":[{"column":"ticker","list":true,"match":"exact","param":"ticker"},{"column":"type","list":true,"match":"exact","param":"type"},{"column":"market","list":true,"match":"exact","param":"market"},{"column":"primary_exchange","list":true,"match":"exact","param":"primary_exchange"}],"history":false,"key":["ticker"],"path":"market/tickers","ticker":"ticker","time":"as_of","websocket":true},{"columns":[{"name":"ticker","type":"text"},{"name":"market_cap","type":"float64"},{"name":"sic_code","type":"text"},{"name":"sic_description","type":"text"},{"name":"locale","type":"text"},{"name":"total_employees","type":"int32"},{"name":"list_date","type":"date"},{"name":"share_class_shares_outstanding","type":"int64"},{"name":"weighted_shares_outstanding","type":"int64"},{"name":"description","type":"text"},{"name":"homepage_url","type":"text"},{"name":"city","type":"text"},{"name":"state","type":"text"},{"name":"as_of","type":"date"},{"name":"updated_at","type":"timestamptz"}],"endpoint":"/v1/market/ticker-details","enrich_columns":[],"enrich_data":false,"fetch":"/v1/market/ticker-details/{ticker}","filters":[{"column":"ticker","list":true,"match":"exact","param":"ticker"},{"column":"sic_code","list":true,"match":"exact","param":"sic_code"},{"column":"locale","list":true,"match":"exact","param":"locale"},{"column":"sic_description","list":false,"match":"contains","param":"sic_description"}],"history":false,"key":["ticker"],"path":"market/ticker-details","ticker":"ticker","time":"as_of","websocket":true},{"columns":[{"name":"id","type":"int32"},{"name":"date","type":"date"},{"name":"rate","type":"float64"},{"name":"percentile_1","type":"float64"},{"name":"percentile_25","type":"float64"},{"name":"percentile_75","type":"float64"},{"name":"percentile_99","type":"float64"},{"name":"volume_billions","type":"float64"},{"name":"avg_30d","type":"float64"},{"name":"avg_90d","type":"float64"},{"name":"avg_180d","type":"float64"},{"name":"date_added","type":"date"}],"endpoint":"/v1/rates/sofr","enrich_columns":[],"enrich_data":false,"fetch":"/v1/rates/sofr/{id}","filters":[],"history":true,"key":["id"],"path":"rates/sofr","ticker":null,"time":"date","websocket":true},{"columns":[{"name":"id","type":"int32"},{"name":"date","type":"date"},{"name":"five_year","type":"float64"},{"name":"seven_year","type":"float64"},{"name":"ten_year","type":"float64"},{"name":"twenty_year","type":"float64"},{"name":"thirty_year","type":"float64"}],"endpoint":"/v1/rates/yield-curve","enrich_columns":[],"enrich_data":false,"fetch":"/v1/rates/yield-curve/{id}","filters":[],"history":true,"key":["id"],"path":"rates/yield-curve","ticker":null,"time":"date","websocket":true},{"columns":[{"name":"id","type":"int32"},{"name":"nct_id","type":"text"},{"name":"brief_title","type":"text"},{"name":"overall_status","type":"text"},{"name":"start_date","type":"date"},{"name":"completion_date","type":"date"},{"name":"results_posted_date","type":"date"},{"name":"lead_sponsor","type":"text"},{"name":"collaborators","type":"json"},{"name":"conditions","type":"json"},{"name":"interventions","type":"json"},{"name":"primary_outcomes","type":"json"},{"name":"key_secondary_outcomes","type":"json"},{"name":"adverse_events","type":"json"},{"name":"participant_flow","type":"json"},{"name":"added_at","type":"timestamp"}],"endpoint":"/v1/research/clinical-trials","enrich_columns":[],"enrich_data":false,"fetch":"/v1/research/clinical-trials/{id}","filters":[{"column":"nct_id","list":true,"match":"exact","param":"nct_id"},{"column":"overall_status","list":true,"match":"exact","param":"overall_status"},{"column":"lead_sponsor","list":false,"match":"contains","param":"lead_sponsor"},{"column":"brief_title","list":false,"match":"contains","param":"brief_title"}],"history":true,"key":["id"],"path":"research/clinical-trials","ticker":null,"time":"added_at","websocket":true},{"columns":[{"name":"id","type":"int32"},{"name":"title","type":"text"},{"name":"link","type":"text"},{"name":"description","type":"text"},{"name":"pub_date","type":"timestamp"},{"name":"creator","type":"text"},{"name":"contributors","type":"text"},{"name":"identifier1","type":"text"},{"name":"identifier2","type":"text"},{"name":"date_added","type":"date"}],"endpoint":"/v1/research/patents","enrich_columns":[],"enrich_data":false,"fetch":"/v1/research/patents/{id}","filters":[{"column":"title","list":false,"match":"contains","param":"title"},{"column":"creator","list":false,"match":"contains","param":"creator"},{"column":"contributors","list":false,"match":"contains","param":"contributors"}],"history":true,"key":["id"],"path":"research/patents","ticker":null,"time":"date_added","websocket":true},{"columns":[{"name":"accession_number","type":"text"},{"name":"filing_date","type":"date"},{"name":"accepted_at","type":"timestamptz"},{"name":"form_type","type":"text"},{"name":"company_name","type":"text"},{"name":"ticker","type":"text"},{"name":"cik","type":"int64"},{"name":"index_url","type":"text"},{"name":"source","type":"text"},{"name":"inserted_at","type":"timestamptz"}],"endpoint":"/v1/sec/filings","enrich_columns":[{"name":"quote_price","type":"float64"},{"name":"quote_change_pct","type":"float64"},{"name":"quote_prev_close","type":"float64"},{"name":"quote_open","type":"float64"},{"name":"quote_high","type":"float64"},{"name":"quote_low","type":"float64"},{"name":"quote_vwap","type":"float64"},{"name":"quote_volume","type":"float64"},{"name":"quote_as_of","type":"date"},{"name":"quote_updated_at","type":"timestamptz"}],"enrich_data":true,"fetch":"/v1/sec/filings/{accession_number}","filters":[{"column":"form_type","list":true,"match":"exact","param":"form_type"},{"column":"ticker","list":true,"match":"exact","param":"ticker"},{"column":"company_name","list":false,"match":"contains","param":"company_name"}],"history":true,"key":["accession_number"],"path":"sec/filings","ticker":"ticker","time":"filing_date","websocket":true},{"columns":[{"name":"accession_number","type":"text"},{"name":"filing_date","type":"date"},{"name":"accepted_at","type":"timestamptz"},{"name":"form_type","type":"text"},{"name":"filer_cik","type":"int64"},{"name":"filer_name","type":"text"},{"name":"period_of_report","type":"date"},{"name":"report_type","type":"text"},{"name":"is_amendment","type":"bool"},{"name":"amendment_type","type":"text"},{"name":"other_managers_count","type":"int32"},{"name":"holdings_count","type":"int32"},{"name":"holdings_value","type":"float64"},{"name":"is_confidential_omitted","type":"bool"},{"name":"filer_city","type":"text"},{"name":"filer_state","type":"text"},{"name":"inserted_at","type":"timestamptz"}],"endpoint":"/v1/sec/13f-filings","enrich_columns":[],"enrich_data":false,"fetch":"/v1/sec/13f-filings/{accession_number}","filters":[{"column":"accession_number","list":true,"match":"exact","param":"accession_number"},{"column":"form_type","list":true,"match":"exact","param":"form_type"},{"column":"filer_name","list":false,"match":"contains","param":"filer_name"},{"column":"report_type","list":true,"match":"exact","param":"report_type"}],"history":true,"key":["accession_number"],"path":"sec/13f-filings","ticker":null,"time":"filing_date","websocket":true},{"columns":[{"name":"accession_number","type":"text"},{"name":"filing_date","type":"date"},{"name":"document_type","type":"text"},{"name":"period_of_report","type":"date"},{"name":"issuer_name","type":"text"},{"name":"ticker","type":"text"},{"name":"issuer_cik","type":"int64"},{"name":"owners","type":"text"},{"name":"transactions","type":"int64"},{"name":"shares_acquired","type":"float64"},{"name":"shares_disposed","type":"float64"},{"name":"trans_codes","type":"text"},{"name":"aff_10b5_one","type":"bool"},{"name":"source","type":"text"},{"name":"inserted_at","type":"timestamptz"}],"endpoint":"/v1/sec/insider-filings","enrich_columns":[{"name":"quote_price","type":"float64"},{"name":"quote_change_pct","type":"float64"},{"name":"quote_prev_close","type":"float64"},{"name":"quote_open","type":"float64"},{"name":"quote_high","type":"float64"},{"name":"quote_low","type":"float64"},{"name":"quote_vwap","type":"float64"},{"name":"quote_volume","type":"float64"},{"name":"quote_as_of","type":"date"},{"name":"quote_updated_at","type":"timestamptz"}],"enrich_data":true,"fetch":"/v1/sec/insider-filings/{accession_number}","filters":[{"column":"accession_number","list":true,"match":"exact","param":"accession_number"},{"column":"document_type","list":true,"match":"exact","param":"document_type"},{"column":"ticker","list":true,"match":"exact","param":"ticker"},{"column":"issuer_name","list":false,"match":"contains","param":"issuer_name"}],"history":true,"key":["accession_number"],"path":"sec/insider-filings","ticker":"ticker","time":"filing_date","websocket":true},{"columns":[{"name":"id","type":"int64"},{"name":"accession_number","type":"text"},{"name":"filing_date","type":"date"},{"name":"document_type","type":"text"},{"name":"issuer_name","type":"text"},{"name":"ticker","type":"text"},{"name":"issuer_cik","type":"int64"},{"name":"table_type","type":"text"},{"name":"security_title","type":"text"},{"name":"trans_date","type":"date"},{"name":"trans_code","type":"text"},{"name":"trans_shares","type":"float64"},{"name":"trans_price_per_share","type":"float64"},{"name":"trans_total_value","type":"float64"},{"name":"trans_acquired_disposed_cd","type":"text"},{"name":"shares_owned_following","type":"float64"},{"name":"value_owned_following","type":"float64"},{"name":"direct_indirect_ownership","type":"text"},{"name":"nature_of_ownership","type":"text"},{"name":"conv_exercise_price","type":"float64"},{"name":"exercise_date","type":"date"},{"name":"expiration_date","type":"date"},{"name":"underlying_security_title","type":"text"},{"name":"underlying_security_shares","type":"float64"},{"name":"footnote_ids","type":"text"}],"endpoint":"/v1/sec/insider-transactions","enrich_columns":[{"name":"quote_price","type":"float64"},{"name":"quote_change_pct","type":"float64"},{"name":"quote_prev_close","type":"float64"},{"name":"quote_open","type":"float64"},{"name":"quote_high","type":"float64"},{"name":"quote_low","type":"float64"},{"name":"quote_vwap","type":"float64"},{"name":"quote_volume","type":"float64"},{"name":"quote_as_of","type":"date"},{"name":"quote_updated_at","type":"timestamptz"}],"enrich_data":true,"fetch":"/v1/sec/insider-transactions/{id}","filters":[{"column":"accession_number","list":true,"match":"exact","param":"accession_number"},{"column":"ticker","list":true,"match":"exact","param":"ticker"},{"column":"trans_code","list":true,"match":"exact","param":"trans_code"},{"column":"table_type","list":true,"match":"exact","param":"table_type"}],"history":true,"key":["id"],"path":"sec/insider-transactions","ticker":"ticker","time":"filing_date","websocket":true},{"columns":[{"name":"id","type":"int64"},{"name":"accession_number","type":"text"},{"name":"filing_date","type":"date"},{"name":"filer_name","type":"text"},{"name":"filer_cik","type":"int64"},{"name":"period_of_report","type":"date"},{"name":"seq","type":"int32"},{"name":"name_of_issuer","type":"text"},{"name":"title_of_class","type":"text"},{"name":"cusip","type":"text"},{"name":"ticker","type":"text"},{"name":"value_usd","type":"float64"},{"name":"shares","type":"float64"},{"name":"shares_type","type":"text"},{"name":"put_call","type":"text"},{"name":"investment_discretion","type":"text"},{"name":"voting_sole","type":"float64"},{"name":"voting_shared","type":"float64"},{"name":"voting_none","type":"float64"}],"endpoint":"/v1/sec/13f-holdings","enrich_columns":[{"name":"quote_price","type":"float64"},{"name":"quote_change_pct","type":"float64"},{"name":"quote_prev_close","type":"float64"},{"name":"quote_open","type":"float64"},{"name":"quote_high","type":"float64"},{"name":"quote_low","type":"float64"},{"name":"quote_vwap","type":"float64"},{"name":"quote_volume","type":"float64"},{"name":"quote_as_of","type":"date"},{"name":"quote_updated_at","type":"timestamptz"}],"enrich_data":true,"fetch":"/v1/sec/13f-holdings/{id}","filters":[{"column":"accession_number","list":true,"match":"exact","param":"accession_number"},{"column":"ticker","list":true,"match":"exact","param":"ticker"},{"column":"cusip","list":true,"match":"exact","param":"cusip"},{"column":"name_of_issuer","list":false,"match":"contains","param":"name_of_issuer"},{"column":"filer_name","list":false,"match":"contains","param":"filer_name"}],"history":true,"key":["id"],"path":"sec/13f-holdings","ticker":"ticker","time":"filing_date","websocket":true},{"columns":[{"name":"id","type":"int64"},{"name":"ticker","type":"text"},{"name":"contract","type":"text"},{"name":"trading_day","type":"date"},{"name":"contract_type","type":"text"},{"name":"strike","type":"float64"},{"name":"expiration","type":"date"},{"name":"volume","type":"float64"},{"name":"avg_volume_20d","type":"float64"},{"name":"vol_ratio","type":"float64"},{"name":"open_interest","type":"float64"},{"name":"vol_oi_ratio","type":"float64"},{"name":"dollar_premium","type":"float64"},{"name":"otm_pct","type":"float64"},{"name":"iv","type":"float64"},{"name":"delta","type":"float64"},{"name":"is_block","type":"bool"},{"name":"is_sweep","type":"bool"},{"name":"reason","type":"text"},{"name":"inserted_at","type":"timestamptz"}],"endpoint":"/v1/options/flow","enrich_columns":[{"name":"quote_price","type":"float64"},{"name":"quote_change_pct","type":"float64"},{"name":"quote_prev_close","type":"float64"},{"name":"quote_open","type":"float64"},{"name":"quote_high","type":"float64"},{"name":"quote_low","type":"float64"},{"name":"quote_vwap","type":"float64"},{"name":"quote_volume","type":"float64"},{"name":"quote_as_of","type":"date"},{"name":"quote_updated_at","type":"timestamptz"}],"enrich_data":true,"fetch":"/v1/options/flow/{id}","filters":[{"column":"ticker","list":true,"match":"exact","param":"ticker"},{"column":"contract","list":true,"match":"exact","param":"contract"},{"column":"contract_type","list":true,"match":"exact","param":"contract_type"},{"column":"reason","list":true,"match":"exact","param":"reason"}],"history":true,"key":["id"],"path":"options/flow","ticker":"ticker","time":"trading_day","websocket":true}],"conventions":{"envelope":"every JSON response of rows is {data, total, has_more, limit, offset}","fetch":"GET /v1/{path}/{key} returns one row by its key where the key is one column","filters":"a filter is named after the column it filters (exclude_<column> drops values); matching never depends on case; list filters take comma separated values","from_to":"both inclusive; a plain date is a whole day in the service timezone, otherwise RFC 3339","history":"GET /v1/{path} selects a period with from and to; a category with history false keeps only its current state and has no history list","paging":"limit (1 to max_limit), offset and sort are required wherever rows are returned; facets count instead and exports stream the whole selection","timezone":"America/New_York","today":"/today is the last 24 hours, served from the cache (from Postgres only while the cache warms or if Redis is down); a category keyed on a date shows today and yesterday"},"max_limit":1000},"schema":{"type":"object"}}},"description":"Success"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[],"summary":"Dataset columns, filters and conventions","tags":["metadata"]}},"/v1/health":{"get":{"parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"mode":{"enum":["starting","cache","database-only"],"type":"string"},"postgres":{"type":"string"},"redis":{"type":"string"},"status":{"enum":["ok","degraded","starting","down"],"type":"string"}},"type":"object"}}},"description":"Success"},"503":{"content":{"application/json":{"schema":{"properties":{"mode":{"enum":["starting","cache","database-only"],"type":"string"},"postgres":{"type":"string"},"redis":{"type":"string"},"status":{"enum":["ok","degraded","starting","down"],"type":"string"}},"type":"object"}}},"description":"Starting or Postgres unavailable"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[],"summary":"Service health","tags":["metadata"]}},"/v1/login":{"post":{"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"properties":{"email":{"type":"string"},"password":{"format":"password","type":"string"}},"required":["email","password"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"api_key":{"type":"string"},"email":{"type":"string"},"plan":{"$ref":"#/components/schemas/Plan"}},"type":"object"}}},"description":"Success"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[],"summary":"Log in and issue a new API key","tags":["accounts"]}},"/v1/market/candles/{ticker}":{"get":{"parameters":[{"description":"Ticker symbol","in":"path","name":"ticker","required":true,"schema":{"type":"string"}},{"description":"Bar size","in":"query","name":"timeframe","required":true,"schema":{"enum":["1m","5m","30m","1d","30d"],"type":"string"}},{"description":"Only bars starting at or after this date or RFC 3339 timestamp","in":"query","name":"after","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"close":{"type":"number"},"high":{"type":"number"},"low":{"type":"number"},"open":{"type":"number"},"time":{"format":"date-time","type":"string"},"trades":{"type":["integer","null"]},"volume":{"type":"number"},"vwap":{"type":["number","null"]}},"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"Live ticker candles, oldest first","tags":["market"]}},"/v1/market/quotes/export":{"get":{"description":"Stream the selection as a download. Requires export and history access. Categories without history export their current state and reject from/to. Pagination is optional.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"limit","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"sort","required":false,"schema":{"enum":["ticker","as_of","price","open_price","high_price","low_price","prev_close","change","change_pct","volume","vwap","updated_at","fetched_at","name","type","primary_exchange","cik","market_cap","sic_code","sic_description","locale","city","state","total_employees","list_date","weighted_shares_outstanding","homepage_url","sector"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on type; comma-separated values","explode":false,"in":"query","name":"type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on primary_exchange; comma-separated values","explode":false,"in":"query","name":"primary_exchange","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on sector; comma-separated values","explode":false,"in":"query","name":"sector","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on sic_description; comma-separated values","explode":false,"in":"query","name":"sic_description","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on name","in":"query","name":"name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/market_quotes_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success","headers":{"Content-Disposition":{"description":"Attachment filename","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"export market/quotes","tags":["market"]}},"/v1/market/quotes/today":{"get":{"description":"Fetches the last 24 hours of data (date-keyed categories include today and yesterday). The endpoint keeps its `/today` name; the window is always the last 24 hours. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["ticker","as_of","price","open_price","high_price","low_price","prev_close","change","change_pct","volume","vwap","updated_at","fetched_at","name","type","primary_exchange","cik","market_cap","sic_code","sic_description","locale","city","state","total_employees","list_date","weighted_shares_outstanding","homepage_url","sector"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["ticker","type","primary_exchange","sector","sic_description","name"],"type":"string"}},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on type; comma-separated values","explode":false,"in":"query","name":"type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on primary_exchange; comma-separated values","explode":false,"in":"query","name":"primary_exchange","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on sector; comma-separated values","explode":false,"in":"query","name":"sector","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on sic_description; comma-separated values","explode":false,"in":"query","name":"sic_description","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on name","in":"query","name":"name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/market_quotes_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"today market/quotes (last 24 hours)","tags":["market"]}},"/v1/market/quotes/{key}":{"get":{"description":"Fetch one row in the standard data envelope. Requires history access and a row within the plan's history window.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"ticker row key","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/market_quotes_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"fetch market/quotes","tags":["market"]}},"/v1/market/snapshots":{"get":{"description":"Historical rows within the plan's history window. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["ticker","trading_day","open_price","high_price","low_price","close_price","change_pct","volume","vwap","transaction_count","inserted_at","name","type","primary_exchange","cik","market_cap","sic_code","sic_description","locale","city","state","total_employees","list_date","weighted_shares_outstanding","homepage_url","sector"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["ticker","type","primary_exchange","sector","sic_description","name"],"type":"string"}},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on type; comma-separated values","explode":false,"in":"query","name":"type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on primary_exchange; comma-separated values","explode":false,"in":"query","name":"primary_exchange","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on sector; comma-separated values","explode":false,"in":"query","name":"sector","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on sic_description; comma-separated values","explode":false,"in":"query","name":"sic_description","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on name","in":"query","name":"name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/market_snapshots_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"list market/snapshots","tags":["market"]}},"/v1/market/snapshots/export":{"get":{"description":"Stream the selection as a download. Requires export and history access. Categories without history export their current state and reject from/to. Pagination is optional.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"limit","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"sort","required":false,"schema":{"enum":["ticker","trading_day","open_price","high_price","low_price","close_price","change_pct","volume","vwap","transaction_count","inserted_at","name","type","primary_exchange","cik","market_cap","sic_code","sic_description","locale","city","state","total_employees","list_date","weighted_shares_outstanding","homepage_url","sector"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on type; comma-separated values","explode":false,"in":"query","name":"type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on primary_exchange; comma-separated values","explode":false,"in":"query","name":"primary_exchange","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on sector; comma-separated values","explode":false,"in":"query","name":"sector","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on sic_description; comma-separated values","explode":false,"in":"query","name":"sic_description","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on name","in":"query","name":"name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/market_snapshots_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success","headers":{"Content-Disposition":{"description":"Attachment filename","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"export market/snapshots","tags":["market"]}},"/v1/market/snapshots/today":{"get":{"description":"Fetches the last 24 hours of data (date-keyed categories include today and yesterday). The endpoint keeps its `/today` name; the window is always the last 24 hours. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["ticker","trading_day","open_price","high_price","low_price","close_price","change_pct","volume","vwap","transaction_count","inserted_at","name","type","primary_exchange","cik","market_cap","sic_code","sic_description","locale","city","state","total_employees","list_date","weighted_shares_outstanding","homepage_url","sector"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["ticker","type","primary_exchange","sector","sic_description","name"],"type":"string"}},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on type; comma-separated values","explode":false,"in":"query","name":"type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on primary_exchange; comma-separated values","explode":false,"in":"query","name":"primary_exchange","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on sector; comma-separated values","explode":false,"in":"query","name":"sector","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on sic_description; comma-separated values","explode":false,"in":"query","name":"sic_description","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on name","in":"query","name":"name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/market_snapshots_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"today market/snapshots (last 24 hours)","tags":["market"]}},"/v1/market/ticker-details/export":{"get":{"description":"Stream the selection as a download. Requires export and history access. Categories without history export their current state and reject from/to. Pagination is optional.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"limit","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"sort","required":false,"schema":{"enum":["ticker","market_cap","sic_code","sic_description","locale","total_employees","list_date","share_class_shares_outstanding","weighted_shares_outstanding","description","homepage_url","city","state","as_of","updated_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on sic_code; comma-separated values","explode":false,"in":"query","name":"sic_code","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on locale; comma-separated values","explode":false,"in":"query","name":"locale","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on sic_description","in":"query","name":"sic_description","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/market_ticker_details_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success","headers":{"Content-Disposition":{"description":"Attachment filename","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"export market/ticker-details","tags":["market"]}},"/v1/market/ticker-details/today":{"get":{"description":"Fetches the last 24 hours of data (date-keyed categories include today and yesterday). The endpoint keeps its `/today` name; the window is always the last 24 hours. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["ticker","market_cap","sic_code","sic_description","locale","total_employees","list_date","share_class_shares_outstanding","weighted_shares_outstanding","description","homepage_url","city","state","as_of","updated_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["ticker","sic_code","locale","sic_description"],"type":"string"}},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on sic_code; comma-separated values","explode":false,"in":"query","name":"sic_code","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on locale; comma-separated values","explode":false,"in":"query","name":"locale","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on sic_description","in":"query","name":"sic_description","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/market_ticker_details_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"today market/ticker-details (last 24 hours)","tags":["market"]}},"/v1/market/ticker-details/{key}":{"get":{"description":"Fetch one row in the standard data envelope. Requires history access and a row within the plan's history window.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"ticker row key","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/market_ticker_details_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"fetch market/ticker-details","tags":["market"]}},"/v1/market/tickers/export":{"get":{"description":"Stream the selection as a download. Requires export and history access. Categories without history export their current state and reject from/to. Pagination is optional.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"limit","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"sort","required":false,"schema":{"enum":["ticker","name","type","market","primary_exchange","cik","composite_figi","share_class_figi","active","delisted_utc","last_updated_utc","as_of","updated_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on type; comma-separated values","explode":false,"in":"query","name":"type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on market; comma-separated values","explode":false,"in":"query","name":"market","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on primary_exchange; comma-separated values","explode":false,"in":"query","name":"primary_exchange","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/market_tickers_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success","headers":{"Content-Disposition":{"description":"Attachment filename","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"export market/tickers","tags":["market"]}},"/v1/market/tickers/today":{"get":{"description":"Fetches the last 24 hours of data (date-keyed categories include today and yesterday). The endpoint keeps its `/today` name; the window is always the last 24 hours. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["ticker","name","type","market","primary_exchange","cik","composite_figi","share_class_figi","active","delisted_utc","last_updated_utc","as_of","updated_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["ticker","type","market","primary_exchange"],"type":"string"}},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on type; comma-separated values","explode":false,"in":"query","name":"type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on market; comma-separated values","explode":false,"in":"query","name":"market","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on primary_exchange; comma-separated values","explode":false,"in":"query","name":"primary_exchange","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/market_tickers_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"today market/tickers (last 24 hours)","tags":["market"]}},"/v1/market/tickers/{key}":{"get":{"description":"Fetch one row in the standard data envelope. Requires history access and a row within the plan's history window.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"ticker row key","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/market_tickers_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"fetch market/tickers","tags":["market"]}},"/v1/me":{"get":{"parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"api_keys":{"items":{"properties":{"created_at":{"format":"date-time","type":"string"},"prefix":{"type":"string"}},"type":"object"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"email":{"type":"string"},"plan":{"$ref":"#/components/schemas/Plan"}},"type":"object"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"Current account and API key prefixes","tags":["accounts"]}},"/v1/news/articles":{"get":{"description":"Historical rows within the plan's history window. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["id","datetime","source","ticker","company_name","title","description","url","keyword","badge","release_period","sentiment_compound","sentiment_pos","sentiment_neg","sentiment_neu","natural_key","date_added"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["ticker","source","exclude_source","title","release_period"],"type":"string"}},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive prefix match on source","in":"query","name":"source","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive exclude match on source; comma-separated values","explode":false,"in":"query","name":"exclude_source","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on title","in":"query","name":"title","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive exact match on release_period; comma-separated values","explode":false,"in":"query","name":"release_period","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/news_articles_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"list news/articles","tags":["news"]}},"/v1/news/articles/export":{"get":{"description":"Stream the selection as a download. Requires export and history access. Categories without history export their current state and reject from/to. Pagination is optional.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"limit","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"sort","required":false,"schema":{"enum":["id","datetime","source","ticker","company_name","title","description","url","keyword","badge","release_period","sentiment_compound","sentiment_pos","sentiment_neg","sentiment_neu","natural_key","date_added"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive prefix match on source","in":"query","name":"source","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive exclude match on source; comma-separated values","explode":false,"in":"query","name":"exclude_source","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on title","in":"query","name":"title","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive exact match on release_period; comma-separated values","explode":false,"in":"query","name":"release_period","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/news_articles_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success","headers":{"Content-Disposition":{"description":"Attachment filename","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"export news/articles","tags":["news"]}},"/v1/news/articles/today":{"get":{"description":"Fetches the last 24 hours of data (date-keyed categories include today and yesterday). The endpoint keeps its `/today` name; the window is always the last 24 hours. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["id","datetime","source","ticker","company_name","title","description","url","keyword","badge","release_period","sentiment_compound","sentiment_pos","sentiment_neg","sentiment_neu","natural_key","date_added"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["ticker","source","exclude_source","title","release_period"],"type":"string"}},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive prefix match on source","in":"query","name":"source","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive exclude match on source; comma-separated values","explode":false,"in":"query","name":"exclude_source","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on title","in":"query","name":"title","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive exact match on release_period; comma-separated values","explode":false,"in":"query","name":"release_period","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/news_articles_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"today news/articles (last 24 hours)","tags":["news"]}},"/v1/news/articles/{key}":{"get":{"description":"Fetch one row in the standard data envelope. Requires history access and a row within the plan's history window.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"id row key","in":"path","name":"key","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/news_articles_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"fetch news/articles","tags":["news"]}},"/v1/options/flow":{"get":{"description":"Historical rows within the plan's history window. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["id","ticker","contract","trading_day","contract_type","strike","expiration","volume","avg_volume_20d","vol_ratio","open_interest","vol_oi_ratio","dollar_premium","otm_pct","iv","delta","is_block","is_sweep","reason","inserted_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["ticker","contract","contract_type","reason"],"type":"string"}},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on contract; comma-separated values","explode":false,"in":"query","name":"contract","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on contract_type; comma-separated values","explode":false,"in":"query","name":"contract_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on reason; comma-separated values","explode":false,"in":"query","name":"reason","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/options_flow_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"list options/flow","tags":["options"]}},"/v1/options/flow/export":{"get":{"description":"Stream the selection as a download. Requires export and history access. Categories without history export their current state and reject from/to. Pagination is optional.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"limit","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"sort","required":false,"schema":{"enum":["id","ticker","contract","trading_day","contract_type","strike","expiration","volume","avg_volume_20d","vol_ratio","open_interest","vol_oi_ratio","dollar_premium","otm_pct","iv","delta","is_block","is_sweep","reason","inserted_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on contract; comma-separated values","explode":false,"in":"query","name":"contract","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on contract_type; comma-separated values","explode":false,"in":"query","name":"contract_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on reason; comma-separated values","explode":false,"in":"query","name":"reason","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/options_flow_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success","headers":{"Content-Disposition":{"description":"Attachment filename","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"export options/flow","tags":["options"]}},"/v1/options/flow/today":{"get":{"description":"Fetches the last 24 hours of data (date-keyed categories include today and yesterday). The endpoint keeps its `/today` name; the window is always the last 24 hours. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["id","ticker","contract","trading_day","contract_type","strike","expiration","volume","avg_volume_20d","vol_ratio","open_interest","vol_oi_ratio","dollar_premium","otm_pct","iv","delta","is_block","is_sweep","reason","inserted_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["ticker","contract","contract_type","reason"],"type":"string"}},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on contract; comma-separated values","explode":false,"in":"query","name":"contract","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on contract_type; comma-separated values","explode":false,"in":"query","name":"contract_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on reason; comma-separated values","explode":false,"in":"query","name":"reason","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/options_flow_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"today options/flow (last 24 hours)","tags":["options"]}},"/v1/options/flow/{key}":{"get":{"description":"Fetch one row in the standard data envelope. Requires history access and a row within the plan's history window.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"id row key","in":"path","name":"key","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/options_flow_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"fetch options/flow","tags":["options"]}},"/v1/plans":{"get":{"parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"plans":{"items":{"$ref":"#/components/schemas/Plan"},"type":"array"}},"type":"object"}}},"description":"Success"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[],"summary":"Available account plans","tags":["accounts"]}},"/v1/rates/sofr":{"get":{"description":"Historical rows within the plan's history window. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["id","date","rate","percentile_1","percentile_25","percentile_75","percentile_99","volume_billions","avg_30d","avg_90d","avg_180d","date_added"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/rates_sofr_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"list rates/sofr","tags":["rates"]}},"/v1/rates/sofr/export":{"get":{"description":"Stream the selection as a download. Requires export and history access. Categories without history export their current state and reject from/to. Pagination is optional.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"limit","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"sort","required":false,"schema":{"enum":["id","date","rate","percentile_1","percentile_25","percentile_75","percentile_99","volume_billions","avg_30d","avg_90d","avg_180d","date_added"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/rates_sofr_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success","headers":{"Content-Disposition":{"description":"Attachment filename","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"export rates/sofr","tags":["rates"]}},"/v1/rates/sofr/today":{"get":{"description":"Fetches the last 24 hours of data (date-keyed categories include today and yesterday). The endpoint keeps its `/today` name; the window is always the last 24 hours. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["id","date","rate","percentile_1","percentile_25","percentile_75","percentile_99","volume_billions","avg_30d","avg_90d","avg_180d","date_added"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/rates_sofr_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"today rates/sofr (last 24 hours)","tags":["rates"]}},"/v1/rates/sofr/{key}":{"get":{"description":"Fetch one row in the standard data envelope. Requires history access and a row within the plan's history window.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"id row key","in":"path","name":"key","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/rates_sofr_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"fetch rates/sofr","tags":["rates"]}},"/v1/rates/yield-curve":{"get":{"description":"Historical rows within the plan's history window. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["id","date","five_year","seven_year","ten_year","twenty_year","thirty_year"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/rates_yield_curve_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"list rates/yield-curve","tags":["rates"]}},"/v1/rates/yield-curve/export":{"get":{"description":"Stream the selection as a download. Requires export and history access. Categories without history export their current state and reject from/to. Pagination is optional.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"limit","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"sort","required":false,"schema":{"enum":["id","date","five_year","seven_year","ten_year","twenty_year","thirty_year"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/rates_yield_curve_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success","headers":{"Content-Disposition":{"description":"Attachment filename","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"export rates/yield-curve","tags":["rates"]}},"/v1/rates/yield-curve/today":{"get":{"description":"Fetches the last 24 hours of data (date-keyed categories include today and yesterday). The endpoint keeps its `/today` name; the window is always the last 24 hours. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["id","date","five_year","seven_year","ten_year","twenty_year","thirty_year"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/rates_yield_curve_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"today rates/yield-curve (last 24 hours)","tags":["rates"]}},"/v1/rates/yield-curve/{key}":{"get":{"description":"Fetch one row in the standard data envelope. Requires history access and a row within the plan's history window.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"id row key","in":"path","name":"key","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/rates_yield_curve_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"fetch rates/yield-curve","tags":["rates"]}},"/v1/register":{"post":{"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"properties":{"email":{"type":"string"},"password":{"format":"password","type":"string"},"plan":{"default":"free","enum":["free","pro","enterprise",null],"type":["string","null"]}},"required":["email","password"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"api_key":{"type":"string"},"email":{"type":"string"},"plan":{"$ref":"#/components/schemas/Plan"}},"type":"object"}}},"description":"Success"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[],"summary":"Register an account","tags":["accounts"]}},"/v1/research/clinical-trials":{"get":{"description":"Historical rows within the plan's history window. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["id","nct_id","brief_title","overall_status","start_date","completion_date","results_posted_date","lead_sponsor","collaborators","conditions","interventions","primary_outcomes","key_secondary_outcomes","adverse_events","participant_flow","added_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["nct_id","overall_status","lead_sponsor","brief_title"],"type":"string"}},{"description":"Case-insensitive exact match on nct_id; comma-separated values","explode":false,"in":"query","name":"nct_id","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on overall_status; comma-separated values","explode":false,"in":"query","name":"overall_status","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on lead_sponsor","in":"query","name":"lead_sponsor","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive contains match on brief_title","in":"query","name":"brief_title","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/research_clinical_trials_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"list research/clinical-trials","tags":["research"]}},"/v1/research/clinical-trials/export":{"get":{"description":"Stream the selection as a download. Requires export and history access. Categories without history export their current state and reject from/to. Pagination is optional.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"limit","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"sort","required":false,"schema":{"enum":["id","nct_id","brief_title","overall_status","start_date","completion_date","results_posted_date","lead_sponsor","collaborators","conditions","interventions","primary_outcomes","key_secondary_outcomes","adverse_events","participant_flow","added_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Case-insensitive exact match on nct_id; comma-separated values","explode":false,"in":"query","name":"nct_id","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on overall_status; comma-separated values","explode":false,"in":"query","name":"overall_status","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on lead_sponsor","in":"query","name":"lead_sponsor","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive contains match on brief_title","in":"query","name":"brief_title","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/research_clinical_trials_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success","headers":{"Content-Disposition":{"description":"Attachment filename","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"export research/clinical-trials","tags":["research"]}},"/v1/research/clinical-trials/today":{"get":{"description":"Fetches the last 24 hours of data (date-keyed categories include today and yesterday). The endpoint keeps its `/today` name; the window is always the last 24 hours. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["id","nct_id","brief_title","overall_status","start_date","completion_date","results_posted_date","lead_sponsor","collaborators","conditions","interventions","primary_outcomes","key_secondary_outcomes","adverse_events","participant_flow","added_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["nct_id","overall_status","lead_sponsor","brief_title"],"type":"string"}},{"description":"Case-insensitive exact match on nct_id; comma-separated values","explode":false,"in":"query","name":"nct_id","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on overall_status; comma-separated values","explode":false,"in":"query","name":"overall_status","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on lead_sponsor","in":"query","name":"lead_sponsor","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive contains match on brief_title","in":"query","name":"brief_title","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/research_clinical_trials_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"today research/clinical-trials (last 24 hours)","tags":["research"]}},"/v1/research/clinical-trials/{key}":{"get":{"description":"Fetch one row in the standard data envelope. Requires history access and a row within the plan's history window.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"id row key","in":"path","name":"key","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/research_clinical_trials_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"fetch research/clinical-trials","tags":["research"]}},"/v1/research/patents":{"get":{"description":"Historical rows within the plan's history window. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["id","title","link","description","pub_date","creator","contributors","identifier1","identifier2","date_added"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["title","creator","contributors"],"type":"string"}},{"description":"Case-insensitive contains match on title","in":"query","name":"title","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive contains match on creator","in":"query","name":"creator","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive contains match on contributors","in":"query","name":"contributors","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/research_patents_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"list research/patents","tags":["research"]}},"/v1/research/patents/export":{"get":{"description":"Stream the selection as a download. Requires export and history access. Categories without history export their current state and reject from/to. Pagination is optional.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"limit","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"sort","required":false,"schema":{"enum":["id","title","link","description","pub_date","creator","contributors","identifier1","identifier2","date_added"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Case-insensitive contains match on title","in":"query","name":"title","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive contains match on creator","in":"query","name":"creator","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive contains match on contributors","in":"query","name":"contributors","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/research_patents_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success","headers":{"Content-Disposition":{"description":"Attachment filename","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"export research/patents","tags":["research"]}},"/v1/research/patents/today":{"get":{"description":"Fetches the last 24 hours of data (date-keyed categories include today and yesterday). The endpoint keeps its `/today` name; the window is always the last 24 hours. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["id","title","link","description","pub_date","creator","contributors","identifier1","identifier2","date_added"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["title","creator","contributors"],"type":"string"}},{"description":"Case-insensitive contains match on title","in":"query","name":"title","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive contains match on creator","in":"query","name":"creator","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive contains match on contributors","in":"query","name":"contributors","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/research_patents_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"today research/patents (last 24 hours)","tags":["research"]}},"/v1/research/patents/{key}":{"get":{"description":"Fetch one row in the standard data envelope. Requires history access and a row within the plan's history window.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"id row key","in":"path","name":"key","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/research_patents_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"fetch research/patents","tags":["research"]}},"/v1/sec/13f-filings":{"get":{"description":"Historical rows within the plan's history window. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["accession_number","filing_date","accepted_at","form_type","filer_cik","filer_name","period_of_report","report_type","is_amendment","amendment_type","other_managers_count","holdings_count","holdings_value","is_confidential_omitted","filer_city","filer_state","inserted_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["accession_number","form_type","filer_name","report_type"],"type":"string"}},{"description":"Case-insensitive exact match on accession_number; comma-separated values","explode":false,"in":"query","name":"accession_number","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on form_type; comma-separated values","explode":false,"in":"query","name":"form_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on filer_name","in":"query","name":"filer_name","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive exact match on report_type; comma-separated values","explode":false,"in":"query","name":"report_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_13f_filings_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"list sec/13f-filings","tags":["sec"]}},"/v1/sec/13f-filings/export":{"get":{"description":"Stream the selection as a download. Requires export and history access. Categories without history export their current state and reject from/to. Pagination is optional.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"limit","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"sort","required":false,"schema":{"enum":["accession_number","filing_date","accepted_at","form_type","filer_cik","filer_name","period_of_report","report_type","is_amendment","amendment_type","other_managers_count","holdings_count","holdings_value","is_confidential_omitted","filer_city","filer_state","inserted_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Case-insensitive exact match on accession_number; comma-separated values","explode":false,"in":"query","name":"accession_number","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on form_type; comma-separated values","explode":false,"in":"query","name":"form_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on filer_name","in":"query","name":"filer_name","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive exact match on report_type; comma-separated values","explode":false,"in":"query","name":"report_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_13f_filings_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success","headers":{"Content-Disposition":{"description":"Attachment filename","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"export sec/13f-filings","tags":["sec"]}},"/v1/sec/13f-filings/today":{"get":{"description":"Fetches the last 24 hours of data (date-keyed categories include today and yesterday). The endpoint keeps its `/today` name; the window is always the last 24 hours. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["accession_number","filing_date","accepted_at","form_type","filer_cik","filer_name","period_of_report","report_type","is_amendment","amendment_type","other_managers_count","holdings_count","holdings_value","is_confidential_omitted","filer_city","filer_state","inserted_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["accession_number","form_type","filer_name","report_type"],"type":"string"}},{"description":"Case-insensitive exact match on accession_number; comma-separated values","explode":false,"in":"query","name":"accession_number","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on form_type; comma-separated values","explode":false,"in":"query","name":"form_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on filer_name","in":"query","name":"filer_name","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive exact match on report_type; comma-separated values","explode":false,"in":"query","name":"report_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_13f_filings_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"today sec/13f-filings (last 24 hours)","tags":["sec"]}},"/v1/sec/13f-filings/{key}":{"get":{"description":"Fetch one row in the standard data envelope. Requires history access and a row within the plan's history window.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"accession_number row key","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_13f_filings_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"fetch sec/13f-filings","tags":["sec"]}},"/v1/sec/13f-holdings":{"get":{"description":"Historical rows within the plan's history window. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["id","accession_number","filing_date","filer_name","filer_cik","period_of_report","seq","name_of_issuer","title_of_class","cusip","ticker","value_usd","shares","shares_type","put_call","investment_discretion","voting_sole","voting_shared","voting_none"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["accession_number","ticker","cusip","name_of_issuer","filer_name"],"type":"string"}},{"description":"Case-insensitive exact match on accession_number; comma-separated values","explode":false,"in":"query","name":"accession_number","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on cusip; comma-separated values","explode":false,"in":"query","name":"cusip","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on name_of_issuer","in":"query","name":"name_of_issuer","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive contains match on filer_name","in":"query","name":"filer_name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_13f_holdings_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"list sec/13f-holdings","tags":["sec"]}},"/v1/sec/13f-holdings/export":{"get":{"description":"Stream the selection as a download. Requires export and history access. Categories without history export their current state and reject from/to. Pagination is optional.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"limit","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"sort","required":false,"schema":{"enum":["id","accession_number","filing_date","filer_name","filer_cik","period_of_report","seq","name_of_issuer","title_of_class","cusip","ticker","value_usd","shares","shares_type","put_call","investment_discretion","voting_sole","voting_shared","voting_none"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Case-insensitive exact match on accession_number; comma-separated values","explode":false,"in":"query","name":"accession_number","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on cusip; comma-separated values","explode":false,"in":"query","name":"cusip","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on name_of_issuer","in":"query","name":"name_of_issuer","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive contains match on filer_name","in":"query","name":"filer_name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_13f_holdings_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success","headers":{"Content-Disposition":{"description":"Attachment filename","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"export sec/13f-holdings","tags":["sec"]}},"/v1/sec/13f-holdings/today":{"get":{"description":"Fetches the last 24 hours of data (date-keyed categories include today and yesterday). The endpoint keeps its `/today` name; the window is always the last 24 hours. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["id","accession_number","filing_date","filer_name","filer_cik","period_of_report","seq","name_of_issuer","title_of_class","cusip","ticker","value_usd","shares","shares_type","put_call","investment_discretion","voting_sole","voting_shared","voting_none"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["accession_number","ticker","cusip","name_of_issuer","filer_name"],"type":"string"}},{"description":"Case-insensitive exact match on accession_number; comma-separated values","explode":false,"in":"query","name":"accession_number","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on cusip; comma-separated values","explode":false,"in":"query","name":"cusip","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on name_of_issuer","in":"query","name":"name_of_issuer","required":false,"schema":{"type":"string"}},{"description":"Case-insensitive contains match on filer_name","in":"query","name":"filer_name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_13f_holdings_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"today sec/13f-holdings (last 24 hours)","tags":["sec"]}},"/v1/sec/13f-holdings/{key}":{"get":{"description":"Fetch one row in the standard data envelope. Requires history access and a row within the plan's history window.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"id row key","in":"path","name":"key","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_13f_holdings_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"fetch sec/13f-holdings","tags":["sec"]}},"/v1/sec/filings":{"get":{"description":"Historical rows within the plan's history window. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["accession_number","filing_date","accepted_at","form_type","company_name","ticker","cik","index_url","source","inserted_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["form_type","ticker","company_name"],"type":"string"}},{"description":"Case-insensitive exact match on form_type; comma-separated values","explode":false,"in":"query","name":"form_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on company_name","in":"query","name":"company_name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_filings_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"list sec/filings","tags":["sec"]}},"/v1/sec/filings/export":{"get":{"description":"Stream the selection as a download. Requires export and history access. Categories without history export their current state and reject from/to. Pagination is optional.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"limit","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"sort","required":false,"schema":{"enum":["accession_number","filing_date","accepted_at","form_type","company_name","ticker","cik","index_url","source","inserted_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Case-insensitive exact match on form_type; comma-separated values","explode":false,"in":"query","name":"form_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on company_name","in":"query","name":"company_name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_filings_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success","headers":{"Content-Disposition":{"description":"Attachment filename","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"export sec/filings","tags":["sec"]}},"/v1/sec/filings/today":{"get":{"description":"Fetches the last 24 hours of data (date-keyed categories include today and yesterday). The endpoint keeps its `/today` name; the window is always the last 24 hours. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["accession_number","filing_date","accepted_at","form_type","company_name","ticker","cik","index_url","source","inserted_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["form_type","ticker","company_name"],"type":"string"}},{"description":"Case-insensitive exact match on form_type; comma-separated values","explode":false,"in":"query","name":"form_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on company_name","in":"query","name":"company_name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_filings_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"today sec/filings (last 24 hours)","tags":["sec"]}},"/v1/sec/filings/{key}":{"get":{"description":"Fetch one row in the standard data envelope. Requires history access and a row within the plan's history window.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"accession_number row key","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_filings_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"fetch sec/filings","tags":["sec"]}},"/v1/sec/insider-filings":{"get":{"description":"Historical rows within the plan's history window. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["accession_number","filing_date","document_type","period_of_report","issuer_name","ticker","issuer_cik","owners","transactions","shares_acquired","shares_disposed","trans_codes","aff_10b5_one","source","inserted_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["accession_number","document_type","ticker","issuer_name"],"type":"string"}},{"description":"Case-insensitive exact match on accession_number; comma-separated values","explode":false,"in":"query","name":"accession_number","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on document_type; comma-separated values","explode":false,"in":"query","name":"document_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on issuer_name","in":"query","name":"issuer_name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_insider_filings_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"list sec/insider-filings","tags":["sec"]}},"/v1/sec/insider-filings/export":{"get":{"description":"Stream the selection as a download. Requires export and history access. Categories without history export their current state and reject from/to. Pagination is optional.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"limit","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"sort","required":false,"schema":{"enum":["accession_number","filing_date","document_type","period_of_report","issuer_name","ticker","issuer_cik","owners","transactions","shares_acquired","shares_disposed","trans_codes","aff_10b5_one","source","inserted_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Case-insensitive exact match on accession_number; comma-separated values","explode":false,"in":"query","name":"accession_number","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on document_type; comma-separated values","explode":false,"in":"query","name":"document_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on issuer_name","in":"query","name":"issuer_name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_insider_filings_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success","headers":{"Content-Disposition":{"description":"Attachment filename","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"export sec/insider-filings","tags":["sec"]}},"/v1/sec/insider-filings/today":{"get":{"description":"Fetches the last 24 hours of data (date-keyed categories include today and yesterday). The endpoint keeps its `/today` name; the window is always the last 24 hours. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["accession_number","filing_date","document_type","period_of_report","issuer_name","ticker","issuer_cik","owners","transactions","shares_acquired","shares_disposed","trans_codes","aff_10b5_one","source","inserted_at"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["accession_number","document_type","ticker","issuer_name"],"type":"string"}},{"description":"Case-insensitive exact match on accession_number; comma-separated values","explode":false,"in":"query","name":"accession_number","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on document_type; comma-separated values","explode":false,"in":"query","name":"document_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive contains match on issuer_name","in":"query","name":"issuer_name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_insider_filings_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"today sec/insider-filings (last 24 hours)","tags":["sec"]}},"/v1/sec/insider-filings/{key}":{"get":{"description":"Fetch one row in the standard data envelope. Requires history access and a row within the plan's history window.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"accession_number row key","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_insider_filings_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"fetch sec/insider-filings","tags":["sec"]}},"/v1/sec/insider-transactions":{"get":{"description":"Historical rows within the plan's history window. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["id","accession_number","filing_date","document_type","issuer_name","ticker","issuer_cik","table_type","security_title","trans_date","trans_code","trans_shares","trans_price_per_share","trans_total_value","trans_acquired_disposed_cd","shares_owned_following","value_owned_following","direct_indirect_ownership","nature_of_ownership","conv_exercise_price","exercise_date","expiration_date","underlying_security_title","underlying_security_shares","footnote_ids"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["accession_number","ticker","trans_code","table_type"],"type":"string"}},{"description":"Case-insensitive exact match on accession_number; comma-separated values","explode":false,"in":"query","name":"accession_number","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on trans_code; comma-separated values","explode":false,"in":"query","name":"trans_code","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on table_type; comma-separated values","explode":false,"in":"query","name":"table_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_insider_transactions_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"list sec/insider-transactions","tags":["sec"]}},"/v1/sec/insider-transactions/export":{"get":{"description":"Stream the selection as a download. Requires export and history access. Categories without history export their current state and reject from/to. Pagination is optional.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"Inclusive date (YYYY-MM-DD) or RFC 3339 timestamp. Plans with limited history require from within their history window.","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"limit","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Optional; omitted to stream the whole selection","in":"query","name":"sort","required":false,"schema":{"enum":["id","accession_number","filing_date","document_type","issuer_name","ticker","issuer_cik","table_type","security_title","trans_date","trans_code","trans_shares","trans_price_per_share","trans_total_value","trans_acquired_disposed_cd","shares_owned_following","value_owned_following","direct_indirect_ownership","nature_of_ownership","conv_exercise_price","exercise_date","expiration_date","underlying_security_title","underlying_security_shares","footnote_ids"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Case-insensitive exact match on accession_number; comma-separated values","explode":false,"in":"query","name":"accession_number","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on trans_code; comma-separated values","explode":false,"in":"query","name":"trans_code","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on table_type; comma-separated values","explode":false,"in":"query","name":"table_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_insider_transactions_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success","headers":{"Content-Disposition":{"description":"Attachment filename","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"export sec/insider-transactions","tags":["sec"]}},"/v1/sec/insider-transactions/today":{"get":{"description":"Fetches the last 24 hours of data (date-keyed categories include today and yesterday). The endpoint keeps its `/today` name; the window is always the last 24 hours. limit, offset and sort are required unless facet is given.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Required unless facet is provided","in":"query","name":"limit","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"integer"}},{"description":"Required unless facet is provided","in":"query","name":"sort","required":false,"schema":{"enum":["id","accession_number","filing_date","document_type","issuer_name","ticker","issuer_cik","table_type","security_title","trans_date","trans_code","trans_shares","trans_price_per_share","trans_total_value","trans_acquired_disposed_cd","shares_owned_following","value_owned_following","direct_indirect_ownership","nature_of_ownership","conv_exercise_price","exercise_date","expiration_date","underlying_security_title","underlying_security_shares","footnote_ids"],"type":"string"}},{"description":"Sort direction","in":"query","name":"order","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Count values of a filter column instead of returning rows. JSON only; paging is optional.","in":"query","name":"facet","required":false,"schema":{"enum":["accession_number","ticker","trans_code","table_type"],"type":"string"}},{"description":"Case-insensitive exact match on accession_number; comma-separated values","explode":false,"in":"query","name":"accession_number","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on ticker; comma-separated values","explode":false,"in":"query","name":"ticker","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on trans_code; comma-separated values","explode":false,"in":"query","name":"trans_code","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Case-insensitive exact match on table_type; comma-separated values","explode":false,"in":"query","name":"table_type","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_insider_transactions_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"},{"properties":{"data":{"items":{"properties":{"count":{"type":"integer"},"value":{"type":"string"}},"required":["value","count"],"type":"object"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}]}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"today sec/insider-transactions (last 24 hours)","tags":["sec"]}},"/v1/sec/insider-transactions/{key}":{"get":{"description":"Fetch one row in the standard data envelope. Requires history access and a row within the plan's history window.","parameters":[{"description":"Response format","in":"query","name":"format","required":false,"schema":{"default":"json","enum":["json","csv","parquet"],"type":"string"}},{"description":"Include live quote fields on each row","in":"query","name":"enrich_data","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"id row key","in":"path","name":"key","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/sec_insider_transactions_row"},"type":"array"},"has_more":{"type":"boolean"},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"format":"int64","type":"integer"}},"required":["data","total","has_more","limit","offset"],"type":"object"}},"application/vnd.apache.parquet":{"schema":{"format":"binary","type":"string"}},"text/csv":{"schema":{"type":"string"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"fetch sec/insider-transactions","tags":["sec"]}},"/v1/stats":{"get":{"parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"as_of":{"format":"date-time","type":"string"},"categories":{"items":{"properties":{"endpoint":{"type":"string"},"last_24h":{"type":"integer"},"last_30d":{"type":"integer"},"last_7d":{"type":"integer"},"path":{"type":"string"},"total":{"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"Success"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[],"summary":"Dataset row counts","tags":["metadata"]}},"/v1/ws":{"get":{"description":"Requires a plan with WebSocket access. This operation describes the HTTP upgrade. Send JSON text frames: {\"action\":\"subscribe\",\"categories\":[\"news\"],\"tickers\":[\"AAPL\"]}, {\"action\":\"unsubscribe\",\"categories\":[\"news\"]}, or {\"action\":\"ping\"}. Server message types: welcome, subscribed, data, lagged, error, pong.","parameters":[{"description":"Comma-separated category paths or scopes to subscribe to","in":"query","name":"categories","required":false,"schema":{"type":"string"}},{"description":"Comma-separated ticker symbols","in":"query","name":"tickers","required":false,"schema":{"type":"string"}}],"responses":{"101":{"description":"Switching protocols to WebSocket"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed","headers":{"Retry-After":{"description":"Seconds until retry","schema":{"minimum":1,"type":"integer"}}}},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request failed"}},"security":[{"bearerAuth":[]},{"queryApiKey":[]}],"summary":"Upgrade to the realtime WebSocket feed","tags":["realtime"]}}},"servers":[{"url":"/"}]}