Update a universe
https://api.tickerbot.io/ v2/ universes/ {universe}Updates one of your universes: its name, description or members.
Path parameters
stringrequiredUniverse slug.
Body parameters
arrayReplace the full ticker list (up to 10,000; validated against the tickers we track). Does not combine with add/remove (400).
arrayAdd these tickers (deduplicated).
arrayRemove these tickers.
stringNew label. Non-empty, max 80 characters.
stringNew notes. Max 500 characters.
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, after this call.
sizenumberMember count.
kindstringenumAlways custom here: a universe you create or edit is yours.
builtin | A built-in universe, the same for every account: top_10 and top_100. Read-only. |
custom | One of your own universes. |
created_atnumberCreation timestamp (epoch seconds).
updated_atnumberLast modification timestamp (epoch seconds).
effective_atnumberBuilt-in universes only, in epoch seconds; absent on yours.
next_rebalance_atnumberBuilt-in universes only, in epoch seconds; absent on yours.
rebalance_methodstringBuilt-in universes only; absent on yours.
Status codes
| Code | Meaning |
|---|---|
200 | Updated universe doc. |
400 | Malformed universe slug; an unknown body key (strict: unknown fields are rejected, not ignored); a non-array tickers/add/remove field; tickers combined with add/remove; an over-cap name (80 chars) or description (500 chars); an oversized universe (10,000); or unknown_tickers (with a disallowed array) for symbols we don't track. |
403 | system_universe_immutable: built-in universes are read-only. |
404 | not_found. |