Skip to main content
GET
Get TWAP order by ID

Authorizations

X-Monaco-Signature
string
header
required

Ed25519 session-key request signing. Every authenticated request carries three headers: X-Monaco-PublicKey (64-char lowercase-hex session public key), X-Monaco-Timestamp (Unix milliseconds, within 30s of server time), and X-Monaco-Signature (hex ed25519 signature). The signature is over METHOD\npath?query\ntimestamp_ms\nSHA256_hex(body), where the body hash is the SHA-256 of the empty byte string when there is no body. Obtain the session keypair from POST /api/v1/auth/challenge followed by POST /api/v1/auth/verify.

Path Parameters

twapOrderId
string
required

Response

OK

twapOrderId
string<uuid> | null

TWAP parent order UUID

tradingPairId
string<uuid> | null

Trading pair UUID

side
string | null

Order side: BUY or SELL

Example:

"BUY"

tradingMode
string | null

Trading mode: SPOT or MARGIN

Example:

"SPOT"

totalQuantity
string | null

Total quantity requested

Example:

"10"

executedQuantity
string | null

Quantity executed so far across all child orders

Example:

"4.5"

executedNotional
string | null

Notional (quote) value executed so far

Example:

"157500.00"

averageFillPrice
string | null

Volume-weighted average fill price (executedNotional / executedQuantity); absent until the first fill

Example:

"35000.00"

progress
string | null

Execution progress as a decimal fraction (executedQuantity / totalQuantity, 0 to 1)

Example:

"0.45"

limitPrice
string | null

Parent-level limit price; absent when only the slippage band protects child orders

Example:

"35000.00"

slippageToleranceBps
integer<int32> | null

Per-slice protective price band in basis points

Example:

100

reduceOnly
boolean | null

Whether the parent is reduce-only

Example:

false

marginAccountId
string<uuid> | null

Margin account UUID for margin TWAP orders

riskBucketId
string<uuid> | null

Isolated risk bucket UUID for risk-bucket-scoped margin TWAP orders

leverage
string | null

Leverage for margin TWAP orders

Example:

"5"

useMasterBalance
boolean | null

Whether child orders use the master account balance

Example:

false

strategyKey
string | null

Strategy key used to group risk buckets

clientTwapId
string | null

Client-assigned idempotency key

randomize
boolean | null

Whether seeded size/timing randomization is applied to the schedule

Example:

true

startTime
string | null

Window start (ISO 8601)

Example:

"2026-08-01T10:00:00Z"

endTime
string | null

Window end (ISO 8601). Execution stops hard at this time.

Example:

"2026-08-01T11:00:00Z"

intervalMs
integer<int64> | null

Derived base slice interval in milliseconds (stored for audit)

Example:

30000

plannedSlices
integer<int32> | null

Number of slices in the planned schedule

Example:

120

slicesPlaced
integer<int32> | null

Number of child orders placed so far

Example:

54

slicesSkipped
integer<int32> | null

Number of slices skipped or failed so far (limit price through the market, self-trade prevention, halted market, failed admission). Skips never terminate the parent; the deficit flows into catch-up.

Example:

2

nextSliceAt
string | null

Planned time of the next slice (ISO 8601); absent once the parent is terminal

Example:

"2026-08-01T10:27:30Z"

state
string | null

Parent state: PENDING, ACTIVE, COMPLETED, or CANCELLED

Example:

"ACTIVE"

terminalReason
string | null

Terminal cause detail, e.g. an end-of-window shortfall ('ended with shortfall '); absent for non-terminal parents

createdAt
string | null

Creation timestamp (ISO 8601)

Example:

"2026-08-01T09:59:58Z"

updatedAt
string | null

Last update timestamp (ISO 8601)

cancelledAt
string | null

Cancellation timestamp (ISO 8601)

completedAt
string | null

Completion timestamp (ISO 8601)

executionStyle
string | null

Child execution style: TAKER (banded MARKET slices) or PASSIVE (post-only children at the touch with a taker sweep at each slice deadline)

Example:

"TAKER"

triggerPrice
string | null

Price-triggered activation level, when this parent is conditional

triggerDirection
string | null

Trigger crossing direction: ABOVE or BELOW

conditionalExpiry
string | null

Deadline for the trigger to fire (ISO 8601 UTC); reaching it cancels the parent with terminal reason 'trigger expired'

triggeredAt
string | null

When the trigger fired and the floating window started (ISO 8601 UTC); unset while waiting