Add constituents

API QuantAPI Developer

Add one or more constituents to a universe you own. Identify each by ortex_tid (ORTEX tradeable item id) or by exchange + ticker — supply one shape or the other, not both. The call is idempotent: constituents already present are reported under alreadyPresent, and identifiers that cannot be resolved are returned under notFound.

On a Quant key, an add that would push the universe over 250 constituents is rejected with 409 universeSizeExceeded and no constituents are added. Developer and Professional keys are unlimited.

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:

  • Added: Constituents newly added by this request (full detail).
  • Already Present: Identifiers that were already in the universe (no-op).
  • Not Found: Identifiers that could not be resolved to a trading item.

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

Path Params
string
required

Universe name (unique per user, case-insensitive, no spaces).

Body Params

Request body for adding or removing constituents.

constituents
array of objects
required

A non-empty list of constituent identifiers.

constituents*
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

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