← tickerbot.io
View as markdown
Endpoints › Universes

Update a universe

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

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

Body parameters

stringrequired

Universe slug.

string

New label. Non-empty, max 80 characters.

string

New notes. Max 500 characters.

array

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

array

Add these tickers (deduplicated).

array

Remove these tickers.

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, after this call.

sizenumber

Member count.

systemboolean

`false` — this is your universe.

created_atnumber

Creation timestamp.

updated_atnumber

Last modification timestamp.

effective_atnumber

System universes only; absent on yours.

next_rebalance_atnumber

System universes only; absent on yours.

rebalance_methodstring

System universes only; absent on yours.

Status codes

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
Cannot edit a system universe.
404
not_found.

Notes

  • To add or remove ticker subsets without replacing the full list, pass { add: [...], remove: [...] } instead of tickers. The two forms do not combine — sending tickers alongside add/remove is a 400.
  • The body is strict: unknown keys are rejected with a 400 rather than ignored. Same caps as create — name 80 chars, description 500 chars, tickers 10,000 symbols.