← Back to all apps

Overview

Tools Available23
DeveloperS&P Global
CategoryFinance

Query S&P Global data

Available Tools

S&P Global provides 23 tools that can be used to interact with its services.

Get Advisors For Company In Transaction

get_advisors_for_company_in_transaction
Full Description

Returns a list of advisor companies that provided advisory services to the specified company during a particular merger or acquisition transaction.

Examples: Query: "Who advised S&P Global during their purchase of Kensho?" Function 1: get_mergers_from_identifiers(identifiers=["S&P Global"])

Function 1 returns all M&A's that involved S&P Global. Extract the <key_dev_id> from the response where S&P Global was the buyer and Kensho was the target.

Function 2: get_advisors_for_company_in_transaction(identifier="S&P Global", transaction_id=<key_dev_id>)

Query: "Which firms advised AAPL in transaction 67890?" Function: get_advisors_for_company_in_transaction(identifier="AAPL", transaction_id=67890)

Parameters

Required
identifierstring

The identifier, which can be a ticker symbol, ISIN, CUSIP, or company_id

transaction_idinteger

The ID of the merger.

Get Business Relationship From Identifiers

get_business_relationship_from_identifiers
Full Description

Get the current and previous companies that have a specified business relationship with each of the provided identifiers.

  • When possible, pass multiple identifiers in a single call rather than making multiple calls.
  • Results include both "current" (active) and "previous" (historical) relationships.

Examples: Query: "Who are the current and previous suppliers of Intel?" Function: get_business_relationship_from_identifiers(identifiers=["Intel"], business_relationship="supplier")

Query: "What are the borrowers of SPGI and JPM?" Function: get_business_relationship_from_identifiers(identifiers=["SPGI", "JPM"], business_relationship="borrower")

Query: "Who are Dell's customers?" Function: get_business_relationship_from_identifiers(identifiers=["Dell"], business_relationship="customer")

Parameters

Required
business_relationshipstring

The type of business relationship

Options:suppliercustomerdistributorfranchisorfranchiseelandlordtenantlicensorlicenseecreditorborrowerlessorlesseestrategic_allianceinvestor_relations_firminvestor_relations_clienttransfer_agenttransfer_agent_clientvendorclient_services
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

Get Capitalization From Identifiers

get_capitalization_from_identifiers
Full Description

Get the historical market cap, tev (Total Enterprise Value), or shares outstanding for a group of identifiers between inclusive start_date and inclusive end date.

  • When possible, pass multiple identifiers in a single call rather than making multiple calls.
  • When requesting the most recent values, leave start_date and end_date null.
  • For annual data (e.g., "market cap in 2020", "FY2021 values"), use the full year range: start_date as January 1st and end_date as December 31st.
  • For "latest" or "current" values, always leave dates null to get the most recent data point.
  • Only specify date ranges when the user explicitly requests historical data over a specific period.

Examples: Query: "What are the market caps of Visa and Mastercard?" Function: get_capitalization_from_identifiers(capitalization="market_cap", identifiers=["Visa", "Mastercard"], start_date=null, end_date=null)

Query: "What was MDT's market cap in 2020?" Function: get_capitalization_from_identifiers(capitalization="market_cap", identifiers=["MDT"], start_date="2020-01-01", end_date="2020-12-31")

Query: "Market cap trends for MSFT from Q1 2020 to Q3 2021" Function: get_capitalization_from_identifiers(capitalization="market_cap", identifiers=["MSFT"], start_date="2020-01-01", end_date="2021-09-30")

Parameters

Required
capitalizationstring

The capitalization type

Options:market_captevshares_outstanding
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

Optional
end_datestring

The end date for historical capitalization retrieval. Use null for latest values. For annual data, use December 31st of the year.

Default: null
start_datestring

The start date for historical capitalization retrieval. Use null for latest values. For annual data, use January 1st of the year.

Default: null

Get Company Description From Identifiers

get_company_description_from_identifiers
Full Description

Get detailed descriptions of companies, broken down into sections, which may include information about the company's Primary business, Segments (including Products and Services for each), Competition, Significant events, and History. Within the text, four spaces represent a new paragraph. Note that the description is divided into sections with headers, where each section has a new paragraph (four spaces) before and after the section header.

  • When possible, pass multiple identifiers in a single call rather than making multiple calls.

Examples: Query: "Get detailed descriptions for Netflix and Disney" Function: get_company_description_from_identifiers(identifiers=["Netflix", "Disney"])

Query: "What are the detailed company descriptions for KO and PEP?" Function: get_company_description_from_identifiers(identifiers=["KO", "PEP"])

Parameters

