List universes
https://api.tickerbot.io/ v2/ universesLists every universe you can use: your own ticker lists and the built-in ones.
Query parameters
stringOnly 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[]enumWhich 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.
builtin | A built-in universe, the same for every account: top_10 and top_100. |
custom | One of your own universes. |
integerdefault 50Page size. Max 100.
stringThe 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.
Returns
as_ofstringServer time this response was assembled (ISO 8601); on an as-of read, the instant you asked for (As-of).
queryobjectYour 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.
countnumberThe universes in this page.
next_cursorstringOpaque token for the next page; null on the last page. Pass it back as cursor.
universesarrayThe universes in scope, built-ins first, then yours newest first. Every result carries kind (builtin or custom).
Status codes
| Code | Meaning |
|---|---|
200 | Success: the response shape is documented under Returns above. |
400 | An unknown kind, a search over 100 characters, a malformed cursor or a non-positive-integer limit. |
Notes
- A universe is a named list of tickers. Pass its id as
universeto scope a screen (POST /v2/scan) or a subscribe, or as?universe=on/v2/signals/{signal},/v2/eventsand/v2/news. limitandcursorpage the whole list: the built-ins first, then yours.- Path history:
GET /v2/universes/systemis the older spelling of?kind=builtin. It keeps working, permanently, with the same response; its responses carry aLinkheader naming this read.