Method | Endpoint | Request parameter | Description |
---|---|---|---|
GET | /api/v1/symbol/stock | (optional) includeNames [Boolean] | Returns a list of all available stock symbols |
GET | /api/v1/symbol/forex | - | Returns a list of all available stock forex exchange currencies |
GET | /api/v1/symbol/crypto | (optional) includeNames [Boolean] | Returns a list of all available crypto currencies |
Method | Endpoint | Request parameter | Example | Description |
---|---|---|---|---|
GET | /api/v1/profile | symbols [String] | /api/v1/profile?symbol=MSFT | Provides company data such as industry, sector etc. |
GET | /api/v1/sharesfloat | symbol [String] | /api/v1/sharesfloat?symbol=AAPL | Provides the amount of shares float |
GET | /api/v1/executives | symbol [String] | /api/v1/executives?symbol=TSLA | Provides the current composition of executives |
GET | /api/v1/holder | symbol [String] | /api/v1/holder?symbol=NFLX | Provides the current composition of holders |
GET | /api/v1/ownership | symbol [String], includeCurrentQuarter [Boolean] | /api/v1/ownership?symbol=PG&includeCurrentQuarter=true | Provides the current composition of stock owners |
Method | Endpoint | Request parameter | Example | Description |
---|---|---|---|---|
GET | /api/v1/realtime/stock | symbol [String [30] ] | /api/v1/realtime/stock?symbols=PLTR,MSFT | Returns a list of realtime quotes (max. 30 symbols per request) |
GET | /api/v1/realtime/forex | source [String], target [String] | /api/v1/realtime/forex?source=EUR&target=USD | Returns a list of realtime forex prices |
GET | /api/v1/realtime/crypto | source [String], target [String] | /api/v1/realtime/crypto?source=BTC&target=USD | Returns a list of realtime crypto prices |
Method | Endpoint | Request parameter | Example | Description |
---|---|---|---|---|
GET | /api/v1/historical/stock | interval [String], symbol [String] | /api/v1/historical/stock?symbols=PLTR,MSFT | Returns a list of historical quotes |
GET | /api/v1/historical/forex | interval [String], symbol [String] | /api/v1/historical/forex?source=EUR&target=USD | Returns a list of historical forex prices |
GET | /api/v1/historical/crypto | interval [String], symbol [String] | /api/v1/historical/crypto?source=BTC&target=USD | Returns a list of historical crypto prices |
Method | Endpoint | Request parameter | Example | Description |
---|---|---|---|---|
GET | /api/v1/balancesheets | period [String], symbol [String] | /api/v1/balancesheets?period=quarter&symbol=MSFT | Provides balance sheet statements of a specific stock company |
GET | /api/v1/cashflow | period [String], symbol [String] | /api/v1/cashflow?period=quarter&symbol=MSFT | Provides cash flow statements of a specific stock company |
GET | /api/v1/income | period [String], symbol [String] | /api/v1/income?period=quarter&symbol=MSFT | Provides income statements of a specific stock company |
Method | Endpoint | Request parameter | Example | Description |
---|---|---|---|---|
GET | /api/v1/ratios | period [String], symbol [String] | /api/v1/ratios?period=quarter&symbol=MSFT | Provides ratios of a specific stock company |
GET | /api/v1/keymetrics | period [String], symbol [String] | /api/v1/keymetrics?period=quarter&symbol=MSFT | Provides key metrics of a specific stock company |
GET | /api/v1/scores | symbol [String] | /api/v1/scores?symbol=MSFT | Provides scores of a specific stock company such as piotroski or altmanZScore |
Method | Endpoint | Request parameter | Example | Description |
---|---|---|---|---|
GET | /api/v1/grade | symbol [String] | /api/v1/grade?symbol=AAPL | Provides grade of a specific stock company |
GET | /api/v1/eps | symbol [String] | /api/v1/eps?symbol=AAPL | Provides actual and estimated earnings of a specific stock company |
GET | /api/v1/estimates | period [String], symbol [String] | /api/v1/estimates?period=quarter&symbol=AAPL | Provides estimates of a specific stock company |