> ## 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. # List positions > List your account's positions. Requires one of: - a key for your account with `account:read` - a key for a maker with `vault:read` and the maker permission `READ_POSITIONS` ## OpenAPI ````yaml /hyperliquid/openapi.json get /v1/me/positions 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: get: tags: - Positions summary: List positions description: >- List your account's positions. Requires one of: - a key for your account with `account:read` - a key for a maker with `vault:read` and the maker permission `READ_POSITIONS` operationId: listAccountPositions parameters: - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Cursor' - $ref: '#/components/parameters/PositionStatusQueryOptional' - name: Origin in: header required: false schema: type: string format: uri description: Required for browser sessions; API keys do not require an Origin. example: https://totalis.trade responses: '200': description: >- Your positions, reconciled against the vault contract. A key for your account lists the positions you hold; a key for a maker lists the positions the maker backs. The key's permissions are checked on every request. One freshness status covers the read; amounts are atomic USDC strings or null. No shared caching. headers: Cache-Control: $ref: '#/components/headers/CacheControl' Vary: $ref: '#/components/headers/Vary' content: application/json: schema: $ref: '#/components/schemas/PositionList' example: context: as_of: '2026-09-26T12:00:02Z' status: CURRENT items: - position_id: >- 0x80acb2c7053741866dba533f638a391852f855ebd1aabe170ee2b505d71b4938 maker_id: '7' owner: '0x1111111111111111111111111111111111111111' status: OPEN close_reason: null fee_bps: 100 net_stake: '24950000' acquisition_cost: '25000000' payout: '100000000' settlement_payout: null unclaimed_profit: '0' cashout_price: null legs: - outcome_id: '1209' side: 'YES' status: UNRESOLVED result_numerator: null result_denominator: null - outcome_id: '1210' side: 'NO' status: UNRESOLVED result_numerator: null result_denominator: null created_at: '2026-09-25T18:21:44Z' updated_at: '2026-09-25T18:21:44Z' settlement_kind: null - position_id: >- 0xd9d9664d8d5996d51a8aea5a199441e519d09b797ea4b2a370016b03ce5a4e11 maker_id: '7' owner: '0x1111111111111111111111111111111111111111' status: SETTLED_UNCLAIMED close_reason: null fee_bps: 100 net_stake: '49900000' acquisition_cost: '50000000' payout: '120000000' settlement_payout: '120000000' unclaimed_profit: '70100000' cashout_price: null legs: - outcome_id: '1180' side: 'YES' status: RESOLVED result_numerator: '100000000' result_denominator: '100000000' - outcome_id: '1195' side: 'NO' status: RESOLVED result_numerator: '100000000' result_denominator: '100000000' created_at: '2026-09-20T09:14:02Z' updated_at: '2026-09-24T16:00:11Z' settlement_kind: WIN next_cursor: null has_more: false total_count: '2' '400': description: >- - `INVALID_QUERY` (retry `NEVER`): A query parameter is malformed, out of range or not accepted by this operation. `field_violations` names it. 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' '409': description: >- - `CURSOR_EXPIRED` (retry `REFRESH`): The account-read snapshot behind this cursor expired or its scope changed; restart from the first page. 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. - `SOURCE_UNAVAILABLE` (retry `BACKOFF`): The account-read or stream source is unavailable. - `CONTRACT_UNAVAILABLE` (retry `BACKOFF`): This producer is disabled in this environment. headers: Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' security: - apiKey: - account:read - apiKey: - vault:read components: parameters: Limit: name: limit in: query schema: $ref: '#/components/schemas/PageLimit' description: >- Maximum items per page, 1 to 200, default 50. A page may hold fewer, even none, while has_more is true. example: 50 Cursor: name: cursor in: query description: >- Omit for the first page; then send the previous response's next_cursor unchanged. schema: $ref: '#/components/schemas/PageCursor' example: eyJ2IjoxLCJzIjoiMTIzNDUifQ PositionStatusQueryOptional: name: status in: query required: false description: Return only positions with this lifecycle status. schema: type: string enum: - OPEN - AWAITING_SETTLEMENT - SETTLED_UNCLAIMED - CLOSED example: OPEN headers: CacheControl: description: Always `no-store`; account data must not be cached. schema: const: no-store Vary: schema: type: string description: >- The response varies by the Authorization header, so shared caches must not reuse it across credentials. RetryAfter: description: Seconds to wait before resending the same request schema: type: integer minimum: 1 schemas: PositionList: type: object additionalProperties: false required: - context - items - next_cursor - has_more - total_count properties: context: $ref: '#/components/schemas/ReadContext' description: >- Freshness of this read: the oldest source observation and one status for every amount in the response. items: type: array items: $ref: '#/components/schemas/Position' description: >- Positions on this page, newest created_at first, then position_id descending. next_cursor: $ref: '#/components/schemas/NextCursor' description: >- Opaque cursor for the next page, bound to this response's snapshot; null on the last page. Send it back unchanged as cursor. has_more: type: boolean description: >- True when another page exists; true exactly when next_cursor is non-null. total_count: type: string pattern: ^(0|[1-9][0-9]{0,77})$ description: >- Exact number of positions in the whole filtered snapshot (not just this page), as a decimal string. Error: additionalProperties: false properties: error: $ref: '#/components/schemas/ErrorDetail' description: The one error this request failed with. required: - error type: object PageLimit: type: integer minimum: 1 maximum: 200 default: 50 description: >- Maximum items in one page. A page may hold fewer, even none, while has_more is true. PageCursor: type: string minLength: 1 maxLength: 2048 description: >- Opaque list cursor. Send a previous response's next_cursor back unchanged; never build or parse one. ReadContext: type: object additionalProperties: false required: - as_of - status properties: as_of: $ref: '#/components/schemas/Timestamp' description: RFC3339 observation time of the oldest source this read used. status: type: string enum: - CURRENT - STALE - UNAVAILABLE description: >- Freshness of the whole read. CURRENT: every source is fresh and reconciled. STALE: a source lags or has not reconciled, such as a catching-up projection, a pending reorg rescan or a period not fully covered; amounts may be displayed with their age but never authorize an action. UNAVAILABLE: a required source could not be read, so the amounts it backs are null. description: >- Freshness of the read. Pages of one list share the snapshot bound into their cursor. Position: type: object additionalProperties: false required: - position_id - maker_id - owner - status - close_reason - fee_bps - net_stake - acquisition_cost - payout - settlement_payout - unclaimed_profit - cashout_price - legs - created_at - updated_at - settlement_kind properties: position_id: type: string pattern: ^0x[0-9a-f]{64}$ description: 'Position ID: the contract''s ticketId (bytes32 hex).' maker_id: $ref: '#/components/schemas/NonZeroUInt64String' description: Maker that wrote the position, as a decimal string. owner: $ref: '#/components/schemas/LowercaseNonZeroAddress' description: Current position owner wallet (lowercase). status: type: string enum: - OPEN - AWAITING_SETTLEMENT - SETTLED_UNCLAIMED - CLOSED description: >- OPEN: not yet known eligible for settlement; AWAITING_SETTLEMENT: every leg resolved, or a leg lost, but no settlement observed; SETTLED_UNCLAIMED: settled with profit still unclaimed; CLOSED: closed by zero-profit settlement, final claim or sell-back. fee_bps: type: integer minimum: 0 maximum: 10000 description: >- Profit fee in basis points, fixed when the position opened. The holder claims unclaimed_profit minus unclaimed_profit * fee_bps / 10000. close_reason: type: - string - 'null' enum: - CLAIM - SELL_BACK - null description: >- How a CLOSED position closed: CLAIM (final claim of winnings) or SELL_BACK (bought back by the maker). Null otherwise, including direct zero-profit settlement closes and closes without retained evidence. net_stake: $ref: '#/components/schemas/UnsignedMetric' description: Stake after the taker entry fee. acquisition_cost: $ref: '#/components/schemas/UnsignedMetric' description: >- What the current owner paid for the whole position: the price of the latest transfer to them, or the gross stake with the entry fee if they have held it since opening. Settlement, claims and sell-back don't change it. Null when retained chain history has a gap that could hide a transfer. P&L compares it with what the owner gets back, settlement_payout or cashout_price, less the profit fee of fee_bps on the amount above net_stake, whatever the owner paid. payout: $ref: '#/components/schemas/UnsignedMetric' description: >- Payout if every leg wins, as the maker signed it in the quote; the maker's initial exposure is payout minus net_stake. settlement_payout: $ref: '#/components/schemas/UnsignedMetric' description: >- Settlement payout observed on-chain; null before settlement and for sold-back positions. unclaimed_profit: $ref: '#/components/schemas/UnsignedMetric' description: >- Gross profit still claimable; "0" unless SETTLED_UNCLAIMED. The holder receives unclaimed_profit minus unclaimed_profit * fee_bps / 10000. cashout_price: $ref: '#/components/schemas/UnsignedMetric' description: >- Cash-out price paid when the position was sold back; null unless close_reason is SELL_BACK. legs: type: array items: $ref: '#/components/schemas/Leg' minItems: 1 maxItems: 50 description: >- Position legs in ascending outcome_id order, with each leg's resolution. created_at: type: string format: date-time description: >- RFC3339 time of the position's opening event; lists order by it, newest first. updated_at: type: string format: date-time description: RFC3339 time of the position's latest lifecycle event. settlement_kind: type: - string - 'null' enum: - LOSS - PARTIAL - WIN - EARLY_LOST - null description: >- Settlement result: LOSS (zero payout), PARTIAL (payout below net stake), WIN (payout at or above net stake) or EARLY_LOST (lost before every leg resolved). Null before settlement, for sell-backs, or when historical evidence is missing. NextCursor: type: - string - 'null' minLength: 1 maxLength: 2048 description: Opaque cursor for the next page, or null when has_more is false. 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 Timestamp: type: string format: date-time NonZeroUInt64String: allOf: - $ref: '#/components/schemas/UInt64String' description: Never `0`. LowercaseNonZeroAddress: type: string pattern: ^0x[0-9a-f]{40}$ description: Never `0x0000000000000000000000000000000000000000`. UnsignedMetric: oneOf: - $ref: '#/components/schemas/Amount' - type: 'null' description: >- Non-negative amount in atomic USDC (6 decimals, "1000000" = 1 USDC); null when it could not be established, never zero in its place. Leg: type: object required: - outcome_id - side - status - result_numerator - result_denominator properties: outcome_id: $ref: '#/components/schemas/UInt32String' description: HIP-4 outcome ID of the leg, as a decimal string. side: type: string enum: - 'YES' - 'NO' description: Outcome side the position holds, YES or NO. status: enum: - RESOLVED - UNRESOLVED - UNAVAILABLE description: >- RESOLVED: the outcome has a final result. UNRESOLVED: result still pending; UNAVAILABLE: historical result evidence is missing. result_numerator: oneOf: - type: string pattern: ^(0|[1-9][0-9]{0,7}|100000000)$ - type: 'null' description: >- Selected-side result factor over result_denominator: 100000000 is a full win, 0 a loss, values between are fractional. Null until the leg has a known result. result_denominator: oneOf: - const: '100000000' - type: 'null' description: >- Always 100000000, the pinned grading scale. Null until the leg has a known result. 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 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 Amount: type: string pattern: ^(0|[1-9][0-9]{0,77})$ 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 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.