Required
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

Get Company Other Names From Identifiers

get_company_other_names_from_identifiers
Full Description

Given a list of identifiers, fetch the alternate, historical, and native names associated with each identifier. Alternate names are additional names a company might go by (for example, Hewlett-Packard Company also goes by the name HP). Historical names are previous names for the company if it has changed over time. Native names are primary non-Latin character native names for global companies, including languages such as Arabic, Russian, Greek, Japanese, etc. This also includes limited history on native name changes.

  • When possible, pass multiple identifiers in a single call rather than making multiple calls.

Examples: Query: "What are the alternate names for Meta and Alphabet?" Function: get_company_other_names_from_identifiers(identifiers=["Meta", "Alphabet"])

Query: "Get other names for NSRGY" Function: get_company_other_names_from_identifiers(identifiers=["NSRGY"])

Parameters

Required
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

Get Company Summary From Identifiers

get_company_summary_from_identifiers
Full Description

Get one paragraph summary/short descriptions of companies, including information about the company's primary business, products and services offered and their applications, business segment details, client/customer groups served, geographic markets served, distribution channels, strategic alliances/partnerships, founded/incorporated year, latest former name, and headquarters and additional offices.

  • When possible, pass multiple identifiers in a single call rather than making multiple calls.

Examples: Query: "Give me summaries of Tesla and General Motors" Function: get_company_summary_from_identifiers(identifiers=["Tesla", "General Motors"])

Query: "What are the summaries for F and STLA?" Function: get_company_summary_from_identifiers(identifiers=["F", "STLA"])

Parameters

Required
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

Get Competitors From Identifiers

get_competitors_from_identifiers
Full Description

Retrieves a list of company_id and company_name that are competitors for a list of companies, filtered by the source of the competitor information.

  • When possible, pass multiple identifiers in a single call rather than making multiple calls.
  • Available competitor sources: all, 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)

Examples: Query: "Who are Microsoft's competitors from SEC filings?" Function: get_competitors_from_identifiers(identifiers=["Microsoft"], competitor_source="filing")

Query: "Get all competitors of AAPL and GOOGL" Function: get_competitors_from_identifiers(identifiers=["AAPL", "GOOGL"], competitor_source="all")

Parameters

Required
competitor_sourcestring

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).

Options:allfilingkey_devcontactthird_partyself_identifiednamed_by_competitor
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

Get Cusip From Identifiers

get_cusip_from_identifiers
Full Description

Get the CUSIPs for a group of identifiers.

  • When possible, pass multiple identifiers in a single call rather than making multiple calls.

Examples: Query: "What is the CUSIP for Humana?" Function: get_cusip_from_identifiers(identifiers=["Humana"])

Query: "Get CUSIPs for ATO and DTE" Function: get_cusip_from_identifiers(identifiers=["ATO", "DTE"])

Parameters

Required
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

Get Earnings From Identifiers

get_earnings_from_identifiers
Full Description

Get all earnings calls for a list of identifiers.

Returns a list of dictionaries with 'name' (str), 'key_dev_id' (int), and 'datetime' (str in ISO 8601 format with UTC timezone) attributes for each identifier.

  • Use get_latest_earnings_from_identifiers to get only the most recent earnings
  • Use get_next_earnings_from_identifiers to get only the next upcoming earnings
  • To fetch the full transcript, call get_transcript_from_key_dev_id with the key_dev_id

Examples: Query: "Get all earnings calls for Microsoft" Function: get_earnings_from_identifiers(identifiers=["Microsoft"])

Query: "Get earnings for CRM and ORCL" Function: get_earnings_from_identifiers(identifiers=["CRM", "ORCL"])

Parameters

Required
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

Get Financial Line Item From Identifiers

get_financial_line_item_from_identifiers
Full Description

Get the financial line item associated with a list of identifiers.

  • When possible, pass multiple identifiers in a single call rather than making multiple calls.
  • To fetch the most recent value, leave all time parameters as null.
  • Line item names are case-insensitive, use underscores, and support common aliases (e.g., 'revenue' and 'normal_revenue' return the same data).
  • To filter by time, use either absolute time (start_year, end_year, start_quarter, end_quarter) OR relative time (num_periods, num_periods_back)—but not both.
  • Set calendar_type based on how the query references the time period—use "fiscal" for fiscal year references and "calendar" for calendar year references.
  • When calendar_type=None, it defaults to 'fiscal'.
  • Exception: with multiple identifiers and absolute time, calendar_type=None defaults to 'calendar' for cross-company comparability; calendar_type='fiscal' returns fiscal data but should not be compared across companies since fiscal years have different end dates.

