tickerbot.io

List event kinds

GEThttps://api.tickerbot.io/v2/events/kinds

Returns every event kind: what it is, whether it is in the default stream and can be subscribed to, what its ts means, and the fields you can name in q, select and group_by when you ask for that kind alone.

as_ofstring

Server time this response was assembled (ISO 8601); on an as-of read, the instant you asked for (As-of).

countnumber

The kinds in kinds.

common_fieldsarray

The fields every event has, whatever its kind: id (stable across reads; use it to drop duplicates), ticker, ts, kind. Each as name, type, description, nullable.

kindsarray

One entry per kind.

kindstring

The value kind takes on Query events and Subscribe to events.

labelstring

A display name.

descriptionstring

What one event of this kind is.

defaultboolean

true when Query events returns it with kind left out.

subscribableboolean

true when Subscribe to events takes it.

tsstring

What ts means for this kind.

id_rulestring

What the key in this kind's id is made of.

history_startstring

The earliest ts stored (YYYY-MM-DD). null for signal: each signal's history starts on its own date at each grain, given by List signals as grains.<grain>.since.

fieldsarray

The payload fields, each name, type (number, string, date, timestamp), description and nullable, plus values on a field that takes a fixed set: one value and description per value, such as each Form 4 code on insider action. With this kind alone they are bare names in q, select and group_by.

filtersarray

Parameters that apply with this kind only, each name and description, plus deprecated: true on those that stop on 2027-01-12.

CodeMeaning
200Success: the response shape is documented under Returns above. Cacheable for an hour.
  • The same fields are listed under payload on Query events; both come from one source.