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_symbol + ticker — supply one shape or the other, not both (exchange is still accepted as a deprecated alias of exchange_symbol). The call is idempotent: constituents already present are reported under alreadyPresent, and identifiers that cannot be resolved are returned under notFound, each with a reason.

exchange_symbol + ticker resolves to the listing trading under that ticker today. To add a delisted name, or the original company behind a ticker that has since been reused, give the item an as_of date (YYYY-MM-DD) on which the ticker identified the listing you mean, or identify it by ortex_tid. A top-level as_of applies to every exchange_symbol + ticker item without its own. An undated ticker that only matches a past listing comes back in notFound with reason historicalListingOnly. Check active on each added constituent to see whether the listing still trades.

On a Quant key, an add that would push the universe over 250 constituents is rejected with 409 universeSizeExceeded and no constituents are added. The same limit applies when a universe is read: a Quant key cannot query a universe of more than 250 constituents with the bulk endpoints (for example one built on a higher plan). 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*
date

Default as_of (YYYY-MM-DD) for every exchange_symbol + ticker item that does not carry its own.

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