Generate Preview

post

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

The Generate Preview API submits an account and its strategy to create a preview of
an optimized portfolio. This endpoint synchronously returns the generated orders for
the account, utilizing cached market data and relaxing certain constraints to quickly
provide a preview of the expected orders. Note that the Trade constraint is not enforced, when generating a preview.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

account

object

required

optimizer_params

object

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.

fixed_cost_per_trade

number

≥ 0

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

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).

organization_id

string | null

Organization identifier, taken from the authenticated Moment-Organization request header. A value supplied in the request body is ignored.

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.

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