- TWAP orders, from Create TWAP order.
identity.kindisorder. - TWAP order strategies, from Create order strategy with
strategy_typetwap.identity.kindisstrategy.
Query Parameters
| Field | Type | Need | Description | Example |
|---|---|---|---|---|
”account” | string | required | Account address to filter TWAPs | 42trU9A5… |
“limit” | integer | optional | Maximum number of records to return, default to 100. Values outside 1 to 500 are clamped to that range | 100 |
”cursor” | string | optional | The next_cursor from the previous page. Default to none | 3vQB7B6M… |
Response
- Status 200: Successfully retrieved TWAP records
| Field | Type | Description |
|---|---|---|
”identity” | object | Where 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” | string | Trading pair symbol |
”side” | string | Whether the TWAP is a bid or an ask |
”initial_amount” | decimal string | Total amount (in token denomination) of the TWAP |
”filled_amount” | decimal string | Amount (in token denomination) filled so far |
”average_fill_price” | decimal string or null | Average fill price. null if nothing has filled |
”reduce_only” | boolean | If each slice is reduce only |
”duration_seconds” | integer | For 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” | boolean | If slice sizes and timing are randomized. Always false for an order |
”slippage_percent” | decimal string or null | Maximum slippage for each slice, in percent. null for a strategy that uses the default |
”price_limit” | decimal string or null | Price limit of a strategy. Always null for an order |
”number_of_clips” | integer | Number of planned slices. For an order, this is planned_sub_order_count |
”placed_clip_count” | integer | Number 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 null | Always null here. See Get TWAP record history |
”created_at_ms” | integer | Timestamp in milliseconds when the TWAP was created |
”updated_at_ms” | integer | Timestamp in milliseconds when the TWAP was last updated |
”capabilities” | array of strings | What 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 null | Next cursor for pagination |
’has_more’ | boolean | True if there exists a ‘next_cursor’ |
0.121000000000000000.
- Status 400: Invalid request parameters or cursor
- Status 500: Internal server error