list_market_segments
TOOLList market segmentsscope: dataflow:entities.search · read-only
Tool description, as exposed to the agent
Returns the market segments (exchange lists) companies are traded on, each with the numeric market_segment_id that list_companies filters on: for example 'Large Cap Stockholm' (13), 'FTSE 100' (33), 'AIM' (52). A market segment is finer-grained than an exchange - the FTSE 100, FTSE 250 and AIM are separate segments of the London market - and the major indices are modelled as segments too, so this is also how you screen an index's constituents. Each row reports the segment's id, name, ticker-style symbol, country, trading currency, and the MIC and name of the market operating it. Pass countries to narrow to specific markets; omitted, it returns every market you are entitled to, ordered by country and then by that country's own market ranking, so each country's primary market comes first. Call this before list_companies to obtain market_segment_ids; search_securities and list_companies rows report the primary market_segment_id of each company. Successful calls may consume Dataflow credits per returned segment.Parameters
| Parameter | Type | Description | |
|---|---|---|---|
| countries | string[] | optional | Optional ISO 3166-1 alpha-2 filter on the market's country (e.g. 'SE' for the Swedish markets). Omitted, every market you are entitled to is returned.max items 20 |
Billing
Pricing key: catalog.market_segments. Successful calls consume Dataflow credits per your contract. See Credits & pricing.
