Create a Model Order

post

https://sandbox-api.monark-markets.com/primary/v1/omnibus/model-order

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Model order submission details, including the individual investor orders in the aggregate block.

Request model for submitting an aggregated Omnibus model order.

referenceId

string

required

length between 1 and 100

Partner-submitted aggregate order reference. Must be unique per partner.

modelId

string | null

Optional client model or rebalance identifier.

omnibusFundId

uuid

required

length ≥ 1

Registered fund being traded.

omnibusShareClassId

uuid

required

length ≥ 1

Share class being traded. Must belong to the omnibus fund.

financialInstitutionId

uuid

required

length ≥ 1

Financial institution whose investor accounts are included in this aggregate order.

side

string

enum

required

Aggregate order side: buy or sell.

Allowed:

currency

string

required

length ≥ 1

Order currency. Only USD is supported for the first version.

distributionElection

string

enum

required

Distribution election used as part of the position identity.

Allowed:

taxLotElection

string

enum

required

Tax lot election for sell order handling.

Allowed:

orders

array of objects

required

length ≥ 1

Individual investor orders included in the aggregate model order.

orders*

Individual investor order inside an Omnibus model order create request.

referenceId

string

required

length between 1 and 100

Partner-submitted individual order reference. Must be unique per partner.

accountId

uuid

required

length ≥ 1

Monark account identifier. Primary resolves the compatibility investor from this account.

financialAdvisorId

uuid | null

Optional financial advisor associated with the investor's financial institution.

quantity

double | null

Share quantity. Required for sell model orders and omitted for buy model orders.

notionalAmount

double | null

Dollar notional amount. Required for buy model orders and omitted for sell model orders.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Model order was accepted and persisted.

400Model order was rejected because the request or referenced data is invalid.

409Model order was rejected because of a conflicting state, such as a duplicate reference, unmet required order actions, unavailable holdings, or a risk-control limit.