Skip to main content
PUT
Modify a limit order

Authorizations

X-API-Key
string
header
required

Body

application/json

Provide at least one of newPrice / newSize. Resize keeps the id; a price change yields a new id.

orderId
string
required

Opaque order id returned at placement.

crossSpread
boolean
default:false

When false (default), a modify that grows a level — a reprice, or a size increase — to a price that crosses the spread (a buy at/above the best registered ask, a sell at/below the best registered bid) is rejected with CROSSES_SPREAD, and the tx is sent post-only. Size decreases are never rejected. Set true to keep a spread-crossing order.

newPrice
string | null
Example:

"151.25"

newSize
string | null
Example:

"2.0"

signer
string

The wallet that signs, for an order on an ArcherAccount-owned book: the account's owner or delegate. Omit for a wallet-owned order, which its maker signs. Existing clients may keep sending it as authority; send one name only.

withInstructions
boolean | null
default:false

Also return the unsigned instructions under instructions, for composing your own transaction instead of signing ours. Omitted or false leaves the response exactly as it was.

Response

Unsigned transaction built.

Unsigned tx for the owner to sign, plus affected order ids, action targeting, and auto-funded collateral.

addressLookupTables
string[]
required
anchorMidTicks
integer<int64>
required

The book's mid anchor in ticks. Always 0 for limit-order books: a level's offset is its absolute price tick.

depositBaseLots
integer<int64>
required
depositQuoteLots
integer<int64>
required
expiresAt
integer<int64>
required
includesDeposit
boolean
required
nextSequenceNumber
integer<int64>
required

The maker-book sequence number this tx writes.

orderIds
string[]
required
requiredBaseLots
integer<int64>
required

Total base lots the resulting book state requires as collateral (the program's update_book solvency check).

requiredQuoteLots
integer<int64>
required

Total quote lots required, including the positive-maker-fee buffer.

transaction
string
required

Base64 unsigned VersionedTransaction in its wire encoding: a v0 message when the write fits 1232 bytes, otherwise a v1 (SIMD-0385) message, which a full maker registry needs. A v1 transaction must be sent base64-encoded and signed by a wallet that supports version 1.

instructions
object | null

Unsigned instructions, present only when the request set withInstructions.

price
string | null

Human price (quote per base) the order rests/rested at. Absent for cancel-all.

side
enum<string> | null

Side this action targets. Absent for cancel-all.

Available options:
buy,
sell
size
string | null

Human base-token size the action targets — placed size (place), new size (modify), or canceled size (cancel-one). Absent for cancel-all.