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, …).

sector
string

Filter by sector name.

Name, legal name or ticker contains.

scope
enum<string>
default:public

public (default) = listed companies; private = the private-company lane (XPRV keys); all.

Available options:
public,
private,
all
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

1–1000, default 100.

offset
integer

Default 0.

Response

OK

The response is of type object.