> ## Documentation Index > Fetch the complete documentation index at: https://docs.omnibook.xyz/llms.txt > Use this file to discover all available pages before exploring further. # Request a withdrawal > Closed schema (api.md §6A.2). `client_withdrawal_id` is the per-user idempotency key and must be **strictly increasing**: a fresh id (`> hwm`) is forwarded; an equal id (`== hwm`) is treated as an idempotent retry and returns the current phase; a stale id (`< hwm`) returns `409 stale_client_withdrawal_id`. `201` = freshly accepted; `200` = a phase report for a retry/known id. The gateway validates `dest` structurally only and forwards its casing verbatim for the funding port's EIP-55 check. ## OpenAPI ````yaml /api-spec/venue-openapi.yaml post /v1/withdrawals openapi: 3.1.0 info: title: Exchange API — REST lane version: 1.0.0 summary: Client-facing REST surface for the binary prediction-market exchange. description: > The client-visible REST contract of the API lane — the normative source is `specs/api.md`; the request-ingress mechanics are in `specs/gateway.md`. ## Conventions (api.md §1) - **Versioning:** every path is under `/v1/`. Unknown *request* fields are rejected (`400 unknown_field`); clients MUST ignore unknown *response* fields (additive changes are non-breaking). - **Numbers:** prices are integer **ticks** (1–99, cents); quantities are integer shares; money is integer cents. u64-domain values (`order_id`, `client_order_id`, `seq`, cents amounts, timestamps) render as decimal **strings**; u32-and-below render as JSON numbers. Floats never appear. - **Timestamps:** `ts`/`*_ts` fields are nanoseconds since the Unix epoch as decimal strings — the sequencer's stamp, untranslated. - **`as_of_seq`:** every read response carries the stream sequence number its answer is current as of. Two reads with the same `as_of_seq` describe one consistent instant. - **Pagination:** list endpoints take `limit` (default 100, max 1000) and an opaque `cursor`; responses echo `cursor` for the next page (empty string when exhausted). ## Authentication (api.md §2, gateway.md §4–§5) Every request — there is no anonymous surface — carries three headers: `DX-ACCESS-KEY`, `DX-ACCESS-TIMESTAMP` (Unix ms), and `DX-ACCESS-SIGNATURE` (base64 HMAC-SHA256 over the canonical string `timestamp + "\n" + METHOD + "\n" + path?query + "\n" + body`, ±5000 ms replay window). Keys carry scopes `read` (GETs) and `trade` (order/withdrawal mutations); the required scope per operation is given in `x-required-scope`. Rate limits are per-key token buckets (read 100/s +200 burst; write 50/s +100 burst) answered with `429` + `Retry-After`. ## Execution outcomes are not errors (api.md §5) Post-only cross, FOK infeasible, IOC remainder, STP and max-cost-infeasible arrive as a **successful** placement response with `status: "canceled"` and a `reason` — they are the order's history, not a protocol failure. Only the reject taxonomy in §5 maps to non-2xx. x-other-lanes: websocket: endpoint: wss://{host}/v1/ws spec: specs/api.md §7, specs/ws.md note: >- AsyncAPI territory — subscribe/unsubscribe command envelope, public channels (orderbook_delta, trades, ticker) and the private `user` channel with snapshot+resume. Not modelled in this OpenAPI document. mcp: endpoint: POST /v1/mcp spec: specs/mcp.md note: >- JSON-RPC 2.0 agent lane exposing the same reads/writes as MCP tools. Described by its own tool schema, not OpenAPI. servers: - url: https://api.raeth.exchange description: >- Production. Every request is authenticated — there is no anonymous access, including market data. See Authentication. security: - DxAccessKey: [] DxAccessTimestamp: [] DxAccessSignature: [] tags: - name: Exchange description: Exchange-wide control state (api.md §3). - name: Markets description: Market metadata, orderbooks and public tape (api.md §4). - name: Portfolio (read) description: Key-scoped balance, positions, fills and orders (api.md §6.1–6.3, 6.6). - name: Orders (write) description: >- Order placement, cancel, decrease, batch and mass-cancel (api.md §6.5–6.10). - name: Funding description: Deposit address and withdrawals (api.md §6A). - name: Admin description: > Control-plane operator actions (specs/admin.md). Served on a SEPARATE listener from every path above — see the operation's own `servers` override; the top-level `servers` block does not reach it. externalDocs: description: Normative API surface specification (REST + WebSocket). url: specs/api.md paths: /v1/withdrawals: post: tags: - Funding summary: Request a withdrawal description: | Closed schema (api.md §6A.2). `client_withdrawal_id` is the per-user idempotency key and must be **strictly increasing**: a fresh id (`> hwm`) is forwarded; an equal id (`== hwm`) is treated as an idempotent retry and returns the current phase; a stale id (`< hwm`) returns `409 stale_client_withdrawal_id`. `201` = freshly accepted; `200` = a phase report for a retry/known id. The gateway validates `dest` structurally only and forwards its casing verbatim for the funding port's EIP-55 check. operationId: postWithdrawal requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WithdrawalRequest' responses: '200': description: Current phase of a known/retried withdrawal id. content: application/json: schema: $ref: '#/components/schemas/WithdrawalStatus' example: wid: '9001' status: reserved '201': description: Freshly accepted withdrawal (api.md §6A.2). content: application/json: schema: $ref: '#/components/schemas/WithdrawalStatus' example: wid: '9001' status: requested '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/MissingScope' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '422': $ref: '#/components/responses/Unprocessable' '429': $ref: '#/components/responses/RateLimited' '503': $ref: '#/components/responses/FundingCapacity' '504': $ref: '#/components/responses/SequencingTimeout' components: schemas: WithdrawalRequest: type: object description: Closed schema (api.md §6A.2). additionalProperties: false properties: client_withdrawal_id: allOf: - $ref: '#/components/schemas/U64String' description: nonzero, strictly increasing per user (idempotency key) amount: allOf: - $ref: '#/components/schemas/U64String' description: nonzero cents dest: type: string description: >- exactly 42 chars: lowercase `0x` + 40 hex (either case); mixed-case triggers the funding port's EIP-55 checksum verify pattern: ^0x[0-9a-fA-F]{40}$ required: - client_withdrawal_id - amount - dest WithdrawalStatus: type: object properties: wid: $ref: '#/components/schemas/U64String' status: type: string enum: - requested - reserved - confirmed - failed - alarm required: - wid - status U64String: type: string description: A u64-domain value rendered as a decimal string (api.md §1). pattern: ^[0-9]+$ example: '182390' ErrorEnvelope: type: object description: The uniform error body (api.md §5). properties: error: type: object properties: code: type: string description: lowercase snake_case reject/gateway code. num: type: - integer - 'null' description: >- The u16 reject code; non-null iff origin is `core` or `port` drawing from the shared registry (funding-port rejects carry a null num). origin: type: string enum: - core - port - gateway message: type: string details: type: - object - 'null' required: - code - num - origin - message - details required: - error responses: BadRequest: description: > Edge validation fault (origin gateway: `unknown_field`, `malformed_json`, `schema_violation`, `bad_client_withdrawal_id`, `bad_amount`, `bad_destination`) or a core/port validity reject (`bad_price_tick`, `bad_qty`, `invalid_decrease`, `client_order_id_required`). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: unknown_field num: null origin: gateway message: unknown_field details: null Unauthorized: description: Missing or invalid signature (`unauthorized`, origin gateway). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: unauthorized num: null origin: gateway message: unauthorized details: null MissingScope: description: >- Key lacks the required scope (`missing_scope`), or a risk reject (`per_market_limit`, `user_suspended`, `reduce_only_violation`, …). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: missing_scope num: null origin: gateway message: missing_scope details: null NotFound: description: >- `market_not_found`, `unknown_order`, `unknown_withdrawal`, or `not_found`. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: unknown_order num: 260 origin: core message: unknown_order details: null Conflict: description: > `duplicate_client_order_id`, `stale_client_withdrawal_id`, or a market-state reject (`market_closed`, `market_inactive`, `exchange_paused`, `trading_paused`, `market_frozen`). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: duplicate_client_order_id num: 259 origin: core message: duplicate_client_order_id details: null Unprocessable: description: >- Funding reject (`insufficient_balance`, `sell_exceeds_position`, `max_cost_exceeded`). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: insufficient_balance num: 257 origin: core message: insufficient_balance details: null RateLimited: description: Token bucket empty (`rate_limited`). Retry after the header interval. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: rate_limited num: null origin: gateway message: rate_limited details: null FundingCapacity: description: >- Funding port at capacity (`funding_capacity`) or order-book full (`book_full`). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: funding_capacity num: null origin: port message: funding_capacity details: null SequencingTimeout: description: > The sequenced outcome did not arrive within the response budget (`sequencing_timeout`, origin gateway). For a placement, retry the identical request then `GET /v1/portfolio/orders?client_order_id=` — at most one order results (api.md §8). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: sequencing_timeout num: null origin: gateway message: sequencing_timeout details: null securitySchemes: DxAccessKey: type: apiKey in: header name: DX-ACCESS-KEY description: The API key id (decimal string). DxAccessTimestamp: type: apiKey in: header name: DX-ACCESS-TIMESTAMP description: Request timestamp, Unix milliseconds (decimal). ±5000 ms replay window. DxAccessSignature: type: apiKey in: header name: DX-ACCESS-SIGNATURE description: > base64(HMAC-SHA256(secret, "timestamp\nMETHOD\npath?query\nbody")). For the WS handshake the body is empty and the path is `/v1/ws`. ````