Skip to main content
POST
Build a signable take-profit / stop-loss update intent

Body

application/json
trader
string
required

The trader (position owner). USDC collateral is pulled from and paid out to this address.

tradeIndex
integer
required

Position slot index for this trader + pair (0-based; a trader can hold several positions on the same pair). Read it from GET /v2/positions → trades[].trade.index.

Required range: x >= 0
takeProfit
required

Take-profit price in USD. 0 or omitted = no take-profit (0 also removes an existing one on updates).

stopLoss
required

Stop-loss price in USD. 0 or omitted = no stop-loss (0 also removes an existing one on updates).

pairIndex
integer

Pair index (alternative to pair).

Required range: x >= 0
pair
string

Pair symbol, e.g. ETH/USD (separators /, -, _ accepted; case-insensitive).

Minimum string length: 1
nonce

Replay-protection nonce (uint256; unordered Permit2-style bitmap, not sequential). A random one is generated when omitted — only pass a value to pre-reserve or deterministically retry an intent. Check availability via GET /v2/nonce.

deadlineMs

Intent expiry as a unix timestamp in MILLISECONDS (not seconds). Defaults to now + the service value shown in /v2/meta → defaults.intentDeadlineMs.

Response

Success envelope: ok is true and data carries the payload documented below.

ok
enum<boolean>
required

Always true on success.

Available options:
true
data
object
required

A ready-to-sign EIP-712 payload. Sign {domain, types, primaryType, message} with signTypedData (trader or a registered delegate, per signerRule) and hand the 65-byte r||s||v signature to the Avantis service that executes this intent kind.