API Documentation

📘

The API provides two features:

  1. Ticker list: This returns a list of all companies for which there are models.
  2. 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.

1236

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)

1060

Data Schema (Ticker List)

ItemDescription
nameName of company
tickerDaloopa's ticker for the company
industryIndustry of company (e.g. Communication Services)
sectorSector of company (e.g. Media)
companyidentifier_setDictionary 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)

1814

Data Schema (Model Data)

ItemDescription
calendar_periodCalendar period of datapoint in format of 2021Q2 or FY2020
categorySection under which the datapoint is grouped in model (e.g., Income Statement, Guidance)
company_nameName of company
filing_dateDate of filing from which datapoint is sourced
filing_typeType of filing from which datapoint is sourced (e.g., 8-K, 10-Q)
fiscal_periodFiscal period of datapoint in format of 2021Q2 or FY2020
idID of datapoint in Daloopa database
labelDescription of datapoint
restatedTrue or False
series_idID of associated series in Daloopa database
series_id_relationsRelation to series ID (currently not used)
series_tagSeries tag in Daloopa database (currently not used)
source_linkLink to datapoint in source document
spanQuarterly or annual
tickerAssociated ticker
unitUnit of datapoint (billion, million, dollar, percent)
value_normalizedNormalized value (e.g. converts annual to quarterly)
value_rawRaw value