{"openapi":"3.1.0","info":{"title":"Vantafin Public Data API","description":"REST API for every dataset Vantafin offers: company data, quotes, corporate actions, ownership, fundamentals, SEC filings, news, earnings transcripts and macro series. Authenticate with a Vantafin API key via the `X-API-Key` header, an `Authorization: Bearer` header, or the `apiKey` query parameter.","version":"1.0.0","contact":{"name":"Vantafin","url":"https://vantafin.com/docs"}},"servers":[{"url":"https://api.vantafin.com"}],"paths":{"/v1/status":{"get":{"tags":["public-data-api"],"summary":"Api Status","description":"Confirm the key works and report the caller's rate-limit ceiling.","operationId":"api_status_v1_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/openapi.json":{"get":{"tags":["public-data-api"],"summary":"Public Openapi","description":"Machine-readable OpenAPI 3 specification for the public Data API.\n\nBuilt from FastAPI's generated schema but filtered to only the ``/v1`` paths (the\ninternal chat/stocks routes are excluded) with public-API metadata, the production\nserver URL, and the API-key security schemes. Intended for programmatic integration\nand client codegen; served without authentication.","operationId":"public_openapi_v1_openapi_json_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/companydata/tickers":{"get":{"tags":["public-data-api"],"summary":"List Tickers","description":"List the universe of tickers Vantafin tracks (paginated by ticker cursor).","operationId":"list_tickers_v1_companydata_tickers_get","parameters":[{"name":"search","in":"query","required":false,"schema":{"type":"string","description":"Filter by ticker or company name substring","default":"","title":"Search"},"description":"Filter by ticker or company name substring"},{"name":"type","in":"query","required":false,"schema":{"type":"string","description":"Filter: 'stock', 'etf', or 'fund'","default":"","title":"Type"},"description":"Filter: 'stock', 'etf', or 'fund'"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"Return tickers strictly after this ticker","default":"","title":"Cursor"},"description":"Return tickers strictly after this ticker"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companydata/tickers/{ticker}":{"get":{"tags":["public-data-api"],"summary":"Get Ticker","description":"Full company/ETF profile for a single ticker.","operationId":"get_ticker_v1_companydata_tickers__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companydata/ciks/{cik}":{"get":{"tags":["public-data-api"],"summary":"Get Company By Cik","description":"Full company/ETF profile for a single SEC CIK.","operationId":"get_company_by_cik_v1_companydata_ciks__cik__get","parameters":[{"name":"cik","in":"path","required":true,"schema":{"type":"string","title":"Cik"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companydata/isins/{isin}":{"get":{"tags":["public-data-api"],"summary":"Get Company By Isin","description":"Full company/ETF profile for a single ISIN.","operationId":"get_company_by_isin_v1_companydata_isins__isin__get","parameters":[{"name":"isin","in":"path","required":true,"schema":{"type":"string","title":"Isin"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companydata/cusips/{cusip}":{"get":{"tags":["public-data-api"],"summary":"Get Company By Cusip","description":"Full company/ETF profile for a single CUSIP.","operationId":"get_company_by_cusip_v1_companydata_cusips__cusip__get","parameters":[{"name":"cusip","in":"path","required":true,"schema":{"type":"string","title":"Cusip"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companydata/search":{"get":{"tags":["public-data-api"],"summary":"Search Tickers","description":"Fuzzy company/ticker search — returns the same profile fields as Company Profile (Ticker).","operationId":"search_tickers_v1_companydata_search_get","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","minLength":1,"description":"Search text","title":"Query"},"description":"Search text"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/quotes":{"get":{"tags":["public-data-api"],"summary":"Batch Quotes","description":"Latest stored quote for up to 200 tickers at once.","operationId":"batch_quotes_v1_quotes_get","parameters":[{"name":"tickers","in":"query","required":true,"schema":{"type":"string","description":"Comma-separated tickers, e.g. AAPL,MSFT,NVDA","title":"Tickers"},"description":"Comma-separated tickers, e.g. AAPL,MSFT,NVDA"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/quotes/{ticker}":{"get":{"tags":["public-data-api"],"summary":"Get Quote","description":"Latest stored quote for a single ticker.","operationId":"get_quote_v1_quotes__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/earnings":{"get":{"tags":["public-data-api"],"summary":"List All Earnings","description":"Earnings calendar rows across all tickers.","operationId":"list_all_earnings_v1_earnings_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":250,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/earnings/{ticker}":{"get":{"tags":["public-data-api"],"summary":"Get Earnings","operationId":"get_earnings_v1_earnings__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":1,"default":500,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dividends":{"get":{"tags":["public-data-api"],"summary":"List All Dividends","description":"Dividend history rows across all tickers.","operationId":"list_all_dividends_v1_dividends_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":250,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dividends/{ticker}":{"get":{"tags":["public-data-api"],"summary":"Get Dividends","operationId":"get_dividends_v1_dividends__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":1,"default":500,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/splits":{"get":{"tags":["public-data-api"],"summary":"List All Splits","description":"Stock split rows across all tickers.","operationId":"list_all_splits_v1_splits_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":250,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/splits/{ticker}":{"get":{"tags":["public-data-api"],"summary":"Get Splits","operationId":"get_splits_v1_splits__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":1,"default":500,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/ipos":{"get":{"tags":["public-data-api"],"summary":"List All Ipos","description":"IPO calendar rows (past + upcoming) across all tickers, newest first.\n\nEach row merges the FMP IPO calendar, disclosure filings and prospectus pricing\ninto one record. Optionally bound by ``from``/``to`` on the IPO date.","operationId":"list_all_ipos_v1_ipos_get","parameters":[{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter IPOs on/after this date (YYYY-MM-DD).","title":"From"},"description":"Filter IPOs on/after this date (YYYY-MM-DD)."},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter IPOs on/before this date (YYYY-MM-DD).","title":"To"},"description":"Filter IPOs on/before this date (YYYY-MM-DD)."},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":250,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/ipos/{ticker}":{"get":{"tags":["public-data-api"],"summary":"Get Ipos","description":"Merged IPO record(s) for a single ticker, newest first.","operationId":"get_ipos_v1_ipos__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/etf-holdings/{ticker}":{"get":{"tags":["public-data-api"],"summary":"Get Etf Holdings","description":"Constituent holdings for an ETF or mutual fund ticker.","operationId":"get_etf_holdings_v1_etf_holdings__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/institutional-ownership/{ticker}":{"get":{"tags":["public-data-api"],"summary":"Get Institutional Ownership","description":"ETFs that hold this equity ticker.","operationId":"get_institutional_ownership_v1_institutional_ownership__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":300,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/fund-holdings/{ticker}":{"get":{"tags":["public-data-api"],"summary":"Get Fund Holdings For Symbol","description":"Mutual funds that hold this equity ticker.","operationId":"get_fund_holdings_for_symbol_v1_fund_holdings__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":300,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/short-interest/{ticker}":{"get":{"tags":["public-data-api"],"summary":"Get Short Interest","operationId":"get_short_interest_v1_short_interest__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":1,"default":500,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/insider-transactions":{"get":{"tags":["public-data-api"],"summary":"List Insider Transactions Public","description":"Latest Form 4 insider purchases and sales across all tickers.","operationId":"list_insider_transactions_public_v1_insider_transactions_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":250,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/insider-transactions/{ticker}":{"get":{"tags":["public-data-api"],"summary":"Get Insider Transactions Public","operationId":"get_insider_transactions_public_v1_insider_transactions__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":250,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/macro":{"get":{"tags":["public-data-api"],"summary":"Get Macro","operationId":"get_macro_v1_macro_get","parameters":[{"name":"category","in":"query","required":false,"schema":{"type":"string","description":"Macro category; omit to list categories","default":"","title":"Category"},"description":"Macro category; omit to list categories"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":1,"default":500,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/screener/fields":{"get":{"tags":["public-data-api"],"summary":"Screener Fields","description":"Discoverability: every metric that can be filtered, sorted or selected.\n\nReturns each field's id, human label, category, value kind and whether it is\nfilterable/sortable, plus the operators each kind accepts and the columns always\nreturned by ``GET /v1/screener``.","operationId":"screener_fields_v1_screener_fields_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/screener":{"get":{"tags":["public-data-api"],"summary":"Screener","description":"Screen the US equity universe across the full screener metric registry.\n\nCombine any number of filter clauses, sort by any metric, page with limit/offset,\nand request extra metric columns. See ``GET /v1/screener/fields`` for the metric\ncatalogue. Percent metrics are in percent units (25 = 25%); dollar metrics in\ndollars (1e9 = $1B).","operationId":"screener_v1_screener_get","parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"description":"Repeatable filter clause 'metric:operator:value'. Numeric operators: above, below, above_or_equal, below_or_equal, equal, between (two values, e.g. price:between:10:50), outside. Categorical metrics (sector, industry, country, exchange) use 'equal' with a comma-separated list (e.g. sector:equal:Technology,Healthcare; country uses ISO-2 codes). Text metrics (ticker, company) accept 'equal' or 'contains'.","default":[],"title":"Filter"},"description":"Repeatable filter clause 'metric:operator:value'. Numeric operators: above, below, above_or_equal, below_or_equal, equal, between (two values, e.g. price:between:10:50), outside. Categorical metrics (sector, industry, country, exchange) use 'equal' with a comma-separated list (e.g. sector:equal:Technology,Healthcare; country uses ISO-2 codes). Text metrics (ticker, company) accept 'equal' or 'contains'."},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"Metric id to sort by (default marketCap)","default":"marketCap","title":"Sort"},"description":"Metric id to sort by (default marketCap)"},{"name":"order","in":"query","required":false,"schema":{"type":"string","description":"Sort direction: asc or desc","default":"desc","title":"Order"},"description":"Sort direction: asc or desc"},{"name":"columns","in":"query","required":false,"schema":{"type":"string","description":"Comma-separated extra metric ids to include in each row","default":"","title":"Columns"},"description":"Comma-separated extra metric ids to include in each row"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size, 1-100 (default 50)","default":50,"title":"Limit"},"description":"Page size, 1-100 (default 50)"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Row offset for pagination","default":0,"title":"Offset"},"description":"Row offset for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/financials/{ticker}":{"get":{"tags":["public-data-api"],"summary":"Get Financials","operationId":"get_financials_v1_financials__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"statement","in":"query","required":false,"schema":{"type":"string","description":"income | balance-sheet | cash-flow","default":"income","title":"Statement"},"description":"income | balance-sheet | cash-flow"},{"name":"period","in":"query","required":false,"schema":{"type":"string","description":"annual | quarterly","default":"annual","title":"Period"},"description":"annual | quarterly"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":400,"minimum":1,"default":40,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/revenue-segmentation/{ticker}":{"get":{"tags":["public-data-api"],"summary":"Get Revenue Segmentation","description":"Revenue broken down by product line or geography for equity tickers.","operationId":"get_revenue_segmentation_v1_revenue_segmentation__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"dimension","in":"query","required":false,"schema":{"type":"string","description":"product | geographic","default":"product","title":"Dimension"},"description":"product | geographic"},{"name":"period","in":"query","required":false,"schema":{"type":"string","description":"annual | quarterly","default":"annual","title":"Period"},"description":"annual | quarterly"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/allocation-breakdown/{ticker}":{"get":{"tags":["public-data-api"],"summary":"Get Allocation Breakdown","description":"Sector and country weightings for an ETF or mutual fund.","operationId":"get_allocation_breakdown_v1_allocation_breakdown__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/filings/{ticker}":{"get":{"tags":["public-data-api"],"summary":"Get Filings","operationId":"get_filings_v1_filings__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"form","in":"query","required":false,"schema":{"type":"string","description":"Form type filter, e.g. 10-K or 10-K,10-Q,8-K","default":"","title":"Form"},"description":"Form type filter, e.g. 10-K or 10-K,10-Q,8-K"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":2000,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/filings/by-id/{filing_id}":{"get":{"tags":["public-data-api"],"summary":"Get Filing By Id Public","operationId":"get_filing_by_id_public_v1_filings_by_id__filing_id__get","parameters":[{"name":"filing_id","in":"path","required":true,"schema":{"type":"string","title":"Filing Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/news":{"get":{"tags":["public-data-api"],"summary":"Get Market News","operationId":"get_market_news_v1_news_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":250,"minimum":1,"default":50,"title":"Limit"}},{"name":"type","in":"query","required":false,"schema":{"type":"string","description":"Filter by article type: stockNews or pressRelease.","default":"","title":"Type"},"description":"Filter by article type: stockNews or pressRelease."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/news/{ticker}":{"get":{"tags":["public-data-api"],"summary":"Get Ticker News","operationId":"get_ticker_news_v1_news__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":250,"minimum":1,"default":50,"title":"Limit"}},{"name":"type","in":"query","required":false,"schema":{"type":"string","description":"Filter by article type: stockNews or pressRelease.","default":"","title":"Type"},"description":"Filter by article type: stockNews or pressRelease."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/transcripts/tickers":{"get":{"tags":["public-data-api"],"summary":"List Transcript Symbols","description":"List tickers that have at least one indexed earnings call transcript.","operationId":"list_transcript_symbols_v1_transcripts_tickers_get","parameters":[{"name":"search","in":"query","required":false,"schema":{"type":"string","description":"Filter by ticker substring.","default":"","title":"Search"},"description":"Filter by ticker substring."},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"Return tickers strictly after this ticker (pagination).","default":"","title":"Cursor"},"description":"Return tickers strictly after this ticker (pagination)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/transcripts/{ticker}":{"get":{"tags":["public-data-api"],"summary":"List Transcripts","operationId":"list_transcripts_v1_transcripts__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/transcripts/{ticker}/{transcript_id}":{"get":{"tags":["public-data-api"],"summary":"Get Transcript","operationId":"get_transcript_v1_transcripts__ticker___transcript_id__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"transcript_id","in":"path","required":true,"schema":{"type":"string","title":"Transcript Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/earnings-materials/{ticker}":{"get":{"tags":["public-data-api"],"summary":"List Earnings Materials","description":"List earnings materials (IR decks, press releases, supplements) for a ticker.","operationId":"list_earnings_materials_v1_earnings_materials__ticker__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"period","in":"query","required":false,"schema":{"type":"string","description":"Optional fiscal period filter, e.g. Q3","default":"","title":"Period"},"description":"Optional fiscal period filter, e.g. Q3"},{"name":"fiscal_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Optional fiscal year, e.g. 2025","title":"Fiscal Year"},"description":"Optional fiscal year, e.g. 2025"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/earnings-materials/{ticker}/{material_id}":{"get":{"tags":["public-data-api"],"summary":"Get Earnings Material","description":"Metadata for a single earnings material (includes the chunk-search-able id).","operationId":"get_earnings_material_v1_earnings_materials__ticker___material_id__get","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"material_id","in":"path","required":true,"schema":{"type":"string","title":"Material Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key"},"BearerAuth":{"type":"http","scheme":"bearer"},"ApiKeyQuery":{"type":"apiKey","in":"query","name":"apiKey"}},"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"PatchMeBody":{"properties":{"theme":{"anyOf":[{"type":"string","enum":["light","dark"]},{"type":"null"}],"title":"Theme"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"}},"type":"object","title":"PatchMeBody"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]},{"ApiKeyQuery":[]}]}