Skip to main content
GET
Event wire

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

One phrase, case-insensitive, matched as a substring of the headline, the ticker or the company name; not the filing text and no search syntax. At most 200 characters.

family
enum<string>[]

Event families, comma-separated or repeated: dividend, stock_split, guidance, earnings, mna, debt_financing, equity_financing, buyback, restatement_non_reliance, cyber_incident, restructuring, impairment, leadership, governance_vote, agreement, legal_regulatory, listing_compliance, other. An unknown one is a 400.

Available options:
dividend,
stock_split,
guidance,
earnings,
mna,
debt_financing,
equity_financing,
buyback,
restatement_non_reliance,
cyber_incident,
restructuring,
impairment,
leadership,
governance_vote,
agreement,
legal_regulatory,
listing_compliance,
other
from
string<date>

First filing date, YYYY-MM-DD.

to
string<date>

Last filing date, YYYY-MM-DD; not before from.

sort
enum<string>
default:newest

Filing-date order.

Available options:
newest,
oldest
limit
integer
default:50

Page size, 1–100.

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

Rows to skip: the previous nextOffset.

Required range: x >= 0
counts
enum<string>

1 adds familyCounts: matches per family for the same q and dates, ignoring family.

Available options:
0,
1,
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.

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