> ## 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. # Create API key > Issues a scoped `ttk_` key for the session's account from a request your account wallet signed, and returns its secret this once. Requires a wallet session or the Totalis app's own sign-in session, sent with exactly one allowed `Origin` (otherwise `FORBIDDEN`); an API key cannot call it (`UNAUTHENTICATED`). ## OpenAPI ````yaml /hyperliquid/openapi.json post /v1/me/api-keys 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. There are three ways in, each sent as `Authorization: Bearer `: - **Scoped API key** (`ttk_`), for servers, bots and market makers. The account owner creates it in the Totalis app, or a wallet-session user creates one with `POST /v1/me/api-keys` and a fresh wallet signature (see API keys). It acts for one account, yours or a maker's, with only the scopes it holds, and needs no `Origin`. - **Wallet session**, for users who bring their own wallet to a partner's web page. The page signs the wallet in with `POST /v1/auth/wallet-challenges` and `POST /v1/auth/wallet-sessions`; the session is bound to the page's registered `Origin` and must be sent from it. Pages may also label their traffic with their publishable browser key in `X-Totalis-Partner: tpb_...`. - **Partner server key** (`tpk_`), only for `POST /v1/partner/wallet-admissions`, which lets a new wallet open its account during the invite-only launch. Server to server, never in a browser, and never with an `Origin`. Public market reads need no credential. A credential only authenticates: every bet, cash-out and withdrawal also carries the wallet or maker signature the HyperEVM contract verifies. An external wallet sends `POST /v1/core-exits` to move its vault cash to HyperCore before a HyperCore order. For access, partner credentials (origins, browser and server keys), builder codes or staging, email [founders@totalis.trade](mailto:founders@totalis.trade). 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: 152.0.0-maker-withdrawal servers: - url: https://hip4-api.totalis.trade description: Production 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, withdrawals, deposits and HyperCore exits. - name: Makers description: 'The rest of a maker''s setup after Making: capital and collateral.' - name: Partners & wallet sign-in description: >- A partner admits its users' own wallets, which sign in from the partner's pages. - name: API keys description: >- Issue, rotate and revoke scoped keys from a wallet session. An API key cannot manage keys. - 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/api-keys: post: tags: - API keys summary: Create API key description: >- Issues a scoped `ttk_` key for the session's account from a request your account wallet signed, and returns its secret this once. Requires a wallet session or the Totalis app's own sign-in session, sent with exactly one allowed `Origin` (otherwise `FORBIDDEN`); an API key cannot call it (`UNAUTHENTICATED`). operationId: createPersonalApiKey parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateKeyRequest' example: label: Trading bot scopes: - account:read - account:stream - quote:accept - rfq:read - rfq:write expires_in_days: 30 proof: challenge_id: 0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a33 signature: >- 0x4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f4f2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a1b responses: '201': description: The new key and its secret, shown only in this response. content: application/json: schema: $ref: '#/components/schemas/PersonalCreatedKey' example: key: id: 0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a31 account: kind: PARTICIPANT id: 0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a30 environment: production label: Trading bot scopes: - account:read - account:stream - quote:accept - rfq:read - rfq:write status: ACTIVE created_at: '2026-10-16T12:00:10Z' expires_at: '2026-11-15T12:00:10Z' last_used_at: null revoked_at: null rotated_from: null overlap_until: null secret: >- ttk_v1_prd_0199a1b2-c3d4-7e5f-8a6b-7c8d9e0f1a31.q7Xv2LmP9sKd4RtYwB8nZc1HfGj6UeAo3VpNiMxTl0Q headers: Cache-Control: $ref: '#/components/headers/CacheControlNoStore' '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' headers: Cache-Control: $ref: '#/components/headers/CacheControlNoStore' '401': description: >- No session, or an API key (`ttk_`), which never manages keys. - `UNAUTHENTICATED` (retry `NEVER`): The credential is missing, invalid, expired or revoked. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' headers: Cache-Control: $ref: '#/components/headers/CacheControlNoStore' '403': description: >- A missing, repeated or unregistered `Origin`, or a `proof` that is not the owner's signature of an unexpired, unused challenge for exactly this request. - `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' headers: Cache-Control: $ref: '#/components/headers/CacheControlNoStore' '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' headers: Cache-Control: $ref: '#/components/headers/CacheControlNoStore' '409': description: >- - `IDEMPOTENCY_KEY_REUSED` (retry `NEVER`): The idempotency key was already used with different input. - `SECRET_UNAVAILABLE` (retry `NEVER`): The one-time secret was already issued and cannot be shown again. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' headers: Cache-Control: $ref: '#/components/headers/CacheControlNoStore' '422': description: >- - `KEY_LIMIT_REACHED` (retry `NEVER`): The owner already holds the maximum number of API keys. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' headers: Cache-Control: $ref: '#/components/headers/CacheControlNoStore' '429': description: >- - `RATE_LIMITED` (retry `BACKOFF`): The request quota for this credential or route is exhausted. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' headers: Cache-Control: $ref: '#/components/headers/CacheControlNoStore' Retry-After: $ref: '#/components/headers/ApiKeysRetryAfter' '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. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' headers: Cache-Control: $ref: '#/components/headers/CacheControlNoStore' Retry-After: $ref: '#/components/headers/ApiKeysRetryAfter' security: - walletSession: [] components: parameters: 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: CreateKeyRequest: type: object additionalProperties: false properties: label: $ref: '#/components/schemas/KeyLabel' description: Your name for the key, 1 to 80 characters. scopes: $ref: '#/components/schemas/ScopeList' description: >- Permissions the key holds; each must apply to the account, as the capabilities route lists. expires_in_days: $ref: '#/components/schemas/KeyExpiryDays' description: Lifetime in days, 1 to 90, or 0 for no expiry; 30 when omitted. proof: $ref: '#/components/schemas/OwnerProof' description: >- The account owner's signature over the challenge for exactly this request without `proof`. required: - label - scopes - proof description: >- The same shape for a personal account and a maker. proof is the owner's signature over the issue_key challenge for exactly this request without proof. PersonalCreatedKey: allOf: - $ref: '#/components/schemas/PersonalIssuedKey' - $ref: '#/components/schemas/CreatedKey' Error: additionalProperties: false properties: error: $ref: '#/components/schemas/ErrorDetail' description: The one error this request failed with. required: - error type: object KeyLabel: type: string minLength: 1 maxLength: 80 ScopeList: allOf: - type: array items: $ref: '#/components/schemas/Scope' minItems: 1 maxItems: 32 uniqueItems: true - {} - {} - {} description: >- Replay needs a feed the key can read: account:stream or rfq:read for a personal account, vault:read, quote:read or rfq:read for a maker. KeyExpiryDays: type: integer minimum: 0 maximum: 90 default: 30 description: >- 0 means Forever (no expiry); 1–90 sets a finite lifetime in days. Omission defaults to 30. OwnerProof: type: object additionalProperties: false required: - challenge_id - signature description: >- The account owner's personal_sign or ERC-1271 signature over the exact challenge message. For a maker the owner is its controller; for a personal account, its account wallet. properties: challenge_id: $ref: '#/components/schemas/Uuid' description: The `challenge_id` of the challenge that was signed. signature: $ref: '#/components/schemas/ContractSignature' description: >- The owner's signature over the challenge's `message`, exactly as returned. PersonalIssuedKey: allOf: - $ref: '#/components/schemas/IssuedKey' CreatedKey: allOf: - $ref: '#/components/schemas/IssuedKey' 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 Scope: type: string enum: - identity:read - account:read - account:stream - rfq:read - rfq:write - quote:write - quote:read - replay:read - vault:read - vault:write - quote:accept - position:cashout - funding:deposit - funding:withdraw - sponsorship:use - maker:access:read - operations:read - operations:submit description: >- One permission a key can hold. Each operation lists the scopes it requires, and a key holds only scopes that apply to its account, as the capabilities routes list. `operations:read` is reserved and never issued; `maker:access:read` is no longer issued and has no effect on a key that still carries 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}$ ContractSignature: type: string pattern: ^0x(?:[0-9a-f]{2}){1,4096}$ IssuedKey: type: object additionalProperties: false properties: key: allOf: - $ref: '#/components/schemas/KeyMetadata' description: The new key's metadata. secret: type: string pattern: >- ^ttk_v1_(dev|stg|prd)_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\.[A-Za-z0-9_-]{43}$ description: >- The `ttk_` secret, shown only in this response; a retry of the same request answers `SECRET_UNAVAILABLE`, so store it now. required: - key - secret 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_ACCOUNT_ACTIVATION_REQUIRED - CORE_EXIT_ABANDONED - CORE_MOVE_IN_FLIGHT - USERNAME_TAKEN - USERNAME_ALREADY_SET - INVALID_SIGNATURE - WALLET_CONTRACT_UNSUPPORTED - WRONG_AUTHORITY - KEY_LIMIT_REACHED - USERNAME_NOT_ALLOWED - 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_EXIT_UNAVAILABLE - COLLATERAL_REDUCTION_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 KeyMetadata: type: object additionalProperties: false properties: id: $ref: '#/components/schemas/Uuid' description: >- Key ID; the secret embeds it, and the key routes take it as `key_id`. account: $ref: '#/components/schemas/Account' description: The one account the key acts for. environment: enum: - development - staging - production description: The deployment the key works in; a key never works in another. label: $ref: '#/components/schemas/KeyLabel' description: Your name for the key, 1 to 80 characters. scopes: $ref: '#/components/schemas/ScopeList' description: >- Permissions the key holds; each operation lists the scopes it requires. status: enum: - ACTIVE - ROTATING - EXPIRED - REVOKED description: >- `ACTIVE`; `ROTATING` once a rotation replaced it, until `overlap_until`; `EXPIRED` past its deadline; or `REVOKED`. created_at: $ref: '#/components/schemas/CommonTimestamp' description: When the key was issued. expires_at: oneOf: - $ref: '#/components/schemas/CommonTimestamp' - type: 'null' description: >- Null means no scheduled expiry. Revocation, overlap deadlines and current authority still apply. last_used_at: oneOf: - $ref: '#/components/schemas/CommonTimestamp' - type: 'null' description: When the key last authenticated a request, or null if never. revoked_at: oneOf: - $ref: '#/components/schemas/CommonTimestamp' - type: 'null' description: When the key was revoked, or null. rotated_from: oneOf: - $ref: '#/components/schemas/Uuid' - type: 'null' description: >- The key this one replaced in a rotation, or null for a newly created key. overlap_until: oneOf: - $ref: '#/components/schemas/CommonTimestamp' - type: 'null' description: >- While `ROTATING`, when this replaced key stops working; otherwise null. required: - id - account - environment - label - scopes - status - created_at - expires_at - last_used_at - revoked_at - rotated_from - overlap_until Account: oneOf: - type: object additionalProperties: false properties: kind: const: PARTICIPANT description: 'The account kind: `PARTICIPANT` for a personal account.' id: $ref: '#/components/schemas/Uuid' description: The personal account's ID. required: - kind - id title: Participant - type: object additionalProperties: false properties: kind: const: MAKER description: 'The account kind: `MAKER` for a maker vault.' id: $ref: '#/components/schemas/NonZeroUInt64String' description: The on-chain maker ID, as a decimal string. chain_id: type: string enum: - '998' - '999' description: >- The HyperEVM chain of the maker's vault: 999 mainnet, 998 testnet. vault_address: $ref: '#/components/schemas/LowercaseNonZeroAddress' description: The Totalis vault contract the maker is registered in. required: - kind - id - chain_id - vault_address title: Maker - type: object additionalProperties: false properties: kind: const: OPERATOR description: 'The account kind: `OPERATOR`, never issued.' id: $ref: '#/components/schemas/Uuid' description: The operator's ID. required: - kind - id title: Operator description: >- The one account a key acts for: a personal account or a maker vault. A key never spans accounts. CommonTimestamp: type: string format: date-time pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?Z$ maxLength: 30 NonZeroUInt64String: allOf: - $ref: '#/components/schemas/UInt64String' description: Never `0`. 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 headers: CacheControlNoStore: description: Never cache API-key management responses. required: true schema: type: string const: no-store ApiKeysRetryAfter: description: Seconds to wait before resending the same request. required: true schema: type: integer minimum: 0 securitySchemes: walletSession: type: http scheme: bearer description: >- Wallet session: the `access_token` from `POST /v1/auth/wallet-sessions`, for a user who brings their own wallet to a partner's web page. It acts for that wallet's account with no scope limit, and is bound to the `Origin` it signed in from: send exactly one `Origin` header with that value, or the request is `ORIGIN_REQUIRED` or `UNAUTHENTICATED`. It lasts at most 30 days and ends after 7 idle days or at `DELETE /v1/auth/wallet-sessions/current`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.