List your universes

API QuantAPI Developer

List every universe you own. A universe is a named set of trading items you maintain yourself and then reference from the ORTEX bulk data endpoints.

Universe maintenance requires a Quant, Developer or Professional API plan. Trader, Custom and Enterprise keys, and the TEST trial key, are rejected with 403 insufficientSubscription. Quant keys may hold up to 250 constituents per universe; Developer and Professional keys are unlimited. Every call costs a flat 0.1 credits.

Available Data Points:

  • Name: The universe name — unique per user (case-insensitive).
  • Constituent Count: The number of trading items currently in the universe.
  • Created At: When the universe was created (ISO-8601 UTC).
  • Updated At: When the universe was last modified (ISO-8601 UTC).

Maintaining a universe

  • Create: POST /api/v11/universes/ with a JSON body {"name": "my_universe"}.
  • Add constituents: POST /api/v11/universes/my_universe/constituents/ with a list of identifiers (ortex_tid, or exchange + ticker).
  • List / verify: GET /api/v11/universes/my_universe/constituents/ to review the members.
  • Use it: Pass the universe name to the bulk data endpoints, e.g. /api/v11/universe/<endpoint>/?universe=my_universe&date=YYYY-MM-DD.
  • Rename / delete: PATCH or DELETE /api/v11/universes/my_universe/ to rename or remove it.

Paid key required: These endpoints act on universes owned by your ORTEX account, so the TEST trial key cannot be used with them — a request carrying it is rejected with 403 insufficientSubscription.

Get full access! Get a key at app.ortex.com/apis

Query Params
integer

Page number within the paginated result set. Must be >= 1. Defaults to 1.

integer

Number of rows per page. The default and the maximum allowed depend on the API tier; values above the tier maximum are clamped down to it.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json