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
- actionobjectREQUIRED
Batch modify action object
- typestring
Action type ("batchModify")
- modifiesarray
Array of order modifications
- oidinteger
Order ID to modify
- orderobject
New order parameters in wire format
- astring
Asset name (e.g., "BTC", "ETH") or asset index as integer (0, 1, etc.)
- bboolean
Buy side (true for buy, false for sell)
- pstring
New limit price as a stringified number
- sstring
New size/quantity as a stringified number
- rboolean
Reduce-only flag
- tobject
Order type specification
- limitobject
Limit order type
- tifstring
Time in force ("Gtc", "Ioc", "Alo")
- vaultAddressstring
Optional vault address
- expiresAfterinteger
Optional expiration timestamp (ms)
Returns
- hashstring
Hash to sign with wallet (0x-prefixed hex string)
- nonceinteger
Unique nonce for this action (timestamp in milliseconds)
- actionobject
Processed batchModify action object in wire format
- typestring
Action type ("batchModify")
- modifiesarray
Array of order modifications in wire format
- oidinteger
Order ID to modify
- orderobject
Modified order parameters in wire format
- ainteger
Asset index (0 for BTC, 1 for ETH, etc.)
- bboolean
Buy side (true for buy, false for sell)
- pstring
New limit price as a stringified number
- sstring
New size/quantity as a stringified number
- rboolean
Reduce-only flag
- tobject
Order type specification
- limitobject
Limit order type
- tifstring
Time in force ("Gtc", "Ioc", "Alo")
- summarystring
Human-readable summary of order modifications (e.g., "Modifying 1 BTC order (OID: 123456789)")
- assetsarray
Array of asset information for the orders being modified
- indexinteger
Asset index (0 for BTC, 1 for ETH, etc.)
- namestring
Asset name (e.g., "BTC", "ETH")
- isSpotboolean
Whether this is a spot market asset
- szDecimalsinteger
Number of decimal places for size/quantity