Examples: Query: "Get MSFT and AAPL revenue and gross profit quarterly" Function: get_financial_line_item_from_identifiers(line_item="revenue", identifiers=["MSFT", "AAPL"], period_type="quarterly") Function: get_financial_line_item_from_identifiers(line_item="gross_profit", identifiers=["MSFT", "AAPL"], period_type="quarterly")

Query: "General Electric's ebt excluding unusual items for FY2023" Function: get_financial_line_item_from_identifiers(line_item="ebt_excluding_unusual_items", identifiers=["General Electric"], period_type="annual", calendar_type="fiscal", start_year=2023, end_year=2023)

Query: "What is the most recent three quarters except one ppe for Exxon and Hasbro?" Function: get_financial_line_item_from_identifiers(line_item="ppe", period_type="quarterly", num_periods=2, num_periods_back=1, identifiers=["Exxon", "Hasbro"])

Query: "What are the ytd operating income values for Hilton for the calendar year 2022?" Function: get_financial_line_item_from_identifiers(line_item="operating_income", period_type="ytd", calendar_type="calendar", start_year=2022, end_year=2022, identifiers=["Hilton"])

Query: "Compare AAPL and MSFT revenue for 2023" Function: get_financial_line_item_from_identifiers(line_item="revenue", identifiers=["AAPL", "MSFT"], period_type="annual", calendar_type="calendar", start_year=2023, end_year=2023)

Parameters

Required
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

line_itemstring

The type of financial line_item requested

