{"components":{"headers":{"ETag":{"description":"Identifies this response's content. Send it back in `If-None-Match` to get a 304 when nothing changed.","schema":{"type":"string"}},"RateLimit":{"description":"What remains of each limit and the seconds until it resets (IETF RateLimit header fields), e.g. `\"minute\";r=59;t=42, \"month\";r=19873;t=604800, \"concurrent\";r=3`.","schema":{"type":"string"}},"RateLimitPolicy":{"description":"The account's limits (IETF RateLimit header fields), e.g. `\"minute\";q=60;w=60, \"month\";q=20000, \"concurrent\";q=4;qu=\"concurrent-requests\"`.","schema":{"type":"string"}},"RequestId":{"description":"The request's ID, also in `meta.request_id` or the problem's `request_id`. A short token you send in `X-Request-Id` is used instead of a new one.","schema":{"type":"string"}}},"parameters":{"AsOf":{"description":"Read the record as it stood on this day (YYYY-MM-DD): each figure from the latest statement filed on or before the day, the standing statement when it was already on file (so today's date is the standing read), figures no filing had stated by then absent, and a derived figure recomputed from its inputs' statements of that day or withheld. Every row names the filing it is read from in `read_from`. Filed dates are EDGAR's filing dates on the ledger. Values without a revision chain on the ledger yet are absent from an as-of read.","in":"query","name":"as_of","required":false,"schema":{"format":"date","type":"string"}},"Collapse":{"description":"Keep the original discrete row for each metric, unit, period kind, and period end.","in":"query","name":"collapse","required":false,"schema":{"default":false,"type":"boolean"}},"Columns":{"description":"Comma-separated figures to return in each row, beside its cik, ticker, exchange and entity_name. Omit for every figure.","example":["revenue","net_margin","market_cap"],"explode":false,"in":"query","name":"columns","required":false,"schema":{"items":{"enum":["coverage_state","fiscal_year","annual_end_date","instant_end_date","prior_annual_end_date","public_float_end_date","shares_outstanding_end_date","revenue","gross_profit","operating_income","net_income","eps_diluted","operating_cash_flow","capital_expenditures","free_cash_flow","share_based_compensation","depreciation_and_amortization","revenue_prior","net_income_prior","assets","current_assets","cash_and_equivalents","liabilities","current_liabilities","stockholders_equity","common_shares_outstanding","public_float","gross_margin","operating_margin","net_margin","fcf_margin","roe","roa","current_ratio","cash_ratio","liabilities_to_equity","revenue_yoy","net_income_yoy","capex_intensity","sbc_intensity","dividends_paid","share_repurchases","dividends_per_share","capital_returns","payout_ratio","capital_returns_to_fcf","shares_change","price","price_day","market_cap","pe","ps","pb","fcf_yield","dividend_yield","ttm_end_date","revenue_ttm","net_income_ttm","operating_cash_flow_ttm","free_cash_flow_ttm","pe_ttm","ps_ttm","fcf_yield_ttm"],"type":"string"},"type":"array"},"style":"form"},"Day":{"description":"The filing day to read, as YYYY-MM-DD. Omitted, the latest day on file. A day past the latest is not found.","in":"query","name":"date","required":false,"schema":{"format":"date","type":"string"}},"Dir":{"in":"query","name":"dir","required":false,"schema":{"default":"asc","enum":["asc","desc"],"type":"string"}},"Forms":{"description":"SEC form codes to include, comma-separated and matched exactly after uppercase normalization. Omit for every form on file.","example":["10-Q","10-K"],"explode":false,"in":"query","name":"forms","required":false,"schema":{"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"},"style":"form"},"IfNoneMatch":{"description":"The `ETag` of a response you hold. When the response hasn't changed, the answer is a 304 with no body.","in":"header","name":"If-None-Match","required":false,"schema":{"type":"string"}},"InsiderKind":{"in":"query","name":"kind","required":false,"schema":{"default":"all","enum":["all","purchase","sale"],"type":"string"}},"InsiderLimit":{"description":"Maximum number of ownership filings returned.","in":"query","name":"limit","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},"Items":{"description":"8-K item numbers a filing must carry, comma-separated: 2.02 for earnings announcements. Omit for every filing.","example":["2.02"],"explode":false,"in":"query","name":"items","required":false,"schema":{"items":{"minLength":4,"type":"string"},"minItems":1,"type":"array"},"style":"form"},"Limit":{"in":"query","name":"limit","required":false,"schema":{"default":25,"maximum":500,"minimum":1,"type":"integer"}},"MetricKey":{"description":"Thaler metric key such as revenue or free_cash_flow","in":"path","name":"metric_key","required":true,"schema":{"minLength":1,"type":"string"}},"MetricKeys":{"description":"Canonical metric keys to include, comma-separated. Omit for every metric.","example":["revenue","net_income"],"explode":false,"in":"query","name":"keys","required":false,"schema":{"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"},"style":"form"},"MetricLimit":{"description":"Limits are capped at 500 unless keys and collapse are both supplied.","in":"query","name":"limit","required":false,"schema":{"default":25,"maximum":5000,"minimum":1,"type":"integer"}},"MetricValueId":{"description":"Return lineage for one exact metric value.","in":"query","name":"metric_value_id","required":false,"schema":{"format":"uuid","type":"string"}},"Offset":{"in":"query","name":"offset","required":false,"schema":{"default":0,"maximum":1000000,"minimum":0,"type":"integer"}},"Period":{"in":"query","name":"period","required":false,"schema":{"default":"latest","enum":["latest","annual","quarterly","all"],"type":"string"}},"RevisionFiscalPeriod":{"description":"Only the chains of values with this fiscal period label (FY, Q1 to Q4), case-insensitive.","in":"query","name":"fiscal_period","required":false,"schema":{"maxLength":4,"type":"string"}},"RevisionFiscalYear":{"description":"Only the chains of values placed in this fiscal year.","in":"query","name":"fiscal_year","required":false,"schema":{"type":"integer"}},"SegmentsPeriod":{"in":"query","name":"period","required":false,"schema":{"default":"annual","enum":["annual","quarterly"],"type":"string"}},"Since":{"description":"Include transactions on or after this reported transaction date.","in":"query","name":"since","required":false,"schema":{"format":"date","type":"string"}},"Sort":{"description":"Screen column to sort by: ticker or any screen figure key. Figure sorts always place missing figures last.","in":"query","name":"sort","required":false,"schema":{"default":"ticker","type":"string"}},"Ticker":{"description":"Ticker symbol addressed by Thaler's security list","in":"path","name":"ticker","required":true,"schema":{"minLength":1,"type":"string"}},"Where":{"description":"Repeatable filter clause of the form column:op:value, where op is gte, lte, gt, or lt and value is a plain decimal (no exponents) of at most 32 characters, e.g. revenue:gte:1000000000.","example":["revenue:gte:1000000000"],"explode":true,"in":"query","name":"where","required":false,"schema":{"items":{"type":"string"},"maxItems":64,"type":"array"},"style":"form"}},"responses":{"BadRequest":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"A parameter is missing, unknown or out of range; `detail` says which.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"InternalError":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Thaler failed to answer. The request isn't counted.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"NotFound":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"No such company, filing, holder or day. For a ticker route, Thaler doesn't cover the ticker.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"NotModified":{"description":"The response is unchanged since the `ETag` sent in `If-None-Match`. Counted like any other request.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"}}},"RateLimited":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Refused: the account has reached a limit (60 requests a minute, 20000 a month, 4 at a time). The request isn't counted.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"Retry-After":{"description":"Seconds until a request can succeed.","schema":{"minimum":1,"type":"integer"}},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"Timeout":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"The request took too long. The request isn't counted.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"Unauthorized":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"No API key, or a key that is malformed, unknown, revoked or expired. `code` says which.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"Unavailable":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Thaler is busy or not ready. Try again shortly; the request isn't counted.","headers":{"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}}},"schemas":{"Attribution":{"additionalProperties":false,"properties":{"text":{"description":"The sentence to show.","type":"string"},"url":{"description":"The terms it points to.","format":"uri","type":"string"}},"required":["text","url"],"type":"object"},"Decimal":{"description":"A figure as a decimal string, exact to the digit as filed: `416161000000`, `39.75`, `-58000000`, `0.3018`. Parse it with a decimal type; a double loses digits past the fifteenth.","pattern":"^-?[0-9]+(\\.[0-9]+)?$","type":"string"},"FactLocation":{"properties":{"concept":{"type":["string","null"]},"context":{"type":["string","null"]},"document":{"type":["string","null"]},"line_id":{"type":["string","null"]},"match_quality":{"enum":["unique","ambiguous","hidden_only","none"],"type":"string"}},"required":["match_quality"],"type":"object"},"Filing":{"properties":{"accepted_at":{"description":"When EDGAR accepted the filing; for an announcement, the moment it went public.","format":"date-time","type":["string","null"]},"accession_number":{"type":"string"},"announcement_timing":{"description":"Session slot of an earnings announcement against the New York trading day (09:30 to 16:00 Eastern); null for every other filing.","enum":["before_open","during_market","after_close",null],"type":["string","null"]},"cik":{"type":"integer"},"entity_name":{"type":"string"},"exchange":{"type":["string","null"]},"filed_at":{"format":"date","type":["string","null"]},"fiscal_period":{"type":["string","null"]},"fiscal_year":{"type":["integer","null"]},"form":{"type":"string"},"items":{"description":"8-K item numbers as EDGAR lists them (an earnings announcement is furnished under 2.02); empty for other forms.","items":{"type":"string"},"type":"array"},"primary_document":{"type":["string","null"]},"report_date":{"format":"date","type":["string","null"]},"source_url":{"format":"uri","type":["string","null"]},"ticker":{"type":["string","null"]}},"required":["cik","entity_name","form","accession_number"],"type":"object"},"FilingSource":{"properties":{"accepted_at":{"format":"date-time","type":["string","null"]},"accession_number":{"type":"string"},"cik":{"type":"integer"},"documents":{"description":"Its documents: the form's own document first, then the exhibits Thaler read.","items":{"$ref":"#/components/schemas/FilingSourceDocument"},"type":"array"},"entity_name":{"type":"string"},"filed_at":{"format":"date","type":["string","null"]},"folder":{"description":"The filing's folder on EDGAR, with a trailing slash.","format":"uri","type":"string"},"form":{"type":"string"},"ticker":{"type":["string","null"]}},"required":["accession_number","cik","entity_name","form","folder","documents"],"type":"object"},"FilingSourceDocument":{"properties":{"document":{"description":"The file's name in the filing's folder.","type":"string"},"kind":{"description":"The document's type as filed: the form code, or an exhibit number.","type":"string"},"read":{"description":"Whether Thaler has read this document.","type":"boolean"},"url":{"format":"uri","type":"string"}},"required":["document","kind","url","read"],"type":"object"},"FilingSourceEnvelope":{"properties":{"data":{"$ref":"#/components/schemas/FilingSource"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"FilingsDay":{"properties":{"companies":{"description":"How many companies made them.","type":"integer"},"date":{"description":"The day shown.","format":"date","type":"string"},"days":{"description":"Filings per day over the fourteen days ending on the day shown, oldest first; days without filings are absent.","items":{"$ref":"#/components/schemas/FilingsDayCount"},"type":"array"},"filings":{"description":"Every filing the covered universe made that day.","type":"integer"},"forms":{"description":"Every form filed that day with its count, most filed first.","items":{"$ref":"#/components/schemas/FilingsDayForm"},"type":"array"},"insiders":{"$ref":"#/components/schemas/FilingsDayInsiders"},"latest":{"description":"The most recent day with filings on file.","format":"date","type":"string"},"lines":{"description":"Current reports and event notices, earliest acceptance first, capped at 1500.","items":{"$ref":"#/components/schemas/Filing"},"type":"array"},"lines_total":{"description":"How many lines the day owed; larger than the lines carried only past the cap.","type":"integer"},"live":{"description":"The day is today in New York and the wire is still adding to it.","type":"boolean"},"reports":{"items":{"$ref":"#/components/schemas/FilingsDayReport"},"type":"array"},"updated_at":{"description":"When EDGAR accepted the day's latest filing on file.","format":"date-time","type":"string"}},"required":["date","latest","filings","companies","lines","lines_total","reports","insiders","forms","days"],"type":"object"},"FilingsDayCount":{"properties":{"date":{"format":"date","type":"string"},"filings":{"type":"integer"}},"required":["date","filings"],"type":"object"},"FilingsDayEnvelope":{"properties":{"data":{"$ref":"#/components/schemas/FilingsDay"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"FilingsDayForm":{"properties":{"filings":{"type":"integer"},"form":{"type":"string"}},"required":["form","filings"],"type":"object"},"FilingsDayInsiders":{"properties":{"largest":{"description":"The day's largest trades by value, largest first, one per filing and side.","items":{"$ref":"#/components/schemas/FilingsDayTrade"},"type":"array"},"purchase_value":{"$ref":"#/components/schemas/Decimal"},"purchases":{"description":"Filings reporting open-market purchases.","type":"integer"},"sale_value":{"$ref":"#/components/schemas/Decimal"},"sales":{"description":"Filings reporting open-market sales.","type":"integer"}},"required":["purchases","purchase_value","sales","sale_value","largest"],"type":"object"},"FilingsDayReport":{"properties":{"accepted_at":{"format":"date-time","type":["string","null"]},"accession_number":{"type":"string"},"cik":{"type":"integer"},"entity_name":{"type":"string"},"exchange":{"type":["string","null"]},"fiscal_period":{"type":["string","null"]},"fiscal_year":{"type":["integer","null"]},"form":{"type":"string"},"prior_revenue":{"$ref":"#/components/schemas/NullableDecimal","description":"Revenue for the matching period a year earlier, when on file."},"report_date":{"format":"date","type":["string","null"]},"revenue":{"$ref":"#/components/schemas/NullableDecimal","description":"Revenue for the period the report covers, as reported, when the ledger already holds it."},"revenue_end":{"format":"date","type":["string","null"]},"revenue_start":{"format":"date","type":["string","null"]},"source_url":{"type":["string","null"]},"ticker":{"type":["string","null"]}},"required":["cik","entity_name","form","accession_number"],"type":"object"},"FilingsDayTrade":{"properties":{"accession_number":{"type":"string"},"cik":{"type":"integer"},"entity_name":{"type":"string"},"is_director":{"type":"boolean"},"is_officer":{"type":"boolean"},"is_ten_percent_owner":{"type":"boolean"},"kind":{"enum":["purchase","sale"],"type":"string"},"officer_title":{"type":["string","null"]},"owner_name":{"type":["string","null"]},"shares":{"$ref":"#/components/schemas/Decimal"},"source_url":{"type":"string"},"ticker":{"type":["string","null"]},"value":{"$ref":"#/components/schemas/Decimal"}},"required":["accession_number","cik","entity_name","kind","is_director","is_officer","is_ten_percent_owner","shares","value","source_url"],"type":"object"},"FilingsEnvelope":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Filing"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"Holder":{"properties":{"accession_number":{"type":"string"},"cik":{"type":"integer"},"closed":{"type":["integer","null"]},"filed_at":{"format":"date","type":"string"},"name":{"type":"string"},"opened":{"description":"Null when the manager has no earlier report on the ledger.","type":["integer","null"]},"other_managers":{"type":"integer"},"period":{"format":"date","type":"string"},"positions":{"type":"integer"},"prior_period":{"format":"date","type":["string","null"]},"quarters":{"items":{"$ref":"#/components/schemas/HolderQuarter"},"type":"array"},"rows":{"items":{"$ref":"#/components/schemas/HolderPosition"},"type":"array"},"rows_total":{"type":"integer"},"value_total":{"$ref":"#/components/schemas/Decimal","description":"Dollars."}},"required":["cik","name","period","accession_number","filed_at","positions","value_total","other_managers","opened","closed","rows","rows_total","quarters"],"type":"object"},"HolderEnvelope":{"properties":{"data":{"$ref":"#/components/schemas/Holder"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"HolderHit":{"properties":{"cik":{"type":"integer"},"latest_period":{"format":"date","type":["string","null"]},"latest_positions":{"type":["integer","null"]},"latest_value":{"$ref":"#/components/schemas/NullableDecimal"},"name":{"type":"string"}},"required":["cik","name"],"type":"object"},"HolderHitsEnvelope":{"properties":{"data":{"items":{"$ref":"#/components/schemas/HolderHit"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"HolderPosition":{"properties":{"amount":{"$ref":"#/components/schemas/Decimal"},"amount_type":{"type":"string"},"cik":{"type":["integer","null"]},"class":{"type":"string"},"cusip":{"type":"string"},"entity_name":{"type":["string","null"]},"issuer":{"description":"As the manager names it.","type":"string"},"prior_amount":{"$ref":"#/components/schemas/NullableDecimal"},"prior_value":{"$ref":"#/components/schemas/NullableDecimal"},"put_call":{"description":"Put, Call, or empty.","type":"string"},"ticker":{"type":["string","null"]},"value":{"$ref":"#/components/schemas/Decimal"},"weight":{"$ref":"#/components/schemas/NullableDecimal"}},"required":["cusip","issuer","class","put_call","amount","amount_type","value"],"type":"object"},"HolderQuarter":{"properties":{"accession_number":{"type":"string"},"filed_at":{"format":"date","type":"string"},"period":{"format":"date","type":"string"},"positions":{"type":"integer"},"value_total":{"$ref":"#/components/schemas/Decimal"}},"required":["period","accession_number","filed_at","positions","value_total"],"type":"object"},"InsiderActivityEnvelope":{"properties":{"data":{"$ref":"#/components/schemas/InsiderActivityPage"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"InsiderActivityPage":{"properties":{"filings":{"items":{"$ref":"#/components/schemas/InsiderFiling"},"type":"array"},"purchase_transactions":{"minimum":0,"type":"integer"},"reported_purchase_value":{"$ref":"#/components/schemas/Decimal","description":"Shares × price over counted rows, each distinct trade once however many filers reported it."},"reported_sale_value":{"$ref":"#/components/schemas/Decimal","description":"Shares × price over counted rows, each distinct trade once however many filers reported it."},"sale_transactions":{"minimum":0,"type":"integer"},"total_transactions":{"minimum":0,"type":"integer"},"uncounted_transactions":{"description":"Rows listed but left out of the values: a filed price that fails a plausibility check, or a security that is not common equity.","minimum":0,"type":"integer"}},"required":["total_transactions","purchase_transactions","sale_transactions","uncounted_transactions","reported_purchase_value","reported_sale_value","filings"],"type":"object"},"InsiderFiling":{"properties":{"accession_number":{"type":"string"},"aff10b5_one":{"type":["boolean","null"]},"cik":{"type":"integer"},"entity_name":{"type":"string"},"filed_at":{"format":"date","type":["string","null"]},"footnotes":{"items":{"$ref":"#/components/schemas/InsiderFootnote"},"type":"array"},"form":{"enum":["4","4/A","5","5/A"],"type":"string"},"is_amendment":{"type":"boolean"},"owners":{"items":{"$ref":"#/components/schemas/InsiderOwner"},"type":"array"},"period_of_report":{"format":"date","type":["string","null"]},"source_url":{"format":"uri","type":"string"},"ticker":{"type":["string","null"]},"transactions":{"items":{"$ref":"#/components/schemas/InsiderTransaction"},"type":"array"}},"required":["accession_number","cik","entity_name","form","is_amendment","source_url","owners","transactions","footnotes"],"type":"object"},"InsiderFootnote":{"properties":{"id":{"type":"string"},"text":{"type":"string"}},"required":["id","text"],"type":"object"},"InsiderOwner":{"properties":{"cik":{"type":"integer"},"is_director":{"type":"boolean"},"is_officer":{"type":"boolean"},"is_other":{"type":"boolean"},"is_ten_percent_owner":{"type":"boolean"},"name":{"type":"string"},"officer_title":{"type":["string","null"]},"other_text":{"type":["string","null"]}},"required":["cik","name","is_director","is_officer","is_ten_percent_owner","is_other"],"type":"object"},"InsiderTransaction":{"properties":{"acquired_disposed_code":{"type":["string","null"]},"direct_indirect_ownership":{"type":["string","null"]},"footnote_ids":{"items":{"type":"string"},"type":"array"},"nature_of_ownership":{"type":["string","null"]},"ordinal":{"type":"integer"},"price_per_share":{"$ref":"#/components/schemas/NullableDecimal"},"security_title":{"type":"string"},"shares":{"$ref":"#/components/schemas/NullableDecimal"},"shares_owned_following":{"$ref":"#/components/schemas/NullableDecimal"},"transaction_code":{"enum":["P","S"],"type":"string"},"transaction_date":{"format":"date","type":["string","null"]},"transaction_value":{"$ref":"#/components/schemas/NullableDecimal"},"value_status":{"description":"Whether shares × price stands as filed (counted), fails a plausibility check on the filed price (suspect), or is a security other than common equity such as notes or preferred (not_equity). Only counted rows enter the page's values.","enum":["counted","suspect","not_equity"],"type":"string"}},"required":["ordinal","security_title","transaction_code","footnote_ids","value_status"],"type":"object"},"MetricCatalogEntry":{"properties":{"covered_company_count":{"minimum":0,"type":"integer"},"description":{"type":"string"},"formula":{"type":["string","null"]},"key":{"type":"string"},"label":{"type":"string"},"mappings":{"items":{"$ref":"#/components/schemas/MetricMapping"},"type":"array"},"statement":{"type":["string","null"]},"unit":{"type":["string","null"]},"value_kind":{"enum":["reported","derived"],"type":"string"}},"required":["key","label","description","value_kind","covered_company_count","mappings"],"type":"object"},"MetricCatalogEnvelope":{"properties":{"data":{"items":{"$ref":"#/components/schemas/MetricCatalogEntry"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"MetricLineage":{"properties":{"accession_number":{"type":["string","null"]},"cik":{"type":"integer"},"concept":{"type":"string"},"end_date":{"format":"date","type":"string"},"entity_name":{"type":"string"},"exchange":{"type":["string","null"]},"filed_at":{"format":"date","type":["string","null"]},"fiscal_period":{"type":["string","null"]},"fiscal_year":{"type":["integer","null"]},"form":{"type":["string","null"]},"frame":{"type":["string","null"]},"location":{"$ref":"#/components/schemas/FactLocation"},"metric_key":{"type":"string"},"metric_label":{"type":"string"},"metric_unit":{"type":"string"},"metric_value":{"$ref":"#/components/schemas/Decimal"},"metric_value_id":{"format":"uuid","type":"string"},"period_kind":{"type":"string"},"raw_fact_id":{"format":"uuid","type":"string"},"raw_ingestion_run_id":{"format":"uuid","type":["string","null"]},"raw_unit":{"type":"string"},"raw_value":{"$ref":"#/components/schemas/Decimal"},"role":{"type":"string"},"source_payload_id":{"format":"uuid","type":["string","null"]},"start_date":{"format":"date","type":["string","null"]},"taxonomy":{"type":"string"},"ticker":{"type":["string","null"]}},"required":["metric_value_id","cik","entity_name","metric_key","metric_label","metric_value","metric_unit","end_date","period_kind","raw_fact_id","taxonomy","concept","raw_unit","raw_value","role"],"type":"object"},"MetricLineageEnvelope":{"properties":{"data":{"items":{"$ref":"#/components/schemas/MetricLineage"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"MetricMapping":{"properties":{"concept":{"type":"string"},"priority":{"type":"integer"},"sign_multiplier":{"type":"integer"},"taxonomy":{"type":"string"},"unit":{"type":["string","null"]}},"required":["taxonomy","concept","priority","sign_multiplier"],"type":"object"},"MetricRevision":{"properties":{"accession_number":{"type":"string"},"cik":{"type":"integer"},"delta":{"$ref":"#/components/schemas/NullableDecimal","description":"value minus previous_value on a revised row; null otherwise."},"end_date":{"format":"date","type":"string"},"entity_name":{"type":"string"},"exchange":{"type":["string","null"]},"filed_at":{"format":"date","type":["string","null"]},"fiscal_period":{"type":["string","null"]},"fiscal_year":{"type":["integer","null"]},"form":{"type":["string","null"]},"kind":{"enum":["first","same","revised","re_expressed"],"type":"string"},"metric_key":{"type":"string"},"metric_label":{"type":"string"},"metric_unit":{"type":"string"},"metric_value_id":{"format":"uuid","type":"string"},"period_kind":{"type":"string"},"previous_value":{"$ref":"#/components/schemas/NullableDecimal"},"raw_fact_id":{"format":"uuid","type":"string"},"revision_rank":{"description":"The filing's place in the chain, 1 for the earliest filing on the ledger to state the figure.","minimum":1,"type":"integer"},"split_ratio":{"$ref":"#/components/schemas/NullableDecimal","description":"New shares per old share a re_expressed statement was re-expressed by; null otherwise."},"standing":{"description":"The statement whose fact is the metric value's source lineage.","type":"boolean"},"start_date":{"format":"date","type":["string","null"]},"ticker":{"type":["string","null"]},"value":{"$ref":"#/components/schemas/Decimal"}},"required":["metric_value_id","cik","entity_name","metric_key","metric_label","metric_unit","end_date","period_kind","revision_rank","kind","value","raw_fact_id","accession_number","standing"],"type":"object"},"MetricRevisionsEnvelope":{"properties":{"data":{"items":{"$ref":"#/components/schemas/MetricRevision"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"MetricStatementRef":{"properties":{"accession_number":{"type":"string"},"filed_at":{"format":"date","type":["string","null"]},"form":{"type":["string","null"]},"kind":{"enum":["first","same","revised","re_expressed"],"type":"string"},"revision_rank":{"minimum":1,"type":"integer"}},"required":["accession_number","revision_rank","kind"],"type":"object"},"MetricValue":{"properties":{"cik":{"type":"integer"},"confidence":{"$ref":"#/components/schemas/Decimal"},"end_date":{"format":"date","type":"string"},"entity_name":{"type":"string"},"exchange":{"type":["string","null"]},"fiscal_period":{"type":["string","null"]},"fiscal_year":{"type":["integer","null"]},"metric_key":{"type":"string"},"metric_label":{"type":"string"},"metric_value_id":{"format":"uuid","type":"string"},"period_kind":{"type":"string"},"read_from":{"description":"The filing the value is read from: the standing statement, or under an as-of read the statement on file by that day; null where the ledger holds no revision chain for the value yet. A derived figure names the latest-filed of the statements its inputs are read from.","oneOf":[{"$ref":"#/components/schemas/MetricStatementRef"},{"type":"null"}]},"revised":{"description":"A later filing changed this figure (the revision chain holds a revised statement). Under an as-of read, among the statements on file by that day.","type":"boolean"},"revision_count":{"minimum":0,"type":"integer"},"start_date":{"format":"date","type":["string","null"]},"statement":{"type":["string","null"]},"ticker":{"type":["string","null"]},"unit":{"type":"string"},"value":{"$ref":"#/components/schemas/Decimal"},"value_kind":{"enum":["reported","derived"],"type":"string"}},"required":["metric_value_id","cik","entity_name","metric_key","metric_label","value","unit","end_date","period_kind","value_kind","confidence"],"type":"object"},"MetricValuesEnvelope":{"properties":{"data":{"items":{"$ref":"#/components/schemas/MetricValue"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"NullableDecimal":{"description":"A decimal string as `Decimal`, or null where the figure is not on file.","pattern":"^-?[0-9]+(\\.[0-9]+)?$","type":["string","null"]},"PriceAction":{"properties":{"evidence":{"description":"The accession the filing's ratio came from","type":["string","null"]},"ex_date":{"format":"date","type":"string"},"kind":{"enum":["split","dividend","ticker_change"],"type":"string"},"ratio":{"$ref":"#/components/schemas/NullableDecimal","description":"New shares per old share"},"source":{"type":"string"}},"required":["ex_date","kind","source"],"type":"object"},"PriceLatest":{"properties":{"day":{"format":"date","type":"string"},"last_sale_at":{"format":"date-time","type":["string","null"]},"market_cap":{"$ref":"#/components/schemas/NullableDecimal","description":"price times shares; null when no count qualifies"},"price":{"$ref":"#/components/schemas/Decimal"},"prior_day":{"format":"date","type":["string","null"]},"prior_price":{"$ref":"#/components/schemas/NullableDecimal"},"record_close":{"$ref":"#/components/schemas/NullableDecimal"},"record_day":{"format":"date","type":["string","null"]},"record_source":{"type":["string","null"]},"shares":{"$ref":"#/components/schemas/NullableDecimal","description":"The company's latest certified share count on or before the day, no older than 400 days"},"shares_as_of":{"format":"date","type":["string","null"]},"source":{"description":"iex, or the record source that stands for the day","type":"string"},"symbol":{"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["symbol","day","price","source","updated_at"],"type":"object"},"PriceMark":{"properties":{"agreement":{"$ref":"#/components/schemas/NullableDecimal","description":"Share of the sample within one percent"},"close":{"$ref":"#/components/schemas/Decimal"},"day":{"format":"date","type":"string"},"sample":{"description":"Reports or trades behind the figure","type":"integer"},"source":{"type":"string"}},"required":["day","close","source","sample"],"type":"object"},"Prices":{"properties":{"actions":{"description":"Every split the company's filings and the tape agree on","items":{"$ref":"#/components/schemas/PriceAction"},"type":"array"},"adj_price":{"description":"The price in today's shares: divided by every split's ratio since the day","items":{"$ref":"#/components/schemas/Decimal"},"type":"array"},"cik":{"type":"integer"},"days":{"items":{"format":"date","type":"string"},"type":"array"},"entity_name":{"type":"string"},"from":{"format":"date","type":"string"},"latest":{"oneOf":[{"$ref":"#/components/schemas/PriceLatest"},{"type":"null"}]},"market_cap":{"description":"The price times the latest certified share count on or before the day, carried through the splits between; null where no count within 400 days stands or the company's classes trade apart","items":{"$ref":"#/components/schemas/NullableDecimal"},"type":"array"},"marks":{"items":{"$ref":"#/components/schemas/PriceMark"},"type":"array"},"price":{"description":"Dollars, as traded on the day","items":{"$ref":"#/components/schemas/Decimal"},"type":"array"},"source":{"items":{"enum":["iex","fails","iex_official","thirteen_f","nport"],"type":"string"},"type":"array"},"ticker":{"type":"string"},"to":{"format":"date","type":"string"}},"required":["cik","ticker","entity_name","from","to","days","price","adj_price","source","market_cap","marks","actions"],"type":"object"},"PricesEnvelope":{"properties":{"data":{"$ref":"#/components/schemas/Prices"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"Problem":{"description":"An RFC 9457 problem. `type` links to the code's entry on the errors page.","properties":{"code":{"enum":["bad_request","missing_key","invalid_key","revoked_key","expired_key","not_found","method_not_allowed","rate_limited","internal_error","unavailable","timeout"],"type":"string"},"detail":{"description":"What went wrong and what to do, in a sentence or two.","type":"string"},"request_id":{"description":"Quote it when you write to support@thaler.sh.","type":"string"},"status":{"maximum":599,"minimum":400,"type":"integer"},"title":{"type":"string"},"type":{"format":"uri","type":"string"},"violated-policies":{"description":"On a 429, the limits the request would have broken.","items":{"enum":["minute","month","concurrent"],"type":"string"},"type":"array"}},"required":["type","title","status","detail","code","request_id"],"type":"object"},"RawConcept":{"properties":{"cik":{"type":"integer"},"concept":{"type":"string"},"earliest_end_date":{"format":"date","type":["string","null"]},"entity_name":{"type":"string"},"exchange":{"type":"string"},"fact_count":{"type":"integer"},"latest_end_date":{"format":"date","type":["string","null"]},"taxonomy":{"type":"string"},"ticker":{"type":"string"},"unit":{"type":"string"}},"required":["ticker","exchange","cik","entity_name","taxonomy","concept","unit","fact_count"],"type":"object"},"RawConceptsEnvelope":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RawConcept"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"Release":{"additionalProperties":false,"properties":{"checks":{"description":"Whether the release passed the checks run on it before it was published.","enum":["passed","failed"],"type":"string"},"date":{"description":"The release date.","format":"date","type":"string"},"published_at":{"format":"date-time","type":"string"},"stamp":{"description":"The release date and the first characters of its content hash, which identify it exactly.","type":"string"}},"required":["date","checks","published_at","stamp"],"type":"object"},"ReleaseEnvelope":{"properties":{"data":{"$ref":"#/components/schemas/Release"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"ResponseMeta":{"additionalProperties":false,"properties":{"as_of":{"description":"The day a read of the record as it stood was asked for.","format":"date","type":"string"},"attribution":{"$ref":"#/components/schemas/Attribution","description":"On prices, the attribution IEX's terms require wherever the prices are shown."},"collapse":{"type":"boolean"},"columns":{"description":"On the Screener, the figures asked for with `columns`.","items":{"type":"string"},"type":"array"},"date":{"format":"date","type":"string"},"dir":{"enum":["asc","desc"],"type":"string"},"forms":{"type":"string"},"keys":{"items":{"type":"string"},"type":"array"},"kind":{"enum":["purchase","sale"],"type":"string"},"limit":{"maximum":500,"minimum":1,"type":"integer"},"metric_key":{"type":"string"},"offset":{"maximum":1000000,"minimum":0,"type":"integer"},"period":{"enum":["latest","annual","quarterly","all"],"type":"string"},"query":{"type":"string"},"release":{"description":"The data release this response was served from; null before the first release.","oneOf":[{"$ref":"#/components/schemas/Release"},{"type":"null"}]},"request_id":{"description":"Quote it when you write to support@thaler.sh.","type":"string"},"route":{"type":"string"},"schema":{"const":"thaler.data.v1","type":"string"},"set_aside":{"minimum":0,"type":"integer"},"since":{"format":"date","type":"string"},"sort":{"type":"string"},"ticker":{"type":"string"},"total":{"minimum":0,"type":"integer"},"universe":{"minimum":0,"type":"integer"},"where":{"items":{"type":"string"},"maxItems":64,"type":"array"}},"required":["schema","route","release","request_id"],"type":"object"},"ScreenEnvelope":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ScreenRow"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"ScreenRow":{"properties":{"annual_end_date":{"format":"date","type":["string","null"]},"assets":{"$ref":"#/components/schemas/NullableDecimal"},"capex_intensity":{"$ref":"#/components/schemas/NullableDecimal"},"capital_expenditures":{"$ref":"#/components/schemas/NullableDecimal"},"capital_returns":{"$ref":"#/components/schemas/NullableDecimal"},"capital_returns_to_fcf":{"$ref":"#/components/schemas/NullableDecimal"},"cash_and_equivalents":{"$ref":"#/components/schemas/NullableDecimal"},"cash_ratio":{"$ref":"#/components/schemas/NullableDecimal"},"cik":{"type":"integer"},"common_shares_outstanding":{"$ref":"#/components/schemas/NullableDecimal"},"coverage_state":{"type":"string"},"current_assets":{"$ref":"#/components/schemas/NullableDecimal"},"current_liabilities":{"$ref":"#/components/schemas/NullableDecimal"},"current_ratio":{"$ref":"#/components/schemas/NullableDecimal"},"depreciation_and_amortization":{"$ref":"#/components/schemas/NullableDecimal"},"dividend_yield":{"$ref":"#/components/schemas/NullableDecimal"},"dividends_paid":{"$ref":"#/components/schemas/NullableDecimal"},"dividends_per_share":{"$ref":"#/components/schemas/NullableDecimal"},"entity_name":{"type":"string"},"eps_diluted":{"$ref":"#/components/schemas/NullableDecimal"},"exchange":{"type":"string"},"fcf_margin":{"$ref":"#/components/schemas/NullableDecimal"},"fcf_yield":{"$ref":"#/components/schemas/NullableDecimal"},"fcf_yield_ttm":{"$ref":"#/components/schemas/NullableDecimal"},"fiscal_year":{"type":["integer","null"]},"free_cash_flow":{"$ref":"#/components/schemas/NullableDecimal"},"free_cash_flow_ttm":{"$ref":"#/components/schemas/NullableDecimal"},"gross_margin":{"$ref":"#/components/schemas/NullableDecimal"},"gross_profit":{"$ref":"#/components/schemas/NullableDecimal"},"instant_end_date":{"format":"date","type":["string","null"]},"liabilities":{"$ref":"#/components/schemas/NullableDecimal"},"liabilities_to_equity":{"$ref":"#/components/schemas/NullableDecimal"},"market_cap":{"$ref":"#/components/schemas/NullableDecimal"},"net_income":{"$ref":"#/components/schemas/NullableDecimal"},"net_income_prior":{"$ref":"#/components/schemas/NullableDecimal"},"net_income_ttm":{"$ref":"#/components/schemas/NullableDecimal"},"net_income_yoy":{"$ref":"#/components/schemas/NullableDecimal"},"net_margin":{"$ref":"#/components/schemas/NullableDecimal"},"operating_cash_flow":{"$ref":"#/components/schemas/NullableDecimal"},"operating_cash_flow_ttm":{"$ref":"#/components/schemas/NullableDecimal"},"operating_income":{"$ref":"#/components/schemas/NullableDecimal"},"operating_margin":{"$ref":"#/components/schemas/NullableDecimal"},"payout_ratio":{"$ref":"#/components/schemas/NullableDecimal"},"pb":{"$ref":"#/components/schemas/NullableDecimal"},"pe":{"$ref":"#/components/schemas/NullableDecimal"},"pe_ttm":{"$ref":"#/components/schemas/NullableDecimal"},"price":{"$ref":"#/components/schemas/NullableDecimal"},"price_day":{"format":"date","type":["string","null"]},"prior_annual_end_date":{"format":"date","type":["string","null"]},"ps":{"$ref":"#/components/schemas/NullableDecimal"},"ps_ttm":{"$ref":"#/components/schemas/NullableDecimal"},"public_float":{"$ref":"#/components/schemas/NullableDecimal"},"public_float_end_date":{"format":"date","type":["string","null"]},"revenue":{"$ref":"#/components/schemas/NullableDecimal"},"revenue_prior":{"$ref":"#/components/schemas/NullableDecimal"},"revenue_ttm":{"$ref":"#/components/schemas/NullableDecimal"},"revenue_yoy":{"$ref":"#/components/schemas/NullableDecimal"},"roa":{"$ref":"#/components/schemas/NullableDecimal"},"roe":{"$ref":"#/components/schemas/NullableDecimal"},"sbc_intensity":{"$ref":"#/components/schemas/NullableDecimal"},"share_based_compensation":{"$ref":"#/components/schemas/NullableDecimal"},"share_repurchases":{"$ref":"#/components/schemas/NullableDecimal"},"shares_change":{"$ref":"#/components/schemas/NullableDecimal"},"shares_outstanding_end_date":{"format":"date","type":["string","null"]},"stockholders_equity":{"$ref":"#/components/schemas/NullableDecimal"},"ticker":{"type":"string"},"ttm_end_date":{"format":"date","type":["string","null"]}},"required":["cik","ticker","exchange","entity_name"],"type":"object"},"SecurityHolder":{"properties":{"accession_number":{"type":"string"},"amount":{"$ref":"#/components/schemas/Decimal"},"amount_type":{"description":"SH for shares, PRN for principal amount.","type":"string"},"filed_at":{"format":"date","type":"string"},"holder_cik":{"type":"integer"},"holder_name":{"type":"string"},"prior_amount":{"$ref":"#/components/schemas/NullableDecimal","description":"Null when the manager did not hold it a quarter earlier, or when that quarter's report is not on file (see prior_known)."},"prior_known":{"description":"Whether the manager's report for the quarter before is on file.","type":"boolean"},"prior_value":{"$ref":"#/components/schemas/NullableDecimal"},"value":{"$ref":"#/components/schemas/Decimal","description":"Dollars."},"weight":{"$ref":"#/components/schemas/NullableDecimal","description":"Share of the manager's reported portfolio, as a fraction."}},"required":["holder_cik","holder_name","accession_number","filed_at","amount","amount_type","value","prior_known"],"type":"object"},"SecurityHolders":{"properties":{"amount_held":{"$ref":"#/components/schemas/Decimal","description":"Shares held by the managers on file, as a decimal string."},"cik":{"type":"integer"},"closed":{"description":"Managers who held it a quarter earlier and whose report now is on file without it; null when no quarter before is on the ledger.","type":["integer","null"]},"entity_name":{"type":"string"},"holders":{"type":"integer"},"opened":{"description":"Managers holding it now whose report a quarter earlier is on file without it; null when no quarter before is on the ledger.","type":["integer","null"]},"period":{"description":"The quarter end shown.","format":"date","type":"string"},"prior_amount_held":{"$ref":"#/components/schemas/NullableDecimal"},"prior_holders":{"type":["integer","null"]},"prior_period":{"format":"date","type":["string","null"]},"rows":{"items":{"$ref":"#/components/schemas/SecurityHolder"},"type":"array"},"rows_total":{"type":"integer"},"ticker":{"type":"string"},"updated_at":{"format":"date-time","type":["string","null"]},"value_held":{"$ref":"#/components/schemas/Decimal","description":"Dollars."}},"required":["cik","ticker","entity_name","period","holders","amount_held","value_held","opened","closed","rows","rows_total"],"type":"object"},"SecurityHoldersEnvelope":{"properties":{"data":{"$ref":"#/components/schemas/SecurityHolders"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"SecurityProfile":{"properties":{"cik":{"type":"integer"},"company_coverage_state":{"type":"string"},"entity_name":{"type":"string"},"exchange":{"type":"string"},"filing_count":{"type":"integer"},"is_active":{"type":"boolean"},"is_primary":{"type":"boolean"},"latest_filing_at":{"format":"date","type":["string","null"]},"metric_value_count":{"type":"integer"},"price":{"description":"The latest price and market cap on the ledger, absent when there is none","oneOf":[{"$ref":"#/components/schemas/PriceLatest"},{"type":"null"}]},"raw_fact_count":{"type":"integer"},"security_coverage_state":{"type":"string"},"security_id":{"format":"uuid","type":"string"},"ticker":{"type":"string"},"ticker_normalized":{"type":"string"}},"required":["security_id","ticker","ticker_normalized","exchange","is_primary","is_active","security_coverage_state","cik","entity_name","company_coverage_state","filing_count","raw_fact_count","metric_value_count"],"type":"object"},"SecurityProfileEnvelope":{"properties":{"data":{"$ref":"#/components/schemas/SecurityProfile"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"SecuritySearchEnvelope":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SecuritySearchHit"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"},"SecuritySearchHit":{"properties":{"cik":{"type":"integer"},"company_coverage_state":{"type":"string"},"entity_name":{"type":"string"},"exchange":{"type":"string"},"security_coverage_state":{"type":"string"},"ticker":{"type":"string"},"ticker_normalized":{"type":"string"}},"required":["ticker","ticker_normalized","exchange","cik","entity_name","security_coverage_state","company_coverage_state"],"type":"object"},"SegmentAxis":{"properties":{"axis":{"enum":["segment","geography","product"],"type":"string"},"measures":{"items":{"$ref":"#/components/schemas/SegmentMeasure"},"type":"array"}},"required":["axis","measures"],"type":"object"},"SegmentMeasure":{"properties":{"concept":{"description":"The XBRL concept as filed, `us-gaap:OperatingIncomeLoss`.","type":"string"},"measure":{"enum":["revenue","operating_income","gross_profit","cost_of_revenue","assets","long_lived_assets","capital_expenditure","depreciation"],"type":"string"},"members":{"items":{"$ref":"#/components/schemas/SegmentMember"},"type":"array"},"periods":{"items":{"$ref":"#/components/schemas/SegmentPeriod"},"type":"array"},"totals":{"description":"The consolidated figure per period, as a decimal string.","items":{"$ref":"#/components/schemas/NullableDecimal"},"type":"array"},"unit":{"type":"string"}},"required":["measure","concept","unit","periods","members","totals"],"type":"object"},"SegmentMember":{"properties":{"label":{"type":"string"},"member":{"description":"The member as filed, `aapl:IPhoneMember`.","type":"string"},"values":{"description":"One figure per period, in the periods' order, as decimal strings.","items":{"$ref":"#/components/schemas/NullableDecimal"},"type":"array"}},"required":["member","label","values"],"type":"object"},"SegmentPeriod":{"properties":{"accession_number":{"type":"string"},"derived":{"description":"Present and true when the period is a fourth quarter taken as the year less three quarters.","type":"boolean"},"end_date":{"format":"date","type":"string"},"filed_at":{"format":"date","type":["string","null"]},"fiscal_period":{"type":"string"},"fiscal_year":{"type":"integer"},"form":{"type":"string"}},"required":["fiscal_year","fiscal_period","end_date","accession_number","form"],"type":"object"},"Segments":{"properties":{"axes":{"items":{"$ref":"#/components/schemas/SegmentAxis"},"type":"array"},"cik":{"type":"integer"},"documents":{"description":"Reports read for this company.","type":"integer"},"entity_name":{"type":"string"},"period":{"enum":["annual","quarterly"],"type":"string"},"ticker":{"type":"string"},"updated_at":{"format":"date-time","type":["string","null"]}},"required":["cik","ticker","entity_name","period","axes","documents"],"type":"object"},"SegmentsEnvelope":{"properties":{"data":{"$ref":"#/components/schemas/Segments"},"meta":{"$ref":"#/components/schemas/ResponseMeta"}},"required":["data","meta"],"type":"object"}},"securitySchemes":{"key":{"bearerFormat":"thaler_ API key","description":"An API key from https://thaler.sh/developers/keys: `thaler_` then 38 letters and digits, the last 6 of which are a checksum. Send it as `Authorization: Bearer thaler_…`.","scheme":"bearer","type":"http"}}},"info":{"contact":{"email":"support@thaler.sh","url":"https://thaler.sh/developers"},"description":"Financial data from SEC filings, linked to its sources. Read-only. Prices include IEX's last sale for each trading day: Data provided for free by IEX. By accessing or using IEX Historical Data, you agree to the IEX Historical Data Terms of Use (https://www.iex.io/legal/hist-data-terms).","termsOfService":"https://thaler.sh/terms","title":"Thaler API","version":"1.0.0-beta.2"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","openapi":"3.1.0","paths":{"/v1/filings/day":{"get":{"description":"The day's filings across every covered company, shaped for News: the lines worth reading (current reports and event notices, earliest acceptance first), the day's reports with the revenue they carried, the day's reported insider purchases and sales, every form filed with its count, and filings per day over the fourteen days ending on the day. Without a date, the latest day on file.","operationId":"getFilingsDay","parameters":[{"$ref":"#/components/parameters/Day"},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingsDayEnvelope"}}},"description":"One day of filings","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"One day of the covered universe's filings","tags":["filings"]}},"/v1/filings/{accession}":{"get":{"description":"The company, the form, when it was filed, the filing folder on EDGAR, and its documents (the form's own document first, then the exhibits Thaler read), without fetching any of them.","operationId":"getFiling","parameters":[{"in":"path","name":"accession","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingSourceEnvelope"}}},"description":"The filing and its documents","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"A filing by accession","tags":["filings"]}},"/v1/holders":{"get":{"description":"Institutional investment managers on file, matched by name when `query` is given, otherwise the largest by the value of their latest report.","operationId":"searchHolders","parameters":[{"in":"query","name":"query","required":false,"schema":{"maxLength":64,"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"default":10,"maximum":50,"minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolderHitsEnvelope"}}},"description":"Managers, with their latest quarter, value and positions","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"Managers by name, or the largest","tags":["holders"]}},"/v1/holders/{cik}":{"get":{"description":"The manager's latest report position by position, largest by value first, each with its share of the report and the position a quarter earlier (null when new), the security resolved to a covered company where the CUSIP maps to one, the quarter's totals, positions opened and closed, and the quarters on file.","operationId":"getHolder","parameters":[{"in":"path","name":"cik","required":true,"schema":{"type":"integer"}},{"in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":500,"minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolderEnvelope"}}},"description":"The manager's latest report","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"What a manager holds, from its latest Form 13F","tags":["holders"]}},"/v1/insider-activity":{"get":{"description":"Form 4 and Form 5 non-derivative open-market purchase and sale transactions. Superseded originals and amendments that cannot be matched unambiguously are excluded.","operationId":"listInsiderActivity","parameters":[{"description":"Several companies at once: their tickers, comma-separated, at most sixty.","example":["AAPL","MSFT"],"explode":false,"in":"query","name":"tickers","required":false,"schema":{"items":{"type":"string"},"maxItems":60,"minItems":1,"type":"array"},"style":"form"},{"$ref":"#/components/parameters/Since"},{"$ref":"#/components/parameters/InsiderKind"},{"$ref":"#/components/parameters/InsiderLimit"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsiderActivityEnvelope"}}},"description":"Reported purchase and sale ledger with filing provenance","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"Reported insider purchases and sales across covered companies","tags":["insiders"]}},"/v1/metrics":{"get":{"operationId":"listMetrics","parameters":[{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricCatalogEnvelope"}}},"description":"Every active canonical metric and every screen-surface ratio computed at read-model refresh, with mappings and covered-company counts","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"Metric catalog: canonical figures plus screen-surface ratios with coverage counts","tags":["metrics"]}},"/v1/release":{"get":{"description":"The daily data release: its date, whether its checks passed, when it was published, and a stamp that identifies it exactly. A release covers companies, securities, filings and metric values; filings, insider trades, holders, segments and prices are also updated between releases. Every response names the release it was served from in `meta.release`. Answers 503 before the first release.","operationId":"getRelease","parameters":[{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseEnvelope"}}},"description":"The release being served","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"The current data release","tags":["releases"]}},"/v1/screen":{"get":{"description":"One row per company with core metrics on file and an active security, filtered by repeatable where clauses over the closed screen column set. Companies missing a filtered figure are excluded and counted in meta.set_aside, never silently dropped.","operationId":"screen","parameters":[{"$ref":"#/components/parameters/Where"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Dir"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Columns"},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenEnvelope"}}},"description":"Screen rows with total, excluded (set_aside), and universe counts in meta","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"Screen the company universe by reported figures","tags":["screen"]}},"/v1/securities":{"get":{"operationId":"searchSecurities","parameters":[{"in":"query","name":"query","required":true,"schema":{"maxLength":64,"minLength":1,"type":"string"}},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecuritySearchEnvelope"}}},"description":"Ranked search hits, exact ticker first","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"Search active securities by ticker prefix or entity name","tags":["securities"]}},"/v1/securities/{ticker}/filings":{"get":{"operationId":"listFilings","parameters":[{"$ref":"#/components/parameters/Ticker"},{"$ref":"#/components/parameters/Forms"},{"$ref":"#/components/parameters/Items"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingsEnvelope"}}},"description":"Filing timeline","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"Filing timeline for a security","tags":["filings"]}},"/v1/securities/{ticker}/holders":{"get":{"description":"Institutional managers' positions in the company in the latest quarter on file, largest by value first, each with the manager's position a quarter earlier (null when the manager did not hold it) and its share of the manager's reported portfolio. Totals: managers holding it now and a quarter ago, shares held, value held, managers who opened and closed the position. Form 13F covers managers with $100 million or more; positions are as of the quarter end and filed up to 45 days later, and the latest quarter fills in as reports land.","operationId":"getHolders","parameters":[{"$ref":"#/components/parameters/Ticker"},{"in":"query","name":"limit","required":false,"schema":{"default":50,"maximum":200,"minimum":1,"type":"integer"}},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityHoldersEnvelope"}}},"description":"The company's holders this quarter","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"Who holds a company, from Form 13F","tags":["holders"]}},"/v1/securities/{ticker}/insider-activity":{"get":{"description":"Ticker-scoped Form 4 and Form 5 non-derivative open-market purchase and sale transactions with the reporting owners, filing dates, footnotes, and SEC source URLs.","operationId":"getInsiderActivity","parameters":[{"$ref":"#/components/parameters/Ticker"},{"$ref":"#/components/parameters/Since"},{"$ref":"#/components/parameters/InsiderKind"},{"$ref":"#/components/parameters/InsiderLimit"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsiderActivityEnvelope"}}},"description":"Ticker-scoped reported purchase and sale ledger","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"Reported insider purchases and sales for a security","tags":["insiders"]}},"/v1/securities/{ticker}/metrics":{"get":{"operationId":"getMetrics","parameters":[{"$ref":"#/components/parameters/Ticker"},{"$ref":"#/components/parameters/Period"},{"$ref":"#/components/parameters/MetricKeys"},{"$ref":"#/components/parameters/Collapse"},{"$ref":"#/components/parameters/MetricLimit"},{"$ref":"#/components/parameters/AsOf"},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricValuesEnvelope"}}},"description":"Canonical metric values","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"Canonical metric values for a security","tags":["metrics"]}},"/v1/securities/{ticker}/metrics/{metric_key}/lineage":{"get":{"operationId":"getMetricLineage","parameters":[{"$ref":"#/components/parameters/Ticker"},{"$ref":"#/components/parameters/MetricKey"},{"$ref":"#/components/parameters/MetricValueId"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/AsOf"},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricLineageEnvelope"}}},"description":"Metric source lineage","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"Metric lineage back to source facts","tags":["metrics"]}},"/v1/securities/{ticker}/metrics/{metric_key}/revisions":{"get":{"description":"The revision chain behind a company's values for one metric. One row per metric value and filing, newest period first and each chain in filing order (`revision_rank`), with the value that filing stated, its form, filed date and accession. `kind` is `first` for the earliest filing on the ledger, `same` where the filing carried the previous figure (exactly, or the same figure at a coarser precision), `revised` where it stated a different figure (`delta` is the change), and `re_expressed` where a per-share or share-count figure is the previous one divided or multiplied by the stock splits the ledger knows between the two filings (`split_ratio`, new shares per old). `standing` marks the statement whose fact is the metric value's source lineage.","operationId":"getMetricRevisions","parameters":[{"$ref":"#/components/parameters/Ticker"},{"$ref":"#/components/parameters/MetricKey"},{"$ref":"#/components/parameters/MetricValueId"},{"$ref":"#/components/parameters/RevisionFiscalYear"},{"$ref":"#/components/parameters/RevisionFiscalPeriod"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricRevisionsEnvelope"}}},"description":"Metric revision chain","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"Every filing's statement of a metric's figures: what each read when first reported and every time since","tags":["metrics"]}},"/v1/securities/{ticker}/prices":{"get":{"description":"One figure per trading day: IEX's last regular-session sale, read from the exchange's free historical files (data provided for free by IEX; an IEX print is not the consolidated close), replaced by an official close where the record carries one for the day: the SEC's fails-to-deliver files, Form 13F quarter ends and Form N-PORT month ends (value over shares across reporting managers, the median of three or more). `days`, `price` and `source` are parallel columns; `marks` lists every close of record in the range with the reports behind it; `latest` is the newest price with the market cap it makes with the company's latest certified share count, dated. A year by default; `range` (1m, 3m, 1y, 5y, max) or `from` and `to` widen it. Prices are as traded on their day, unadjusted.","operationId":"getPrices","parameters":[{"$ref":"#/components/parameters/Ticker"},{"in":"query","name":"range","required":false,"schema":{"default":"1y","enum":["1m","3m","1y","5y","max"],"type":"string"}},{"in":"query","name":"from","required":false,"schema":{"format":"date","type":"string"}},{"in":"query","name":"to","required":false,"schema":{"format":"date","type":"string"}},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricesEnvelope"}}},"description":"The company's prices in the range","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"Prices, from IEX and the record","tags":["prices"]}},"/v1/securities/{ticker}/profile":{"get":{"operationId":"getSecurityProfile","parameters":[{"$ref":"#/components/parameters/Ticker"},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityProfileEnvelope"}}},"description":"Ticker-addressable security profile","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"Security profile","tags":["securities"]}},"/v1/securities/{ticker}/raw-concepts":{"get":{"operationId":"getRawConcepts","parameters":[{"$ref":"#/components/parameters/Ticker"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RawConceptsEnvelope"}}},"description":"Raw concepts","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"Raw XBRL concepts observed for a security","tags":["metrics"]}},"/v1/securities/{ticker}/segments":{"get":{"description":"Revenue, operating income and other measures broken down by business segment, geography and product, read from each annual and quarterly report's own XBRL. One concept per axis and measure (the one that names the most members and periods), the latest filing's figure for every member and period (later reports restate), and the consolidated total the same filings reported. Annual by default; `period=quarterly` gives the quarters, with a fourth quarter derived as the year less the three reported quarters where a filing never tags it (`derived: true` on the period). Members are labelled as the filer labels them.","operationId":"getSegments","parameters":[{"$ref":"#/components/parameters/Ticker"},{"$ref":"#/components/parameters/SegmentsPeriod"},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentsEnvelope"}}},"description":"The company's axes, each with its measures","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"X-Request-Id":{"$ref":"#/components/headers/RequestId"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalError"},"503":{"$ref":"#/components/responses/Unavailable"},"504":{"$ref":"#/components/responses/Timeout"}},"summary":"Figures by segment, geography and product","tags":["segments"]}}},"security":[{"key":[]}],"servers":[{"url":"https://api.thaler.sh"}],"tags":[{"description":"Companies and their listings: search by name or ticker, and a company's profile.","name":"securities"},{"description":"Reported and calculated figures, current or as of a past date; the catalog of metric keys; and the filing, XBRL fact and revisions behind every value.","name":"metrics"},{"description":"Filings by company, by day, and by accession number.","name":"filings"},{"description":"Open-market purchases and sales from Forms 4 and 5.","name":"insiders"},{"description":"Institutional holders from Form 13F: a company's holders quarter over quarter, and what one manager holds.","name":"holders"},{"description":"Figures by business segment, geography and product, as the company's own reports tag them.","name":"segments"},{"description":"IEX's last sale per trading day, the closes of record, and market cap. Data provided for free by IEX.","name":"prices"},{"description":"The Screener: every covered company, filtered and sorted by its figures.","name":"screen"},{"description":"The data release being served, and the train that builds it.","name":"releases"}]}