⛔ DEPRECATED (2026-05-01) — Aggregated Live Macro Regional Sentiment

get deprecated

https://dev-copilot-api.permutable.ai/v1/macro/live/regional/{model_id}

DEPRECATED — Removal date: 2026-05-01

This endpoint will be permanently removed on 2026-05-01. Migrate to the replacement shown in the description below before that date. See the Deprecated Endpoints guide for the full migration list.

Use GET /headlines/index/macro/live/regional/{model_id} instead. Retrieves aggregated sentiment data for macroeconomic topics, over the last 2 hours. Filters by countries.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

model_id

string

required

Model ID to filter by. Get these from GET /models

Query Params

topic_preset

string

Defaults to ALL

Topic preset to filter by. Available presets: ALL, ECONOMIC DATA, MONETARY POLICY, FISCAL POLICY, DISASTERS AND CONFLICT, POLITICS, EXTREME WEATHER across all models. 'FINANCIAL MARKETS' is available for macro_2 and macro_3. Defaults to 'ALL'.

index_type

string

enum

Defaults to COMBINED

Type of index to filter by. Can be COMBINED, DOMESTIC, INTERNATIONAL

Allowed:

sparse

Only return the datapoints that had associated headlines. Useful for memory saving as less data points returned. WARNING: If you set this to False, the response will be very large and may exceed the maximum response size. Best practice is to set this to True and fill null values client side.

align_to_period_end

Align publication_time timestamps to the end of each time period instead of the start. For example, hourly data collected during the 09:00:00 - 10:00:00 period would be aligned to 10:00:00 instead of 09:00:00.

country_preset

string

Defaults to ALL

Country preset or individual country name to filter by. Available presets: ALL, G7, EUROPE, ASIA, EAST_ASIA, SOUTH_ASIA, SOUTHEAST_ASIA, AMERICAS, AFRICA, DEVELOPED, DEVELOPING. Defaults to 'ALL'. Get individual country names from GET /countries and presets from GET /countries/presets

language_preset

string

Defaults to ALL

Language preset to filter by. Available presets: ALL, ENGLISH, EUROPEAN, EUROPEAN_MAJOR, ASIAN, EAST_ASIAN, SOUTH_ASIAN, SOUTHEAST_ASIAN, MIDDLE_EASTERN, AFRICAN, LATIN_AMERICAN. Defaults to 'ALL'. Get individual language codes from GET /languages and presets from GET /languages/presets

source_country_preset

string

Defaults to ALL

Source country preset or individual country name to filter by. Available presets: ALL, G7, EUROPE, ASIA, EAST_ASIA, SOUTH_ASIA, SOUTHEAST_ASIA, AMERICAS, AFRICA, DEVELOPED, DEVELOPING. Defaults to 'ALL'. Get individual country names from GET /countries and presets from GET /countries/presets

source_preset

string

Defaults to ALL

Source preset to filter by. Available presets: ALL, FINANCIAL. Defaults to 'ALL'. Get individual source names from GET /sources and presets from GET /sources/presets

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successful Response

400Bad Request — invalid or missing query parameters

403Forbidden: Either not authorized due to header or missing ticker permissions.

404Not Found: No macro data found for the provided params.

429Too Many Requests — rate limit exceeded; slow down and retry

500Internal Server Error — an unexpected error occurred on the server