> ## Documentation Index > Fetch the complete documentation index at: https://shield.fi/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get a pool > Retrieve one pool by its canonical pool key. ## OpenAPI ````yaml openapi.json GET /pools/{key} openapi: 3.1.0 info: title: Shield Swap API description: >- Shield Swap REST API for pools, positions, swaps, routes, quotes, settlement status, and transaction input schemas. Transactions target the configured shield_swap program and `token_registry.aleo`. ## Numeric wire format Exact financial values are JSON strings, not JSON numbers. Unsigned decimal inputs use ASCII digits and an optional `.` fraction, for example `"1234.50"`; base-unit integers use ASCII digits only. Grouping separators, localized decimal commas, signs, exponent notation, whitespace, Unicode digits, and redundant leading zeros are not accepted for those inputs. Signed response metrics may include a leading `-`. Clients should localize only for display and convert user input back to this canonical form before sending it. ## Authentication Most endpoints require credentials from an invited wallet. Public routes are `/health`, `/ready`, `/metrics`, `/auth/*`, `/protocol/state`, `/compliance*`, `GET /tokens*`, `GET /pools`, `GET /pools/stats`, and `GET /pools/{key}`. Browsers use HTTP-only session cookies issued by `/auth/verify`. Access sessions last 15 minutes and are renewed through `/auth/refresh`. Programmatic clients use a long-lived token from `POST /api-tokens` as `Authorization: Bearer ss_…`. API tokens cover data and trading routes and can request WebSocket tickets. Token management, code redemption, and admin routes require a browser session. ## WebSocket feed The live feed runs on the separate websocket gateway at `GET /ws`. 1. Request a ticket from `GET /auth/ws-ticket` using a browser session or API token. 2. Open the socket and send the `authenticate` frame within 5 seconds. 3. Subscribe to each required room. 4. Before the 60-second ticket expires, request a new ticket and send another `authenticate` frame. The socket accepts WebSocket tickets only. Session JWTs and API tokens are rejected. ```json {"action": "authenticate", "token": ""} {"action": "subscribe", "room": "trades:"} {"action": "unsubscribe", "room": ""} {"action": "synchronize"} ``` After reconnecting, resend subscriptions and then send `synchronize`. The gateway replies `{"control": "synchronized"}` when those subscriptions are active. Refetch any REST data that depends on the stream after receiving the reply. Each connection allows 32 rooms, 240 client frames per minute, and 2 KB per frame. A client may subscribe only to the balance room for its ticket subject. Rooms: - `pool_launches`: newly created pools - `pool_stats:`: price & liquidity updates - `ohlcv:`: candle updates - `trades:`: swaps / mints / burns - `balances:
`: balance-change hints for an address - `protocol_config`: revisioned protocol-configuration invalidations Server messages are either events (`{"type": , "data": { … }}`) or control messages (`{"control": }`). Event types are `PoolLaunch`, `PoolStats`, `Ohlcv`, `Trade`, `BalanceChange`, and `ProtocolConfigChanged`. Its data contains `revision`, `observed_block`, and the changed `scope`/`key` pairs. Financial fields use the numeric format described above. Treat `ProtocolConfigChanged` as an invalidation, not as the new configuration. Fetch `GET /protocol/state?minimum_revision=`; retry a `503 protocol_revision_pending` after the advertised `Retry-After`; and discard or requote any `/route` result whose `protocol_revision` is older. Subscribe to `pool_stats:` separately when live price and liquidity updates matter. The gateway currently sends `synchronized` and `resync_required` controls. `resync_required` means the stream may have missed updates, so refetch affected data over REST. Ignore unknown control values. Event delivery is at most once. Treat REST as the source of truth. During a deployment the gateway may close the socket with code 1012 (service restart); reconnect and restore the subscriptions. contact: name: Shield Swap license: name: '' version: 0.1.0 servers: - url: https://api.swap.shield.fi description: Shield Swap mainnet API security: [] tags: - name: schema description: On-chain function input schemas for trading / liquidity / token operations - name: auth description: Wallet sign-in, sessions, logout, and WebSocket tickets - name: access description: Invite access redemption and administration - name: api-tokens description: >- Long-lived API tokens for programmatic access; send as `Authorization: Bearer ss_…` on any gated endpoint - name: referral description: Referral redemption and administration - name: pools description: Pool metadata, stats, trades, OHLCV - name: positions description: LP positions - name: swaps description: Historical swaps - name: tokens description: Token registry - name: balances description: On-chain token balances - name: compliance description: Token/pair allowlist, pause, and pool-creation gating state - name: protocol description: Fee tiers and tick spacings - name: route description: Swap routing - name: debug description: On-chain introspection helpers - name: airdrop description: >- Faucet: sends ALEO, USDCx, and ETH to a user address as records, once per address per 15 min - name: unclaimed description: Pending swap outputs and position fees paths: /pools/{key}: get: tags: - pools summary: Get a pool operationId: get_pool parameters: - name: key in: path description: On-chain pool field key required: true schema: type: string responses: '200': description: Pool state + stats + token metadata content: application/json: schema: $ref: '#/components/schemas/PoolWithStatsResponseDoc' '404': description: Pool not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDoc' '500': description: Internal error content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDoc' components: schemas: PoolWithStatsResponseDoc: type: object required: - data properties: data: $ref: '#/components/schemas/PoolWithStatsDoc' ErrorResponseDoc: type: object required: - error properties: error: type: string ref: type: - string - 'null' PoolWithStatsDoc: allOf: - $ref: '#/components/schemas/PoolStateDoc' - type: object required: - reserve0 - reserve1 - display_flipped properties: base_token: oneOf: - type: 'null' - $ref: '#/components/schemas/TokenDoc' display_flipped: type: boolean description: True when the canonical display orientation is (token1, token0). quote_token: oneOf: - type: 'null' - $ref: '#/components/schemas/TokenDoc' reserve0: type: string reserve1: type: string stats: oneOf: - type: 'null' - $ref: '#/components/schemas/PoolStatsDoc' token0_info: oneOf: - type: 'null' - $ref: '#/components/schemas/TokenDoc' token1_info: oneOf: - type: 'null' - $ref: '#/components/schemas/TokenDoc' PoolStateDoc: type: object required: - id - key - token0 - token1 - enabled - creator - fee_percent - created_at - init_tx properties: created_at: type: string creator: type: string enabled: type: boolean fee_percent: type: string id: type: string init_tx: type: string key: type: string token0: type: string token1: type: string TokenDoc: type: object required: - id - address - name - symbol - decimals properties: address: type: string amm_token_program: type: - string - 'null' description: >- Program for the token representation used by the AMM; the wrapper program for wrapped assets. decimals: type: integer format: int32 id: type: string image: type: - string - 'null' name: type: string symbol: type: string underlying_program: type: - string - 'null' underlying_token_id: type: - string - 'null' PoolStatsDoc: type: object required: - id - price - price_reversed - active_tick - tick_spacing - liquidity - pool - fee_protocol - protocol_fees0 - protocol_fees1 - fee_growth_global0_x_128 - fee_growth_global1_x_128 - max_liquidity_per_tick - next_init_below - next_init_above properties: active_tick: type: integer format: int32 fee_growth_global0_x_128: type: string fee_growth_global1_x_128: type: string fee_protocol: type: integer format: int32 id: type: string liquidity: type: string max_liquidity_per_tick: type: string next_init_above: type: integer format: int32 next_init_below: type: integer format: int32 pool: type: string price: type: string price_reversed: type: string protocol_fees0: type: string protocol_fees1: type: string tick_spacing: type: integer format: int32 ````