Skip to main content

Build Modify REST API Endpoint

Build batch modify action. Returns hash to sign with summary of order modifications.

Updated on
May 19, 2026
info

Exchange API calls do not consume Quicknode API credits. Transactions through this endpoint are appended with a builder fee. See hyperliquidapi.com for a full breakdown. To white-label with your own builder code, contact us.


Body Parameters

action
object
REQUIRED

Batch modify action object

type
string

Action type ("batchModify")

modifies
array

Array of order modifications

oid
integer

Order ID to modify

order
object

New order parameters in wire format

a
string

Asset name (e.g., "BTC", "ETH") or asset index as integer (0, 1, etc.)

b
boolean

Buy side (true for buy, false for sell)

p
string

New limit price as a stringified number

s
string

New size/quantity as a stringified number

r
boolean

Reduce-only flag

t
object

Order type specification

limit
object

Limit order type

tif
string

Time in force ("Gtc", "Ioc", "Alo")

vaultAddress
string

Optional vault address

expiresAfter
integer

Optional expiration timestamp (ms)

Returns

hash
string

Hash to sign with wallet (0x-prefixed hex string)

nonce
integer

Unique nonce for this action (timestamp in milliseconds)

action
object

Processed batchModify action object in wire format

type
string

Action type ("batchModify")

modifies
array

Array of order modifications in wire format

oid
integer

Order ID to modify

order
object

Modified order parameters in wire format

a
integer

Asset index (0 for BTC, 1 for ETH, etc.)

b
boolean

Buy side (true for buy, false for sell)

p
string

New limit price as a stringified number

s
string

New size/quantity as a stringified number

r
boolean

Reduce-only flag

t
object

Order type specification

limit
object

Limit order type

tif
string

Time in force ("Gtc", "Ioc", "Alo")

summary
string

Human-readable summary of order modifications (e.g., "Modifying 1 BTC order (OID: 123456789)")

assets
array

Array of asset information for the orders being modified

index
integer

Asset index (0 for BTC, 1 for ETH, etc.)

name
string

Asset name (e.g., "BTC", "ETH")

isSpot
boolean

Whether this is a spot market asset

szDecimals
integer

Number of decimal places for size/quantity

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free