Skip to main content
GET
List companies

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

country
string

ISO-2 country code (US, SA, AE, JP, …); an invalid code is ignored.

sector
string

Filter by sector name.

Name, legal name or ticker contains, plus the global search's top 25 matches (aliases, typos).

scope
enum<string>
default:public

public (default) = listed companies; private = the private-company lane (XPRV keys); all = both; delisted = listed issuers with a recorded delisting date. Another value is a 400.

Available options:
public,
private,
all,
delisted
sort
enum<string>

Sort column; default market-cap ranking.

Available options:
name,
price,
net_change,
change,
volume,
market_cap,
pe
direction
enum<string>
default:desc

asc or desc (default).

Available options:
asc,
desc
limit
integer
default:100

1–1000, default 100; above 1000 is a 400 (page with offset).

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

Default 0.

Required range: x >= 0

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.

companies
object[]
total
integer
countries
object[]