> ## Documentation Index > Fetch the complete documentation index at: https://docs.totalis.trade/llms.txt > Use this file to discover all available pages before exploring further. # Cash out position > Cash out a position by opening a cash-out RFQ. Requires a key for your account with `rfq:write`. ## OpenAPI ````yaml /hyperliquid/openapi.json post /v1/me/positions/{position_id}/cashout openapi: 3.1.1 info: title: Totalis Hyperliquid API description: >- REST API for Totalis singles and parlays on Hyperliquid HIP-4 outcome markets, for client integrations and external market makers. Authenticate with a scoped API key created in the Totalis app, sent as `Authorization: Bearer `. Public market reads need no key. Balance-affecting commands also carry the wallet or maker signature the HyperEVM contract verifies. Amounts are base-10 strings in native USDC atomic units, large identifiers are decimal strings, and every command `POST` requires an `Idempotency-Key` header. Every error is `{error: {code, message, retry, request_id, field_violations}}`. `code` is stable; each operation lists the codes it returns per status. `retry` is `NEVER` (stop), `BACKOFF` (resend the same request with the same `Idempotency-Key` after `Retry-After` seconds) or `REFRESH` (re-read state, then send a new request with a new key). `field_violations` names invalid inputs by JSON pointer, such as `/legs/0/side`. version: 127.0.0-pure-reads servers: - url: https://hip4-api.totalis.trade description: Production public edge - url: https://hip4-api-staging.totalis.trade description: Staging and chain-998 public edge security: [] tags: - name: Markets description: HIP-4 markets, their sides and price history. No API key needed. - name: RFQs & Quotes description: >- RFQs and the quotes that answer them: what a taker calls, then what a maker calls. - name: Positions description: Positions the account holds, or its maker backs. - name: Account description: >- The account a key acts for: identity, balances, activity, operations and withdrawals. - name: Makers description: 'The rest of a maker''s setup after Making: capital and collateral.' - name: Deployment description: The contract deployment every signature is made against. - name: WebSocket description: The authenticated WebSocket for account and maker updates. paths: /v1/me/positions/{position_id}/cashout: parameters: - $ref: '#/components/parameters/PositionId' post: tags: - RFQs & Quotes summary: Cash out position description: |- Cash out a position by opening a cash-out RFQ. Requires a key for your account with `rfq:write`. operationId: createCashout parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCashoutCommand' example: {} responses: '201': description: >- The cash-out RFQ was created, or an exact retry returned it. Makers answer with cash-out quotes priced on the position as it stood at the RFQ's `decision_block`; you accept one like an entry quote, and the maker confirms it. content: application/json: schema: $ref: '#/components/schemas/RfqCreated' example: rfq_id: 01a0df58-a825-7f0e-9d2c-3b4a5968778f '400': description: >- - `INVALID_REQUEST` (retry `NEVER`): The body, a path parameter or a header is malformed or fails validation. `field_violations` names invalid body fields. - `INVALID_IDEMPOTENCY_KEY` (retry `NEVER`): The command needs exactly one lowercase UUIDv7 `Idempotency-Key` header; confirm takes none. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' '401': description: >- - `UNAUTHENTICATED` (retry `NEVER`): The credential is missing, invalid, expired or revoked. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' '403': description: >- - `FORBIDDEN` (retry `NEVER`): The credential is valid but lacks the scope, permission or role this operation needs. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' '409': description: >- - `IDEMPOTENCY_KEY_REUSED` (retry `NEVER`): The idempotency key was already used with different input. - `STATE_CONFLICT` (retry `REFRESH`): The resource changed and no longer admits this request. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' '429': description: >- - `RATE_LIMITED` (retry `BACKOFF`): The request quota for this credential or route is exhausted. - `RFQ_INTENT_LIMIT` (retry `BACKOFF`): The account has too many open RFQs. headers: Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' '503': description: >- - `AUTHORIZATION_UNAVAILABLE` (retry `BACKOFF`): Identity or credential authority storage is unavailable. - `DEPENDENCY_STALE` (retry `BACKOFF`): A projection or upstream the request depends on (chain projection, HyperCore state, database) is behind its freshness bound or unavailable. - `FINANCIAL_ACTIONS_DISABLED` (retry `BACKOFF`): Financial actions are disabled for this deployment. headers: Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' security: - apiKey: - rfq:write components: parameters: PositionId: name: position_id in: path required: true schema: $ref: '#/components/schemas/Bytes32' description: >- Position ID: the contract's ticketId of the position, as lowercase bytes32 hex. example: '0x5e0f6a2b8c4d1e3f7a9b0c2d4e6f8a1b3c5d7e9f0a2b4c6d8e0f1a3b5c7d9e1f' IdempotencyKey: name: Idempotency-Key in: header required: true schema: type: string format: uuid pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ description: >- Lowercase UUIDv7 naming this command, unique per caller and route. A retry with the same key and body returns the original result; the same key with a different body returns `409 IDEMPOTENCY_KEY_REUSED`. example: 0198a6f6-82a5-7abc-9f2a-4f0fb437493e schemas: CreateCashoutCommand: type: object additionalProperties: false properties: intent_id: $ref: '#/components/schemas/Uuid' description: >- Automatic-RFQ intent (UUIDv7) this RFQ belongs to. Send it with intent_generation, or omit both. intent_generation: $ref: '#/components/schemas/PositiveInt64String' description: >- Generation of the intent, as a decimal string. A higher generation atomically cancels the intent's open earlier RFQ; send it with intent_id. allOf: - $ref: '#/components/schemas/IntentIdentityPair' description: >- The cash-out RFQ to open on the position in the path. The caller's embedded wallet must be its current owner. RfqCreated: type: object additionalProperties: false required: - rfq_id properties: rfq_id: type: string format: uuid description: ID of the new RFQ. Error: additionalProperties: false properties: error: $ref: '#/components/schemas/ErrorDetail' description: The one error this request failed with. required: - error type: object Bytes32: type: string pattern: ^0x[0-9a-f]{64}$ Uuid: type: string format: uuid pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ PositiveInt64String: type: string pattern: >- ^([1-9][0-9]{0,17}|[1-8][0-9]{18}|9[0-1][0-9]{17}|92[0-1][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[0-1][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6]|9223372036854775807)$ maxLength: 19 description: Positive signed 64-bit decimal integer, at most 9223372036854775807. IntentIdentityPair: {} ErrorDetail: additionalProperties: false properties: code: $ref: '#/components/schemas/ErrorCode' description: Stable registered code; branch on this, not on message or status. field_violations: description: >- Each invalid input by JSON pointer; empty when the error is not about a specific input. items: $ref: '#/components/schemas/FieldViolation' type: array message: description: Human-readable; may change without notice. minLength: 1 type: string request_id: description: >- UUIDv7 of this request, also returned in the X-Request-ID header. Quote it when reporting a problem. format: uuid pattern: >- ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ type: string retry: $ref: '#/components/schemas/Retry' description: What the caller should do next; fixed by the registry for each code. required: - code - message - retry - request_id - field_violations type: object ErrorCode: description: >- Stable HTTP error code. Each code has one HTTP status and one retry value. enum: - INVALID_REQUEST - INVALID_QUERY - INVALID_CURSOR - INVALID_IDEMPOTENCY_KEY - ORIGIN_REQUIRED - SUBPROTOCOL_REQUIRED - UNSUPPORTED_BROWSE_CONTRACT - UNAUTHENTICATED - FORBIDDEN - ORIGIN_NOT_ALLOWED - ACCESS_REQUIRED - NOT_FOUND - IDENTITY_NOT_FOUND - QUOTE_NOT_FOUND - INVITE_CODE_NOT_FOUND - IDEMPOTENCY_KEY_REUSED - STATE_CONFLICT - INVITE_CODE_EXHAUSTED - STALE_CURSOR - CURSOR_EXPIRED - CURSOR_RESET - RECURRING_DEFINITION_CONFLICT - EMBEDDED_WALLET_CONFLICT - SECRET_UNAVAILABLE - ROTATION_IN_PROGRESS - TELEMETRY_CONFLICT - RFQ_NOT_CANCELLABLE - RFQ_NOT_OPEN - RFQ_GENERATION_STALE - RFQ_GENERATION_IN_FLIGHT - QUOTE_EXPIRED - QUOTE_CANCELLED - QUOTE_REPLACED - QUOTE_SIGNER_CHANGED - QUOTE_CAPACITY_EXCEEDED - CORE_ACCOUNT_NOT_READY - CORE_EXIT_ABANDONED - CORE_FUNDING_CONFLICT - CORE_VAULT_RESERVATION - CORE_MOVE_IN_FLIGHT - INVALID_SIGNATURE - WRONG_AUTHORITY - KEY_LIMIT_REACHED - HYPERCORE_WALLET_UNQUALIFIED - HYPERCORE_ACCOUNT_NOT_MAIN - HYPERCORE_INSUFFICIENT_BALANCE - RATE_LIMITED - CONNECTION_LIMIT - RFQ_INTENT_LIMIT - QUOTE_EXPOSURE_LIMIT - DEPENDENCY_STALE - AUTHORIZATION_UNAVAILABLE - SOURCE_UNAVAILABLE - CONTRACT_UNAVAILABLE - MARKET_DATA_UNAVAILABLE - BROWSE_UNAVAILABLE - FINANCIAL_ACTIONS_DISABLED - CORE_FUNDING_UNAVAILABLE - CORE_EXIT_UNAVAILABLE - SPONSORSHIP_UNAVAILABLE - CONTRACT_SIGNATURE_OVERLOADED - QUOTE_EXPOSURE_STALE - COMBO_AUTOMATIC_DISABLED - EMBEDDED_WALLET_UNAVAILABLE - CONNECTION_DRAIN type: string FieldViolation: additionalProperties: false properties: code: description: >- REQUIRED: the input is missing. INVALID: it is present but malformed or out of range. UNEXPECTED: the input is not accepted here. enum: - REQUIRED - INVALID - UNEXPECTED type: string field: description: >- JSON pointer into the body, or into the query parameters as one flat object for requests without a body, for example /legs/0/stake or /limit. pattern: ^(/([^~/]|~[01])*)+$ type: string required: - field - code type: object Retry: description: >- NEVER: stop. BACKOFF: resend the same request with the same Idempotency-Key after Retry-After. REFRESH: re-read state, then send a new request with a new Idempotency-Key. enum: - NEVER - BACKOFF - REFRESH type: string headers: RetryAfter: description: Seconds to wait before resending the same request schema: type: integer minimum: 1 securitySchemes: apiKey: type: http scheme: bearer description: >- Scoped API key from the Totalis app settings. Each key acts for one account, yours or a maker's, and holds only scopes that account can use. Each operation lists the scopes it requires. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.