One block of a listed company's financial data, paid per call
Changed onOne block of a listed company's financial data, such as its reported figures or its valuation, paid per request with no API key.
One block of the company's briefing, as of today, from its public form, with the company's name, address, market and the time the briefing was computed. Nothing of the header block comes with another block: the header is a block of its own. The whole briefing is GET /api/companies/{company}.
A block name outside the list the block parameter takes is refused with a 404 before any price is quoted. A block left out for this company answers 404 BLOCK_NOT_COVERED_YET, and nothing is charged.
The numbers block alone takes a date (YYYY-MM-DD): its figures as known at the end of that day in the company's market, each with knownBasis (filed, reported or deadline) and knownSince (for deadline, the date our deadline rule assumes). A period the store cannot date is named and left out. Where the dated read is not available the route answers 503 DATED_READ_UNAVAILABLE, and nothing is charged.
Refused before any price is quoted, so no payment is taken: a date on any other block, or a time (400: the figures carry their own filing dates and the ratios keep no earlier version, so those blocks are sold as of today), a malformed address (400), and an address that names no company sold here (404 NOT_FOUND) or one whose statements have not been read (404 NOT_COVERED_YET). A key holder is never charged on this route: the key's plan decides, as on /api/context.
Request
- Base URLhttps://api.prereason.com
- AuthHTTP bearer
Path parameters
The company. For a company filing with the SEC, its ticker or CIK; for a Japanese company, its securities code; for a Korean company, its stock code; for an Indian company, its ISIN; the LEI of a company filing in the UK or of a European company (2138002P5RNKC5W2JZ46); for a Brazilian company, its B3 ticker or CNPJ (PETR4); and for a company listed in Hong Kong, its stock code written as HK and its five digits (HK00001). Case does not matter.
The block of the company briefing to return.
Query parameters
The numbers block only. A past date (YYYY-MM-DD) whose figures to serve as known at the end of that day in the company's market. Refused on every other block. For a period's latest figures, including a later amendment's, leave date out.
Response format (json or markdown). Default is markdown.
Response
The block, Markdown by default, JSON with format=json
Changes
- info
added the new optional
queryrequest parameterdate
- info
- info
endpoint added
- info