tickerbot.io

List universes

GEThttps://api.tickerbot.io/v2/universes

Lists every universe you can use: your own ticker lists and the built-in ones.

string

Only universes whose id, name or description contains this text (case-insensitive). Results are ranked across built-in and your own universes: an exact id or name match first, then an id or name that starts with the term, then one that contains it, then descriptions that have it as a whole word, then descriptions that contain it; list order within each rank. Paging a search never repeats or skips.

string[]enum

Which universes to list: builtin (top_10, top_100), custom (your own) or both as a comma list. Leave it out for your own; from the cut-off on Deprecations it lists both.

builtinA built-in universe, the same for every account: top_10 and top_100.
customOne of your own universes.
integerdefault 50

Page size. Max 100.

string

The previous response's next_cursor. Send it with the same params as the first page (limit may change); a page whose params differ is a 400 naming the param.

as_ofstring

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

queryobject

Your request echoed, each param with its effective value: search (null when not sent), kind (a list; the default when you left it out) and limit.

countnumber

The universes in this page.

next_cursorstring

Opaque token for the next page; null on the last page. Pass it back as cursor.

universesarray

The universes in scope, built-ins first, then yours newest first. Every result carries kind (builtin or custom).

CodeMeaning
200Success: the response shape is documented under Returns above.
400An unknown kind, a search over 100 characters, a malformed cursor or a non-positive-integer limit.
  • A universe is a named list of tickers. Pass its id as universe to scope a screen (POST /v2/scan) or a subscribe, or as ?universe= on /v2/signals/{signal}, /v2/events and /v2/news.
  • limit and cursor page the whole list: the built-ins first, then yours.
  • Path history: GET /v2/universes/system is the older spelling of ?kind=builtin. It keeps working, permanently, with the same response; its responses carry a Link header naming this read.