View as markdown
Endpoints · Universes

Get one universe

GEThttps://api.tickerbot.io/v2/universes/{id}

Returns the universe doc. Use top_10/top_100 to fetch a system universe; any other slug must be one your account owns.

Query parameters

stringrequired

Universe slug.

Returns

as_ofstring

Server time this response was assembled (ISO 8601).

idstring

The slug — the universe's handle in `?universe=`.

namestring

Display label.

descriptionstring

Free-form notes; `""` when unset.

tickersarray

Members.

sizenumber

Member count.

systemboolean

`true` for a built-in universe, `false` for one you created.

effective_atnumber

System universes only: when this membership took effect.

next_rebalance_atnumber

System universes only: when membership is next recomputed.

created_atnumber

Creation timestamp.

updated_atnumber

Last modification timestamp.

rebalance_methodstring

System universes only: how membership is chosen.

Status codes

200
The universe doc.
400
Malformed universe slug (must match ^[a-z][a-z0-9_]{0,62}$).
404
not_found.

Notes

  • A SYSTEM universe carries four fields your own do not: effective_at (when this membership took effect), next_rebalance_at, rebalance_method, and system: true. Built-ins are rebalanced monthly, so a scan scoped to top_100 is scoped to that month's members — pin membership by copying the list into a universe of your own.