{"openapi":"3.1.0","info":{"title":"ptdata","description":"Point-in-time US corporate data: fundamentals, index constituents, filings, earnings.","version":"0.1.0"},"paths":{"/v1/fundamentals":{"get":{"tags":["data"],"summary":"Fundamentals","operationId":"fundamentals_v1_fundamentals_get","parameters":[{"name":"ticker","in":"query","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"as_of_date","in":"query","required":true,"schema":{"type":"string","format":"date","title":"As Of Date"}},{"name":"metrics","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[],"title":"Metrics"}},{"name":"fiscal_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fiscal Year"}},{"name":"fiscal_period","in":"query","required":false,"schema":{"type":"string","default":"FY","title":"Fiscal Period"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundamentalsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/index-constituents":{"get":{"tags":["data"],"summary":"Index Constituents","operationId":"index_constituents_v1_index_constituents_get","parameters":[{"name":"index","in":"query","required":true,"schema":{"type":"string","title":"Index"}},{"name":"as_of_date","in":"query","required":true,"schema":{"type":"string","format":"date","title":"As Of Date"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndexConstituentsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/filings":{"get":{"tags":["data"],"summary":"Filings","operationId":"filings_v1_filings_get","parameters":[{"name":"ticker","in":"query","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"as_of_date","in":"query","required":true,"schema":{"type":"string","format":"date","title":"As Of Date"}},{"name":"form_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Form Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/earnings-event":{"get":{"tags":["data"],"summary":"Earnings Event","operationId":"earnings_event_v1_earnings_event_get","parameters":[{"name":"ticker","in":"query","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"fiscal_year","in":"query","required":true,"schema":{"type":"integer","title":"Fiscal Year"}},{"name":"fiscal_period","in":"query","required":true,"schema":{"type":"string","title":"Fiscal Period"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EarningsEventResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AsReported":{"properties":{"revenue":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Revenue"},"eps_gaap":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Eps Gaap"},"eps_non_gaap":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Eps Non Gaap"}},"type":"object","title":"AsReported"},"Constituent":{"properties":{"ticker":{"type":"string","title":"Ticker"},"cik":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cik"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","required":["ticker"],"title":"Constituent"},"EarningsEventResponse":{"properties":{"ticker":{"type":"string","title":"Ticker"},"fiscal_year":{"type":"integer","title":"Fiscal Year"},"fiscal_period":{"type":"string","title":"Fiscal Period"},"sec_acceptance_ts":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Sec Acceptance Ts"},"dissemination_ts":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Dissemination Ts"},"dissemination_confidence":{"type":"string","title":"Dissemination Confidence"},"filing_accession":{"type":"string","title":"Filing Accession"},"filing":{"$ref":"#/components/schemas/FilingRef"},"as_reported":{"anyOf":[{"$ref":"#/components/schemas/AsReported"},{"type":"null"}]},"implied_expectation":{"anyOf":[{"$ref":"#/components/schemas/ImpliedExpectationBlock"},{"type":"null"}]},"price_reaction":{"anyOf":[{"$ref":"#/components/schemas/PriceReaction"},{"type":"null"}]},"lineage":{"$ref":"#/components/schemas/Lineage"}},"type":"object","required":["ticker","fiscal_year","fiscal_period","dissemination_confidence","filing_accession","filing","lineage"],"title":"EarningsEventResponse"},"FilingMeta":{"properties":{"accession_number":{"type":"string","title":"Accession Number"},"form_type":{"type":"string","title":"Form Type"},"filing_date":{"type":"string","format":"date","title":"Filing Date"},"acceptance_datetime":{"type":"string","format":"date-time","title":"Acceptance Datetime"},"period_of_report":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Period Of Report"},"amends_accession":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amends Accession"}},"type":"object","required":["accession_number","form_type","filing_date","acceptance_datetime"],"title":"FilingMeta"},"FilingMetadataResponse":{"properties":{"ticker":{"type":"string","title":"Ticker"},"as_of_date":{"type":"string","format":"date","title":"As Of Date"},"filings":{"items":{"$ref":"#/components/schemas/FilingMeta"},"type":"array","title":"Filings"},"lineage":{"$ref":"#/components/schemas/Lineage"}},"type":"object","required":["ticker","as_of_date","filings","lineage"],"title":"FilingMetadataResponse"},"FilingRef":{"properties":{"accession_number":{"type":"string","title":"Accession Number"},"acceptance_datetime":{"type":"string","format":"date-time","title":"Acceptance Datetime"}},"type":"object","required":["accession_number","acceptance_datetime"],"title":"FilingRef"},"FundamentalsResponse":{"properties":{"ticker":{"type":"string","title":"Ticker"},"as_of_date":{"type":"string","format":"date","title":"As Of Date"},"metrics":{"additionalProperties":{"$ref":"#/components/schemas/MetricValue"},"type":"object","title":"Metrics"},"unavailable":{"additionalProperties":{"$ref":"#/components/schemas/MetricGuidance"},"type":"object","title":"Unavailable","default":{}},"lineage":{"$ref":"#/components/schemas/Lineage"}},"type":"object","required":["ticker","as_of_date","metrics","lineage"],"title":"FundamentalsResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ImpliedExpectationBlock":{"properties":{"as_of_date":{"type":"string","format":"date","title":"As Of Date"},"expected_move_pct":{"type":"number","title":"Expected Move Pct"},"atm_iv":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Atm Iv"},"method":{"type":"string","title":"Method"}},"type":"object","required":["as_of_date","expected_move_pct","method"],"title":"ImpliedExpectationBlock"},"IndexConstituentsResponse":{"properties":{"index":{"type":"string","title":"Index"},"as_of_date":{"type":"string","format":"date","title":"As Of Date"},"tickers":{"items":{"type":"string"},"type":"array","title":"Tickers"},"constituents":{"items":{"$ref":"#/components/schemas/Constituent"},"type":"array","title":"Constituents"},"lineage":{"$ref":"#/components/schemas/Lineage"}},"type":"object","required":["index","as_of_date","tickers","constituents","lineage"],"title":"IndexConstituentsResponse"},"Lineage":{"properties":{"source":{"type":"string","title":"Source"},"knowledge_from":{"type":"string","format":"date-time","title":"Knowledge From"},"methodology_version":{"type":"string","title":"Methodology Version"},"ingestion_run_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ingestion Run Id"},"amends_chain":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Amends Chain"}},"type":"object","required":["source","knowledge_from","methodology_version"],"title":"Lineage","description":"Provenance attached to every response."},"MetricGuidance":{"properties":{"reason":{"type":"string","title":"Reason"},"available_alternatives":{"items":{"type":"string"},"type":"array","title":"Available Alternatives","default":[]},"docs_url":{"type":"string","title":"Docs Url"}},"type":"object","required":["reason","docs_url"],"title":"MetricGuidance","description":"Why a requested metric is absent + what to use instead. Returned (keyed by the requested\nmetric name) instead of silently omitting a null — most importantly, points a financials query\nfor `revenue` to the as-reported revenue family."},"MetricValue":{"properties":{"value":{"type":"number","title":"Value"},"unit":{"type":"string","title":"Unit"},"fiscal_year":{"type":"integer","title":"Fiscal Year"},"fiscal_period":{"type":"string","title":"Fiscal Period"},"source_accession":{"type":"string","title":"Source Accession"},"knowledge_from":{"type":"string","format":"date-time","title":"Knowledge From"},"methodology_version":{"type":"string","title":"Methodology Version"},"provenance":{"type":"string","title":"Provenance","default":"xbrl"},"extraction_confidence":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Extraction Confidence"}},"type":"object","required":["value","unit","fiscal_year","fiscal_period","source_accession","knowledge_from","methodology_version"],"title":"MetricValue"},"PriceReaction":{"properties":{"window":{"items":{"type":"integer"},"type":"array","title":"Window"},"t_plus_1_return":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"T Plus 1 Return"}},"type":"object","required":["window"],"title":"PriceReaction"},"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"}}},"tags":[{"name":"data","description":"Point-in-time corporate data (free + Pro)"}]}