Get a universe
GET
https://api.tickerbot.io/ v2/ universes/ {universe}Returns one universe: a built-in (top_10, top_100) or one you own.
Path parameters
stringrequiredUniverse slug: a built-in (top_10, top_100) or one of yours.
Returns
as_ofstringServer time this response was assembled (ISO 8601); on an as-of read, the instant you asked for (As-of).
idstringThe slug: the universe's handle in ?universe=.
namestringDisplay label.
descriptionstringFree-form notes; "" when unset.
tickersarrayMembers.
sizenumberMember count.
kindstringenumWhose universe it is.
builtin | A built-in universe, the same for every account: top_10 and top_100. Read-only. |
custom | One of your own universes. |
effective_atnumberBuilt-in universes only: when this membership took effect (epoch seconds).
next_rebalance_atnumberBuilt-in universes only: when membership is next recomputed (epoch seconds).
created_atnumberCreation timestamp (epoch seconds).
updated_atnumberLast modification timestamp (epoch seconds).
rebalance_methodstringBuilt-in universes only: how membership is chosen.
Status codes
| Code | Meaning |
|---|---|
200 | The universe doc. |
400 | Malformed universe slug (must match ^[a-z][a-z0-9_]{0,62}$). |
404 | not_found. |
Notes
- Built-ins are rebalanced monthly, so a screen scoped to
top_100is scoped to that month's members. Pin membership by copying the list into a universe of your own.