Skip to main content
GET
Person transactions

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

cik
string
required

Query Parameters

limit
integer
default:20

Page size, 1–100, default 20. Newest first.

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

Offset.

Required range: x >= 0
from
string<date>

First transaction date, YYYY-MM-DD.

to
string<date>

Last transaction date, YYYY-MM-DD.

codes
string

Form 4 transaction codes, comma-separated, e.g. P,S.

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.

transactions
object[]
totalCount
integer
offset
integer
limit
integer
hasMore
boolean