Options:revenueregular_revenuenormal_revenuefinance_division_revenueinsurance_division_revenuerevenue_from_sale_of_assetsrevenue_from_sale_of_investmentsrevenue_from_interest_and_investment_incomeother_revenuetotal_other_revenuefees_and_other_incometotal_revenuecost_of_goods_soldcogsfinance_division_operating_expenseoperating_expense_finance_divisioninsurance_division_operating_expenseoperating_expense_insurance_divisionfinance_division_interest_expenseinterest_expense_finance_divisioncost_of_revenuecorgross_profitselling_general_and_admin_expenseselling_general_and_adminsgasg_and_aselling_general_and_admin_costexploration_and_drilling_costsexploration_and_drilling_expenseprovision_for_bad_debtsprovision_for_bad_debtpre_opening_costspre_opening_expensetotal_selling_general_and_admin_expensetotal_sgatotal_selling_general_and_admin_costtotal_selling_general_and_adminresearch_and_development_expenser_and_d_costrnd_expensernd_costr_and_d_expenseresearch_and_development_costdepreciation_and_amortizationd_and_adnaamortization_of_goodwill_and_intangiblesimpairment_of_oil_gas_and_mineral_propertiesimpairment_o_and_gimpairment_of_oil_and_gastotal_depreciation_and_amortizationtotal_d_and_atotal_dnaother_operating_expensetotal_other_operating_expensetotal_operating_expenseoperating_expenseoperating_incomeinterest_expenseinterest_and_investment_incomenet_interest_expenseincome_from_affiliatescurrency_exchange_gainsother_non_operating_incometotal_other_non_operating_incomeebt_excluding_unusual_itemsearnings_before_taxes_excluding_unusual_itemsrestructuring_chargesmerger_chargesmerger_and_restructuring_chargesimpairment_of_goodwillgain_from_sale_of_assetsgain_from_sale_of_investmentsasset_writedownin_process_research_and_development_expensein_process_r_and_d_expensein_process_rnd_expensein_process_rnd_costin_process_research_and_development_costin_process_r_and_d_costinsurance_settlementslegal_settlementsother_unusual_itemstotal_other_unusual_itemstotal_unusual_itemsunusual_itemsebt_including_unusual_itemsearnings_before_taxes_including_unusual_itemsincome_tax_expenseincome_taxincome_taxesearnings_from_continued_operationscontinued_operations_earningsearnings_from_discontinued_operationsdiscontinued_operations_earningsextraordinary_item_and_accounting_changenet_income_to_companyminority_interest_in_earningsnet_income_to_minority_interestnet_incomepremium_on_redemption_of_preferred_stockpreferred_stock_dividendother_preferred_stock_adjustmentsother_adjustments_to_net_incomepreferred_dividends_and_other_adjustmentsnet_income_allocable_to_general_partnernet_income_to_common_shareholders_including_extra_itemsnet_income_to_common_shareholders_excluding_extra_itemscash_and_equivalentscashcash_and_cash_equivalentsshort_term_investmentstrading_asset_securitiestotal_cash_and_short_term_investmentscash_and_short_term_investmentsaccounts_receivableshort_term_accounts_receivablecurrent_accounts_receivableother_receivablescurrent_other_receivablesshort_term_other_receivablesnotes_receivablecurrent_notes_receivableshort_term_notes_receivabletotal_receivablesshort_term_total_receivablescurrent_total_receivablecurrent_total_receivablesshort_term_total_receivabletotal_receivableinventoryinventoriesprepaid_expenseprepaid_expensesfinance_division_loans_and_leases_short_termfinance_division_short_term_loans_and_leasesshort_term_finance_division_loans_and_leasesshort_term_loans_and_leases_of_the_finance_divisionfinance_division_other_current_assetsother_short_term_assets_of_the_finance_divisionfinance_division_other_short_term_assetsother_current_assets_of_the_finance_divisionloans_held_for_saledeferred_tax_asset_current_portioncurrent_deferred_tax_assetshort_term_deferred_tax_assetrestricted_cashother_current_assetstotal_current_assetstotal_short_term_assetsshort_term_assetscurrent_assetsgross_property_plant_and_equipmentgppegross_ppeaccumulated_depreciationnet_property_plant_and_equipmentppeproperty_plant_and_equipmentnppenet_ppelong_term_investmentsnon_current_investmentsgoodwillother_intangiblesfinance_division_loans_and_leases_long_termlong_term_loans_and_leases_of_the_finance_divisionlong_term_finance_division_loans_and_leasesfinance_division_long_term_loans_and_leasesfinance_division_other_non_current_assetsother_long_term_assets_of_the_finance_divisionfinance_division_other_long_term_assetsother_non_current_assets_of_the_finance_divisionlong_term_accounts_receivablenon_current_accounts_receivablelong_term_loans_receivablenon_current_loans_receivableloans_receivablelong_term_deferred_tax_assetsnon_current_deferred_tax_assetslong_term_deferred_chargesnon_current_deferred_chargesother_long_term_assetsnon_current_other_assetslong_term_other_assetsother_non_current_assetstotal_assetsassetsaccounts_payableaccrued_expensesshort_term_borrowingsshort_term_borrowingcurrent_borrowingcurrent_borrowingscurrent_portion_of_long_term_debtcurrent_portion_of_lt_debtcurrent_portion_of_non_current_debtcurrent_portion_of_capital_leasescurrent_portion_of_cap_leasescurrent_portion_of_leasescurrent_portion_of_capitalized_leasescurrent_portion_of_long_term_debt_and_capital_leasestotal_current_portion_of_long_term_debt_and_capital_leasescurrent_portion_of_non_current_debt_and_capital_leasestotal_current_portion_of_long_term_debt_and_capitalized_leasestotal_current_portion_of_lt_debt_and_cap_leasescurrent_portion_of_long_term_debt_and_capitalized_leasestotal_current_portion_of_non_current_debt_and_capital_leasestotal_current_portion_of_non_current_debt_and_capitalized_leasescurrent_portion_of_non_current_debt_and_capitalized_leasescurrent_portion_of_lt_debt_and_cap_leasesfinance_division_debt_current_portionfinance_division_other_current_liabilitiescurrent_income_taxes_payablecurrent_portion_of_income_taxes_payablecurrent_unearned_revenuecurrent_portion_of_unearned_revenuecurrent_deferred_tax_liabilityother_current_liabilityother_current_liabilitiestotal_current_liabilitiescurrent_liabilitieslong_term_debtnon_current_debtcapital_leasescapitalized_leaseslong_term_leasesfinance_division_debt_non_current_portionfinance_division_debt_long_term_portionfinance_division_long_term_debtfinance_division_non_current_debtfinance_division_other_non_current_liabilitiesfinance_division_other_long_term_liabilitiesnon_current_unearned_revenuelong_term_unearned_revenuepension_and_other_post_retirement_benefitnon_current_deferred_tax_liabilityother_non_current_liabilitiesother_long_term_liabilitiesnon_current_other_liabilitieslong_term_other_liabilitiestotal_liabilitiesliabilitiespreferred_stock_redeemableredeemable_preferred_stockpreferred_stock_non_redeemablenon_redeemable_preferred_stockpreferred_stock_convertibleconvertible_preferred_stockpreferred_stock_otherother_preferred_stockpreferred_stock_additional_paid_in_capitaladditional_paid_in_capital_preferred_stockpreferred_stock_equity_adjustmentequity_adjustment_preferred_stocktreasury_stock_preferred_stock_convertibletreasury_convertible_preferred_stocktreasury_preferred_stock_convertibletreasury_stock_convertible_preferred_stocktreasury_stock_preferred_stock_non_redeemabletreasury_non_redeemable_preferred_stocktreasury_preferred_stock_non_redeemabletreasury_stock_non_redeemable_preferred_stocktreasury_stock_preferred_stock_redeemabletreasury_preferred_stock_redeemabletreasury_stock_redeemable_preferred_stocktreasury_redeemable_preferred_stocktotal_preferred_equitypreferred_stocktotal_preferred_stockpreferred_equitycommon_stockadditional_paid_in_capitalretained_earningstreasury_stockother_equitytotal_common_equitycommon_equitytotal_equityshareholders_equityequitytotal_shareholders_equitytotal_liabilities_and_equityliabilities_and_equitycommon_shares_outstandingadjustments_to_cash_flow_net_incomeother_amortizationtotal_other_non_cash_itemsnet_decrease_in_loans_originated_and_soldprovision_for_credit_lossesloss_on_equity_investmentsstock_based_compensationtax_benefit_from_stock_optionsnet_cash_from_discontinued_operationcash_from_discontinued_operationother_operating_activitieschange_in_trading_asset_securitieschange_in_accounts_receivablechange_in_inventorieschange_in_accounts_payablechange_in_unearned_revenuechange_in_income_taxeschange_in_deferred_taxeschange_in_other_net_operating_assetschange_in_net_operating_assetscash_from_operationscash_from_operating_activitiescash_flow_from_operationscapital_expenditurecapital_expenditurescapexsale_of_property_plant_and_equipmentsale_of_ppecash_acquisitionsdivestituressale_of_real_estatesale_of_real_estate_propertiessale_of_real_propertiessale_of_intangible_assetssale_of_intangiblessale_of_intangible_assetnet_cash_from_investmentsnet_decrease_in_investment_loans_originated_and_soldother_investing_activitiestotal_other_investing_activitiescash_from_investingcashflow_from_investingcashflow_from_investing_activitiescash_from_investing_activitiesshort_term_debt_issuedcurrent_debt_issuedlong_term_debt_issuednon_current_debt_issuedtotal_debt_issuedshort_term_debt_repaidcurrent_debt_repaidlong_term_debt_repaidnon_current_debt_repaidtotal_debt_repaidissuance_of_common_stockrepurchase_of_common_stockissuance_of_preferred_stockrepurchase_of_preferred_stockcommon_dividends_paidpreferred_dividends_paidtotal_dividends_paiddividends_paidspecial_dividends_paidother_financing_activitiescash_from_financingcashflow_from_financing_activitiescash_from_financing_activitiescashflow_from_financingforeign_exchange_rate_adjustmentsfx_adjustmentsforeign_exchange_adjustmentsmiscellaneous_cash_flow_adjustmentsmisc_cash_flow_adjnet_change_in_cashchange_in_cashdepreciationdepreciation_of_rental_assetssale_proceeds_from_rental_assetsbasic_epsbasic_earning_per_share_including_extra_itemsbasic_eps_including_extra_itemsbasic_earning_per_sharebasic_eps_excluding_extra_itemsbasic_earning_per_share_excluding_extra_itemsbasic_eps_from_accounting_changebasic_earning_per_share_from_accounting_changebasic_eps_from_extraordinary_itemsbasic_earning_per_share_from_extraordinary_itemsbasic_eps_from_accounting_change_and_extraordinary_itemsbasic_earning_per_share_from_accounting_change_and_extraordinary_itemsweighted_average_basic_shares_outstandingdiluted_epsdiluted_earning_per_sharediluted_earning_per_share_including_extra_itemsdiluted_eps_including_extra_itemsdiluted_eps_excluding_extra_itemsdiluted_earning_per_share_excluding_extra_itemsweighted_average_diluted_shares_outstandingnormalized_basic_epsnormalized_basic_earning_per_sharenormalized_diluted_epsnormalized_diluted_earning_per_sharedividends_per_sharedistributable_cash_per_sharediluted_eps_from_accounting_change_and_extraordinary_itemsdiluted_earning_per_share_from_accounting_change_and_extraordinary_itemsdiluted_eps_from_accounting_changediluted_earning_per_share_from_accounting_changediluted_eps_from_extraordinary_itemsdiluted_earning_per_share_from_extraordinary_itemsdiluted_eps_from_discontinued_operationsdiluted_earning_per_share_from_discontinued_operationsfunds_from_operationsffoebitdaearnings_before_interest_taxes_depreciation_and_amortizationebitaearnings_before_interest_taxes_and_amortizationebitearnings_before_interest_and_taxesebitdarearnings_before_interest_taxes_depreciation_amortization_and_rental_expensenet_debteffective_tax_ratetax_ratecurrent_ratioquick_ratiototal_debt_to_capitalnet_working_capitalworking_capitalchange_in_net_working_capitaltotal_debttotal_debt_to_equity_ratiototal_debt_ratiototal_debt_to_total_equitydebt_ratiototal_debt_to_equity
Optional
calendar_typestring

