tickerbot.io

Update a universe

PATCHhttps://api.tickerbot.io/v2/universes/{universe}

Updates one of your universes: its name, description or members.

stringrequired

Universe slug.

array

Replace the full ticker list (up to 10,000; validated against the tickers we track). Does not combine with add/remove (400).

array

Add these tickers (deduplicated).

array

Remove these tickers.

string

New label. Non-empty, max 80 characters.

string

New notes. Max 500 characters.

as_ofstring

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

idstring

The slug: the universe's handle in ?universe=.

namestring

Display label.

descriptionstring

Free-form notes; "" when unset.

tickersarray

Members, after this call.

sizenumber

Member count.

kindstringenum

Always custom here: a universe you create or edit is yours.

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

Creation timestamp (epoch seconds).

updated_atnumber

Last modification timestamp (epoch seconds).

effective_atnumber

Built-in universes only, in epoch seconds; absent on yours.

next_rebalance_atnumber

Built-in universes only, in epoch seconds; absent on yours.

rebalance_methodstring

Built-in universes only; absent on yours.

CodeMeaning
200Updated universe doc.
400Malformed 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.
403system_universe_immutable: built-in universes are read-only.
404not_found.