Instructions
API Reference
DraftLast reviewed 2026-06-23Deal instruction lifecycle — create, claim, and execute
Create a deal instruction
Creates a new instruction in PENDING status assigned to a book or specific trader.
Execute an instruction item
Links an item to a deal and marks it EXECUTED. Updates parent instruction status.
Claim an instruction item
Claims a PENDING item for the authenticated trader. Returns 409 if already claimed.
Claim an instruction
Claims a PENDING instruction for the authenticated trader. Returns 409 if already claimed.
Get an instruction by ID
Returns the instruction and all associated items in sequence order.