Fiscal year or calendar year

Default: null
end_quarterinteger

Ending quarter (1-4). Only used when period_type is quarterly.

Default: null
end_yearinteger

The ending year for the data range. Use null for the most recent data.

Default: null
num_periodsinteger

The number of periods to retrieve data for (1-99)

Default: null
num_periods_backinteger

The end period of the data range expressed as number of periods back relative to the present period (0-99)

Default: null
period_typestring

The period type (annual or quarterly)

Default: null
start_quarterinteger

Starting quarter (1-4). Only used when period_type is quarterly.

Default: null
start_yearinteger

The starting year for the data range. Use null for the most recent data.

Default: null

Get Financial Statement From Identifiers

get_financial_statement_from_identifiers
Full Description

Get a financial statement (balance_sheet, income_statement, or cashflow) for a group of identifiers.

  • When possible, pass multiple identifiers in a single call rather than making multiple calls.
  • To fetch the most recent statement, leave all time parameters as null.
  • To filter by time, use either absolute time (start_year, end_year, start_quarter, end_quarter) OR relative time (num_periods, num_periods_back)—but not both.
  • Set calendar_type based on how the query references the time period—use "fiscal" for fiscal year references and "calendar" for calendar year references.
  • When calendar_type=None, it defaults to 'fiscal'.
  • Exception: with multiple identifiers and absolute time, calendar_type=None defaults to 'calendar' for cross-company comparability; calendar_type='fiscal' returns fiscal data but should not be compared across companies since fiscal years have different end dates.

