> ## Documentation Index
> Fetch the complete documentation index at: https://docs.archer.exchange/llms.txt
> Use this file to discover all available pages before exploring further.

# Modify a limit order

> Resize keeps the order id; a price change is cancel+place and yields a new id. Built as strict level ops on the owner's book (`UpdateBookLimit`): the tx fails if the order's resting size changed since it was read — refetch and retry.

**Spread guard (post-only):** unless `crossSpread` is true, a modify that grows a level — a reprice, or a size increase — at/above the best registered ask (buy) or at/below the best registered bid (sell) is rejected with `CROSSES_SPREAD`, as the program does on-chain. Shrinking an order never crosses, so a size-only decrease is always allowed.



## OpenAPI

````yaml /openapi.json put /v1/order/limit
openapi: 3.0.3
info:
  description: >-
    REST API for the Archer Exchange — a high-performance Solana-based order
    book exchange.


    All monetary values (prices, sizes, fees) are returned as decimal strings
    for precision.


    ### Rate Limiting

    All endpoints are rate-limited via a token-bucket algorithm. When the limit
    is exceeded, the API returns `429 Too Many Requests`.


    ### Error Format

    All errors follow a consistent JSON format:

    ```json

    {
      "error": "ERROR_CODE",
      "message": "Human-readable description"
    }

    ```


    ### Handling errors

    Every error falls into one of five actions. REST errors come back as
    `{"error": CODE, "message"}`. A transaction that fails on-chain reports
    `{"InstructionError": [index, {"Custom": code}]}`; codes are the `errors`
    list of the program IDL (`archer-sdk/idl/archer_v1.json`). When a build
    endpoint's preflight catches an on-chain error first, it returns `400
    INVALID_PARAMS` with the reason in `message`.


    | Action | REST | On-chain (code) |

    |---|---|---|

    | **Retry as is**, with backoff | `RATE_LIMITED` (429),
    `SERVICE_UNAVAILABLE` (503), `INTERNAL_ERROR` (500); relay `OVERLOADED`,
    `PREFLIGHT_UNAVAILABLE`. Keep backing off on 429: 50 of them within a minute
    from one IP returns `BANNED` (403) for 10 minutes | none |

    | **Refetch, rebuild, retry**: the book or registry changed under you | |
    `LevelSizeMismatch` (527), `StaleSequenceNumber` (509),
    `SequenceNumberTooFarAhead` (522), `RegistryBooksMismatch` (525),
    `IncompleteMakerBooks` (513), `NoMatchingLiquidity` (507); relay status
    `expired` (re-sign with a fresh blockhash) |

    | **Reprice** | `CROSSES_SPREAD`, `SLIPPAGE_EXCEEDED` | `PostOnlyWouldCross`
    (524), `CrossingOrderLevels` (505), `InvalidPrice` (503),
    `SlippageToleranceExceeded` (703) |

    | **Resize** | `INSUFFICIENT_LIQUIDITY` (the body's `availableSize` is what
    fits) | `MakerBookSideFull` (528: cancel a level first),
    `InvalidSizeAtLevel` (506), `InsufficientBalance` (402) and SPL Token `1`
    (fund the account or shrink), `ZeroSwapAmount` (702) |

    | **Stop**: fix the request or the setup; retrying cannot help |
    `INVALID_PARAMS`, `MISSING_API_KEY` / `INVALID_API_KEY` (401), `FORBIDDEN`,
    `NOT_FOUND`, `MARKET_NOT_FOUND`, `METHOD_NOT_ALLOWED`; `MARKET_PAUSED` /
    `MARKET_FROZEN` until the market resumes |
    `UnauthorizedArcherAccountDelegate` (1001), `BuilderFeeExceedsAccountCap`
    (1003), `UnauthorizedMaker` (502), `MakerNotRegistered` (512),
    `PostOnlyRequiresLimitOrderBook` (526), `MarketNotActive` (107),
    `MarketFrozen` (114); any 200–399 code (wrong account wiring, a bug to
    report) |
  title: Archer Exchange API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.archer.exchange
  - description: Staging
    url: https://api-staging.archer.exchange
  - description: Local
    url: http://localhost:8080
security:
  - apiKey: []
tags:
  - description: Discover and inspect available trading markets
    name: Markets
  - description: Token metadata for every mint Archer lists
    name: Tokens
  - description: Get price quotes before placing an order
    name: Quote
  - description: Build unsigned Solana transactions for swaps
    name: Orders
  - description: Build unsigned Solana transactions for limit orders
    name: Limit Orders
  - description: >-
      ArcherAccount — a wallet's delegated trading identity. Collateral sits in
      token accounts owned by the account PDA; an authorized delegate can trade
      and quote as the account but never withdraw.
    name: Account
  - description: Read a maker book — balances and resting levels — by PDA or by owner
    name: Maker Books
  - description: Deposit / withdraw / close — fund movement for a maker book
    name: Maker Funds
  - description: Public protocol-wide aggregate statistics
    name: Stats
  - description: >-
      Submit signed Solana transactions and let Archer land them. Hosted at
      `https://send.archer.exchange`, separate from the REST API, using the same
      API key.
    name: Transaction Relay
