> ## 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 balances > Get your Totalis balance: your wallet's USDC on HyperEVM plus your free vault balance. Requires a key for your account with `account:read`. ## OpenAPI ````yaml /hyperliquid/openapi.json get /v1/me/balances 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/balances: get: tags: - Account summary: Get balances description: >- Get your Totalis balance: your wallet's USDC on HyperEVM plus your free vault balance. Requires a key for your account with `account:read`. operationId: getBalances responses: '200': description: >- Your Totalis balance, broken into its parts, with any pending or unknown amount marked. HyperCore balances are not included; read them from Hyperliquid. content: application/json: schema: $ref: '#/components/schemas/Balance' example: amount: '37500000' state: CURRENT components: - kind: WALLET_USDC amount: '12500000' state: CURRENT - kind: VAULT_FREE amount: '30000000' state: CURRENT pending: wallet_reserved: '5000000' vault_deposits: '0' vault_withdrawals: '0' core_exits: '0' has_unknown_operations: false checkpoint: block_number: '31552210' projection_state: CURRENT '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' '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: - account:read components: schemas: Balance: description: >- The account's spendable Totalis balance in atomic USDC (6 decimals, "1000000" = 1 USDC): embedded wallet USDC plus free vault cash. HyperCore balances are read from Hyperliquid directly or through GET /v1/hypercore/portfolio. type: object additionalProperties: false required: - amount - state - components - pending - checkpoint properties: amount: description: >- Spendable total in atomic USDC; null unless state is CURRENT. It is wallet USDC plus free vault cash minus pending.wallet_reserved, floored at zero. oneOf: - $ref: '#/components/schemas/CommonAmount' - type: 'null' state: description: >- Combined state of the components: STALE if any is stale, else UNKNOWN if any could not be read, else CURRENT. enum: - CURRENT - UNKNOWN - STALE components: description: 'The two parts of the balance: WALLET_USDC then VAULT_FREE.' type: array minItems: 2 maxItems: 2 items: $ref: '#/components/schemas/BalanceComponent' pending: description: In-flight amounts behind the balance, in atomic USDC (6 decimals). type: object additionalProperties: false required: - wallet_reserved - vault_deposits - vault_withdrawals - core_exits - has_unknown_operations properties: wallet_reserved: $ref: '#/components/schemas/CommonAmount' description: >- Wallet USDC already committed to open Totalis withdrawals and stake fundings; subtracted from amount. vault_deposits: $ref: '#/components/schemas/CommonAmount' description: >- Deposits into the vault that are queued or in flight and not yet committed. vault_withdrawals: $ref: '#/components/schemas/CommonAmount' description: >- Withdrawals out of the vault that are queued or in flight and not yet committed. core_exits: $ref: '#/components/schemas/CommonAmount' description: >- Route 2 exits leaving the vault or awaiting their HyperCore credit, each counted once. has_unknown_operations: description: >- True when one of the account's operations is in state UNKNOWN, so balances may still change when it resolves. type: boolean checkpoint: $ref: '#/components/schemas/Checkpoint' description: >- Chain projection the figures reflect; wallet USDC is read at this same block. Error: additionalProperties: false properties: error: $ref: '#/components/schemas/ErrorDetail' description: The one error this request failed with. required: - error type: object CommonAmount: type: string pattern: ^(0|[1-9][0-9]*)$ maxLength: 39 format: uint128-decimal BalanceComponent: type: object additionalProperties: false required: - kind - amount - state properties: kind: description: >- WALLET_USDC: embedded wallet USDC on HyperEVM; VAULT_FREE: unreserved cash held for the account in the Totalis vault. enum: - WALLET_USDC - VAULT_FREE amount: description: >- Component amount in atomic USDC (6 decimals); null when the component could not be read (state UNKNOWN). oneOf: - $ref: '#/components/schemas/CommonAmount' - type: 'null' state: description: >- CURRENT when read at a current checkpoint; STALE when the vault projection lags; UNKNOWN when the wallet read at the checkpoint block failed. enum: - CURRENT - UNKNOWN - STALE Checkpoint: type: object additionalProperties: false required: - block_number - projection_state properties: block_number: $ref: '#/components/schemas/UInt64String' description: >- Last HyperEVM block the vault projection has indexed; the read reflects chain state up to and including this block. projection_state: description: >- CURRENT when the projection is within 32 blocks of a chain head observed in the last two minutes; STALE when it lags, so figures may be behind. enum: - CURRENT - STALE 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 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 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.