Examples: Query: "Fetch the balance sheets of Bank of America and Goldman Sachs for 2024" Function: get_financial_statement_from_identifiers(identifiers=["Bank of America", "Goldman Sachs"], statement="balance_sheet", period_type="annual", start_year=2024, end_year=2024)

Query: "Get income statements for NEE and DUK" Function: get_financial_statement_from_identifiers(identifiers=["NEE", "DUK"], statement="income_statement")

Query: "Q2 2023 cashflow for XOM" Function: get_financial_statement_from_identifiers(identifiers=["XOM"], statement="cashflow", period_type="quarterly", start_year=2023, end_year=2023, start_quarter=2, end_quarter=2)

Query: "What is the balance sheet for The New York Times for the past 7 years except for the most recent 2 years?" Function: get_financial_statement_from_identifiers(statement="balance_sheet", num_periods=5, num_periods_back=2, identifiers=["NYT"])

Query: "What are the annual income statement for the calendar years between 2013 and 2016 for BABA and W?" Function: get_financial_statement_from_identifiers(statement="income_statement", period_type="annual", calendar_type="calendar", start_year=2013, end_year=2016, identifiers=["BABA", "W"])

Parameters

Required
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

statementstring

The type of financial statement

Options:balance_sheetincome_statementcashflow
Optional
calendar_typestring

Fiscal year or calendar year

Default: null
end_quarterinteger

Ending quarter (1-4). Only used when period_type is quarterly.

Default: null
end_yearinteger

The ending year for the data range. Use null for the most recent data.

Default: null
num_periodsinteger

The number of periods to retrieve data for (1-99)

Default: null
num_periods_backinteger

The end period of the data range expressed as number of periods back relative to the present period (0-99)

Default: null
period_typestring

The period type (annual or quarterly)

Default: null
start_quarterinteger

Starting quarter (1-4). Only used when period_type is quarterly.

Default: null
start_yearinteger

The starting year for the data range. Use null for the most recent data.

Default: null

Get History Metadata From Identifiers

get_history_metadata_from_identifiers
Full Description

Get the history metadata associated with a list of identifiers. History metadata includes currency, symbol, exchange name, instrument type, and first trade date.

  • When possible, pass multiple identifiers in a single call rather than making multiple calls.

Examples: Query: "What exchange does Starbucks trade on?" Function: get_history_metadata_from_identifiers(identifiers=["Starbucks"])

Parameters

Required
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

Get Info From Identifiers

get_info_from_identifiers
Full Description

Get the information associated with a list of identifiers. Info includes company name, status, type, simple industry, number of employees (if available), founding date, webpage, HQ address, HQ city, HQ zip code, HQ state, HQ country, HQ country iso code, and CIQ company_id.

  • When possible, pass multiple identifiers in a single call rather than making multiple calls.

