Modular Finance Dataflow

search_securities

TOOLSearch securitiesscope: dataflow:entities.search · read-only
Tool description, as exposed to the agent
Searches for publicly listed companies and their stocks (share classes) by free-text query. Use this first to obtain the company_id required by other tools such as get_owner_list. The query can be a company name (e.g. 'BP'), stock name, ticker symbol (e.g. 'BP.'), 12-character ISIN (e.g. 'GB0007980591'), or 20-character LEI. Coverage spans publicly listed companies globally, with strong coverage of the UK, Europe, and the US. Each match returns one company plus its associated share classes; a company with multiple share classes (e.g. voting and non-voting shares) returns one entry with multiple stocks. Each match also reports how the company is classified and where it trades: sector_id / sector_name and industry_id / industry_name (Modular Finance's own sector taxonomy, listed in full by list_sectors), and market_segment_id / market_segment_name with market_country for the primary listing (listed by list_market_segments). country is where the company is incorporated and can differ from market_country, where its shares trade. Those ids are the filters list_companies takes, so a match is also the starting point for "which other companies are like this one". Use list_companies instead of this tool when you have no name to search for and want every company matching a sector, country or market segment. Successful calls may consume Dataflow credits.

Parameters

ParameterTypeDescription
querystringrequiredFree-text query. Accepts a company name, stock name, ticker symbol, 12-character ISIN, or 20-character LEI.min length 2 · max length 256
countriesstring[]optionalOptional ISO 3166-1 alpha-2 filter on where the company is LISTED, which is not always where it is incorporated (e.g. 'GB' matches Man Group, a FTSE 100 constituent incorporated in Jersey). A company listed on more than one market matches any of them.max items 20
include_unlistedbooleanoptionalWhen true, also returns companies whose stocks are not currently listed on a public market.default false
limitintegeroptionalMaximum number of company matches. Each match may include multiple stocks (share classes), which do not count toward this limit.default 10 · min 1 · max 50

Billing

Pricing key: security_search. Successful calls consume Dataflow credits per your contract. See Credits & pricing.