Skip to main content
DELETE
Cancel a limit order (one or all)

Authorizations

X-API-Key
string
header
required

Body

application/json

Cancel one order by id, OR all of an owner's orders on a market (all=true with market+owner).

accountOwner
string | null

The wallet that owns the ArcherAccount this request acts through. With platform it derives the account PDA server-side — you never handle a PDA. Omit for a plain wallet-owned book. Replaces the earlier archerAccount field, which is no longer read.

all
boolean
default:false
market
string | null

Required when all=true.

Example:

"u8tnfCb1JSSghuNFquQ2beStYgAN1kmd1f1Lhxbaec4"

orderId
string | null

Cancel a single order by id.

platform
enum<string> | null
default:self

Platform namespace for accountOwner. Ignored unless accountOwner is set.

Available options:
self,
treadfi
signer
string | null

The wallet that signs. Required when all is true. For a single order it is needed only when the order sits on an ArcherAccount-owned book (the account's owner or delegate); a wallet-owned order is signed by its maker. Existing clients may keep sending it as owner or authority; send one name only.

unwrapSol
boolean
default:false

With withdrawFreeFunds, also append a WSOL CloseAccount so a native-SOL market unwraps to lamports. No-op on non-native markets.

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.

withdrawFreeFunds
boolean
default:false

Cancel-one only. Append a MakerWithdrawFunds after the cancel so collateral freed by that order (computed exactly) returns to the owner's wallet in the same tx. Rejected with all=true — cancel-all only clears; withdraw via POST /v1/maker/withdraw.

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.