Examples: Query: "What's the company information for Northrop Grumman and Lockheed Martin?" Function: get_info_from_identifiers(identifiers=["Northrop Grumman", "Lockheed Martin"])

Query: "Get company info for UBER and LYFT" Function: get_info_from_identifiers(identifiers=["UBER", "LYFT"])

Parameters

Required
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

Get Isin From Identifiers

get_isin_from_identifiers
Full Description

Get the ISINs for a group of identifiers.

  • When possible, pass multiple identifiers in a single call rather than making multiple calls.

Examples: Query: "What is the ISIN for Autodesk?" Function: get_isin_from_identifiers(identifiers=["Autodesk"])

Query: "Get ISINs for RCL and CCL" Function: get_isin_from_identifiers(identifiers=["RCL", "CCL"])

Parameters

Required
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

Get Latest

get_latest
Full Description

Get the latest annual reporting year, latest quarterly reporting quarter and year, and current date.

Parameters

Optional
use_local_timezoneboolean

Whether to use the local timezone of the user

Default: True

Get Latest Earnings From Identifiers

get_latest_earnings_from_identifiers
Full Description

Get the latest (most recent) earnings call for a list of identifiers.

Returns a dictionary with 'name' (str), 'key_dev_id' (int), and 'datetime' (str in ISO 8601 format with UTC timezone) attributes for each identifier.

  • Use get_earnings_from_identifiers for all historical earnings
  • Use get_next_earnings_from_identifiers for upcoming earnings
  • To fetch the full transcript, call get_transcript_from_key_dev_id with the key_dev_id

Examples: Query: "What was Microsoft's latest earnings call?" Function: get_latest_earnings_from_identifiers(identifiers=["Microsoft"])

Query: "Get latest earnings for JPM and GS" Function: get_latest_earnings_from_identifiers(identifiers=["JPM", "GS"])

Parameters

Required
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

Get Merger Info From Transaction Id

get_merger_info_from_transaction_id
Full Description

Provides comprehensive information about a specific merger or acquisition transaction, including its timeline (announced date, closed date), participants' company_name and company_id (target, buyers, sellers), and financial consideration details (including monetary values).

Use this tool for questions about announcement dates and transaction details.

Examples: Query: "When was the acquisition of Ben & Jerry's announced?" Function 1: get_mergers_from_identifiers(identifiers=["Ben & Jerry's"])

Function 1 returns all M&A's that involved Ben & Jerry's. Extract the <key_dev_id> from the response where Ben & Jerry's was the target.

Function 2: get_merger_info_from_transaction_id(transaction_id=<key_dev_id>)

Query: "What was the transaction size of Vodafone's acquisition of Mannesmann?" Function 1: get_mergers_from_identifiers(identifiers=["Vodafone"])

Function 1 returns all M&A's that involved Vodafone. Extract the <key_dev_id> from the response where Vodafone was the buyer and Mannesmann was the target.

Function 2: get_merger_info_from_transaction_id(transaction_id=<key_dev_id>)

Parameters

Required
transaction_idinteger

The ID of the transaction.

Get Mergers From Identifiers

get_mergers_from_identifiers
Full Description

Retrieves all merger and acquisition transactions involving the specified company.

Results are categorized by the company's role: target (being acquired), buyer (making the acquisition), or seller (divesting an asset).

  • When possible, pass multiple identifiers in a single call rather than making multiple calls.
  • Provides transaction_id, merger_title, and transaction closed_date.

Examples: Query: "Which companies did Microsoft purchase?" Function: get_mergers_from_identifiers(identifiers=["Microsoft"])

Query: "Get acquisitions for AAPL and GOOGL" Function: get_mergers_from_identifiers(identifiers=["AAPL", "GOOGL"])

Parameters

Required
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

Get N Quarters Ago

get_n_quarters_ago
Full Description

Get the year and quarter corresponding to [n] quarters before the current quarter.

Parameters

Required
ninteger

Number of quarters before the current quarter

Get Next Earnings From Identifiers

get_next_earnings_from_identifiers
Full Description

Get the next scheduled earnings call for a list of identifiers.

Returns a dictionary with 'name' (str), 'key_dev_id' (int), and 'datetime' (str in ISO 8601 format with UTC timezone) attributes for each identifier.

  • Use get_latest_earnings_from_identifiers for the most recent completed earnings
  • Use get_earnings_from_identifiers for all historical earnings
  • To fetch the full transcript (once available), call get_transcript_from_key_dev_id with the key_dev_id

Examples: Query: "When is Waste Management's next earnings call?" Function: get_next_earnings_from_identifiers(identifiers=["Waste Management"])

