Skip to main content
POST

Authorizations

API-Key
string
header
required

The "API-Key" header should contain your API key.

API-Sign
string
header
required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Body

application/json
nonce
integer<int64>
required

Nonce used in construction of API-Sign header

strategy_type
enum<string>
required

Strategy type. twap is the only supported value today.

Available options:
twap
symbol
string
required

Asset pair id or altname, e.g. BTC/USD or XBTUSD.

asset_class
enum<string>
required

Standard spot pairs. Tokenized assets and synthetic pairs are not supported for Spot TWAP creation.

Available options:
forex
side
enum<string>
required

Direction of the strategy.

Available options:
buy,
sell
volume
string
required

Total quantity to execute over the strategy horizon, in base currency.

ordertype
enum<string>
required

Order type of the child orders:

  • market = child orders execute at the market price
  • limit = child orders are limited by price
Available options:
market,
limit
expiretm
string
required

Strategy end time. Must be in the future, at least 60 seconds after the resolved starttm, and no more than 30 days from now.

  • +<n> = end <n> seconds from now
  • <n> = unix timestamp (seconds) of the end time
validate
boolean
default:false

If true, validate the request without creating or submitting the strategy. The response returns an empty strategy_id. The creation-time balance check is not run.

price
string

Limit price of the child orders. Required when ordertype is limit. Must be omitted when ordertype is market.

starttm
string
default:0

Strategy start time. Defaults to now. Must be no more than 30 days from now.

  • 0 = now (default)
  • +<n> = start <n> seconds from now
  • <n> = unix timestamp (seconds) of the start time

Response

200 - application/json

Strategy accepted.

result
StrategyAdded · object
error
string[]

Kraken API error