API Documentation

Live Global Macro Sentiment Indices (GMSI) by Country

get
https://copilot-api.permutable.ai/v1/headlines/index/gmsi/live/

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

Query Params
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.

string
enum
Defaults to directional

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

Allowed:
string
enum
Defaults to COMBINED

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

Allowed:
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:
integer
1 to 1000
Defaults to 100

Maximum number of records to return.

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

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?