{"openapi":"3.1.0","info":{"title":"Belfort Data API","version":"1.0.0-pilot","contact":{"name":"Belfort Research","email":"support@belfortagent.xyz","url":"https://docs.belfortagent.xyz/"},"description":"Company financial data extracted only from SEC filings, with a source filing on every figure. Source: U.S. Securities and Exchange Commission. Not affiliated with or endorsed by the SEC. Values are as filed. A blank in a filing is null, never zero. What statements leave out is listed at https://docs.belfortagent.xyz/known-limits/. A metric figure can change or disappear when a later filing arrives, and figures aren't versioned: this is the current reading, with no way to ask for an earlier one.\nFree with no key, no account and no payment: AAPL, MSFT, JPM, KO, XOM, NVDA, AMZN, GOOGL, TSLA and LLY, on every route except Form 13F holdings by manager, up to 60 calls an hour per network. Try `curl https://api.belfortagent.xyz/v1/companies/AAPL/metrics`. Any other company answers 402 and needs a key (data.belfortagent.xyz) or a per-call x402 payment. /v1/status needs no key for any company.\nAlso free with no key, under the same hourly limit: in Japan Nintendo (7974), Hitachi (6501), Tokyo Electron (8035) and Keyence (6861); in Korea SK hynix (000660), Hyundai Motor (005380), NAVER (035420) and Kia (000270); in Taiwan Hon Hai (2317), MediaTek (2454), Delta Electronics (2308) and Chunghwa Telecom (2412); in the EU at least one company in each of the 16 countries covered, by LEI: KBC (BE, 213800X3Q9LSAKRUWY91), KEO (CY, 213800LF5V3PPJB88H23), Novo Nordisk (DK, 549300DAQ1CVT6CXN342), IAG (ES, 959800TZHQRUSH1ESL13), Neste (FI, 5493009GY1X8GQ66AM14), Nokia (FI, 549300A0JPRWG1KI7U06), AXA (FR, F5WCUMTUM4RKZ1MAIE39), L'Oréal (FR, 529900JI1GG6F7RKVI53), LVMH (FR, IOG4E947OATN0KJYSD45), Schneider Electric (FR, 969500A1YF1XUYYXS284), HSBC (GB, MLU0ZO3ML4LN2LL2TL39), Rolls-Royce (GB, 213800EC7997ZBLZJH69), Hrvatski Telekom (HR, 097900BFHJ0000029454), MOL (HU, 213800R83KX5FQFGXS67), Eimskip (IS, 549300IUR8Q7Y44KBL02), Ignitis (LT, 5493005RZJHJT5PNHY10), Malta International Airport (MT, 2138008EKXNMKZRXCT63), ASML (NL, 724500Y6DUVHQD6OXN27), Airbus (NL, MINO79WLOO247M1IL051), Galp (PT, 2138003319Y7NM75FG53), H&M (SE, 529900O5RR7R39FRDM42) and Tatry Mountain Resorts (SK, 315700YHD1JR6VB1BA90). Brazil has no free companies: it is for paid accounts only.\nThe market routes are the exceptions to \"only SEC filings\": /v1/th/ serves a few figures read from each Thai company's own investor-relations website, never from SET or the SEC; /v1/tw/, /v1/jp/, /v1/kr/, /v1/br/ and /v1/eu/ serve figures from each market's official source, named on each route. Every other route is SEC data only.\nA key on a prepaid account spends credits, 1 for a figure call and 3 for a document page by default, today's free allowance first. Only a 200 that returns at least one record is charged. Errors, an unknown company, an empty result and a result where every figure was withheld are free. A metered 200 carries X-Credits-Charged and X-Credits-Remaining. When the account can't cover a call the answer is 402 with a top-up link. A key with no account is never metered."},"servers":[{"url":"https://api.belfortagent.xyz","description":"Belfort Data API"}],"security":[{"ApiKey":[]}],"paths":{"/v1/changes":{"get":{"operationId":"getChanges","summary":"Keys changed in a dataset since a feed position. Key required, no credits charged.","description":"`since` is a feed position from `meta.position`, as a decimal string. Each key appears once, with its latest `added`, `changed` or `removed` action. The feed needs a key, costs no credits, and isn't available through x402 or the free demo.\nEvery response's `meta.position` says how far into the change log its data goes, 404s included. To start, copy what you need and keep the smallest `meta.position` you saw as your `since`. To catch up, page through `/v1/changes?dataset=…&since=…` following `next_cursor`, fetch each added or changed key and delete each removed one, then set `since` to the smallest of the feed's `meta.to` and the `meta.position` of every response you just fetched, 404s included. A 404 on a fetch means that key isn't served yet; when the `company` feed later lists that company as added, fetch all its datasets. If a fetch fails with anything other than 200 or 404, or its `meta.position` is null, don't move `since`: fetch it again later. A 404 `since_unknown` or 409 `full_copy_required` means start again with a full copy. Changes are kept 90 days. If every response says `meta.position` is null, the change log isn't running yet: copy again in full once it is a number.","parameters":[{"name":"dataset","in":"query","required":true,"schema":{"type":"string","enum":["metrics","company","statements","ownership","macro","insider","form13f","filings","normalized","segments","holders","earnings"]}},{"name":"since","in":"query","required":true,"description":"Non-negative integer feed position as a decimal string.","schema":{"type":"string","pattern":"^[0-9]+$"}},{"name":"cursor","in":"query","description":"The previous page's next_cursor, with the same dataset and since.","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":1000,"default":500}}],"responses":{"200":{"description":"Changed keys, each once with its latest action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangesResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"since_unknown: the position is outside what the feed keeps. Start again with a full copy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"full_copy_required: the feed can't list the changes in this range. Start again with a full copy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"$ref":"#/components/responses/RateLimited"},"503":{"description":"The feed isn't available yet, the database can't be reached, or the read took too long. Try again after Retry-After.\nEvery response's `meta.position` says how far into the change log its data goes, 404s included. To start, copy what you need and keep the smallest `meta.position` you saw as your `since`. To catch up, page through `/v1/changes?dataset=…&since=…` following `next_cursor`, fetch each added or changed key and delete each removed one, then set `since` to the smallest of the feed's `meta.to` and the `meta.position` of every response you just fetched, 404s included. A 404 on a fetch means that key isn't served yet; when the `company` feed later lists that company as added, fetch all its datasets. If a fetch fails with anything other than 200 or 404, or its `meta.position` is null, don't move `since`: fetch it again later. A 404 `since_unknown` or 409 `full_copy_required` means start again with a full copy. Changes are kept 90 days. If every response says `meta.position` is null, the change log isn't running yet: copy again in full once it is a number.","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/status":{"get":{"operationId":"getStatus","summary":"Data age for each kind of data. Needs no key.","security":[],"responses":{"200":{"description":"Current snapshots and their age.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}}}},"/v1/companies/{id}":{"get":{"operationId":"getCompany","summary":"One company by ticker or CIK.","parameters":[{"$ref":"#/components/parameters/CompanyId"}],"responses":{"200":{"description":"The company.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.006"},"protocols":[{"x402":{}}]}}},"/v1/companies/{id}/metrics":{"get":{"operationId":"getCompanyMetrics","summary":"Key metrics, newest period first. Unknown query parameters get 400.","parameters":[{"$ref":"#/components/parameters/CompanyId"},{"name":"metric","in":"query","required":false,"description":"One metric. Without it, the five headline metrics. A bank's own income lines (`total_interest_income`, `net_interest_income`, `noninterest_income`, `net_revenue`) are served for banks and lenders only, and only when named.","schema":{"$ref":"#/components/schemas/MetricKey"}},{"name":"frequency","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Frequency"}},{"name":"period","in":"query","required":false,"description":"Another name for `frequency`, the word the financials routes use. Give one of the two, not both.","schema":{"$ref":"#/components/schemas/Frequency"}}],"responses":{"200":{"description":"Metric points.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.006"},"protocols":[{"x402":{}}]}}},"/v1/companies/{id}/statements":{"get":{"operationId":"getCompanyStatements","summary":"Statements as filed, one document per filing and statement, newest filing first. Unknown query parameters get 400.","parameters":[{"$ref":"#/components/parameters/CompanyId"},{"name":"statement","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StatementKind"}},{"name":"form","in":"query","required":false,"description":"Filing form, such as 10-K or 10-Q.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Documents per page.","schema":{"type":"integer","minimum":1,"maximum":20,"default":4}},{"name":"cursor","in":"query","required":false,"description":"The `next_cursor` of the previous page.","schema":{"type":"string"}}],"responses":{"200":{"description":"One page of statement documents.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.018"},"protocols":[{"x402":{}}]}}},"/v1/companies/{id}/ownership":{"get":{"operationId":"getCompanyOwnership","summary":"Schedule 13D/13G reporting-owner records for this issuer, newest filing first. Structured XML filings from 2024-12-18 only. Unknown query parameters get 400.","parameters":[{"$ref":"#/components/parameters/CompanyId"},{"name":"form","in":"query","required":false,"description":"Filing form, such as SCHEDULE 13G or SCHEDULE 13D/A.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Records per page.","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}}],"responses":{"200":{"description":"Ownership records for the issuer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OwnershipResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.018"},"protocols":[{"x402":{}}]}}},"/v1/companies/{id}/insider-trades":{"get":{"operationId":"getCompanyInsiderTrades","summary":"Form 3/4/5 insider transactions for an issuer, newest first. Blank price is null.","description":"The id may also be the CIK of an issuer that has insider transactions here but is not in the company list. A CIK with no insider transactions and no company row is a 404, which costs nothing.","parameters":[{"$ref":"#/components/parameters/CompanyId"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"One page of insider transaction documents.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentPageResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.018"},"protocols":[{"x402":{}}]}}},"/v1/companies/{id}/form13f":{"get":{"operationId":"getCompanyForm13f","summary":"Form 13F holdings for a manager CIK. value_unit is thousands_usd or usd; ticker is null.","description":"The id is the manager's CIK. A manager need not be in the company list: any CIK with 13F holdings here answers. A CIK with no holdings and no company row is a 404, which costs nothing.","parameters":[{"$ref":"#/components/parameters/CompanyId"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"One page of 13F holding documents.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentPageResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.018"},"protocols":[{"x402":{}}]}}},"/v1/companies/{id}/filings":{"get":{"operationId":"getCompanyFilings","summary":"Filings list from SEC submissions, newest first.","parameters":[{"$ref":"#/components/parameters/CompanyId"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"One page of filing list documents.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentPageResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.018"},"protocols":[{"x402":{}}]}}},"/v1/companies/{id}/earnings-releases":{"get":{"operationId":"listCompanyEarningsReleases","summary":"8-K Item 2.02 press-release exhibits, newest filed first. List items omit text (a document page). Optional from/to filter on filed date.","parameters":[{"$ref":"#/components/parameters/CompanyId"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"Inclusive lower bound on filed (YYYY-MM-DD).","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","required":false,"description":"Inclusive upper bound on filed (YYYY-MM-DD).","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"One page of earnings release summaries (no text).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EarningsReleasePageResponse"},"examples":{"page":{"value":{"data":[{"accession":"0000320193-25-000001","filed":"2025-01-31","period":"2024-12-28","title":"Apple Reports First Quarter Results","title_source":"llm_verified","exhibit_type":"EX-99.1","exhibit_description":"EX-99.1","items":["2.02","9.01"],"exhibit_url":"https://www.sec.gov/Archives/edgar/data/320193/000032019325000001/ex991.htm","filing_url":"https://www.sec.gov/Archives/edgar/data/320193/000032019325000001/0000320193-25-000001-index.htm"}],"meta":{"position":null,"snapshot_id":"earn-1","as_of":"2026-11-06T05:08:32Z","next_cursor":null}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.018"},"protocols":[{"x402":{}}]}}},"/v1/companies/{id}/earnings-releases/{accession}":{"get":{"operationId":"getCompanyEarningsRelease","summary":"One earnings release with its plain-text exhibit body.","parameters":[{"$ref":"#/components/parameters/CompanyId"},{"name":"accession","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{10}-\\d{2}-\\d{6}$"}}],"responses":{"200":{"description":"One earnings release including text.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EarningsReleaseResponse"},"examples":{"release":{"value":{"data":{"accession":"0000320193-25-000001","filed":"2025-01-31","period":"2024-12-28","title":"Apple Reports First Quarter Results","title_source":"llm_verified","exhibit_type":"EX-99.1","exhibit_description":"EX-99.1","items":["2.02","9.01"],"exhibit_url":"https://www.sec.gov/Archives/edgar/data/320193/000032019325000001/ex991.htm","filing_url":"https://www.sec.gov/Archives/edgar/data/320193/000032019325000001/0000320193-25-000001-index.htm","text":"Apple Reports First Quarter Results\\n\\nCupertino — …"},"meta":{"position":null,"snapshot_id":"earn-1","as_of":"2026-11-06T05:08:32Z","next_cursor":null}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.03"},"protocols":[{"x402":{}}]}}},"/v1/companies/{id}/financials":{"get":{"operationId":"getCompanyFinancials","summary":"Normalized core financials from printed statement lines, newest period first. Only fields that passed the publish bar are served. Unknown query parameters get 400.","parameters":[{"$ref":"#/components/parameters/CompanyId"},{"name":"field","in":"query","required":false,"description":"One served field. Any other value returns 400.","schema":{"$ref":"#/components/schemas/NormalizedField"}},{"name":"period","in":"query","required":false,"description":"annual keeps quarters 4 (flows) and balances (quarters 0) dated on a fiscal year end, meaning the company has a quarters-4 figure ending that day; quarterly keeps quarters 1 and every balance.","schema":{"$ref":"#/components/schemas/Frequency"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":40}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"One page of normalized facts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.006"},"protocols":[{"x402":{}}]}}},"/v1/companies/{id}/segments":{"get":{"operationId":"getCompanySegments","summary":"Single-axis product, geographic and business-segment revenue figures from SEC filings. Multi-axis cross-tabs and sign-sensitive expense lines are not served. Newest filing first.","parameters":[{"$ref":"#/components/parameters/CompanyId"},{"name":"axis","in":"query","required":false,"schema":{"type":"string","enum":["ProductOrService","ProductsAndServices","Producttype","BusinessLine","Geographical","GeographicalAreas","GeographicDistribution","BusinessSegments","Segments","Subsegments"]}},{"name":"period_end","in":"query","required":false,"description":"Filing period end (YYYY-MM-DD), matching the document's period field.","schema":{"type":"string","format":"date"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"One page of segment documents. Every figure carries its source accession.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentPageResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.018"},"protocols":[{"x402":{}}]}}},"/v1/companies/{id}/holders":{"get":{"operationId":"getCompanyHolders","summary":"Who holds an issuer on Form 13F for one report period (newest when period is omitted). By default one record per manager, ranked by shares, with the manager's filing linked; view=positions returns the raw 13F rows instead. About 35% of 13F rows cannot be linked to a company with two pieces of evidence and are left out.","description":"view=managers (default): one record per manager CIK, ranked by `shares` (or `value` with sort=value).\n`shares` is summed over that manager's counted share rows; options (call and put) and convertible\nprincipal are kept apart and never added to shares. `positions` is the number of rows behind the total.\n`filings` lists each filing the total rests on, with `filing_url`. Shares of different managers are never\nadded together.\n\nAmendments: for one manager and period, the latest filing that states a line (CUSIP and put/call) supplies\nit, and a RESTATEMENT that re-files at least 90% of the report replaces the earlier filings whole. Rows an\namendment replaced stay visible in view=positions with status `superseded`.\n\nValues: a value is checked against the period's price for that security. When a filing's own table shows it\nwas filed in thousands, times a thousand, or with shares and value swapped, its rows are corrected and the\nfiled figure is kept in `adjustments`. A row the evidence cannot settle keeps its filed figure in positions\nand is left out of the manager's `value_usd` (`value_status` is then `partial` or `withheld`).\n\nFreshness: the Form 13F data sets are published as three-month filing windows. `meta.source_window_end` is\nthe last filing date loaded and `meta.newest_period` the newest period for this company. An empty list says\nwhy in `meta.empty_reason`.","parameters":[{"$ref":"#/components/parameters/CompanyId"},{"name":"period","in":"query","required":false,"description":"Report period end (YYYY-MM-DD). Defaults to the newest period on file.","schema":{"type":"string","format":"date"}},{"name":"view","in":"query","required":false,"description":"managers (default): one ranked record per manager. positions: every 13F row for the period, as filed, with how the rules read it.","schema":{"type":"string","enum":["managers","positions"],"default":"managers"}},{"name":"sort","in":"query","required":false,"description":"Ranking for view=managers: shares (default), or value, which ranks on checked values and puts managers whose values are withheld last. Not allowed with view=positions.","schema":{"type":"string","enum":["shares","value"],"default":"shares"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"One page of managers or positions. meta.view says which. Every record names its source filing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoldersResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.018"},"protocols":[{"x402":{}}]}}},"/v1/macro/{series}":{"get":{"operationId":"getMacroSeries","summary":"One official macro series document. Series included only when the source's own terms clearly allow resale. Unknown query parameters get 400.","parameters":[{"name":"series","in":"path","required":true,"schema":{"type":"string","enum":["cpi_u_all_items_sa","cpi_u_core_sa","ppi_final_demand_sa","nonfarm_payrolls_sa","avg_hourly_earnings_private_sa","labor_force_participation_sa","unemployment_rate_sa","treasury_par_3m","treasury_par_2y","treasury_par_10y","treasury_par_30y"]}}],"responses":{"200":{"description":"The series document.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacroResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.006"},"protocols":[{"x402":{}}]}}},"/v1/th/companies/{id}":{"get":{"operationId":"getThaiCompany","summary":"One Thai listed company by SET symbol or registration number.","description":"Company-published financial statements read by Belfort Research from each company's own investor-relations website. Not from SET or the SEC. Every figure links to the company's file. Lists which figures are served for the company and the earliest and latest period end on file.","parameters":[{"$ref":"#/components/parameters/ThCompanyId"}],"responses":{"200":{"description":"The company.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThCompanyResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.006"},"protocols":[{"x402":{}}]}}},"/v1/th/companies/{id}/financials":{"get":{"operationId":"getThaiFinancials","summary":"One figure for a Thai listed company, newest period first.","description":"Company-published financial statements read by Belfort Research from each company's own investor-relations website. Not from SET or the SEC. Every figure links to the company's file. One field per call. A quarterly figure is a discrete three-month quarter; a year-to-date figure is never served as a quarter. Values are exact decimal text in baht (baht per share for basic_eps and diluted_eps), already multiplied by the scale the company declared. Unknown query parameters get 400.","parameters":[{"$ref":"#/components/parameters/ThCompanyId"},{"name":"field","in":"query","required":true,"description":"The figure to return. basic_eps and diluted_eps are baht per share; the others are baht. Most Thai companies print only basic EPS; diluted_eps is served only where the statement prints a diluted line.","schema":{"type":"string","enum":["basic_eps","diluted_eps","net_income","cash_and_equivalents"]}},{"name":"period","in":"query","required":false,"description":"quarterly keeps Q1 to Q3, annual keeps the full year, all keeps both.","schema":{"type":"string","enum":["quarterly","annual","all"],"default":"all"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":40}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"One page of figures.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThFinancialsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.006"},"protocols":[{"x402":{}}]}}},"/v1/tw/companies/{id}":{"get":{"operationId":"getTaiwanCompany","summary":"One Taiwan listed company by stock code or unified business number.","description":"Taiwan's own open data (TWSE and TPEx OpenAPIs, Government Open Data License v1), kept as a time series by Belfort Research's archive of every file. Lists which figures are served for the company and the earliest and latest period end on file. The attribution the licence requires is in `attribution`.","parameters":[{"$ref":"#/components/parameters/TwCompanyId"}],"responses":{"200":{"description":"The company.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TwCompanyResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.006"},"protocols":[{"x402":{}}]}}},"/v1/tw/companies/{id}/financials":{"get":{"operationId":"getTaiwanFinancials","summary":"One statement figure for a Taiwan listed company, newest period first.","description":"Statements from Taiwan's own open data: consolidated, or, for a company that prepares no consolidated statements, its own, and statement_scope says which. One field per call. Amounts are exact decimal text in NT$ (NT$ per share for basic_eps), converted from the thousand NT$ the source prints. Income-statement figures are cumulative from 1 January: a figure with basis year_to_date is never a quarter, and a discrete quarter exists only as basis quarter_derived, the difference of two year-to-date figures. Balances have basis point_in_time. History starts on the day Belfort Research began archiving the source. Unknown query parameters get 400.","parameters":[{"$ref":"#/components/parameters/TwCompanyId"},{"name":"field","in":"query","required":true,"description":"The figure to return. basic_eps is NT$ per share; the others are NT$. net_income includes non-controlling interests, net_income_attributable does not; equity_attributable is the owners' share of total_equity. cash_and_equivalents is printed only by banks, holding companies and insurers; operating_income, current_assets and current_liabilities are printed by general-industry companies and a few others, so most banks, holding companies and insurers have none. Each point's source label says what the exchange called the line.","schema":{"type":"string","enum":["revenue","net_income","net_income_attributable","basic_eps","total_assets","total_liabilities","total_equity","cash_and_equivalents","operating_income","pretax_income","equity_attributable","current_assets","current_liabilities"]}},{"name":"period","in":"query","required":false,"description":"quarterly keeps discrete quarters and every balance (the year-end one too), never a year-to-date or full-year figure; annual keeps the fiscal year; all keeps everything held.","schema":{"type":"string","enum":["all","annual","quarterly"],"default":"all"}},{"name":"basis","in":"query","required":false,"description":"Keep only figures with this basis.","schema":{"type":"string","enum":["quarter","year_to_date","full_year","point_in_time","quarter_derived"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":40}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"One page of figures.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TwFinancialsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.006"},"protocols":[{"x402":{}}]}}},"/v1/tw/companies/{id}/monthly-revenue":{"get":{"operationId":"getTaiwanMonthlyRevenue","summary":"Monthly revenue for a Taiwan listed company, newest month first.","description":"Self-reported and unaudited, and not required to add up to the quarterly statements. monthly_revenue is the month's revenue, monthly_revenue_ytd the cumulative revenue from January. comparative is true for a month that is not the report's own month. Amounts are exact decimal text in NT$. Unknown query parameters get 400.","parameters":[{"$ref":"#/components/parameters/TwCompanyId"},{"name":"field","in":"query","required":false,"schema":{"type":"string","enum":["monthly_revenue","monthly_revenue_ytd"],"default":"monthly_revenue"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":40}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"One page of months.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TwMonthlyResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.006"},"protocols":[{"x402":{}}]}}},"/v1/jp/companies/{id}":{"get":{"operationId":"getJapanCompany","summary":"One Japan company by ticker, EDINET code or corporate number.","description":"Consolidated EDINET filers, with names, accounting standard and fiscal year end. Each answer carries the EDINET/PDL1.0 attribution. Key required; 1 credit for a record. Malformed identifiers get 400 without a data read; unknown valid identifiers get 404 once loaded.","parameters":[{"$ref":"#/components/parameters/JpCompanyId"}],"responses":{"200":{"description":"The company.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JpCompanyResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.006"},"protocols":[{"x402":{}}]}}},"/v1/jp/companies/{id}/financials":{"get":{"operationId":"getJapanFinancials","summary":"Consolidated Japan company figures, newest period first.","description":"Exact decimal strings in JPY (JPY/share for EPS). Each figure links its EDINET filing and identifies its period, duration, accounting standard and audit status. fiscal_year is the calendar year the fiscal year ends. The field filter is optional. Ordered by period_end descending, then field and duration ascending. Key required; 1 credit when at least one point is returned; empty results and errors are free. Unknown query parameters get 400.","parameters":[{"$ref":"#/components/parameters/JpCompanyId"},{"name":"field","in":"query","required":false,"schema":{"type":"string","enum":["revenue","net_income_attributable","basic_eps","diluted_eps","operating_cash_flow","cash_and_equivalents","total_assets","total_equity"]}},{"name":"period","in":"query","required":false,"description":"annual = FY; half_year = H1; quarterly = Q1/Q2/Q3 three-month figures and Q1 balances from legacy quarterly reports; nine_months = 9M cumulative figures and balances; all = every period held.","schema":{"type":"string","enum":["all","annual","half_year","quarterly","nine_months"],"default":"all"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":40}},{"name":"cursor","in":"query","required":false,"description":"The previous next_cursor, with the same identifier and filters.","schema":{"type":"string"}}],"responses":{"200":{"description":"One page of figures.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JpFinancialsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.006"},"protocols":[{"x402":{}}]}}},"/v1/kr/companies/{id}":{"get":{"operationId":"getKoreaCompany","summary":"One Korean company by ticker, DART corporation code or corporate number.","description":"Listed Korean companies, with names, market and fiscal year end month. Each answer carries the FSS DART attribution. Key required; 1 credit for a record. Malformed identifiers get 400 without a data read; unknown valid identifiers get 404 once loaded.","parameters":[{"$ref":"#/components/parameters/KrCompanyId"}],"responses":{"200":{"description":"The company.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KrCompanyResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.006"},"protocols":[{"x402":{}}]}}},"/v1/kr/companies/{id}/financials":{"get":{"operationId":"getKoreaFinancials","summary":"Korean company figures, newest period first.","description":"Exact decimal strings in KRW (KRW/share for EPS). Each figure links its DART filing and identifies its period, duration and consolidated or separate statement scope. fiscal_year is the calendar year the fiscal year ends. The field filter is optional. Ordered by period_end descending, then field and duration ascending. Key required; 1 credit when at least one point is returned; empty results and errors are free. Unknown query parameters get 400.","parameters":[{"$ref":"#/components/parameters/KrCompanyId"},{"name":"field","in":"query","required":false,"schema":{"type":"string","enum":["revenue","cost_of_revenue","gross_profit","sga","research_development","operating_income","interest_expense","pretax_income","income_tax","net_income","net_income_attributable","basic_eps","diluted_eps","total_interest_income","net_interest_income","operating_cash_flow","investing_cash_flow","financing_cash_flow","cash_and_equivalents","receivables","current_assets","intangibles","goodwill","total_assets","accounts_payable","current_liabilities","total_liabilities","retained_earnings","total_equity"]}},{"name":"period","in":"query","required":false,"description":"annual = FY; half_year = Q2 six-month figures and balances; quarterly = Q1 figures and balances, plus Q2/Q3 three-month figures; nine_months = Q3 nine-month figures and balances; all = every period held.","schema":{"type":"string","enum":["all","annual","half_year","quarterly","nine_months"],"default":"all"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":40}},{"name":"cursor","in":"query","required":false,"description":"The previous next_cursor, with the same identifier and filters.","schema":{"type":"string"}}],"responses":{"200":{"description":"One page of figures.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KrFinancialsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.006"},"protocols":[{"x402":{}}]}}},"/v1/eu/companies/{id}":{"get":{"operationId":"getEuCompany","summary":"One European listed company by LEI or ISIN.","description":"Annual consolidated figures of listed companies in BE, CY, DK, ES, FI, FR, GB, HR, HU, IS, LT, MT, NL, PT, SE and SK, from their ESEF annual reports. Every figure and filing carries the credit its source requires. For Spanish figures: This information can be obtained free of charge from the CNMV website, www.cnmv.es. Unknown query parameters get 400.","parameters":[{"$ref":"#/components/parameters/EuCompanyId"}],"responses":{"200":{"description":"The company.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EuCompanyResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.006"},"protocols":[{"x402":{}}]}}},"/v1/eu/companies/{id}/financials":{"get":{"operationId":"getEuFinancials","summary":"One annual consolidated figure, newest period end first.","description":"Annual consolidated figures of listed companies in BE, CY, DK, ES, FI, FR, GB, HR, HU, IS, LT, MT, NL, PT, SE and SK, from their ESEF annual reports. Every figure and filing carries the credit its source requires. For Spanish figures: This information can be obtained free of charge from the CNMV website, www.cnmv.es. Unknown query parameters get 400.","parameters":[{"$ref":"#/components/parameters/EuCompanyId"},{"name":"field","in":"query","required":true,"schema":{"type":"string","enum":["revenue","net_income_attributable","diluted_eps","operating_cash_flow","cash_and_equivalents","total_assets","total_equity"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":40}},{"name":"cursor","in":"query","required":false,"description":"Use next_cursor from this listing with the same id and field. A cursor remains valid across snapshot flips.","schema":{"type":"string"}}],"responses":{"200":{"description":"One page.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EuFinancialsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.006"},"protocols":[{"x402":{}}]}}},"/v1/eu/companies/{id}/filings":{"get":{"operationId":"getEuFilings","summary":"Annual ESEF filings, newest period end first, then filing id.","description":"Annual consolidated figures of listed companies in BE, CY, DK, ES, FI, FR, GB, HR, HU, IS, LT, MT, NL, PT, SE and SK, from their ESEF annual reports. Every figure and filing carries the credit its source requires. For Spanish figures: This information can be obtained free of charge from the CNMV website, www.cnmv.es. Unknown query parameters get 400.","parameters":[{"$ref":"#/components/parameters/EuCompanyId"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":40}},{"name":"cursor","in":"query","required":false,"description":"Use next_cursor from this listing with the same id and field. A cursor remains valid across snapshot flips.","schema":{"type":"string"}}],"responses":{"200":{"description":"One page.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EuFilingsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.006"},"protocols":[{"x402":{}}]}}},"/v1/billing/balance":{"get":{"operationId":"getBillingBalance","summary":"The key's prepaid account: today's free allowance and paid credits by lot, earliest expiry first. Free. Not live yet: answers 404 until credits are switched on.","responses":{"200":{"description":"The balance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingBalanceResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"The key has no prepaid account, or credits are switched off.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}}}},"/v1/billing/checkout":{"post":{"operationId":"createCheckout","summary":"Starts a Stripe Checkout for one credit pack and returns its page. The credits arrive when the payment clears. Credits expire 12 months after purchase. Not live yet: answers 404 until card payments are switched on.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["pack"],"properties":{"pack":{"type":"string","description":"A pack id, for example pack_10. The 400 for a bad id lists them."},"country":{"type":"string","pattern":"^[A-Z]{2}$","description":"Optional buyer billing country (ISO 3166-1 alpha-2). Without it, Checkout asks for a business tax ID where Stripe supports one."}}}}}},"responses":{"200":{"description":"The Checkout page to send the buyer to.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Card payments are switched off.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}}}},"/v1/br/download":{"get":{"operationId":"getBrazilDownload","summary":"Brazil database copy (ODbL)","description":"Requires a paid account's API key and accept=odbl; unmetered. One copy per account per UTC day, or per service key. Returns two presigned GET links valid for 15 minutes, one gzip JSON lines file per table in load-file shape, for the current snapshot only. Returns 503 before a Brazil snapshot, before its dump is uploaded, or when storage or download recording is unavailable or not configured. A 503 does not use the daily allowance.","parameters":[{"name":"accept","in":"query","required":true,"description":"Acknowledge that the Brazil database copy is released under the ODbL 1.0 licence.","schema":{"type":"string","enum":["odbl"]}}],"responses":{"200":{"description":"Current snapshot and two temporary download links.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrDownload"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"Brazil data is available on paid plans only. Buy credits or subscribe, then use that account's API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}}}},"/v1/br/companies/{id}":{"get":{"operationId":"getBrazilCompany","summary":"One Brazil company by CNPJ, CVM code or B3 ticker.","description":"Company profile. Paid account's key required; 1 credit per record; errors are free. Contains information from CVM (Comissão de Valores Mobiliários), Dados Abertos, Cias Abertas (DFP, ITR, cadastro, FCA), accessed through the CVM Open Data Portal https://dados.cvm.gov.br/ and made available under the Open Database License (ODbL) 1.0 https://opendatacommons.org/licenses/odbl/1-0/. Belfort Research selected accounts, converted units and derived some quarterly cash flows; this modified Brazil database is available under the same licence at https://api.belfortagent.xyz/v1/br/download. Not endorsed by CVM.","parameters":[{"$ref":"#/components/parameters/BrCompanyId"}],"responses":{"200":{"description":"The company.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrCompanyResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"description":"Brazil data is available on paid plans only. Buy credits or subscribe, then use that account's API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}}}},"/v1/br/companies/{id}/financials":{"get":{"operationId":"getBrazilFinancials","summary":"Brazil CVM financial figures, newest period first.","description":"Exact decimal text in BRL (BRL/share for EPS). Optional field and period filters. Ordered by period_end descending, then field and duration ascending. Paid account's key required; 1 credit when points are returned; empty results and errors are free. Contains information from CVM (Comissão de Valores Mobiliários), Dados Abertos, Cias Abertas (DFP, ITR, cadastro, FCA), accessed through the CVM Open Data Portal https://dados.cvm.gov.br/ and made available under the Open Database License (ODbL) 1.0 https://opendatacommons.org/licenses/odbl/1-0/. Belfort Research selected accounts, converted units and derived some quarterly cash flows; this modified Brazil database is available under the same licence at https://api.belfortagent.xyz/v1/br/download. Not endorsed by CVM.","parameters":[{"$ref":"#/components/parameters/BrCompanyId"},{"name":"field","in":"query","required":false,"schema":{"type":"string","enum":["revenue","cost_of_revenue","gross_profit","operating_income","pretax_income","income_tax","net_income","net_income_attributable","basic_eps","diluted_eps","financial_intermediation_income","financial_intermediation_result","insurance_activities_income","operating_cash_flow","investing_cash_flow","financing_cash_flow","cash_and_equivalents","current_assets","receivables","inventory","ppe_net","intangibles","goodwill","total_assets","current_liabilities","accounts_payable","short_term_debt","total_equity"]}},{"name":"period","in":"query","required":false,"description":"all = every period; annual = FY; quarterly = Q1/Q2/Q3.","schema":{"type":"string","enum":["all","annual","quarterly"],"default":"all"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":40}},{"name":"cursor","in":"query","required":false,"description":"The previous next_cursor, with the same identifier and filters.","schema":{"type":"string"}}],"responses":{"200":{"description":"One page of figures.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrFinancialsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"description":"Brazil data is available on paid plans only. Buy credits or subscribe, then use that account's API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/Unavailable"}}}}},"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"X-API-Key"}},"parameters":{"CompanyId":{"name":"id","in":"path","required":true,"description":"A ticker in any case (`BRK.B` and `BRK-B` reach the same company) or a CIK with or without leading zeros.","schema":{"type":"string"}},"ThCompanyId":{"name":"id","in":"path","required":true,"description":"A SET symbol in any case, such as `GULF`, or a 13-digit registration number. A US ticker or CIK is not a Thai company id.","schema":{"type":"string"}},"JpCompanyId":{"name":"id","in":"path","required":true,"description":"A four-character Japan ticker (7203 or 130A), EDINET code (E02144) or 13-digit corporate number.","schema":{"type":"string","pattern":"^([0-9][0-9A-Z][0-9][0-9A-Z]|E[0-9]{5}|[0-9]{13})$"}},"KrCompanyId":{"name":"id","in":"path","required":true,"description":"A six-character Korean ticker (005930), eight-digit DART corporation code (00126380) or 13-digit corporate number.","schema":{"type":"string","pattern":"^([0-9][0-9A-Z]{5}|[0-9]{8}|[0-9]{13})$"}},"EuCompanyId":{"name":"id","in":"path","required":true,"description":"A 20-character LEI or a 12-character ISIN with valid check digits, in any case.","schema":{"type":"string"}},"BrCompanyId":{"name":"id","in":"path","required":true,"description":"CNPJ (14 digits or printed form), CVM code (1 to 6 digits), or B3 ticker (case insensitive).","schema":{"type":"string","pattern":"^([0-9]{14}|[0-9]{1,6}|[A-Za-z][A-Za-z0-9]{3}[0-9]{1,2}|[0-9]{2}\\.[0-9]{3}\\.[0-9]{3}/[0-9]{4}-[0-9]{2})$"}},"TwCompanyId":{"name":"id","in":"path","required":true,"description":"A four-digit Taiwan stock code, such as `2330`, or an 8-digit unified business number. A US ticker or CIK is not a Taiwan company id.","schema":{"type":"string"}}},"responses":{"BadRequest":{"description":"The request is malformed or has an unknown query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"The key is missing, unknown or revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"No company matches this ticker, CIK, SET symbol or registration number.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"RateLimited":{"description":"The key is over its per-minute limit. Other 429s (keyless demo, x402) use this shape too.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"PaymentRequired":{"description":"The key's account has no credits left for this call, or, with no key, the call can be paid through x402. Nothing was charged. A keyed 402 carries x402 payment requirements (the PAYMENT-REQUIRED header and billing.x402) only when the account opted in, so an agent holding a key never pays per call by surprise. An x402 payment that fails verification also gets 402, with x402's own body and headers. A 402 on a company that is free with no key means that company is outside the free set, or the route is (Form 13F holdings by manager): see the free companies in this document's description.","headers":{"PAYMENT-REQUIRED":{"description":"x402 payment requirements, base64 JSON. Present only when x402 payment is offered.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"Internal":{"description":"Something failed on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unavailable":{"description":"The database can't be reached, or no data is loaded yet for this route. The code is `internal`. Try again after the wait given in Retry-After.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"ChangesResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["key","change"],"properties":{"key":{"type":"string"},"change":{"type":"string","enum":["added","changed","removed"]}}}},"meta":{"type":"object","additionalProperties":false,"required":["dataset","since","to","as_of","next_cursor"],"properties":{"dataset":{"type":"string"},"since":{"type":"string","pattern":"^[0-9]+$"},"to":{"type":"string","pattern":"^[0-9]+$","description":"Global feed position pinned by page one."},"as_of":{"type":"string","format":"date-time"},"next_cursor":{"type":["string","null"]}}}}},"Error":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"meta":{"type":"object","additionalProperties":false,"required":["position"],"description":"Every data-route 404 includes the change-feed position of its answer.","properties":{"position":{"type":["string","null"],"pattern":"^[0-9]+$"}}},"error":{"type":"object","additionalProperties":false,"required":["code","message"],"properties":{"code":{"type":"string","enum":["unauthorized","forbidden","not_found","since_unknown","full_copy_required","bad_request","rate_limited","internal"]},"message":{"type":"string"},"get_key_url":{"type":"string","format":"uri","description":"Only on an answer to a request made without a key or token, when claim links are on: a sign-up link with a random one-time code. Signing up through it ties this one request to the new account. The same link is in the `X-Get-Key` header."}}}}},"PaymentRequiredError":{"type":"object","additionalProperties":false,"required":["error","billing"],"properties":{"x402Version":{"type":"integer","const":1,"description":"Only when the answer offers x402: the version of the `accepts` list in this body, for x402 version 1 clients. Version 2 clients read the `PAYMENT-REQUIRED` header instead."},"accepts":{"type":"array","description":"Only when the answer offers x402. The same payment options as the `PAYMENT-REQUIRED` header, in x402 version 1 form.","items":{"type":"object","required":["scheme","network","maxAmountRequired","resource","description","mimeType","payTo","maxTimeoutSeconds","asset"],"properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string","enum":["base","base-sepolia"]},"maxAmountRequired":{"type":"string","pattern":"^[0-9]+$"},"resource":{"type":"string","format":"uri"},"description":{"type":"string"},"mimeType":{"type":"string"},"payTo":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"},"maxTimeoutSeconds":{"type":"integer","minimum":1},"asset":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$"},"extra":{"type":"object"}}}},"error":{"type":"object","additionalProperties":false,"required":["code","message"],"properties":{"code":{"type":"string","enum":["payment_required"]},"message":{"type":"string"},"get_key_url":{"type":"string","format":"uri","description":"Only on an answer to a request made without a key or token, when claim links are on: a sign-up link with a random one-time code. Signing up through it ties this one request to the new account. The same link is in the `X-Get-Key` header."}}},"billing":{"type":"object","additionalProperties":false,"required":["credits_needed","free_left_today","paid_available","top_up_url","checkout","terms_url","x402"],"properties":{"credits_needed":{"type":"integer","minimum":1,"description":"What this call costs."},"free_left_today":{"type":["integer","null"],"description":"Free credits left today (UTC). Null on a call with no key."},"paid_available":{"type":["integer","null"],"description":"Paid credits left. Null on a call with no key."},"top_up_url":{"type":"string","format":"uri"},"sign_up_url":{"type":"string","format":"uri","description":"Where a caller with no key gets one. Present unless the service has no sign-up page configured, so read it as optional."},"checkout":{"type":"string","description":"The route that starts a card top-up."},"terms_url":{"type":"string","format":"uri"},"x402":{"oneOf":[{"type":"object","additionalProperties":false,"required":["price","network"],"properties":{"price":{"type":"string","description":"The price of this call in USD, paid in USDC, for example \"$0.005000\"."},"network":{"type":"string","description":"CAIP-2 network id: Base Sepolia (eip155:84532) by default, or Base mainnet (eip155:8453) once the owner sets it."}}},{"type":"null"}]}}}}},"BillingLot":{"type":"object","additionalProperties":false,"required":["lot_id","source","credits","available","purchased_at","expires_at"],"properties":{"lot_id":{"type":"string"},"source":{"type":"string","enum":["stripe","grant","trial"]},"credits":{"type":"integer","minimum":1},"available":{"type":"integer","minimum":0},"purchased_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"}}},"BillingBalance":{"type":"object","additionalProperties":false,"required":["account_id","free_per_day","free_used_today","free_left_today","free_resets_at","paid_available","unrecovered_credits","x402_fallback","lots"],"properties":{"account_id":{"type":"string"},"free_per_day":{"type":"integer","minimum":0},"free_used_today":{"type":"integer","minimum":0},"free_left_today":{"type":"integer","minimum":0},"free_resets_at":{"type":"string","format":"date-time","description":"The next 00:00 UTC. Nothing rolls over."},"paid_available":{"type":"integer","minimum":0},"unrecovered_credits":{"type":"integer","minimum":0,"description":"Credits a refund or dispute took back after they were spent."},"x402_fallback":{"type":"boolean","description":"Whether this account's 402s offer x402 payment. Off unless the holder opted in."},"lots":{"type":"array","description":"Lots with credits left, earliest expiry first, the order they are spent in.","items":{"$ref":"#/components/schemas/BillingLot"}}}},"BillingBalanceResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/BillingBalance"},"meta":{"$ref":"#/components/schemas/BillingMeta"}}},"CheckoutResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["checkout_url","expires_at","pack","credits","price_cents","currency","credits_expire_months"],"properties":{"checkout_url":{"type":"string","format":"uri"},"expires_at":{"type":["string","null"],"format":"date-time"},"pack":{"type":"string"},"credits":{"type":"integer","minimum":1},"price_cents":{"type":"integer","minimum":1,"description":"Excludes tax."},"currency":{"type":"string"},"credits_expire_months":{"type":"integer","minimum":1}}},"meta":{"$ref":"#/components/schemas/BillingMeta"}}},"BillingMeta":{"type":"object","additionalProperties":false,"required":["snapshot_id","as_of","next_cursor"],"properties":{"snapshot_id":{"type":["string","null"]},"as_of":{"type":["string","null"],"format":"date-time"},"next_cursor":{"type":["string","null"]}}},"Meta":{"type":"object","additionalProperties":false,"required":["snapshot_id","as_of","next_cursor","position"],"properties":{"position":{"type":["string","null"],"pattern":"^[0-9]+$","description":"Data is at least as new as this global change-log position. Null before the feed has started, or when the position can't be read."},"snapshot_id":{"type":["string","null"],"description":"The snapshot served. Null only on /v1/status."},"as_of":{"type":["string","null"],"format":"date-time","description":"When the source data was published. Null only on /v1/status with nothing loaded."},"next_cursor":{"type":["string","null"],"description":"Pass as `cursor` for the next page. Null on the last page."},"get_key_url":{"type":"string","format":"uri","description":"Only on a free-demo answer (header `X-Free-Demo: true`) when claim links are on: a sign-up link with a random one-time code. Signing up through it ties this one request to the new account. The same link is in the `X-Get-Key` header."},"pay_per_call":{"type":"object","description":"Only on a free-demo answer, when pay-per-call is on: how to buy the same route for any other company.","additionalProperties":false,"required":["price","network","how","docs"],"properties":{"price":{"type":"string"},"network":{"type":"string"},"how":{"type":"string"},"docs":{"type":"string","format":"uri"}}}}},"MetricKey":{"type":"string","description":"The five headline metrics, then a bank's own income lines, served for banks and lenders only. At a bank, `revenue` is the bank's own total-revenue line or nothing, never its total interest income; `net_revenue` (net interest income plus noninterest income) is the headline revenue figure for a bank.","enum":["revenue","net_income","diluted_eps","operating_cash_flow","cash_and_equivalents","total_interest_income","net_interest_income","noninterest_income","net_revenue"]},"Frequency":{"type":"string","enum":["annual","quarterly"]},"StatementKind":{"type":"string","description":"Balance sheet, income, cash flow, comprehensive income.","enum":["BS","IS","CF","CI"]},"Source":{"type":"object","description":"The filing a figure came from.","additionalProperties":false,"required":["accession","filing_url","form","filed"],"properties":{"accession":{"type":"string","pattern":"^\\d{10}-\\d{2}-\\d{6}$"},"filing_url":{"type":"string","format":"uri"},"form":{"type":"string"},"filed":{"type":"string","format":"date"}}},"FirstReported":{"type":"object","description":"The first filing to report this figure's exact period under this tag and unit, and the value it reported. Equal to `source` and `value` when the figure was never restated. A first report under an older tag is not traced.","additionalProperties":false,"required":["value","accession","filed"],"properties":{"value":{"type":"number"},"accession":{"type":"string","pattern":"^\\d{10}-\\d{2}-\\d{6}$"},"filed":{"type":"string","format":"date"}}},"Operand":{"type":"object","description":"One filed figure a derived figure is computed from. The figure is the sum of the addends and minuends, less the subtrahends.","additionalProperties":false,"required":["role","accession","filing_url","form","filed","start","end","value"],"properties":{"role":{"type":"string","enum":["minuend","subtrahend","addend"]},"concept":{"type":"string","description":"The line's XBRL tag","on a figure calculated from two lines.":null},"accession":{"type":"string","pattern":"^\\d{10}-\\d{2}-\\d{6}$"},"filing_url":{"type":"string","format":"uri"},"form":{"type":"string"},"filed":{"type":"string","format":"date"},"start":{"type":"string","format":"date"},"end":{"type":"string","format":"date"},"value":{"type":"number"}}},"Adjustment":{"type":"object","description":"Something we did beyond copying one filed figure. The value depends on the kind:\n- `scale_corrected_from`: filings of this figure differ by a thousand or a million, and another filing's was taken. Value is the figure replaced; `value` on the point and `source` are the sibling that was used.\n- `scale_dispute_resolved`: another filing states this figure at a thousand or a million times this value, and the evidence backs this one. Value is the other filing's figure, which can also be `first_reported`.\n- `negative_replaced_from`: the tag held a negative sub-line for this period, such as intersegment sales, so `value` is the listed total. Value is the figure replaced.\n- `negative_kept`: the figure is negative and was kept. Value is `total_over:<tag>` when the tag is the filer's total in other periods and `<tag>` is a positive part of it, or `no_listed_figure` when no listed tag has a positive figure for the period.\n- `source_replaced_from`: the newest filing of this period was a form that can carry another company's figures, such as an 8-K, so the figure comes from the filer's own filing of it. Value is the accession passed over.\n- `cash_aligned_from`: the annual and quarterly series held different figures for this balance under one tag, and this point now holds the newest figure a periodic filing's balance sheet shows for the date, named in `source`. Value is the figure replaced.\n- `cash_measure`: the figure is the cash flow total, which includes any restricted cash, because the company tags no cash and cash equivalents figure without it for this date and its filing states no restricted cash for the date. Value `includes_restricted`. A total whose filing states restricted cash above zero, with no cash line that reconciles to it, is left out.\n- `balance_sheet_cash_over`: a figure that includes restricted cash was also filed for this date; the point takes the cash and cash equivalents figure the filing tags without it, or the cash figure that, with the same filing's restricted cash, makes its cash flow total. Value is the tag passed over.\n- `cash_reconciled_over`: the balance-sheet cash tag held a multiple of 100,000 that doesn't reconcile with the filing's own cash flow total, in a filing that states its cash to the unit, so the point takes the figure from another cash tag of the same filing that does. Value is the figure passed over.\n- `zero_replaced_from`: a filed zero was replaced by a figure from another tag. Value is that tag.\n- `stitched_under`: this period came from an older tag, under the series' main tag. Value is the main tag.\n- `revenue_total_over`: the series uses a larger total over a tag that looked like a sub-line. Value is the tag passed over. Listed on every point of the series.\n- `fallback_measure`: the series uses a different measure, because no listed tag covers it. Value is the measure's tag. Listed on every point of the series.\n- `fallback_promoted_over`: the listed tags stopped being filed. Value is their last period end. Listed on every point of the series.\n- `ladder_stitched`: older tags filled in periods. Value is `tag:count`, comma separated.\n- `ambiguous_overlap`: other tags reported periods this series covers, and this series' figure was kept. Value is `tag:count`, comma separated.\n- `ignored_currency`: the filer also reported this tag in another unit, such as a convenience translation. Value lists the units.\n- `fiscal_period_inferred`: an untagged 6-K's fiscal quarter and year were inferred from month-end dates, corroborated by its own income statements. Value describes the quarter, period end and fiscal year end, for example `Q2 from period end 2026-06-30 and fiscal year end 12-31`.\n- `printed_total_differs`: on a bank's calculated `net_revenue`, the bank also filed a different total for the period. Value is that total.\n","additionalProperties":false,"required":["kind","value"],"properties":{"kind":{"type":"string","enum":["scale_corrected_from","scale_dispute_resolved","negative_replaced_from","negative_kept","source_replaced_from","cash_aligned_from","cash_measure","balance_sheet_cash_over","cash_reconciled_over","zero_replaced_from","stitched_under","revenue_total_over","fallback_measure","fallback_promoted_over","ladder_stitched","ambiguous_overlap","ignored_currency","fiscal_period_inferred","printed_total_differs"]},"value":{"type":["string","number"]}}},"MetricPoint":{"type":"object","description":"One figure. A filed figure names its filing, usually the newest within this frequency of it in `source` and the first in `first_reported`. A derived quarter has `source` and `first_reported` null and names both filings in `operands`.","additionalProperties":false,"required":["metric","value","currency","period_end","start","frequency","fiscal_year","fiscal_quarter","concept","derived","adjustments","source","first_reported","operands"],"properties":{"metric":{"$ref":"#/components/schemas/MetricKey"},"value":{"type":"number"},"currency":{"type":["string","null"]},"period_end":{"type":"string","format":"date"},"start":{"type":["string","null"],"format":"date","description":"First day of the period the figure covers. Null for a balance-sheet figure, or a filing that stated no start. On a derived quarter, the day after the subtrahend ends."},"frequency":{"$ref":"#/components/schemas/Frequency"},"fiscal_year":{"type":["integer","null"]},"fiscal_quarter":{"type":["integer","null"],"minimum":1,"maximum":4},"concept":{"type":"string","description":"The XBRL tag the figure was filed under. Both tags on a figure calculated from two lines."},"derived":{"type":"boolean"},"adjustments":{"type":"array","items":{"$ref":"#/components/schemas/Adjustment"}},"source":{"oneOf":[{"$ref":"#/components/schemas/Source"},{"type":"null"}]},"first_reported":{"oneOf":[{"$ref":"#/components/schemas/FirstReported"},{"type":"null"}]},"operands":{"oneOf":[{"type":"array","minItems":2,"maxItems":4,"items":{"$ref":"#/components/schemas/Operand"}},{"type":"null"}]}},"if":{"properties":{"derived":{"const":true}}},"then":{"properties":{"source":{"type":"null"},"first_reported":{"type":"null"},"operands":{"type":"array"}}},"else":{"properties":{"source":{"$ref":"#/components/schemas/Source"},"first_reported":{"$ref":"#/components/schemas/FirstReported"},"operands":{"type":"null"}}}},"MetricDocument":{"type":"object","description":"One series document per company, metric and frequency. Not a response. Points are newest first.","additionalProperties":false,"required":["metric","frequency","points"],"properties":{"metric":{"$ref":"#/components/schemas/MetricKey"},"frequency":{"$ref":"#/components/schemas/Frequency"},"points":{"type":"array","items":{"$ref":"#/components/schemas/MetricPoint"}}}},"StatementValue":{"type":"object","additionalProperties":false,"required":["period_end","quarters","value","display_value","unit"],"if":{"properties":{"value":{"type":"null"}},"required":["value"]},"then":{"properties":{"display_value":{"type":"null"}}},"properties":{"period_end":{"type":"string","format":"date","description":"The SEC rounds this to the nearest month end, so Sep. 27, 2025 reads 2025-09-30 and a period ending Jan. 14, 2025 reads 2024-12-31. A metric point keeps the filed date, so the two can differ by days."},"quarters":{"type":"integer","minimum":0,"description":"The value's duration in whole quarters, which the SEC rounds to the nearest whole number. So 3 can be eight months, and two periods that round to the same month end and quarters share one value. 0 means under about six weeks, which is a balance or a short period. On a balance sheet it is always a balance, and on an income or comprehensive income statement always a short period. On a cash flow statement it is a balance for opening and closing cash, and a short period on a flow line, and the value does not say which. "},"value":{"type":["number","null"],"description":"The value as tagged in the filing, with no sign change. Null when the filing left it blank, never 0."},"display_value":{"type":["number","null"],"description":"The figure with the sign the filing displays: `value`, or its opposite when `negating` is true. Null when `value` is null, or when `negating` is null."},"unit":{"type":["string","null"],"description":"The unit of this value, such as USD or USD/shares. It sits on the value because one tag and period can be filed in two units (Pemex: MXN and USD), and both are listed."}}},"StatementEntry":{"type":"object","description":"One tag on one statement. Values sit on the tag, not on a display line, because the filing data doesn't say which period each line shows. A tag the filing lists twice, typically beginning and ending cash, is one entry with two labels. No claim is made about which label a value belongs to. A tag with nothing reported has empty `values`. Lines tagged with a dimension, such as Apple's Products and Services net sales or figures for variable interest entities, are left out while totals are kept, so a statement can have lines its document lacks, and a line whose figures are all dimensional has empty `values`.","additionalProperties":false,"required":["tag","taxonomy","is_custom","labels","line_numbers","negating","values"],"if":{"properties":{"negating":{"type":"null"}},"required":["negating"]},"then":{"properties":{"values":{"items":{"properties":{"display_value":{"type":"null"}}}}}},"properties":{"tag":{"type":"string"},"taxonomy":{"type":"string","description":"The tag's taxonomy and version","such as us-gaap/2024.":null},"is_custom":{"type":"boolean","description":"True when the filer defined this tag itself."},"labels":{"type":"array","minItems":1,"description":"The filing's own labels for this tag, in statement order. Labels hold ASCII only, so other characters are lost: `stockholders’` reads `stockholders`.","items":{"type":"string"}},"line_numbers":{"type":"array","minItems":1,"description":"The tag's positions on the statement, in order, matching `labels`.","items":{"type":"integer"}},"negating":{"type":["boolean","null"],"description":"True when the filing displays this tag with the opposite sign, which `display_value` applies and `value` does not. Null when the tag's lines disagree, so no single displayed sign exists."},"values":{"type":"array","items":{"$ref":"#/components/schemas/StatementValue"}}}},"StatementDocument":{"type":"object","description":"One statement of one filing. Periodic forms only (10-K, 10-Q, 20-F, 40-F, 10-KT and their amendments).","additionalProperties":false,"required":["accession","filing_url","statement","form","amends","fiscal_year","fiscal_period","period","filed","entries"],"properties":{"accession":{"type":"string","pattern":"^\\d{10}-\\d{2}-\\d{6}$"},"filing_url":{"type":"string","format":"uri"},"statement":{"$ref":"#/components/schemas/StatementKind"},"form":{"type":"string"},"amends":{"type":"boolean","description":"True when this filing is an amendment. The filing it amends isn't named."},"fiscal_year":{"type":["integer","null"]},"fiscal_period":{"type":["string","null"]},"period":{"type":["string","null"],"format":"date","description":"The filing's balance-sheet date, rounded by the SEC to the nearest month end."},"filed":{"type":"string","format":"date"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/StatementEntry"}}}},"Company":{"type":"object","additionalProperties":false,"required":["cik","name","sic","country","fiscal_year_end","tickers","metrics_from","statements_from","reorganization","listings","cusips"],"properties":{"cik":{"type":"string","pattern":"^\\d{10}$"},"name":{"type":"string"},"sic":{"type":["string","null"]},"country":{"type":["string","null"]},"fiscal_year_end":{"type":["string","null"],"description":"Month and day as MMDD."},"tickers":{"type":"array","description":"Every ticker that reaches this company. Empty for a filer with none, which still works by CIK. A ticker reaches one CIK, and may not be where the SEC's ticker file lists it: see `reorganization`.","items":{"type":"string"}},"metrics_from":{"type":["string","null"],"format":"date"},"statements_from":{"type":["string","null"],"format":"date"},"reorganization":{"oneOf":[{"$ref":"#/components/schemas/Reorganization"},{"type":"null"}]},"listings":{"description":"Exchange listings for this CIK from the SEC's ticker records. A CIK can have several tickers on different exchanges. mic is the ISO 10383 code of the exchange, or null when the exchange doesn't map to exactly one. Null when not available yet.","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/CompanyListing"}},{"type":"null"}]},"cusips":{"description":"Class CUSIPs named for this company on Schedule 13D/G cover pages. A CUSIP named for two companies isn't served. ISIN is not served. Null when not available yet.","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/CompanyCusip"}},{"type":"null"}]}}},"CompanyListing":{"type":"object","additionalProperties":false,"required":["ticker","exchange","mic","source"],"properties":{"ticker":{"type":"string"},"exchange":{"type":["string","null"]},"mic":{"type":["string","null"],"description":"ISO 10383 MIC when the SEC exchange name maps to exactly one code."},"source":{"type":"string","enum":["sec_submissions"]}}},"CompanyCusip":{"type":"object","additionalProperties":false,"required":["cusip","source","as_of","evidence"],"properties":{"cusip":{"type":"string","pattern":"^[A-Z0-9]{9}$"},"source":{"type":"string","enum":["schedule_13dg"]},"as_of":{"type":["string","null"],"format":"date"},"evidence":{"type":["string","null"],"description":"Schedule 13D/G accession that named this CUSIP and CIK."}}},"Reorganization":{"type":"object","description":"This company is one of two CIKs of one business, after a holding company reorganization or a change of domicile, and the record is the same on both. The SEC's ticker file lists the tickers under `new_cik`, while the older statements sit under `filings_cik`. The tickers reach `filings_cik` until `new_cik` has statements of its own, then `new_cik`. Each CIK's metrics and statements come from that CIK alone and are never joined, so ask for the other CIK by number to see its figures. Until the tickers move, newer figures can sit under `new_cik`.","additionalProperties":false,"required":["new_cik","filings_cik","tickers","evidence"],"properties":{"new_cik":{"type":"string","pattern":"^\\d{10}$"},"filings_cik":{"type":"string","pattern":"^\\d{10}$"},"tickers":{"type":"array","minItems":1,"items":{"type":"string"}},"evidence":{"type":"string","description":"The SEC filings that show the reorganization."}}},"DataAge":{"type":"object","additionalProperties":false,"required":["snapshot_id","as_of","loaded_at","age_hours"],"properties":{"snapshot_id":{"type":"string"},"as_of":{"type":"string","format":"date-time"},"loaded_at":{"type":"string","format":"date-time"},"age_hours":{"type":"number"}}},"HeldCompany":{"type":"object","additionalProperties":false,"required":["cik","ticker","held_since"],"properties":{"cik":{"type":"string","pattern":"^\\d{10}$"},"ticker":{"type":["string","null"],"description":"Primary ticker (position 0), or null when the company has none."},"held_since":{"type":"string","format":"date-time","description":"When this company's metrics were first held back."}}},"MetricsDataAge":{"type":"object","description":"Data age for metrics, plus any companies whose newest metrics are held back for review after an unusual change. `held` is [] when none are, and null when we can't tell. Treat null as unknown, never as fine.","additionalProperties":false,"required":["snapshot_id","as_of","loaded_at","age_hours","held"],"properties":{"snapshot_id":{"type":"string"},"as_of":{"type":"string","format":"date-time"},"loaded_at":{"type":"string","format":"date-time"},"age_hours":{"type":"number"},"held":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/HeldCompany"}},{"type":"null"}]}}},"MetricsMeta":{"type":"object","additionalProperties":false,"required":["snapshot_id","as_of","next_cursor","held","position"],"properties":{"position":{"type":["string","null"],"pattern":"^[0-9]+$","description":"Data is at least as new as this global change-log position. Null before the feed has started, or when the position can't be read."},"snapshot_id":{"type":["string","null"],"description":"The snapshot served. Null only on /v1/status."},"as_of":{"type":["string","null"],"format":"date-time","description":"When the source data was published. Null only on /v1/status with nothing loaded."},"next_cursor":{"type":["string","null"],"description":"Pass as `cursor` for the next page. Null on the last page."},"held":{"type":"string","enum":["held","not_held","unknown"],"description":"Whether this company's newest metrics are held back for review. unknown means we can't tell; never treat it as not_held."},"held_since":{"type":"string","format":"date-time","description":"Present only when held is held. When the hold began."},"get_key_url":{"type":"string","format":"uri","description":"Only on a free-demo answer (header `X-Free-Demo: true`) when claim links are on: a sign-up link with a random one-time code. Signing up through it ties this one request to the new account. The same link is in the `X-Get-Key` header."},"pay_per_call":{"type":"object","description":"Only on a free-demo answer, when pay-per-call is on: how to buy the same route for any other company.","additionalProperties":false,"required":["price","network","how","docs"],"properties":{"price":{"type":"string"},"network":{"type":"string"},"how":{"type":"string"},"docs":{"type":"string","format":"uri"}}}}},"OwnershipRecord":{"type":"object","description":"One reporting owner on one Schedule 13D or 13G filing. Multiple owners on one filing are separate records; their shares must not be summed as if they were separate holdings. `shares` and `percent_of_class` are text as filed. Blank is null, never zero. Pre-2024-12-18 SC 13D/13G text filings are out of scope.","additionalProperties":false,"required":["issuer_cik","owner_name","owner_cik","form","event_date","filed","shares","percent_of_class","amendment_number","prior_accession","accession","filing_url"],"properties":{"issuer_cik":{"type":"string","pattern":"^\\d{10}$"},"owner_name":{"type":["string","null"]},"owner_cik":{"type":["string","null"],"pattern":"^\\d{10}$"},"form":{"type":"string"},"event_date":{"type":["string","null"],"format":"date"},"filed":{"type":"string","format":"date"},"shares":{"type":["string","null"],"description":"Aggregate amount owned","as filed text.":null},"percent_of_class":{"type":["string","null"],"description":"Percent of class as filed text."},"amendment_number":{"type":["integer","null"],"minimum":0},"prior_accession":{"type":["string","null"],"pattern":"^\\d{10}-\\d{2}-\\d{6}$","description":"An earlier accession named by an amendment, when present."},"accession":{"type":"string","pattern":"^\\d{10}-\\d{2}-\\d{6}$"},"filing_url":{"type":"string","format":"uri"}}},"MacroPoint":{"type":"object","additionalProperties":false,"required":["date","value","unit","source_url","fetched_at","seasonal_adjustment","revision_status"],"properties":{"date":{"type":"string","format":"date"},"value":{"type":["number","string","null"]},"unit":{"type":"string"},"source_url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"seasonal_adjustment":{"type":"string"},"revision_status":{"type":"string"}}},"MacroDocument":{"type":"object","additionalProperties":false,"required":["series","series_id","title","unit","seasonal_adjustment","revision_status","keep_vintages","source_url","fetched_at","points"],"properties":{"series":{"type":"string"},"series_id":{"type":"string"},"title":{"type":"string"},"unit":{"type":"string"},"seasonal_adjustment":{"type":"string"},"revision_status":{"type":"string"},"keep_vintages":{"type":"boolean","description":"False: only the latest published reading is kept, not earlier versions. BLS series are revised; Treasury par yields are final as published."},"source_url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"points":{"type":"array","items":{"$ref":"#/components/schemas/MacroPoint"}}}},"NormalizedField":{"type":"string","enum":["revenue","gross_profit","operating_income","net_income","net_income_attributable","basic_eps","diluted_eps","weighted_diluted_shares","sga","research_development","income_tax","pretax_income","cash_and_equivalents","total_assets","total_liabilities","total_equity","equity_attributable","current_assets","current_liabilities","receivables","inventory","ppe_net","goodwill","intangibles","accounts_payable","short_term_debt","long_term_debt","retained_earnings","operating_cash_flow","investing_cash_flow","financing_cash_flow","capital_expenditure","stock_compensation","total_interest_income","net_interest_income","noninterest_income","net_revenue"],"description":"The last four are a bank's own income lines, served for banks and lenders only. `net_revenue` is the headline revenue figure for a bank; `derived: true` marks one calculated from two printed lines."},"NormalizedFact":{"type":"object","additionalProperties":false,"required":["cik","period_end","quarters","field","value","unit","derived","source_accession","tag"],"properties":{"cik":{"type":"string","pattern":"^[0-9]{10}$"},"period_end":{"type":"string","format":"date"},"quarters":{"type":"integer","minimum":0},"field":{"$ref":"#/components/schemas/NormalizedField"},"value":{"type":"number"},"unit":{"oneOf":[{"type":"string"},{"type":"null"}]},"derived":{"type":"boolean"},"source_accession":{"type":"string"},"tag":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"ThCompany":{"type":"object","additionalProperties":false,"required":["symbol","registration_number","name","website","statements_page","provider","fields","periods"],"description":"Company-published financial statements read by Belfort Research from each company's own investor-relations website. Not from SET or the SEC. Every figure links to the company's file.","properties":{"symbol":{"type":"string","pattern":"^[A-Z0-9.&-]{1,16}$"},"registration_number":{"type":["string","null"],"pattern":"^[0-9]{13}$"},"name":{"type":"string"},"website":{"type":["string","null"],"format":"uri"},"statements_page":{"type":"string","format":"uri","description":"The page on the company's own investor-relations site where the statements are listed."},"provider":{"type":"string","description":"The investor-relations platform the page runs on."},"fields":{"type":"array","description":"The figures served for this company, A to Z.","items":{"type":"string","enum":["basic_eps","diluted_eps","net_income","cash_and_equivalents"]}},"periods":{"type":"object","additionalProperties":false,"required":["earliest","latest"],"properties":{"earliest":{"type":["string","null"],"format":"date"},"latest":{"type":["string","null"],"format":"date"}}}}},"ThSource":{"type":"object","additionalProperties":false,"required":["file_url","statements_page","owner","published","retrieved_at","sha256","locator"],"properties":{"file_url":{"type":"string","format":"uri","description":"The company's own statements file the figure was read from."},"statements_page":{"type":"string","format":"uri"},"owner":{"type":"string","description":"The company that published the file."},"published":{"type":["string","null"],"format":"date","description":"The day the file was posted, when the page or the file's address shows it. Never guessed."},"retrieved_at":{"type":"string","format":"date-time"},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"The hash of the file as retrieved."},"locator":{"type":"object","description":"Where in the file the figure is, as the sheet, the row and the line's label.","additionalProperties":true}}},"ThFinancialPoint":{"type":"object","additionalProperties":false,"required":["fiscal_year","period","period_end","duration","value","audit_status","source"],"properties":{"fiscal_year":{"type":"integer"},"period":{"type":"string","enum":["Q1","Q2","Q3","FY"]},"period_end":{"type":"string","format":"date"},"duration":{"type":"string","enum":["3M","12M","instant"],"description":"3M is a discrete quarter, 12M a full year, instant a balance on the period end."},"value":{"type":"string","pattern":"^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$","description":"Exact decimal text, so no digit is rounded."},"audit_status":{"type":"string","enum":["reviewed","audited","unknown"]},"source":{"$ref":"#/components/schemas/ThSource"}}},"ThFinancials":{"type":"object","additionalProperties":false,"required":["company","field","unit","points"],"properties":{"company":{"type":"object","additionalProperties":false,"required":["symbol","registration_number","name"],"properties":{"symbol":{"type":"string"},"registration_number":{"type":["string","null"]},"name":{"type":"string"}}},"field":{"type":"string","enum":["basic_eps","diluted_eps","net_income","cash_and_equivalents"]},"unit":{"type":"string","enum":["THB","THB/share"]},"points":{"type":"array","items":{"$ref":"#/components/schemas/ThFinancialPoint"}}}},"ThCompanyResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/ThCompany"},"meta":{"$ref":"#/components/schemas/Meta"}}},"ThFinancialsResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/ThFinancials"},"meta":{"$ref":"#/components/schemas/Meta"}}},"TwCompany":{"type":"object","additionalProperties":false,"required":["symbol","registration_number","name","short_name","english_short_name","website","industry_code","statement_template","statement_scope","listed_on","provider","exchange","fields","periods","monthly_fields","months","attribution"],"description":"Taiwan's own open data (TWSE and TPEx OpenAPIs, Government Open Data License v1). The attribution the licence requires is in `attribution`.","properties":{"symbol":{"type":"string","pattern":"^[0-9]{4}$"},"registration_number":{"type":["string","null"],"pattern":"^[0-9]{8}$"},"name":{"type":"string"},"short_name":{"type":["string","null"]},"english_short_name":{"type":["string","null"]},"website":{"type":["string","null"],"format":"uri"},"industry_code":{"type":["string","null"]},"statement_template":{"type":["string","null"],"enum":["ci","basi","fh","ins","bd","mim",null],"description":"The statement format the company files (general industry, bank, financial holding, insurer, securities, mixed)."},"statement_scope":{"type":"string","enum":["consolidated","individual"],"description":"consolidated for a company that prepares consolidated statements. individual for one that prepares only its own: its figures are the company alone, are not comparable with a consolidated company's, and carry no net_income_attributable or equity_attributable."},"listed_on":{"type":["string","null"],"format":"date"},"provider":{"type":"string","enum":["twse_openapi","tpex_openapi"]},"exchange":{"type":"string","enum":["TWSE","TPEx"],"description":"TWSE for a listed company, TPEx for an over-the-counter one."},"fields":{"type":"array","description":"The statement figures served for this company, A to Z.","items":{"type":"string","enum":["revenue","net_income","net_income_attributable","basic_eps","total_assets","total_liabilities","total_equity","cash_and_equivalents","operating_income","pretax_income","equity_attributable","current_assets","current_liabilities"]}},"periods":{"type":"object","additionalProperties":false,"required":["earliest","latest"],"properties":{"earliest":{"type":["string","null"],"format":"date"},"latest":{"type":["string","null"],"format":"date"}}},"monthly_fields":{"type":"array","items":{"type":"string","enum":["monthly_revenue","monthly_revenue_ytd"]}},"months":{"type":"object","additionalProperties":false,"required":["earliest","latest"],"properties":{"earliest":{"type":["string","null"],"pattern":"^20[0-9]{2}-(0[1-9]|1[0-2])$"},"latest":{"type":["string","null"],"pattern":"^20[0-9]{2}-(0[1-9]|1[0-2])$"}}},"attribution":{"type":"string"}}},"TwSource":{"type":"object","additionalProperties":false,"required":["url","dataset","owner","published","retrieved_at","sha256","licence","locator"],"properties":{"url":{"type":"string","format":"uri","description":"The TWSE or TPEx OpenAPI table the figure was read from."},"dataset":{"type":"string"},"owner":{"type":"string","description":"The agency that published the table."},"published":{"type":["string","null"],"format":"date"},"retrieved_at":{"type":"string","format":"date-time"},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"The hash of the table as retrieved."},"licence":{"type":"object","additionalProperties":false,"required":["name","url"],"properties":{"name":{"type":"string"},"url":{"type":"string","format":"uri"}}},"locator":{"type":"object","additionalProperties":false,"required":["company_code","label","source_value","source_unit"],"description":"The source's own label and value for the figure, before conversion.","properties":{"company_code":{"type":"string"},"label":{"type":"string"},"source_value":{"type":"string"},"source_unit":{"type":"string"}}},"derived_from":{"type":"array","description":"Only for basis quarter_derived. The earlier and the later year-to-date figure; the value is later minus earlier.","minItems":2,"maxItems":2,"items":{"type":"object","additionalProperties":false,"required":["period","value","sha256","retrieved_at"],"properties":{"period":{"type":"string"},"value":{"type":"string","pattern":"^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$"},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$"},"retrieved_at":{"type":"string","format":"date-time"}}}}}},"TwFinancialPoint":{"type":"object","additionalProperties":false,"required":["fiscal_year","period","period_end","duration","basis","value","audit_status","first_seen","last_confirmed","restated","source"],"properties":{"fiscal_year":{"type":"integer"},"period":{"type":"string","enum":["Q1","Q2","Q3","Q4","FY"]},"period_end":{"type":"string","format":"date"},"duration":{"type":"string","enum":["3M","6M","9M","12M","instant"]},"basis":{"type":"string","enum":["quarter","year_to_date","full_year","point_in_time","quarter_derived"],"description":"quarter is the first quarter as filed; year_to_date is cumulative from 1 January (6M, 9M); full_year is 12M; point_in_time is a balance on the period end; quarter_derived is the difference of two year-to-date figures. The earlier figure is the one we archived when it was current: if the company restated it afterwards, the derived quarter can differ from the company's own."},"value":{"type":"string","pattern":"^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$","description":"Exact decimal text, so no digit is rounded."},"audit_status":{"type":"string","enum":["reviewed","audited","unknown"]},"first_seen":{"type":"string","format":"date-time","description":"The first archived retrieval that held this value."},"last_confirmed":{"type":"string","format":"date-time","description":"The latest archived retrieval that still held it."},"restated":{"type":"boolean","description":"True when the source changed this figure after we first saw it."},"source":{"$ref":"#/components/schemas/TwSource"}}},"TwFinancials":{"type":"object","additionalProperties":false,"required":["company","field","unit","statement_scope","attribution","points"],"properties":{"company":{"type":"object","additionalProperties":false,"required":["symbol","registration_number","name"],"properties":{"symbol":{"type":"string"},"registration_number":{"type":["string","null"]},"name":{"type":"string"}}},"field":{"type":"string","enum":["revenue","net_income","net_income_attributable","basic_eps","total_assets","total_liabilities","total_equity","cash_and_equivalents","operating_income","pretax_income","equity_attributable","current_assets","current_liabilities"]},"unit":{"type":"string","enum":["TWD","TWD/share"]},"statement_scope":{"type":"string","enum":["consolidated","individual"],"description":"Which statements the figures come from; the same as the company's statement_scope."},"attribution":{"type":"string"},"points":{"type":"array","items":{"$ref":"#/components/schemas/TwFinancialPoint"}}}},"TwMonthlyPoint":{"type":"object","additionalProperties":false,"required":["month","value","comparative","remarks","audit_status","first_seen","last_confirmed","restated","source"],"properties":{"month":{"type":"string","pattern":"^20[0-9]{2}-(0[1-9]|1[0-2])$"},"value":{"type":"string","pattern":"^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$"},"comparative":{"type":"boolean"},"remarks":{"type":["string","null"],"description":"The company's own note, as printed."},"audit_status":{"type":"string","enum":["unaudited_self_reported"]},"first_seen":{"type":"string","format":"date-time"},"last_confirmed":{"type":"string","format":"date-time"},"restated":{"type":"boolean"},"source":{"$ref":"#/components/schemas/TwSource"}}},"TwMonthly":{"type":"object","additionalProperties":false,"required":["company","field","unit","attribution","points"],"properties":{"company":{"type":"object","additionalProperties":false,"required":["symbol","registration_number","name"],"properties":{"symbol":{"type":"string"},"registration_number":{"type":["string","null"]},"name":{"type":"string"}}},"field":{"type":"string","enum":["monthly_revenue","monthly_revenue_ytd"]},"unit":{"type":"string","enum":["TWD"]},"attribution":{"type":"string"},"points":{"type":"array","items":{"$ref":"#/components/schemas/TwMonthlyPoint"}}}},"TwCompanyResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/TwCompany"},"meta":{"$ref":"#/components/schemas/Meta"}}},"TwFinancialsResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/TwFinancials"},"meta":{"$ref":"#/components/schemas/Meta"}}},"TwMonthlyResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/TwMonthly"},"meta":{"$ref":"#/components/schemas/Meta"}}},"JpCompanyIdentity":{"type":"object","additionalProperties":false,"required":["edinet_code","ticker","corporate_number","name_ja","name_en","accounting_standard","fiscal_year_end"],"properties":{"edinet_code":{"type":"string","pattern":"^E[0-9]{5}$"},"ticker":{"type":["string","null"],"pattern":"^[0-9][0-9A-Z][0-9][0-9A-Z]$"},"corporate_number":{"type":["string","null"],"pattern":"^[0-9]{13}$"},"name_ja":{"type":"string"},"name_en":{"type":["string","null"]},"accounting_standard":{"type":"string","enum":["Japan GAAP","IFRS","US GAAP","JMIS"]},"fiscal_year_end":{"type":["string","null"],"pattern":"^[0-9]{2}-[0-9]{2}$"}}},"JpCompany":{"type":"object","additionalProperties":false,"required":["edinet_code","ticker","corporate_number","name_ja","name_en","accounting_standard","fiscal_year_end","attribution"],"properties":{"edinet_code":{"type":"string","pattern":"^E[0-9]{5}$"},"ticker":{"type":["string","null"],"pattern":"^[0-9][0-9A-Z][0-9][0-9A-Z]$"},"corporate_number":{"type":["string","null"],"pattern":"^[0-9]{13}$"},"name_ja":{"type":"string"},"name_en":{"type":["string","null"]},"accounting_standard":{"type":"string","enum":["Japan GAAP","IFRS","US GAAP","JMIS"]},"fiscal_year_end":{"type":["string","null"],"pattern":"^[0-9]{2}-[0-9]{2}$"},"attribution":{"type":"string"}}},"JpSource":{"type":"object","additionalProperties":false,"required":["doc_id","document_url","doc_description","submitted_at","retrieved_at","amended"],"properties":{"doc_id":{"type":"string","pattern":"^S100[0-9A-Z]{4}$"},"document_url":{"type":"string","format":"uri","pattern":"^https://disclosure2\\.edinet-fsa\\.go\\.jp/WZEK0040\\.aspx\\?S100[0-9A-Z]{4}$"},"doc_description":{"type":["string","null"]},"submitted_at":{"type":"string","description":"Submission time as EDINET prints it, in Japan local time (YYYY-MM-DD HH:mm)."},"retrieved_at":{"type":"string","format":"date-time"},"amended":{"type":"boolean"}}},"JpFinancialPoint":{"type":"object","additionalProperties":false,"required":["field","value","unit","fiscal_year","period","duration","period_start","period_end","accounting_standard","audit_status","statement_scope","source"],"properties":{"field":{"type":"string","enum":["revenue","net_income_attributable","basic_eps","diluted_eps","operating_cash_flow","cash_and_equivalents","total_assets","total_equity"]},"value":{"type":"string","pattern":"^-?(0|[1-9][0-9]{0,17})(\\.[0-9]+)?$"},"unit":{"type":"string","enum":["JPY","JPY/share"]},"fiscal_year":{"type":"integer","description":"Calendar year the fiscal year ends."},"period":{"type":"string","enum":["FY","H1","Q1","Q2","Q3","9M"]},"duration":{"type":"string","enum":["12M","6M","3M","9M","instant"]},"period_start":{"type":["string","null"],"format":"date"},"period_end":{"type":"string","format":"date"},"accounting_standard":{"type":"string","enum":["Japan GAAP","IFRS","US GAAP","JMIS"]},"audit_status":{"type":"string","enum":["audited","reviewed","unknown"]},"statement_scope":{"type":"string","const":"consolidated"},"source":{"$ref":"#/components/schemas/JpSource"}}},"JpFinancials":{"type":"object","additionalProperties":false,"required":["company","attribution","points"],"properties":{"company":{"$ref":"#/components/schemas/JpCompanyIdentity"},"attribution":{"type":"string"},"points":{"type":"array","items":{"$ref":"#/components/schemas/JpFinancialPoint"}}}},"JpCompanyResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/JpCompany"},"meta":{"$ref":"#/components/schemas/Meta"}}},"JpFinancialsResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/JpFinancials"},"meta":{"$ref":"#/components/schemas/Meta"}}},"KrCompanyIdentity":{"type":"object","additionalProperties":false,"required":["corp_code","ticker","corporate_number","name_ko","name_en","market","fiscal_year_end_month","industry_code"],"properties":{"corp_code":{"type":"string","pattern":"^[0-9]{8}$"},"ticker":{"type":"string","pattern":"^[0-9][0-9A-Z]{5}$"},"corporate_number":{"type":["string","null"],"pattern":"^[0-9]{13}$"},"name_ko":{"type":"string"},"name_en":{"type":["string","null"]},"market":{"type":"string","enum":["KOSPI","KOSDAQ","KONEX"]},"fiscal_year_end_month":{"type":"integer","minimum":1,"maximum":12},"industry_code":{"type":["string","null"],"pattern":"^[0-9]{3,5}$"}}},"KrCompany":{"type":"object","additionalProperties":false,"required":["corp_code","ticker","corporate_number","name_ko","name_en","market","fiscal_year_end_month","industry_code","attribution"],"properties":{"corp_code":{"type":"string","pattern":"^[0-9]{8}$"},"ticker":{"type":"string","pattern":"^[0-9][0-9A-Z]{5}$"},"corporate_number":{"type":["string","null"],"pattern":"^[0-9]{13}$"},"name_ko":{"type":"string"},"name_en":{"type":["string","null"]},"market":{"type":"string","enum":["KOSPI","KOSDAQ","KONEX"]},"fiscal_year_end_month":{"type":"integer","minimum":1,"maximum":12},"industry_code":{"type":["string","null"],"pattern":"^[0-9]{3,5}$"},"attribution":{"type":"string"}}},"KrSource":{"type":"object","additionalProperties":false,"required":["rcept_no","document_url","published","retrieved_at"],"properties":{"rcept_no":{"type":"string","pattern":"^[0-9]{14}$"},"document_url":{"type":"string","format":"uri","pattern":"^https://dart\\.fss\\.or\\.kr/dsaf001/main\\.do\\?rcpNo=[0-9]{14}$"},"published":{"type":"string","format":"date"},"retrieved_at":{"type":"string","format":"date-time"}}},"KrFinancialPoint":{"type":"object","additionalProperties":false,"required":["field","value","unit","fiscal_year","period","duration","period_start","period_end","statement_scope","source"],"properties":{"field":{"type":"string","enum":["revenue","cost_of_revenue","gross_profit","sga","research_development","operating_income","interest_expense","pretax_income","income_tax","net_income","net_income_attributable","basic_eps","diluted_eps","total_interest_income","net_interest_income","operating_cash_flow","investing_cash_flow","financing_cash_flow","cash_and_equivalents","receivables","current_assets","intangibles","goodwill","total_assets","accounts_payable","current_liabilities","total_liabilities","retained_earnings","total_equity"]},"value":{"type":"string","pattern":"^-?(0|[1-9][0-9]{0,17})(\\.[0-9]+)?$"},"unit":{"type":"string","enum":["KRW","KRW/share"]},"fiscal_year":{"type":"integer","description":"Calendar year the fiscal year ends."},"period":{"type":"string","enum":["FY","Q1","Q2","Q3"]},"duration":{"type":"string","enum":["12M","9M","6M","3M","instant"]},"period_start":{"type":["string","null"],"format":"date"},"period_end":{"type":"string","format":"date"},"statement_scope":{"type":"string","enum":["consolidated","separate"]},"source":{"$ref":"#/components/schemas/KrSource"}}},"KrFinancials":{"type":"object","additionalProperties":false,"required":["company","attribution","points"],"properties":{"company":{"$ref":"#/components/schemas/KrCompanyIdentity"},"attribution":{"type":"string"},"points":{"type":"array","items":{"$ref":"#/components/schemas/KrFinancialPoint"}}}},"KrCompanyResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/KrCompany"},"meta":{"$ref":"#/components/schemas/Meta"}}},"KrFinancialsResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/KrFinancials"},"meta":{"$ref":"#/components/schemas/Meta"}}},"EuCompany":{"type":"object","additionalProperties":false,"required":["lei","name","country","kind","isins","isin_count","provider","fields","periods","attribution"],"properties":{"lei":{"type":"string","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"name":{"type":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"kind":{"type":"string","enum":["other","bank","insurer"]},"isins":{"type":"array","maxItems":100,"uniqueItems":true,"items":{"type":"string","pattern":"^[A-Z]{2}[A-Z0-9]{9}[0-9]$"},"description":"Listed only when isin_count is at most 100; otherwise empty."},"isin_count":{"type":"integer","minimum":0},"provider":{"type":"string","const":"filings_xbrl_org"},"fields":{"type":"array","items":{"type":"string","enum":["revenue","net_income_attributable","diluted_eps","operating_cash_flow","cash_and_equivalents","total_assets","total_equity"]}},"periods":{"type":"object","additionalProperties":false,"required":["earliest","latest"],"properties":{"earliest":{"type":["string","null"],"format":"date"},"latest":{"type":["string","null"],"format":"date"}}},"attribution":{"type":"array","uniqueItems":true,"items":{"type":"string","description":"The source credit required for this figure or filing."}}}},"EuSource":{"type":"object","required":["url","sha256","filing_id","filed_with"],"properties":{"url":{"type":"string","format":"uri","pattern":"^https://filings\\.xbrl\\.org/"},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$"},"filing_id":{"type":"string"},"filed_with":{"type":"string"},"concept":{"type":"string"},"fact_id":{"type":["string","null"]}},"additionalProperties":true},"EuFinancialPoint":{"type":"object","additionalProperties":false,"required":["fiscal_year","period_start","period_end","value","currency","unit","decimals","concept","attribution","source"],"properties":{"fiscal_year":{"type":"integer","minimum":2000,"maximum":2100},"period_start":{"type":"string","format":"date"},"period_end":{"type":"string","format":"date"},"value":{"type":"string","pattern":"^-?[0-9]+(\\.[0-9]+)?$","description":"Exact decimal text in the stated currency and unit."},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"unit":{"type":"string","pattern":"^[A-Z]{3}(/share)?$"},"decimals":{"type":["integer","null"]},"concept":{"type":"string"},"attribution":{"type":"string"},"source":{"$ref":"#/components/schemas/EuSource"}}},"EuFilingPoint":{"type":"object","additionalProperties":false,"required":["filing_id","fiscal_year","period_start","period_end","filed_with","published","report_url","viewer_url","facts_url","package_url","sha256","attribution"],"properties":{"filing_id":{"type":"string"},"fiscal_year":{"type":"integer","minimum":2000,"maximum":2100},"period_start":{"type":"string","format":"date"},"period_end":{"type":"string","format":"date"},"filed_with":{"type":"string"},"published":{"type":["string","null"]},"report_url":{"type":"string","format":"uri","pattern":"^https://filings\\.xbrl\\.org/"},"viewer_url":{"type":"string","format":"uri","pattern":"^https://filings\\.xbrl\\.org/"},"facts_url":{"type":"string","format":"uri","pattern":"^https://filings\\.xbrl\\.org/"},"package_url":{"type":"string","format":"uri","pattern":"^https://filings\\.xbrl\\.org/"},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$"},"attribution":{"type":"string"}}},"EuFinancials":{"type":"object","additionalProperties":false,"required":["company","field","scope","attribution","points"],"properties":{"company":{"type":"object","additionalProperties":false,"required":["lei","name","country"],"properties":{"lei":{"type":"string","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"name":{"type":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$"}}},"field":{"type":"string","enum":["revenue","net_income_attributable","diluted_eps","operating_cash_flow","cash_and_equivalents","total_assets","total_equity"]},"scope":{"type":"string","const":"consolidated"},"attribution":{"type":"array","uniqueItems":true,"items":{"type":"string","description":"The source credit required for this figure or filing."}},"points":{"type":"array","items":{"$ref":"#/components/schemas/EuFinancialPoint"}}}},"EuFilings":{"type":"object","additionalProperties":false,"required":["company","attribution","points"],"properties":{"company":{"type":"object","additionalProperties":false,"required":["lei","name","country"],"properties":{"lei":{"type":"string","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"name":{"type":"string"},"country":{"type":"string","pattern":"^[A-Z]{2}$"}}},"attribution":{"type":"array","uniqueItems":true,"items":{"type":"string","description":"The source credit required for this figure or filing."}},"points":{"type":"array","items":{"$ref":"#/components/schemas/EuFilingPoint"}}}},"EuCompanyResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/EuCompany"},"meta":{"$ref":"#/components/schemas/Meta"}}},"EuFinancialsResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/EuFinancials"},"meta":{"$ref":"#/components/schemas/Meta"}}},"EuFilingsResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/EuFilings"},"meta":{"$ref":"#/components/schemas/Meta"}}},"BrDownloadMeta":{"type":"object","additionalProperties":false,"required":["snapshot_id","as_of","next_cursor"],"properties":{"snapshot_id":{"type":"string"},"as_of":{"type":"string","format":"date-time"},"next_cursor":{"type":"null"}}},"BrDownloadFile":{"type":"object","additionalProperties":false,"required":["name","url","expires_at","bytes","sha256","rows"],"properties":{"name":{"type":"string","enum":["companies.jsonl.gz","facts.jsonl.gz"]},"url":{"type":"string","format":"uri"},"expires_at":{"type":"string","format":"date-time"},"bytes":{"type":"integer","minimum":1},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"rows":{"type":"integer","minimum":0}}},"BrDownload":{"type":"object","additionalProperties":false,"required":["data_notice","data","meta"],"properties":{"data_notice":{"type":"string"},"data":{"type":"object","additionalProperties":false,"required":["snapshot_id","as_of","files"],"properties":{"snapshot_id":{"type":"string"},"as_of":{"type":"string","format":"date-time"},"files":{"type":"array","minItems":2,"maxItems":2,"items":{"$ref":"#/components/schemas/BrDownloadFile"}}}},"meta":{"$ref":"#/components/schemas/BrDownloadMeta"}}},"BrCompanyIdentity":{"type":"object","additionalProperties":false,"required":["cnpj","cvm_code","name","trade_name","tickers","ticker","sector","market","register_status","statement_template","fiscal_year_end"],"properties":{"cnpj":{"type":"string","pattern":"^[0-9]{14}$"},"cvm_code":{"type":"string","pattern":"^[0-9]{1,6}$"},"name":{"type":"string","minLength":1,"maxLength":2000},"trade_name":{"type":["string","null"]},"tickers":{"type":"array","items":{"type":"string","pattern":"^[A-Z][A-Z0-9]{3}[0-9]{1,2}$"},"uniqueItems":true},"ticker":{"type":["string","null"],"pattern":"^[A-Z][A-Z0-9]{3}[0-9]{1,2}$"},"sector":{"type":["string","null"]},"market":{"type":["string","null"]},"register_status":{"type":["string","null"],"minLength":1,"maxLength":2000,"description":"Null when the company has no CVM register entry."},"statement_template":{"type":["string","null"],"enum":["commercial","bank","insurer",null]},"fiscal_year_end":{"type":["string","null"],"pattern":"^[0-9]{2}-[0-9]{2}$"}}},"BrSource":{"type":"object","additionalProperties":false,"required":["doc_id","document_url","category","version","reference_date","published","dataset_file","dataset_sha256","retrieved_at","derived_from"],"properties":{"doc_id":{"type":"string","pattern":"^[0-9]+$"},"document_url":{"type":"string","pattern":"^https://www\\.rad\\.cvm\\.gov\\.br/ENETCONSULTA/frmDownloadDocumento\\.aspx\\?","format":"uri"},"category":{"type":"string","enum":["DFP","ITR"]},"version":{"type":"integer","minimum":1},"reference_date":{"type":"string","format":"date"},"published":{"type":"string","format":"date"},"dataset_file":{"type":"string","pattern":"^(dfp|itr)_cia_aberta_[0-9]{4}\\.zip$"},"dataset_sha256":{"type":"string","pattern":"^[0-9a-fA-F]{64}$"},"retrieved_at":{"type":"string","format":"date-time"},"derived_from":{"type":["array","null"],"items":{"type":"string","pattern":"^[0-9]+$"},"minItems":2,"maxItems":2}}},"BrFinancialPoint":{"type":"object","additionalProperties":false,"required":["cnpj","field","fiscal_year","period","period_start","period_end","duration","value","unit","derivation","audit_status","statement_scope","source","reader_version"],"properties":{"cnpj":{"type":"string","pattern":"^[0-9]{14}$"},"field":{"type":"string","enum":["revenue","cost_of_revenue","gross_profit","operating_income","pretax_income","income_tax","net_income","net_income_attributable","basic_eps","diluted_eps","financial_intermediation_income","financial_intermediation_result","insurance_activities_income","operating_cash_flow","investing_cash_flow","financing_cash_flow","cash_and_equivalents","current_assets","receivables","inventory","ppe_net","intangibles","goodwill","total_assets","current_liabilities","accounts_payable","short_term_debt","total_equity"]},"fiscal_year":{"type":"integer","minimum":1990,"maximum":2100},"period":{"type":"string","enum":["FY","Q1","Q2","Q3"]},"period_start":{"type":["string","null"],"format":"date"},"period_end":{"type":"string","format":"date"},"duration":{"type":"string","enum":["12M","3M","instant"]},"value":{"type":"string","pattern":"^-?(0|[1-9][0-9]{0,17})(\\.[0-9]+)?$"},"unit":{"type":"string","enum":["BRL","BRL/share"]},"derivation":{"type":["string","null"],"enum":[null,"ytd_difference","equals_consolidated"]},"audit_status":{"type":"string","enum":["audited","reviewed"]},"statement_scope":{"type":"string","enum":["consolidated","individual"]},"source":{"$ref":"#/components/schemas/BrSource"},"reader_version":{"type":"string","pattern":"^br-cvm-reader@[0-9]+\\.[0-9]+$"}}},"BrFinancials":{"type":"object","additionalProperties":false,"required":["company","points"],"properties":{"company":{"$ref":"#/components/schemas/BrCompanyIdentity"},"points":{"type":"array","items":{"$ref":"#/components/schemas/BrFinancialPoint"}}}},"BrCompanyResponse":{"type":"object","additionalProperties":false,"required":["data","data_notice","meta"],"properties":{"data":{"$ref":"#/components/schemas/BrCompanyIdentity"},"data_notice":{"type":"string","const":"Contains information from CVM (Comissão de Valores Mobiliários), Dados Abertos, Cias Abertas (DFP, ITR, cadastro, FCA), accessed through the CVM Open Data Portal https://dados.cvm.gov.br/ and made available under the Open Database License (ODbL) 1.0 https://opendatacommons.org/licenses/odbl/1-0/. Belfort Research selected accounts, converted units and derived some quarterly cash flows; this modified Brazil database is available under the same licence at https://api.belfortagent.xyz/v1/br/download. Not endorsed by CVM."},"meta":{"$ref":"#/components/schemas/Meta"}}},"BrFinancialsResponse":{"type":"object","additionalProperties":false,"required":["data","data_notice","meta"],"properties":{"data":{"$ref":"#/components/schemas/BrFinancials"},"data_notice":{"type":"string","const":"Contains information from CVM (Comissão de Valores Mobiliários), Dados Abertos, Cias Abertas (DFP, ITR, cadastro, FCA), accessed through the CVM Open Data Portal https://dados.cvm.gov.br/ and made available under the Open Database License (ODbL) 1.0 https://opendatacommons.org/licenses/odbl/1-0/. Belfort Research selected accounts, converted units and derived some quarterly cash flows; this modified Brazil database is available under the same licence at https://api.belfortagent.xyz/v1/br/download. Not endorsed by CVM."},"meta":{"$ref":"#/components/schemas/Meta"}}},"Status":{"type":"object","additionalProperties":false,"required":["metrics","statements","ownership","macro","insider","form13f","filings","normalized","segments","holders","earnings","th_financials","tw_financials","jp_financials","eu_financials","kr_financials","br_financials","load_in_progress"],"properties":{"metrics":{"oneOf":[{"$ref":"#/components/schemas/MetricsDataAge"},{"type":"null"}]},"statements":{"oneOf":[{"$ref":"#/components/schemas/DataAge"},{"type":"null"}]},"ownership":{"oneOf":[{"$ref":"#/components/schemas/DataAge"},{"type":"null"}]},"macro":{"oneOf":[{"$ref":"#/components/schemas/DataAge"},{"type":"null"}]},"insider":{"oneOf":[{"$ref":"#/components/schemas/DataAge"},{"type":"null"}]},"form13f":{"oneOf":[{"$ref":"#/components/schemas/DataAge"},{"type":"null"}]},"filings":{"oneOf":[{"$ref":"#/components/schemas/DataAge"},{"type":"null"}]},"normalized":{"oneOf":[{"$ref":"#/components/schemas/DataAge"},{"type":"null"}]},"segments":{"oneOf":[{"$ref":"#/components/schemas/DataAge"},{"type":"null"}]},"holders":{"oneOf":[{"$ref":"#/components/schemas/DataAge"},{"type":"null"}]},"earnings":{"oneOf":[{"$ref":"#/components/schemas/DataAge"},{"type":"null"}]},"th_financials":{"description":"Thai company figures read from each company's own investor-relations site. Loaded by hand, so it ages by quarter.","oneOf":[{"$ref":"#/components/schemas/DataAge"},{"type":"null"}]},"tw_financials":{"description":"Taiwan company figures from Taiwan's own open data, kept from our daily archive of the source.","oneOf":[{"$ref":"#/components/schemas/DataAge"},{"type":"null"}]},"jp_financials":{"description":"Japan consolidated EDINET figures. Null until the first Japan load.","oneOf":[{"$ref":"#/components/schemas/DataAge"},{"type":"null"}]},"eu_financials":{"description":"Annual consolidated ESEF figures. Null until the first hand load.","oneOf":[{"$ref":"#/components/schemas/DataAge"},{"type":"null"}]},"kr_financials":{"description":"Korean FSS DART figures. Null until the first Korea load.","oneOf":[{"$ref":"#/components/schemas/DataAge"},{"type":"null"}]},"br_financials":{"description":"Brazil CVM figures. Null until the first Brazil load.","oneOf":[{"$ref":"#/components/schemas/DataAge"},{"type":"null"}]},"load_in_progress":{"description":"True while a data load is publishing new data, so figures may change within minutes. Null when the API could not check.","type":["boolean","null"]}}},"EarningsReleaseListItem":{"type":"object","additionalProperties":false,"required":["accession","filed","period","title","title_source","exhibit_type","exhibit_description","items","exhibit_url","filing_url"],"properties":{"accession":{"type":"string","pattern":"^\\d{10}-\\d{2}-\\d{6}$"},"filed":{"oneOf":[{"type":"string","format":"date"},{"type":"null"}]},"period":{"oneOf":[{"type":"string","format":"date"},{"type":"null"}]},"title":{"oneOf":[{"type":"string"},{"type":"null"}]},"title_source":{"oneOf":[{"type":"string"},{"type":"null"}]},"exhibit_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"exhibit_description":{"oneOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"string"}},"exhibit_url":{"type":"string","format":"uri"},"filing_url":{"type":"string","format":"uri"}}},"EarningsRelease":{"type":"object","additionalProperties":false,"required":["accession","filed","period","title","title_source","exhibit_type","exhibit_description","items","exhibit_url","filing_url","text"],"properties":{"accession":{"type":"string","pattern":"^\\d{10}-\\d{2}-\\d{6}$"},"filed":{"oneOf":[{"type":"string","format":"date"},{"type":"null"}]},"period":{"oneOf":[{"type":"string","format":"date"},{"type":"null"}]},"title":{"oneOf":[{"type":"string"},{"type":"null"}]},"title_source":{"oneOf":[{"type":"string"},{"type":"null"}]},"exhibit_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"exhibit_description":{"oneOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"string"}},"exhibit_url":{"type":"string","format":"uri"},"filing_url":{"type":"string","format":"uri"},"text":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"EarningsReleasePageResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EarningsReleaseListItem"}},"meta":{"$ref":"#/components/schemas/Meta"}}},"EarningsReleaseResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/EarningsRelease"},"meta":{"$ref":"#/components/schemas/Meta"}}},"FinancialsResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NormalizedFact"}},"meta":{"$ref":"#/components/schemas/Meta"}}},"DocumentPageResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"type":"array","items":{"type":"object"}},"meta":{"$ref":"#/components/schemas/Meta"}}},"HoldersMeta":{"type":"object","additionalProperties":false,"required":["snapshot_id","as_of","next_cursor","position"],"properties":{"position":{"type":["string","null"],"pattern":"^[0-9]+$","description":"Data is at least as new as this global change-log position. Null before the first batch, before the change schema is applied, or when the position read fails."},"snapshot_id":{"type":["string","null"]},"as_of":{"type":["string","null"],"format":"date-time"},"next_cursor":{"type":["string","null"],"description":"Pass as `cursor` for the next page. Null on the last page."},"view":{"type":"string","enum":["managers","positions"],"description":"Which shape `data` holds."},"sort":{"type":"string","enum":["shares","value"],"description":"The ranking used. Only with view=managers."},"period_end":{"type":"string","format":"date","description":"The report period served."},"newest_period":{"oneOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The newest report period on file for this company."},"source_window_end":{"oneOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The last filing date in the loaded Form 13F data. SEC publishes the data sets as three-month filing windows, so a period at or after this date has no rows yet."},"managers_total":{"type":"integer","description":"Managers in the period. Only with view=managers."},"checks":{"type":"string","enum":["run","not_run"],"description":"run: values were checked against the period's prices. not_run: no price evidence was built for this period, so every value is as filed (value_check unchecked)."},"note":{"type":"string","description":"Present when the answer is not what was asked for, for example when manager totals are not built in this snapshot."},"empty_reason":{"type":"object","additionalProperties":false,"required":["code","message","newest_period","source_window_end"],"description":"Present on an empty list.","properties":{"code":{"type":"string","enum":["no_holders_linked","period_not_yet_published","no_rows_for_period"]},"message":{"type":"string"},"newest_period":{"oneOf":[{"type":"string","format":"date"},{"type":"null"}]},"source_window_end":{"oneOf":[{"type":"string","format":"date"},{"type":"null"}]}}}}},"HolderFiling":{"type":"object","required":["accession","form","filed","filing_url"],"properties":{"accession":{"type":"string"},"form":{"type":"string","description":"13F-HR or 13F-HR/A."},"filed":{"type":"string","format":"date"},"amendment_type":{"type":"string","description":"RESTATEMENT or NEW HOLDINGS, as declared on the filing."},"filing_url":{"type":"string","format":"uri","description":"The filing's page on sec.gov."}}},"HolderAdjustment":{"type":"object","required":["kind","accession","positions","filed_value_usd"],"properties":{"kind":{"type":"string","enum":["value_scaled_from_thousands","value_scaled_from_x1000","shares_value_swapped"]},"accession":{"type":"string"},"positions":{"type":"integer","description":"Rows corrected."},"filed_value_usd":{"type":"number","description":"What those rows' values summed to as filed, before the correction."}}},"HolderOptionTotals":{"type":"object","required":["shares","value_usd","positions"],"properties":{"shares":{"type":["number","null"],"description":"The amount after the same checks as share rows (a table filed with its columns swapped is corrected, or left out and null when it cannot be). Filers disagree on whether an option row counts contracts or underlying shares, so it is never added to shares."},"value_usd":{"oneOf":[{"type":"number"},{"type":"null"}]},"positions":{"type":"integer"}}},"HolderManager":{"type":"object","required":["manager_cik","manager_name","issuer_cik","period_end","shares","value_usd","positions","value_status","filings","flags"],"properties":{"manager_cik":{"type":"string"},"manager_name":{"oneOf":[{"type":"string"},{"type":"null"}]},"issuer_cik":{"type":"string"},"period_end":{"type":"string","format":"date"},"shares":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Shares summed over this manager's counted share rows (not options, not principal). Null when none is usable. Never added to another manager's."},"value_usd":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Sum of the checked values of those rows. Null when every value is withheld."},"positions":{"type":"integer","description":"Share rows behind the totals."},"value_status":{"type":"string","enum":["ok","unchecked","adjusted","partial","withheld"],"description":"ok: as filed, consistent with the period's price where there was evidence. unchecked: no price evidence for any of its rows, so as filed and not verified. adjusted: some rows corrected on the filing's own evidence (see adjustments). partial: some rows' values left out of value_usd. withheld: all of them."},"options":{"type":"object","description":"Call and put positions on the issuer, kept apart from shares.","properties":{"call":{"$ref":"#/components/schemas/HolderOptionTotals"},"put":{"$ref":"#/components/schemas/HolderOptionTotals"}}},"principal":{"type":"object","description":"Convertible-note principal, in dollars, never mixed into shares.","required":["amount","positions"],"properties":{"amount":{"type":["number","null"],"description":"Null when none of the amounts could be settled."},"positions":{"type":"integer"}}},"filings":{"type":"array","description":"The filings the totals rest on, newest first.","items":{"$ref":"#/components/schemas/HolderFiling"}},"flags":{"type":"array","description":"amended: more than one filing, or an amendment, is involved. amendment_partial: a RESTATEMENT re-filed less than 90% of the report, so lines it does not state were kept. amendment_ambiguous: a line was replaced by an amendment that may have added to it instead (declared NEW HOLDINGS, or a disclosure after confidential treatment, and not a re-file of the report); the filings cannot settle which, so check `filings`. value_adjusted / value_withheld: see value_status. shares_withheld: a row's shares were left out because its columns look swapped. shares_unverified: a row's value contradicts its shares and nothing says which is wrong, so its shares are as filed. duplicate_table: another filer carries an identical table.","items":{"type":"string","enum":["amended","amendment_partial","amendment_ambiguous","value_adjusted","value_withheld","shares_withheld","shares_unverified","duplicate_table"]}},"duplicate_table_with":{"type":"array","description":"Manager CIKs whose filing holds an identical table. Both are shown. Related filers can legitimately share a table, and the data cannot say whether either is wrong.","items":{"type":"string"}},"classes":{"type":"array","description":"Present when the manager's shares span more than one security linked to the company, such as share classes. `shares` adds them all; this says how it splits.","items":{"type":"object","required":["cusip","shares","positions"],"properties":{"cusip":{"type":"string"},"shares":{"type":"number"},"positions":{"type":"integer"}}}},"adjustments":{"type":"array","items":{"$ref":"#/components/schemas/HolderAdjustment"}}}},"HolderPosition":{"type":"object","required":["manager_cik","accession","info_sk","issuer_cik","period_end","filing_url"],"properties":{"manager_cik":{"type":"string"},"manager_name":{"oneOf":[{"type":"string"},{"type":"null"}]},"accession":{"type":"string"},"info_sk":{"type":"string"},"filed":{"type":"string","format":"date"},"is_amendment":{"type":"boolean"},"form":{"type":"string"},"amendment_no":{"type":"integer"},"amendment_type":{"type":"string"},"cusip":{"type":"string"},"map_method":{"type":"string"},"issuer_cik":{"type":"string"},"period_end":{"type":"string","format":"date"},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"The value column as filed."},"value_unit":{"type":"string","enum":["usd","thousands_usd"]},"value_usd":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"As filed, with filings before 2023-01-03 converted from thousands. Never rewritten by the rules; see value_usd_checked."},"shares_or_principal":{"oneOf":[{"type":"number"},{"type":"null"}]},"shares_type":{"type":"string","description":"SH for shares","PRN for principal amount.":null},"put_call":{"oneOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["counted","superseded"],"description":"superseded rows were replaced by a later filing of the same manager and stay visible."},"superseded_by":{"type":"string","description":"The accession that replaced this row."},"value_check":{"type":"string","enum":["ok","unchecked","scaled","swapped","suspect","inconsistent"],"description":"ok: matches the period's price. unchecked: no price evidence. scaled / swapped: corrected on the filing's own evidence. suspect / inconsistent: left out of totals. A row that fits both a unit error and swapped columns (a stock near $31.6) is suspect with its shares left out too."},"value_usd_checked":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Present only when value_check is scaled, swapped, suspect or inconsistent. Null when withheld. Absent means as filed."},"shares_checked":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Present only when the shares were corrected or withheld."},"adjustments":{"type":"array","items":{"type":"object","required":["kind","value"],"properties":{"kind":{"type":"string"},"value":{"type":["number","null"],"description":"The figure as filed."},"shares":{"type":["number","null"]}}}},"filing_url":{"type":"string","format":"uri","description":"The filing's page on sec.gov."}}},"HoldersResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/HolderManager"},{"$ref":"#/components/schemas/HolderPosition"}]}},"meta":{"$ref":"#/components/schemas/HoldersMeta"}}},"StatusResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/Status"},"meta":{"$ref":"#/components/schemas/Meta"}}},"CompanyResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/Company"},"meta":{"$ref":"#/components/schemas/Meta"}}},"MetricsResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MetricPoint"}},"meta":{"$ref":"#/components/schemas/MetricsMeta"}}},"StatementsResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/StatementDocument"}},"meta":{"$ref":"#/components/schemas/Meta"}}},"OwnershipResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OwnershipRecord"}},"meta":{"$ref":"#/components/schemas/Meta"}}},"MacroResponse":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/MacroDocument"},"meta":{"$ref":"#/components/schemas/Meta"}}}}}}