Events

Signal Events

What changed, for clients that poll. Returns the events of one type inside a short window, newest first, each with a stable id to deduplicate on.

  • flip: the signal changed direction (buy to sell, or sell to buy).
  • confidence_cross: confidence moved across threshold. Confidence runs from 0.5 to 1. On the 5d and 15d horizons it stays near 0.5 to 0.65, so a level such as 0.8 only crosses on 2m.
  • sentiment_shift: the daily news sentiment score moved by at least min_shift from the previous reading. Each event carries the ticker's current signal beside it.
  • screener_entry: a ticker entered the top N of a screen (same filters as /screener). Takes no tickers.

Billing: each event is billed once per account, however many times it is returned. A request that returns nothing new costs nothing. Events already in the window the first time a given set of parameters is requested are not billed. A flip, crossing or sentiment shift counts as that day's reading of its ticker, so reading the same ticker again that day costs nothing more. Up to 50 tickers per request.

get/events

Request

  • Base URL: https://api.falpha.ai
  • URL: https://api.falpha.ai/events
  • Auth: one of:
    • API key in query parameter api_key
    • API key in header X-API-Key

Query parameters

typestring

Event type: flip, confidence_cross, sentiment_shift or screener_entry

tickersstring[] nullable

Tickers to watch (repeated param or comma separated). Up to 50. Not used by screener_entry.

periodstring

Signal horizon: 5d, 15d, or 2m

regimestring

Market regime: neutral, bear, or bull

lookback_daysinteger

How many calendar days back to look for events.

min_confidencenumber nullable

flip: only flips whose new confidence is at least this.

thresholdnumber nullable

confidence_cross: the level to watch, between 0.5 and 1.

directionstring

confidence_cross: above, below or any. sentiment_shift: up, down or any. screener_entry: buy, sell or any.

min_shiftnumber

sentiment_shift: the smallest day-over-day move to report. Scores run from about -1 to 1.

sectorstring nullable

screener_entry: optional sector filter (see /sectors).

min_qualitynumber nullable

screener_entry: minimum quality floor.

rank_bystring

screener_entry: confidence or quality

topinteger

screener_entry: the size of the list to watch (max 50).

Response

Successful Response

typestring required
sincestring required

Events dated on or after this day are included.

as_ofstring nullable

The newest data date the answer was computed from.

countinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.