Response fields for get_companies_by_location, get_companies_by_simple_industry, get_companies_by_industry_code, get_companies_by_gics_code

company_id

alternate_name

historical_name

Response fields for get_competitors_by_company

Serializer for individual earnings entries.

Response fields for get_financial_statement

Response fields for ticker_to_identification_triple

Serializer for a single market cap.

Note: The market cap response includes TEV and shares outstanding.

buyer_company_mergers

seller_company_mergers

target_company_mergers

Response fields for get_primary_trading_item

security_id

Response fields for get_tickers_by_simple_industry

Response fields for get_trading_item_by_exchange_code, get_trading_items

trading_item_id

Serializer for individual transcript entries.

sessionid

LLM-ready API

Get the list of companies based in a location with filters iso_code and state.

Parameters:
    iso_code (string, required): The ISO 3166-1 alpha-2 or alpha-3 code representing the country. This should be a two or three letter code conforming to the ISO 3166-1 standard. Example: "US" or "USA" for the United States, "FR" or "FRA" for France, "IN" or "IND" for India.
    state (string, optional): The ISO 3166-2 subdivision code representing a state, province, or region within the specified country. This code identifies the subdivision without repeating the country code. Example: "CA" for California, "MH" for Maharashtra.

iso_code

state

Indicates that the authorization information is missing or invalid.

Get the list of companies that are classified in the gics_code.

Returns a dictionary of shape {"companies": List[<company_id>]}.
The gics_code can be either a 2-digit Sector code, 4-digit Industry Group code, 6-digit Industry code, or 8-digit Sub-industry code.

gics_code

Get the list of companies that are in the given simple_industry

simple_industry

Get the list of companies that are in the given industry_classification and industry_code

industry_classification

industry_code

Get the list of company_id and company_name that are competitors of company_id, optionally filtered by the competitor_source type.

