Skip to main content
GET
Office changes

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_....

Path Parameters

iso
string
required

ISO 3166-1 alpha-2 country code (e.g. US).

Query Parameters

scope
enum<string>

Which bodies. Default government.

Available options:
government,
central_bank
since
string

Changes effective on or after, YYYY-MM-DD.

until
string

Changes effective on or before, YYYY-MM-DD.

era
string

One era code.

kind
enum<string>

Arrivals or departures.

Available options:
arrival,
departure
q
string

Words in the name, title or office.

limit
integer
default:50

Page size, 1–200, default 50.

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

Rows to skip, 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.

iso2
string
bodyCodes
string[]
eras
object[]
changes
object[]
pending
any[]
page
object