Live Global Macro Sentiment Indices (GMSI) by Country

get

https://dev-copilot-api.permutable.ai/v1/headlines/index/gmsi/live/{country}

Returns sentiment index aggregates for the Global Macro Sentiment Indices (GMSI) dataset for a given country and topic. Use interval to switch between hourly aggregates (past 24 hours) and daily aggregates (past 30 days). Use sentiment_type to switch between directional (topic-specific rules) and semantic sentiment models. Use index_type to filter by domestic or international headline coverage, or return both with COMBINED. Get valid country codes from GET /countries (browse all) or GET /countries/search (search by name). Get valid topics from GET /headlines/topics/gmsi.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

country

string

required

ISO-2 country code. Browse all via GET /countries or search by name via GET /countries/search.

Query Params

topic

string

required

Topic name to filter by. Get valid topics from GET /headlines/topics/gmsi. To query multiple topics and/or countries in one call, use GET /index/gmsi/live/batch instead.

sentiment_type

string

enum

Defaults to directional

Sentiment model to apply. directional uses topic-specific classification rules; semantic_sentiment uses general language tone.

Allowed:

index_type

string

enum

Defaults to COMBINED

Headline coverage scope. DOMESTIC includes only domestic coverage, INTERNATIONAL only foreign coverage, COMBINED includes both.

Allowed:

interval

string

enum

Defaults to HOUR

Time interval for aggregation. HOUR returns hourly aggregates over the past 24 hours; DAY returns daily aggregates over the past 30 days.

Allowed:

limit

integer

1 to 1000

Defaults to 100

Maximum number of records to return.

include_intrabar_update

Include incremental updates for the current period. When False, only data older than 1 hour(s) ago is returned, excluding periods still being updated.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

400Bad Request: Invalid country code or topic.

403Forbidden — missing API key, invalid API key, or insufficient permissions

404Not Found — the requested resource does not exist

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

500Internal server error