Skip to main content
GET
Search

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

q
string

Search text.

domains
string

Comma-separated brand domains to resolve when q is empty; domains beyond the 8th are ignored; at most 6 companies return.

limit
integer
default:8

1–20, default 8.

Required range: 1 <= x <= 20
scope
enum<string>
default:curated

curated (default): companies, the series a country page opens, countries. all: every national and first-level-regional series that holds data, each with geo and id (GEO:KEY, read with /countries/{geo}/series?key=), plus commodities, fx_pairs, people, conflicts, organisations and bonds, each row with the id its route takes and a score. terminal: the curated series, those six and crypto and indices (names and ids only, the rows of the terminal's search box). all and terminal add interpretations: what the whole query reads as, by plain rules ("nvda earnings" → NVIDIA's Earnings tab, "uae inflation" → that country's series, "war in the middle east" → conflicts there), each with a target naming the page it opens.

Available options:
curated,
all,
terminal
country
string

Series: only this ISO alpha-2 country and its regions.

natural
enum<string>

1 = a submitted query, perhaps a typed question: when the literal query finds little, rows from the words that carry it join in, and rows scoring under 50 are dropped.

Available options:
1

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.

query
string
companies
object[]
series
any[]
countries
any[]