Parameters:
    company_id (int): The requested company_id
    competitor_source (CompetitorSourceType): The source type of the competitor information: 'filing' (from SEC filings), 'key_dev' (from key developments), 'contact' (from contact relationships), 'third_party' (from third-party sources), 'self_identified' (self-identified), 'named_by_competitor' (from competitor's perspective)."
Returns a dictionary of shape {"competitors": List[{“company_id”: <company_id>, "company_name": <company_name>}]},

competitor_source

Get metadata (name, key dev id, and datetime) for earnings calls for a given company_id.

The response comprises metadata for all upcoming and past earnings calls in
descending order by datetime. The key dev id can be used with the transcript
endpoints to retrieve the earnings call transcript.

Indicates that request parameters are invalid.

Get the earnings calls in datetime for a given company_id in UTC

Get the most likely trading_item_id, security_id, and company_id with a given CUSIP.

cusip

Get the most likely trading_item_id, security_id, and company_id with a given ISIN.

isin

Get the most likely trading_item_id, security_id, and company_id with a given ticker symbol.

ticker

exchange_code

Get the general information of a given company_id, such as name, status, company type, simple industry, number of employees, founding date, webpage, and address.

Get the company's summary (short description) and description (long description)

Indicates that the authorization is missing or invalid.

Get the company's other names: alternate_names (names that a company also goes by), historical_names (names that the company used to go by), and native_names (company names in native language)

Get the latest annual reporting year, latest quarterly reporting quarter and year, and current date in UTC. The output is a dictionary with the following schema::

{
    "annual": {
        "latest_year": int
    },
    "quarterly": {
        "latest_quarter": int,
        "latest_year": int
    },
    "now": {
        "current_year": int,
        "current_quarter": int,
        "current_month": int,
        "current_date": str # in format Y-m-d
    }
}

Get a financial line item for a given company_id

end_quarter

end_year

line_item

period_type

start_quarter

start_year

Get the market caps between start and end date inclusive.

The returned data includes market_cap, tev (Total Enterprise Value), shares_outstanding, and its currency.

end_date

start_date

Get information about the specified merger/acquisition transaction.

Parameters:
    transaction_id: The ID of the specified transaction.

Returns:
    dict: A nested dictionary that contains:
    - An ordered array of the status changes of the transaction.
    - A dict with three keys:
        - target: The company that was merged with or acquired.
        - buyers: A list of companies that bought or merged with the target company.
        - sellers: A list of companies that sold or traded the target company.
    - Optionally the primary consideration (which is the one that happened or was most recently proposed), where the consideration contains:
        - The currency of the consideration.
        - The current gross total value of the consideration.
        - The current implied equity value of the consideration.
        - The current implied enterprise value of the consideration.
        - A list of the consideration's details (sub-components of the consideration), where each consideration detail contains:
            - The detail scenario.
            - The detail subtype.
            - The cash or ash equivalent offered per share.
            - The number of shares in the target company.
            - The current gross total of the consideration detail.

transaction_id

Get the advisor companies and their roles for the specified company in the specified merger/acquisition transaction.

advised_company_id

Get the merger/acquisition transactions for the specified company.

Get the candlestick price chart as a PNG image for a given trading item between start_date and end_date inclusive.

adjusted

periodicity

Returns a PNG image and indicates a successful request.

Indicates that the information was not found.

Get the historical metadata of the trading item id, such as currency, symbol, exchange_name, instrument_type, and first_trade_date.

Get stock prices for a given trading_item_id and its associated currency between start_date and end_date inclusive, with latest available data being from the previous day, and the most recent price will always be the closing price from the day before. The returned prices include the open, close, high, low prices and volume.

Get the list of current and previous companies that are relationship_type OF company_id.

Returns a dictionary of shape:
{
    "current": List[{"company_id": <company_id>, "company_name": <company_name>}],
    "previous": List[{"company_id": <company_id>, "company_name": <company_name>}]
}.

Examples: get_companies_by_business_relationship(company_id: 1234, relationship_type: landlord) returns company 1234's landlords,
and get_companies_by_business_relationship(company_id: 1234, relationship_type: tenant) returns company 1234's tenants.
get_companies_by_business_relationship(company_id: 1234, relationship_type: supplier) returns company 1234's suppliers,
and get_companies_by_business_relationship(company_id: 1234, relationship_type: distributor) returns company 1234's distributors.

relationship_type

Get the list of current and previous ticker identification triples that are relationship_type OF company_id.

Returns a dictionary of shape {“current”: List[{“company_id”: <company_id>, “security_id”: <security_id>, “trading_item_id”: <trading_item_id>}], “previous”: List[{“company_id”: <company_id>, “security_id”: <security_id>, “trading_item_id”: <trading_item_id>}]}.

Examples: get_tickers_by_business_relationship(company_id: 1234, relationship_type: landlord) returns company 1234's landlords,
and get_tickers_by_business_relationship(company_id: 1234, relationship_type: tenant) returns company 1234's tenants.
get_tickers_by_business_relationship(company_id: 1234, relationship_type: supplier) returns company 1234's suppliers,
and get_tickers_by_business_relationship(company_id: 1234, relationship_type: distributor) returns company 1234's distributors.

Get the list of securities for a given company_id. Returns a dictionary of shape {"securities": List[<security_id>]}

Get the primary security for a given company_id. Returns a dictionary of shape {"primary_security": <security_id>}

Get the templated segments of a given company_id for a given start_year, start_quarter, end_year and end_quarter.

Segments can be filtered on the segment_type for 'business' for Line of Business Segments or 'geographic' for Geographic Segments.

Parameters:
company_id (int, required): The company_id requested
segment_type (SegmentType): The segment type to filter on, either “business” or “geographic”. Defaults to “business”.
period_type (PeriodType): The period_type requested for. Can be “annual”, “quarterly”, "ytd". Defaults to “annual” when start_quarter and end_quarter are None.
start_year (int): The starting calendar year
start_quarter (int): The starting calendar quarter
end_year (int): The ending calendar year
end_quarter (int): The ending calendar quarter

Returns:
    dict: A nested dictionary where:
    - The first-level keys are strings representing the time period of either calendar years or quarters (e.g., '2024' for a year, or '2024Q1', '2024Q2' for quarters).
    - The second-level keys are the segment names, either line of business segment names specific to a company's organization or geographic segment (e.g., 'Asia', 'United States', 'Rest of World').
    - Each segment contains the value of the line item (e.g., 'Revenue', 'Operating Income')

    An example response:
    {
        "segments": {
            "2024Q1": {
                "Commodity Insights": {
                    "Operating Income": 263000000.0,
                    "Revenue": 559000000.0
                },
                "Corporate": {
                    "Operating Income": -35000000.0
                },
            },
            "2024Q2": {
                "Commodity Insights": {
                    "Operating Income": 245000000.0,
                    "Revenue": 516000000.0
                },
                "Corporate": {
                    "Operating Income": -38000000.0
                },
            }
        }...

segment_type

Get a financial statement, such as a balance sheet, income statement, or cashflow statement for a given company_id

statement_type

Get the list of tickers that are traded on exchange_code

Get the list of tickers that are traded on the provided filters: iso_code, state, exchange_code, and simple_industry.

Get the list of tickers based in a location with filters iso_code and state.

Parameters:
    iso_code (string, required): The ISO 3166-1 alpha-2 or alpha-3 code representing the country. This should be a two or three letter code conforming to the ISO 3166-1 standard. Example: "US" or "USA" for the United States, "FR" or "FRA" for France, "IN" or "IND" for India.
    state (string, optional): The ISO 3166-2 subdivision code representing a state, province, or region within the specified country. This code identifies the subdivision without repeating the country code. Example: "CA" for California, "MH" for Maharashtra.

Get the list of tickers that are classified in the gics_code.

Returns a dictionary of shape {"tickers": List[{“company_id”: <company_id>, “security_id”: <security_id>, “trading_item_id”: <trading_item_id>}]}.
The gics_code can be either a 2-digit Sector code, 4-digit Industry Group code, 6-digit Industry code, or 8-digit Sub-industry code.

Get the list of tickers and their associated identification triple that are in the given simple_industry

Get the list of tickers and their associated identification triple that are in the given industry_classification and industry_code

Get the list of trading items that are traded on an exchange via exchange_code

Get the list of trading items for a given security_id. Returns a dictionary of shape {"trading_items": List[<trading_item_id>]}

Get the primary trading item for a given security_id. Returns a dictionary of shape {"primary_trading_item": <trading_item_id>}

Get the transcript for a given key_dev_id

The transcript is a list of components comprising component_type, person_name,
and text

key_dev_id

Get the raw transcript for a given key_dev_id

The raw transcript is a single string that indicates speakers by
prepending `[speaker]:` to the transcript of the speaker's speech

Return a list of all permissions that the request user has.

Refresh a client's access token, given their valid refresh token.