API Documentation
The API provides two features:
- Ticker list: This returns a list of all companies for which there are models.
- Model data: This returns the data points in the model for a particular company along with the associated metadata.
Accessing the API Key
The API key can be accessed by clicking on API Settings in the top right corner of the Daloopa Marketplace or by clicking on this link - https://marketplace.daloopa.com/?popup=api-settings.
If the API keys do not appear, please contact your salesperson to setup API access.
1. Ticker List
The following Python code snippet pulls a list of all companies for which there is a model. The result is json file that is converted into a dataframe.
import requests
import pandas as pd
from requests.auth import HTTPBasicAuth
endpoint = 'https://origin.daloopa.com'
response = requests.get(
f'{endpoint}/api/v1/get_companies',
auth=HTTPBasicAuth(
'*******@*****.com',
'************'
),
stream=True
)
df = pd.read_json(response.raw)
Sample Output (Ticker List)
Data Schema (Ticker List)
Item | Description |
---|---|
name | Name of company |
ticker | Daloopa's ticker for the company |
industry | Industry of company (e.g. Communication Services) |
sector | Sector of company (e.g. Media) |
companyidentifier_set | Dictionary of other identifiers for the company, for example CIK, ISIN, CapIQ ticker etc. |
2. Model Data
The following Python code snippet pulls the model data for a given TICKER, loads it into a Pandas dataframe and prints the keys.
import requests
import pandas as pd
from requests.auth import HTTPBasicAuth
endpoint = 'https://www.daloopa.com'
response = requests.get(
f'{endpoint}/api/v1/export/{TICKER},
auth=HTTPBasicAuth(
'******@******.com'
'***********'
),
stream=True
)
df = pd.read_csv(response.raw)
print(df.keys())
Sample Output (Model Data)
Data Schema (Model Data)
Item | Description |
---|---|
calendar_period | Calendar period of datapoint in format of 2021Q2 or FY2020 |
category | Section under which the datapoint is grouped in model (e.g., Income Statement, Guidance) |
company_name | Name of company |
filing_date | Date of filing from which datapoint is sourced |
filing_type | Type of filing from which datapoint is sourced (e.g., 8-K, 10-Q) |
fiscal_period | Fiscal period of datapoint in format of 2021Q2 or FY2020 |
id | ID of datapoint in Daloopa database |
label | Description of datapoint |
restated | True or False |
series_id | ID of associated series in Daloopa database |
series_id_relations | Relation to series ID (currently not used) |
series_tag | Series tag in Daloopa database (currently not used) |
source_link | Link to datapoint in source document |
span | Quarterly or annual |
ticker | Associated ticker |
unit | Unit of datapoint (billion, million, dollar, percent) |
value_normalized | Normalized value (e.g. converts annual to quarterly) |
value_raw | Raw value |
Updated over 2 years ago