Query: "Get next earnings for FDX and UPS" Function: get_next_earnings_from_identifiers(identifiers=["FDX", "UPS"])

Parameters

Required
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

Get Prices From Identifiers

get_prices_from_identifiers
Full Description

Get the historical open, high, low, and close prices, and volume of a group of identifiers between inclusive start_date and inclusive end date.

  • When possible, pass multiple identifiers in a single call rather than making multiple calls.
  • When requesting the most recent values, leave start_date and end_date null.
  • For annual queries (e.g., "prices in 2020"), use the full year range from January 1st to December 31st.
  • If requesting prices for long periods of time (e.g., multiple years), consider using a coarser periodicity (e.g., weekly or monthly) to reduce the amount of data returned.

Examples: Query: "What are the prices of Facebook and Google?" Function: get_prices_from_identifiers(identifiers=["Facebook", "Google"], start_date=null, end_date=null)

Query: "Get prices for META and GOOGL" Function: get_prices_from_identifiers(identifiers=["META", "GOOGL"], start_date=null, end_date=null)

Query: "How did Meta's stock perform in 2020?" Function: get_prices_from_identifiers(identifiers=["Meta"], start_date="2020-01-01", end_date="2020-12-31", periodicity="day")

Parameters

Required
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

Optional
adjustedboolean

Whether to retrieve adjusted prices that account for corporate actions such as dividends and splits.

Default: True
end_datestring

The end date for historical price retrieval. Use null for latest values. For annual queries (e.g., 'prices in 2020'), use December 31st of the year.

Default: null
periodicitystring

The frequency or interval at which the historical data points are sampled or aggregated. Periodicity is not the same as the date range. The date range specifies the time span over which the data is retrieved, while periodicity determines how the data within that date range is aggregated.

Options:dayweekmonthyear
Default: day
start_datestring

The start date for historical price retrieval. Use null for latest values. For annual queries (e.g., 'prices in 2020'), use January 1st of the year.

Default: null

Get Segments From Identifiers

get_segments_from_identifiers
Full Description

Get the templated business or geographic segments associated with a list of identifiers.

  • When possible, pass multiple identifiers in a single call rather than making multiple calls.
  • To fetch the most recent segment data, leave all time parameters as null.
  • To filter by time, use either absolute time (start_year, end_year, start_quarter, end_quarter) OR relative time (num_periods, num_periods_back)—but not both.
  • Set calendar_type based on how the query references the time period—use "fiscal" for fiscal year references and "calendar" for calendar year references.
  • When calendar_type=None, it defaults to 'fiscal'.
  • Exception: with multiple identifiers and absolute time, calendar_type=None defaults to 'calendar' for cross-company comparability; calendar_type='fiscal' returns fiscal data but should not be compared across companies since fiscal years have different end dates.

Examples: Query: "What are the business segments for AT&T?" Function: get_segments_from_identifiers(identifiers=["AT&T"], segment_type="business")

Query: "Get most recent geographic segments for Pfizer and JNJ" Function: get_segments_from_identifiers(identifiers=["Pfizer", "JNJ"], segment_type="geographic")

Query: "What are the ltm business segments for SPGI for the last three calendar quarters but one?" Function: get_segments_from_identifiers(segment_type="business", period_type="ltm", calendar_type="calendar", num_periods=2, num_periods_back=1, identifiers=["SPGI"])

Parameters

Required
identifiersarray

The identifiers, which can be a list of ticker symbols, ISINs, or CUSIPs, or company_ids

segment_typestring

The type of segment

Options:businessgeographic
Optional
calendar_typestring

Fiscal year or calendar year

Default: null
end_quarterinteger

Ending quarter

Default: null
end_yearinteger

The ending year for the data range

Default: null
num_periodsinteger

The number of periods to retrieve data for (1-99)

Default: null
num_periods_backinteger

The end period of the data range expressed as number of periods back relative to the present period (0-99)

Default: null
period_typestring

The period type

Default: null
start_quarterinteger

Starting quarter

Default: null
start_yearinteger

The starting year for the data range

Default: null

Get Transcript From Key Dev Id

get_transcript_from_key_dev_id
Full Description

Get the raw transcript text for an earnings call by key_dev_id.

The key_dev_id is obtained from earnings tools (get_earnings_from_identifiers, get_latest_earnings_from_identifiers, or get_next_earnings_from_identifiers).

Example: Query: "Get the transcript for earnings call 12346" Function: get_transcript_from_key_dev_id(key_dev_id=12346)

Parameters

Required
key_dev_idinteger

The key_dev_id for the earnings call