Get portfolio details with order

Get portfolio details with a hypothetical order applied. This endpoint simulates the impact of placing an order on your portfolio without actually executing it. Useful for pre-trade risk assessment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int64

Market ID (uint16)

int64

Order size in steps (uint32)

int64

Order price in ticks (uint24, max 16777215)

int64

Order side: 0=Buy, 1=Sell

boolean
boolean
int64

Self-trade prevention: 0=ExpireMaker, 1=ExpireTaker, 2=ExpireBoth

int64

Order type: 0=Market, 1=Limit

int64

Time-in-force: 0=GTC, 1=GTT, 2=FOK, 3=IOC

int64

Optional builder ID (uint16, 0 = none)

string

Optional client order ID (uint64, 0 = none)

int64

Optional TTL units for GTT orders (uint16, 0 = none)

permit
object

Permit parameters for v3 authenticated operations.
Client signs EIP-712 VerifyWitness; server builds byte-packed permit suffix.
Uses bitmap nonces for replay protection.

int64

Per-order builder fee in parts per million, denominator 1e6 (uint16, 0 = none). 100 = 1 bps = 0.01%. 10 = 0.1 bps. Must not exceed the user-signed max for this builder (see ApproveBuilderFee). Setting this non-zero changes the signed action hash: builder_fee_bps must be encoded as an extra uint16 word right after builder_id (which is always part of the hash) and before client_order_id/ttl_units. Leave at 0 to use the hash layout without that word.

Responses

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