paths:
  /v1/order/limit:
    put:
      tags:
        - Limit Orders
      summary: Modify a limit order
      description: >-
        Resize keeps the order id; a price change is cancel+place and yields a
        new id. Built as strict level ops on the owner's book
        (`UpdateBookLimit`): the tx fails if the order's resting size changed
        since it was read — refetch and retry.


        **Spread guard (post-only):** unless `crossSpread` is true, a modify
        that grows a level — a reprice, or a size increase — at/above the best
        registered ask (buy) or at/below the best registered bid (sell) is
        rejected with `CROSSES_SPREAD`, as the program does on-chain. Shrinking
        an order never crosses, so a size-only decrease is always allowed.
      operationId: modifyLimitOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyLimitOrderRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitOrderActionResponse'
          description: Unsigned transaction built.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Invalid parameters (bad price/size, crossed/full book, 16-level cap,
            etc.), or the resulting price crosses the spread with
            crossSpread=false (error CROSSES_SPREAD).
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Missing or invalid API key.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Maker book or order not found.
components:
  schemas:
    ModifyLimitOrderRequest:
      description: >-
        Provide at least one of newPrice / newSize. Resize keeps the id; a price
        change yields a new id.
      properties:
        crossSpread:
          default: false
          description: >-
            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.
          type: boolean
        newPrice:
          example: '151.25'
          nullable: true
          type: string
        newSize:
          example: '2.0'
          nullable: true
          type: string
        orderId:
          description: Opaque order id returned at placement.
          type: string
        signer:
          description: >-
            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.
          type: string
        withInstructions:
          default: false
          description: >-
            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.
          nullable: true
          type: boolean
      required:
        - orderId
      type: object
    LimitOrderActionResponse:
      description: >-
        Unsigned tx for the owner to sign, plus affected order ids, action
        targeting, and auto-funded collateral.
      properties:
        addressLookupTables:
          items:
            type: string
          type: array
        anchorMidTicks:
          description: >-
            The book's mid anchor in ticks. Always 0 for limit-order books: a
            level's offset is its absolute price tick.
          format: int64
          type: integer
        depositBaseLots:
          format: int64
          type: integer
        depositQuoteLots:
          format: int64
          type: integer
        expiresAt:
          format: int64
          type: integer
        includesDeposit:
          type: boolean
        instructions:
          allOf:
            - $ref: '#/components/schemas/TransactionInstructions'
          description: >-
            Unsigned instructions, present only when the request set
            `withInstructions`.
          nullable: true
        nextSequenceNumber:
          description: The maker-book sequence number this tx writes.
          format: int64
          type: integer
        orderIds:
          items:
            type: string
          type: array
        price:
          description: >-
            Human price (quote per base) the order rests/rested at. Absent for
            cancel-all.
          nullable: true
          type: string
        requiredBaseLots:
          description: >-
            Total base lots the resulting book state requires as collateral (the
            program's update_book solvency check).
          format: int64
          type: integer
        requiredQuoteLots:
          description: Total quote lots required, including the positive-maker-fee buffer.
          format: int64
          type: integer
        side:
          description: Side this action targets. Absent for cancel-all.
          enum:
            - buy
            - sell
          nullable: true
          type: string
        size:
          description: >-
            Human base-token size the action targets — placed size (place), new
            size (modify), or canceled size (cancel-one). Absent for cancel-all.
          nullable: true
          type: string
        transaction:
          description: >-
            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.
          type: string
      required:
        - transaction
        - orderIds
        - requiredBaseLots
        - requiredQuoteLots
        - nextSequenceNumber
        - anchorMidTicks
        - includesDeposit
        - depositBaseLots
        - depositQuoteLots
        - expiresAt
        - addressLookupTables
      type: object
    ErrorResponse:
      properties:
        error:
          description: Machine-readable error code.
          enum:
            - INVALID_PARAMS
            - MARKET_NOT_FOUND
            - MARKET_PAUSED
            - INSUFFICIENT_LIQUIDITY
            - SLIPPAGE_EXCEEDED
            - NOT_FOUND
            - FORBIDDEN
            - RATE_LIMITED
            - INTERNAL_ERROR
            - SERVICE_UNAVAILABLE
            - MARKET_FROZEN
            - CROSSES_SPREAD
            - MISSING_API_KEY
            - INVALID_API_KEY
            - BANNED
            - METHOD_NOT_ALLOWED
          type: string
        message:
          description: Human-readable error description.
          type: string
      required:
        - error
        - message
      type: object
    TransactionInstructions:
      description: >-
        The instruction form of a built transaction, for callers that assemble
        and sign their own — their own fee strategy, their own lookup tables, or
        bundling Archer's instructions with their own.


        Returned only when the request sets `withInstructions`. The accompanying
        `transaction` is still built and still valid; these are the same
        instructions it contains, so signing one or composing the other are
        equivalent (the backend asserts this: rebuilding these instructions
        compiles to a byte-identical message). They also reflect the same
        maker-book selection the quote was computed from, so a caller that
        re-composes them gets the quoted price.
      properties:
        addressLookupTables:
          description: >-
            Lookup tables the instructions assume. None are configured; always
            empty today.
          items:
            type: string
          type: array
        computeBudgetInstructions:
          description: >-
            Compute-unit limit and price, kept separate so you can drop them and
            substitute your own fee strategy without touching the rest.
          items:
            $ref: '#/components/schemas/SerializedInstruction'
          type: array
        instructions:
          description: >-
            Archer's instructions, in the order they must execute. Any ATA
            creation and WSOL wrap/unwrap are included.
          items:
            $ref: '#/components/schemas/SerializedInstruction'
          type: array
        signer:
          description: The account that must sign and pay the fee.
          type: string
      required:
        - computeBudgetInstructions
        - instructions
        - signer
        - addressLookupTables
      type: object
    SerializedInstruction:
      description: One instruction.
      properties:
        accounts:
          items:
            $ref: '#/components/schemas/InstructionAccount'
          type: array
        data:
          description: Base64-encoded instruction data.
          type: string
        programId:
          type: string
      required:
        - programId
        - accounts
        - data
      type: object
    InstructionAccount:
      description: >-
        One account an instruction touches, in the shape `@solana/web3.js` and
        `@solana/kit` already accept.
      properties:
        isSigner:
          type: boolean
        isWritable:
          type: boolean
        pubkey:
          type: string
      required:
        - pubkey
        - isSigner
        - isWritable
      type: object
  securitySchemes:
    apiKey:
      in: header
      name: X-API-Key
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.