Skip to main content
GET
Get financial health

Authorizations

X-API-Key
string
header
required

Path Parameters

symbol
string
required

Stock ticker. A US listing is the bare symbol (AAPL, NVDA).

A non-US listing takes a Google-Finance-style exchange prefix: PAR:AI (Euronext Paris), LON:AZN (London), TYO:7203 (Tokyo), FRA:AIXA (Frankfurt), AMS:BESI (Amsterdam), MIL:TPRO (Milan), CPH:VWS (Copenhagen), KRX:005930 (Korea), NSE:RELIANCE (India), HKG:0669 (Hong Kong), IST:THYAO (Istanbul). The prefix names the listing venue, whatever the company's domicile: a Cayman-registered company listed in Hong Kong is HKG:2020. Common alternative spellings of a venue resolve too (EPA:AI, HKEX:0669, LSE:AZN, NZX:FPH, BME:AMS, NASDAQ:AAPL), and a Hong Kong code answers to any zero-padding (HKG:992, HKG:0992). A Yahoo-style vendor suffix (AI.PA) is not an identifier here and resolves to nothing; the error names the prefixed form to use instead.

Every instrument and search response carries instrument_id, the exact string to send here.

A dotted share class is written with a dash or a dot (BRK-B, BRK.B); both resolve.

Required string length: 1 - 20
Example:

"PAR:AI"

Response

Health analysis

data
object
meta
object