Skip to main content
GET
List monitor types

Notes

  • To authenticate, you’ll need a Tako API key. It’s best practice to store it as an environment variable to avoid hardcoding sensitive credentials in your code.
  • Start here. A monitor’s parameters are validated against its type’s schema, so read the type before you call Create a monitor. This response is the authoritative list — the table below orients you, but a type added since this page was written appears only in the response.
  • Each item carries parameters_schema (the JSON Schema parameters must satisfy), description (what the type watches and when it fires), lookback_seconds (how far back an occurrence may have happened and still fire), subject_schema (the shape of the resolved subject the type echoes back), and fire_once_only.
  • firing_enabled reports whether this environment runs the rail that evaluates monitors. While it’s false, Create a monitor still accepts a monitor and the monitor stays active, but nothing evaluates it and nothing fires.

The registered types

Type names are namespaced domain.subtype.
stocks.pct_change and stocks.new_52w_extreme are state alerts: a monitor you create while its condition already holds fires on the first bar that ends after creation, not only on a later change. On a delayed feed, that bar arrives as late as the feed’s delay.

Finding a subject

The three team types take a team_id and sports.odds_crosses takes a game_id. Both come from List sports games — a row’s home.id and away.id are team ids, and its id is the game id.

Authorizations

X-API-Key
string
header
required

Response

Every registered monitor type

items
MonitorTypeInfo · object[]
required
firing_enabled
boolean
required

Whether this environment runs the rail that fires monitors. While it is false, createMonitor still accepts a monitor and the monitor stays active, but nothing evaluates it and it reports no firings.