Submit Optimization

post

https://live.moment-api.com/v1/optimization/

The Submit Optimization API submits a set of accounts and their strategies to generate an optimized portfolio.

The API returns an optimization ID that can be used to check the status of the optimization and retrieve the orders generated by the optimization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

accounts

array of objects

required

Accounts*

allow_sell_universe_constraint_violations

boolean

Defaults to false

When true, the optimizer is allowed to keep existing holdings that violate sell-universe constraints (no forced sells purely to clear universe violations). Mirrored onto every account in the request.

batch_id

string | null

^[A-Za-z0-9_-]+$

An optional batch ID to group optimizations together. This can be used to easily identify optimizations that were submitted together. Must contain only alphanumeric characters, hyphens, and underscores.

fixed_cost_per_trade

number

An optional fixed cost per trade to apply to the optimization.

limit_price_buffer

double

An optional limit price buffer to apply to the optimization. This is a percentage value that will be added to the limit price of all the orders.

optimization_source

string | null

enum

Origin tag for the request, recorded for audit and used by downstream filtering. Taken from the Moment-Optimization-Source request header, falling back to a per-route default when that header is absent or unrecognized; a value supplied in the request body is ignored.

optimizer_params

object

required

All-nullable variant of OptimizerParams used as request input — every field is omittable so callers can override only what they care about. The runtime merges the supplied values over the deployment defaults to produce the inner OptimizerParams.

organization_id

string | null

Organization identifier, taken from the authenticated Moment-Organization request header. A value supplied in the request body is ignored; responses that serve a stored request payload back report the header-derived value.

parent_organization_id

string | null

Parent organization identifier, taken from the authenticated Moment-Parent-Organization request header. A value supplied in the request body is ignored; responses that serve a stored request payload back report the header-derived value.

timestamp

date-time | null

An optional historical timestamp at which to run the optimization. The timestamp's date must be between 2024-05-01 and the current date, and the timestamp's time must be between 09:35 AM and 4:00 PM Eastern Time.

valuation_config

object | null

Valuation configuration the caller resolved for the requesting org,
typically a proposal's. If absent, the optimizer resolves the org's
configuration itself.

Response

Language

Credentials

Bearer

URL

Loading…

Response

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

application/json

200Successful Response