> ## 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. # Get RFQ > Get an RFQ. No API key required; callers without one receive the public projection. A key, when sent, must be one of: - a key for your account with `rfq:read` - a key for a maker with `rfq:read` ## OpenAPI ````yaml /hyperliquid/openapi.json get /v1/rfqs/{rfq_id} 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/rfqs/{rfq_id}: parameters: - $ref: '#/components/parameters/RfqId' get: tags: - RFQs & Quotes summary: Get RFQ description: >- Get an RFQ. No API key required; callers without one receive the public projection. A key, when sent, must be one of: - a key for your account with `rfq:read` - a key for a maker with `rfq:read` operationId: getRfq responses: '200': description: >- The RFQ as it stands now. Anyone can read an open RFQ; its owner can also read it after it ends, to see how it ended. content: application/json: schema: $ref: '#/components/schemas/Rfq' example: rfq_id: 01a0df4e-5e07-7a3c-8f21-d4e6b7a90c1a kind: ENTRY taker: '0x1111111111111111111111111111111111111111' stake: '25000000' status: OPEN created_at: '2026-09-26T20:00:50.183Z' expires_at: '2026-09-26T20:01:10.183Z' legs: - outcome_id: '1209' side: 'YES' '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. 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' '404': description: >- - `NOT_FOUND` (retry `NEVER`): The resource does not exist or is not visible to this credential. 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. 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. headers: Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' security: - {} - apiKey: - rfq:read components: parameters: RfqId: name: rfq_id in: path required: true schema: type: string format: uuid description: The RFQ's `rfq_id`, from Create RFQ or `RFQ_CREATED`. example: 01994f3a-6c2e-7d41-9b8a-2f3c4d5e6f70 schemas: Rfq: oneOf: - $ref: '#/components/schemas/EntryRfq' - $ref: '#/components/schemas/CashoutRfq' Error: additionalProperties: false properties: error: $ref: '#/components/schemas/ErrorDetail' description: The one error this request failed with. required: - error type: object EntryRfq: allOf: - $ref: '#/components/schemas/IntentIdentityPair' type: object additionalProperties: false required: - rfq_id - kind - taker - stake - status - created_at - expires_at - legs properties: rfq_id: type: string format: uuid description: Identifier of this RFQ (UUID). kind: const: ENTRY description: RFQ kind; ENTRY asks makers to quote a new position. taker: type: string pattern: ^0x[0-9a-f]{40}$ description: Wallet that signs the accept and will own the position. stake: type: string pattern: ^[1-9][0-9]{0,38}$ description: Stake in atomic USDC (6 decimals), before taker fees. status: type: string enum: - OPEN - ACCEPTED - EXPIRED - CANCELLED - FAILED description: >- OPEN collects quotes until expires_at; EXPIRED means that window passed without an accepted quote; CANCELLED means the owner cancelled it or a newer intent generation replaced it; ACCEPTED means a quote was accepted and confirmed; FAILED means the accepted trade failed on chain (see terminal_reason). terminal_reason: $ref: '#/components/schemas/RfqTerminalReason' description: >- Why a FAILED RFQ ended: the accept transaction reverted, or it expired unexecuted. Present only when status is FAILED. created_at: type: string format: date-time description: When the RFQ was durably created, RFC3339 UTC. expires_at: type: string format: date-time description: >- When quote collection ends, 20 seconds after creation. A created quote stays acceptable until its own expiry. legs: type: array minItems: 1 maxItems: 50 items: $ref: '#/components/schemas/CommonLeg' description: Requested legs in strictly increasing outcome_id order. intent_id: $ref: '#/components/schemas/Uuid' description: >- Automatic-RFQ intent this RFQ belongs to; absent for RFQs created without one. intent_generation: $ref: '#/components/schemas/PositiveInt64String' description: >- Generation of the intent this RFQ was created for, as a decimal string; absent together with intent_id. title: Entry RFQ CashoutRfq: type: object additionalProperties: false required: - rfq_id - kind - position_id - owner - leg_state - legs_hash - decision_block - decision_read_gas - maker_id - status - created_at - expires_at - legs properties: rfq_id: type: string format: uuid description: Identifier of this RFQ (UUID). kind: const: CASHOUT description: >- RFQ kind; CASHOUT asks makers to quote the cash-out of an existing position. position_id: $ref: '#/components/schemas/Hash32' description: Position being cashed out. owner: $ref: '#/components/schemas/LowercaseNonZeroAddress' description: >- Owner of the position at decision_block; the address that signs to accept a quote. leg_state: $ref: '#/components/schemas/Hash32' description: >- Position leg state returned by legStateOf(legs, decision_read_gas) at decision_block. Quotes must sign this exact value. legs_hash: $ref: '#/components/schemas/Hash32' description: >- Hash of the position's canonical legs; equals tickets(position_id).legsHash on chain. decision_block: $ref: '#/components/schemas/UInt64String' description: >- HyperEVM block number, as a decimal string, at which the position, owner and leg_state were read. Makers must price from reads at this block. decision_read_gas: type: string const: '500000' description: Gas limit, in gas units, for the legStateOf read; always 500000. maker_id: $ref: '#/components/schemas/NonZeroUInt64String' description: >- On-chain maker ID of the maker that originally underwrote the position. status: type: string enum: - OPEN - ACCEPTED - EXPIRED - CANCELLED - FAILED description: >- OPEN collects cash-out quotes until expires_at; EXPIRED means that window passed without an accepted quote; CANCELLED means the owner cancelled it or a newer intent generation replaced it; ACCEPTED means a quote was accepted and confirmed; FAILED means the accepted sell-back or transfer failed on chain (see terminal_reason). terminal_reason: $ref: '#/components/schemas/RfqTerminalReason' description: >- Why a FAILED RFQ ended: the accept transaction reverted, or it expired unexecuted. Present only when status is FAILED. created_at: type: string format: date-time description: When the RFQ was durably created, RFC3339 UTC. expires_at: type: string format: date-time description: >- When quote collection ends, 30 seconds after creation. A created quote stays acceptable until its own expiry. legs: type: array minItems: 1 maxItems: 50 items: $ref: '#/components/schemas/CommonLeg' description: The position's legs in canonical order. intent_id: $ref: '#/components/schemas/Uuid' description: >- Automatic-RFQ intent this RFQ belongs to; absent for RFQs created without one. intent_generation: $ref: '#/components/schemas/PositiveInt64String' description: >- Generation of the intent this RFQ was created for, as a decimal string; absent together with intent_id. allOf: - $ref: '#/components/schemas/IntentIdentityPair' title: Cash-out RFQ 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 IntentIdentityPair: {} RfqTerminalReason: type: string enum: - REVERTED - EXPIRED_UNEXECUTED CommonLeg: type: object additionalProperties: false required: - outcome_id - side properties: outcome_id: $ref: '#/components/schemas/UInt32String' description: >- HIP-4 outcome ID the leg is on, as a decimal string. The signed Leg encodes it as uint32. side: $ref: '#/components/schemas/Side' description: >- Outcome side the leg backs. The signed Leg encodes YES as 0 and NO as 1. description: One (outcome, side) pair, as markets and positions name it. 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. Hash32: type: string pattern: ^0x[0-9a-f]{64}$ LowercaseNonZeroAddress: type: string pattern: ^0x[0-9a-f]{40}$ description: Never `0x0000000000000000000000000000000000000000`. UInt64String: type: string pattern: >- ^(0|[1-9][0-9]{0,18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]|1844674407370955161[0-5])$ maxLength: 20 format: uint64-decimal NonZeroUInt64String: allOf: - $ref: '#/components/schemas/UInt64String' description: Never `0`. 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 UInt32String: type: string pattern: >- ^(0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[0-1][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])$ maxLength: 10 Side: type: string enum: - 'YES' - 'NO' 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.