Webhooks

What changed since your last read, paid per call or read with a key

Changed on

One page of PreReason's change events after a cursor: a live briefing's state label changing, a tracked release becoming known (the Fed's weekly balance sheet, the FOMC statement and target range, Treasury auction results, the EIA's weekly crude oil and natural gas stocks, ECB and Bank of Japan policy rates), and, for the companies a read names, figures stored for a newer period, an event driven situation the company briefing reports turning on, and filed news (for the USA: an 8-K's material events, leadership changes and results). Each event says what changed, when it happened, when PreReason knew it, the rule and where to fetch the briefing or metric it concerns; it carries no value.

With no cursor the read starts 24 hours back; each answer's next_cursor is where the next read starts. Events are kept 30 days. A company's events reach only a read that names the company in companies. kinds narrows company news; ownership reports come only to a read that names them.

A key on the Basic or Pro plan reads its plan's events and is never charged here. A caller with no key pays per read. A malformed cursor, an unknown event type, a malformed company, more than 200 companies or an unknown news kind answers 400, and nothing is charged.

get/api/events

Request

  • Base URL
    https://api.prereason.com
  • Auth
    HTTP bearer

Query parameters

cursorstring

The next_cursor of your previous read. Left out, the read starts 24 hours back.

typesstring

Event types, comma separated, from state.changed, release.published, company.figures_updated, company.situation_changed and company.news. Every type when left out.

companiesstring

Company addresses, comma separated, at most 200. A company's events reach only a read that names it.

kindsstring

Company news kinds, comma separated, from earnings-release, material-event, leadership-change and ownership-report. Left out, every kind but ownership-report, which comes only when named.

limitinteger

Events a page holds, 1 to 100. Default 50.

Response

A page of events, its next_cursor and whether more follow

eventsobject[] required
next_cursorstring required
has_moreboolean required
notestring

Present only when the page holds no events, has_more is false and no companies were named: what to ask instead, with the count of market wide events from the last 30 days open to this read.

Changes