Modular Finance Dataflow

list_companies

TOOLList companiesscope: dataflow:entities.search · read-only
Tool description, as exposed to the agent
Lists publicly listed companies matching a set of properties - sector, industry, country, market segment (exchange list) and market-capitalisation range - ordered by market cap or by name. This is the tool for questions that name no company: "which Swedish health-care companies are there", "list the FTSE 100 industrials", "the 20 largest companies in the Nordics". Use search_securities instead when you already know the company's name, ticker or ISIN. The sector_id / industry_id values come from list_sectors and the market_segment_ids values from list_market_segments; call those first, because the sector taxonomy is Modular Finance's own and its names cannot be guessed. Passing a sector together with an industry from a different sector matches nothing, since the two filters are combined with AND. countries filters on where a company is LISTED, which is not always where it is incorporated. Each row carries the company_id you pass straight to the ownership, insider, buyback, short and calendar tools, plus the company's name, country of incorporation, market_country, LEI, sector, industry, primary market segment, share classes, and market capitalisation (mcap, with mcap_currency naming its unit). Because a screener puts companies from different markets in one ranked list, every mcap on the page and the min_mcap / max_mcap bounds are read in a single currency - USD unless you pass the currency argument, and the response echoes the code it used as mcap_currency. mcap is computed on total issued shares - the same basis min_mcap and max_mcap filter on, so the value and the filter always agree - and is absent for a company with no priced market cap. Results are returned a page at a time (default 20, max 50 per page); when next_cursor is present in the response, pass it back as cursor on the next call, keeping every other parameter identical, until next_cursor is absent. Successful calls may consume Dataflow credits per company actually returned; an empty result costs zero credits.

Parameters

ParameterTypeDescription
countriesstring[]optionalOptional ISO 3166-1 alpha-2 filter on where the company is LISTED (e.g. 'SE', 'GB', 'US'), which is not always where it is incorporated. A company listed on more than one market matches any of them.max items 20
sectorsinteger[]optionalOptional sector_id filter from list_sectors (e.g. [5] for 'Health care'). Several ids are OR-ed. Do not guess these ids - the taxonomy is Modular Finance's own.max items 20
industriesinteger[]optionalOptional industry_id filter from list_sectors (e.g. [11] for 'Biotechnology'). Several ids are OR-ed. Combined with sectors using AND, so an industry from a different sector than the one you named matches nothing.max items 50
market_segment_idsinteger[]optionalOptional market segment (exchange list) filter from list_market_segments, e.g. [33] for the FTSE 100. Several ids are OR-ed.max items 20
min_mcapnumberoptionalOptional minimum market capitalisation, expressed in USD unless the currency argument names another code - the same currency the mcap of every row is reported in, so the value and the bound always agree. Computed on total issued shares.min 0
max_mcapnumberoptionalOptional maximum market capitalisation, in the same currency as min_mcap. Must not be below min_mcap.min 0
only_tradedbooleanoptionalWhen true, returns only companies currently trading - excluding delisted, not-yet-listed and unlisted companies.default false
include_unlistedbooleanoptionalWhen true, also returns companies whose stocks are not currently listed on a public market.default false
order'mcap' | 'name'optionalRow ordering: 'mcap' (default) returns the largest companies first; 'name' returns them alphabetically A-Z.default "mcap"
limitintegeroptionalMaximum number of companies per page. Hard cap 50. Share classes nested in a row do not count toward this limit.default 20 · min 1 · max 50
cursorstringoptionalOpaque pagination token from a previous call's next_cursor. Pass it back verbatim with every other parameter unchanged to receive the next page.max length 512
currencystringoptionalOptional ISO 4217 currency code (e.g. 'GBP', 'USD', 'SEK') the screen is computed in: every row's mcap and the min_mcap / max_mcap bounds alike, echoed as mcap_currency. Defaults to USD. Unlike the per-company tools this does not fall back to each company's own trading currency - a ranked, thresholded list of companies from different markets needs one unit to be meaningful at all.

Billing

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