Skip to main content
Returns every TWAP on the account that hasn’t finished, as one list of records. The list merges two sources: Records are sorted by creation time, newest first. Only TWAP orders created through the API are listed. A new TWAP order can take a moment to appear. For finished TWAPs, use Get TWAP record history.

Query Parameters

FieldTypeNeedDescriptionExample
”account”stringrequiredAccount address to filter TWAPs42trU9A5…
“limit”integeroptionalMaximum number of records to return, default to 100. Values outside 1 to 500 are clamped to that range100
”cursor”stringoptionalThe next_cursor from the previous page. Default to none3vQB7B6M…

Response

  • Status 200: Successfully retrieved TWAP records
FieldTypeDescription
”identity”objectWhere the TWAP comes from. “kind” is “order” or “strategy”. An order has “order_id” (integer). A strategy has “strategy_id” (UUID) and “revision” (integer)
“symbol”stringTrading pair symbol
”side”stringWhether the TWAP is a bid or an ask
”initial_amount”decimal stringTotal amount (in token denomination) of the TWAP
”filled_amount”decimal stringAmount (in token denomination) filled so far
”average_fill_price”decimal string or nullAverage fill price. null if nothing has filled
”reduce_only”booleanIf each slice is reduce only
”duration_seconds”integerFor a strategy, the duration you set. For an order, the time from creation to expiration, which is about 30 seconds longer than duration_in_seconds
”randomize”booleanIf slice sizes and timing are randomized. Always false for an order
”slippage_percent”decimal string or nullMaximum slippage for each slice, in percent. null for a strategy that uses the default
”price_limit”decimal string or nullPrice limit of a strategy. Always null for an order
”number_of_clips”integerNumber of planned slices. For an order, this is planned_sub_order_count
”placed_clip_count”integerNumber of slices processed so far. For an order, this is past_sub_order_count
”status”string”pending”: a strategy waiting for its scheduled start
”active”: an order with no slice processed yet, or an armed strategy that isn’t placing slices yet
”running”: placing slices
”paused”: a strategy held by its price limit
”terminal_reason”string or nullAlways null here. See Get TWAP record history
”created_at_ms”integerTimestamp in milliseconds when the TWAP was created
”updated_at_ms”integerTimestamp in milliseconds when the TWAP was last updated
”capabilities”array of stringsWhat you can do with the TWAP now:
“cancel”: cancel an order with Cancel TWAP order, or a strategy with Cancel order strategy
”edit”: edit the strategy with Edit order strategy. Only before it starts placing orders, and not while paused
”timeline”: get the strategy’s events with Get order strategy timeline
’next_cursor’string or nullNext cursor for pagination
’has_more’booleanTrue if there exists a ‘next_cursor’
Amounts and slippage of an order record keep their stored decimal places, for example 0.121000000000000000.
  • Status 400: Invalid request parameters or cursor
  • Status 500: Internal server error

Code Example (Python)