AnyGas Privacy Pool API

openapi: 3.2.0
info:
  title: Anygas Xyz Privacy Pool API
  version: 3.28.2
  contact:
    name: Robyn AnyGas
    url: https://anygas.xyz
  license:
    name: Service terms
    url: https://anygas.xyz/svc/api/terms
  x-lastUpdated: '2026-07-29'
  description: 'Operations tagged privacy-pool across 2 of this provider''s published API definitions: anygas-openapi.json, anygas-xyz-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.anygas.xyz/svc
  description: Production gateway (also https://anygas.xyz/svc)
tags:
- name: privacy-pool
paths:
  /api/pool/info:
    get:
      tags:
      - privacy-pool
      summary: Pool readiness, blocked gates and design notes
      description: 'BETA: the withdrawal circuit is not independently audited. A hard on-chain deposit cap bounds the value at risk. Deposit only what you can afford to lose entirely.'
      responses:
        '200':
          description: Readiness, blocked arming gates, registered association providers
      operationId: getApiPoolInfo
      x-operation-id-source: derived
    servers:
    - url: https://api.anygas.xyz/svc
      description: Production gateway (also https://anygas.xyz/svc)
  /api/pool/state:
    get:
      tags:
      - privacy-pool
      summary: Live contract state
      description: 'Always answers. `source` is one of chain | cache | ledger-only so you can tell a confirmed number from a remembered one. BETA: the withdrawal circuit is not independently audited. A hard on-chain deposit cap bounds the value at risk. Deposit only what you can afford to lose entirely.'
      responses:
        '200':
          description: Deposits, cap, balance, current root, indexer freshness
      operationId: getApiPoolState
      x-operation-id-source: derived
    servers:
    - url: https://api.anygas.xyz/svc
      description: Production gateway (also https://anygas.xyz/svc)
  /api/pool/sets:
    get:
      tags:
      - privacy-pool
      summary: Association sets and Merkle paths
      description: 'Pass ?commitment= to also receive the Merkle path for that deposit. Every set carries anonymity.{size, weak, threshold, advice} — check `weak` before relying on this for privacy. Members are listed in order so you can rebuild the Poseidon depth-20 tree and verify the root yourself. Rate limited to 30/min. BETA: the withdrawal circuit is not independently audited. A hard on-chain deposit cap bounds the value at risk. Deposit only what you can afford to lose entirely.'
      parameters:
      - name: commitment
        in: query
        required: false
        schema:
          type: string
          pattern: ^[0-9a-f]{64}$
        description: your deposit commitment, to receive its authentication path
      responses:
        '200':
          description: Full-pool and per-provider sets, roots, paths and anonymity
      operationId: getApiPoolSets
      x-operation-id-source: derived
    servers:
    - url: https://api.anygas.xyz/svc
      description: Production gateway (also https://anygas.xyz/svc)
  /api/pool/deposit:
    get:
      tags:
      - privacy-pool
      summary: How to deposit (you send the transaction yourself)
      description: 'Returns the contract, denomination and ABI. We do not take custody and do not relay deposits: a relayed deposit would record OUR address as the funding address for everybody, collapsing the provenance that association sets filter on. BETA: the withdrawal circuit is not independently audited. A hard on-chain deposit cap bounds the value at risk. Deposit only what you can afford to lose entirely.'
      responses:
        '200':
          description: Instructions, contract address, denomination, current state
      operationId: getApiPoolDeposit
      x-operation-id-source: derived
    post:
      tags:
      - privacy-pool
      summary: Ask the indexer to re-scan now
      description: 'Nothing in the request body is read or trusted; deposits are indexed from on-chain Deposit events. The keeper does this automatically every 2 minutes, so this only makes it sooner. Rate limited to 6/min. BETA: the withdrawal circuit is not independently audited. A hard on-chain deposit cap bounds the value at risk. Deposit only what you can afford to lose entirely.'
      responses:
        '200':
          description: What was newly indexed, plus current state
      operationId: postApiPoolDeposit
      x-operation-id-source: derived
    servers:
    - url: https://api.anygas.xyz/svc
      description: Production gateway (also https://anygas.xyz/svc)
  /api/pool/withdraw:
    post:
      tags:
      - privacy-pool
      summary: Relay a withdrawal proof — we pay the gas
      description: 'Build the PLONK proof client-side; your secret never leaves your machine. The recipient is bound inside the proof, so nobody (including us) can redirect the payout. Simulated before broadcast, so an invalid proof costs you a 400 rather than a failed transaction. Rate limited to 10/min. BETA: the withdrawal circuit is not independently audited. A hard on-chain deposit cap bounds the value at risk. Deposit only what you can afford to lose entirely.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - proof
              - root
              - nullifierHash
              - recipient
              properties:
                proof:
                  type: array
                  minItems: 24
                  maxItems: 24
                  items:
                    type: string
                  description: 24 field elements in snarkjs plonk.exportSolidityCallData order
                root:
                  type: string
                  pattern: ^0x[0-9a-fA-F]{64}$
                nullifierHash:
                  type: string
                  pattern: ^0x[0-9a-fA-F]{64}$
                recipient:
                  type: string
                  pattern: ^0x[0-9a-fA-F]{40}$
      responses:
        '200':
          description: Broadcast; returns txHash and the amount paid
        '400':
          description: Malformed, or simulated and would revert (not broadcast)
        '409':
          description: Note already spent, or a root the contract has never seen
        '413':
          description: Body too large
        '429':
          description: Rate limited
      operationId: postApiPoolWithdraw
      x-operation-id-source: derived
    servers:
    - url: https://api.anygas.xyz/svc
      description: Production gateway (also https://anygas.xyz/svc)
x-refined-from:
- anygas-openapi.json
- anygas-xyz-openapi.json