Skip to main content
GET
People registry

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

Name or ticker contains (case-insensitive); at most 200 characters.

segment
enum<string>
default:corporate

Population.

Available options:
corporate,
government,
central_bank
ticker
string

People with a seat at this company (exact ticker).

role
enum<string>
default:people

Subset of corporate filers: people (humans only), officers, directors, institutions. Ignored for segment=government|central_bank.

Available options:
people,
officers,
directors,
institutions
currentOnly
enum<string>
default:0

1 = only people with a seat filing in the last two years (officials: in office now).

Available options:
0,
1,
true,
false
sort
enum<string>
default:featured

Order; every order ends on the CIK, so offset paging is stable. Corporate segment only (officials are listed in their institution's chart order).

Available options:
featured,
recent,
name,
companies,
accuracy
limit
integer
default:50

Page size, 1–200.

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

Rows to skip: the previous nextOffset.

Required range: x >= 0
universe
enum<string>
default:1

0 leaves out the universe block (registry-wide counts; null when left out).

Available options:
1,
0,
true,
false

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.

rows
object[]
total
integer
offset
integer
limit
integer
hasMore
boolean
nextOffset
integer
asOf
string<date-time>
universe
object