Skip to main content
GET
List countries

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

Words in the name or ISO code.

region
string

Region or sub-region, e.g. Asia, Western Asia.

sort
enum<string>
default:real_gdp_growth

Rank by this figure, largest first (name: A–Z). Default real_gdp_growth. gdp_growth is deprecated: it is nominal_gdp_growth.

Available options:
real_gdp_growth,
nominal_gdp_growth,
gdp_usd_bn,
population,
inflation,
debt_to_gdp,
name,
gdp_growth
order
enum<string>

Default desc (asc for name), nulls last either way.

Available options:
asc,
desc
limit
integer
default:50

Page size, 1–250, default 50 once any filter or paging parameter is given; without any, every country is served. A limit above 250 is a 400.

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

Rows to skip, default 0: the previous page's nextOffset.

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.

countries
object[]
sort
string
order
string
total
integer
limit
integer
offset
integer
hasMore
boolean
nextOffset
integer
page
object