Skip to main content
GET
List narratives

Authorizations

X-API-KEY
string
header
default:pk_live_YOUR_KEY
required

Astreus API key (pk_live_...), created on the Developers page in the terminal. Also accepted as Authorization: Bearer pk_live_....

Query Parameters

Free text over name and description.

sector
string

GICS sector name.

tickers
string

Comma-separated tickers to scope by.

countries
string

Comma-separated ISO alpha-2 issuer domiciles to scope by (e.g. AE,SA,QA,KW).

ciks
string

Comma-separated issuer platform keys to scope by.

includeDormant
enum<string>

1 to include themes with no activity in the trailing window (returned as lifecycleState=dormant); 0 (default) leaves them out.

Available options:
0,
1
minBreadth
integer
default:0

Minimum companies discussing the theme, 0–50 (default 0 = long tail). Not applied to company or regional themes.

Required range: 0 <= x <= 50
source
enum<string>

all (default), companies or policy.

Available options:
all,
companies,
policy
sort
enum<string>
default:relevance

relevance (default), breadth, momentum or recent.

Available options:
relevance,
breadth,
momentum,
recent
limit
integer
default:40

Page size, 1–200, default 40.

Required range: 1 <= x <= 200
offset
integer
default:0

Rows to skip (the previous nextOffset), default 0. 0–1000000, default 0.

Required range: 0 <= x <= 1000000
activeOnly
enum<string>

1 lists only narratives mentioned in the last 28 days.

Available options:
1,
0
lifecycle
enum<string>

Only narratives in this lifecycle state.

Available options:
emerging,
accelerating,
broadening,
steady,
mature,
fading,
dormant
themeScope
enum<string>
default:all

Theme breadth: market-wide, regional or single-company themes; default all.

Available options:
all,
market,
regional,
company

Response

OK

Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.

asOf
string<date>
universeTotal
integer
policyOnlyTotal
integer
items
object[]
total
integer
hiddenByFloor
integer
limit
integer
offset
integer
hasMore
boolean
nextOffset
integer