Gloam API

Gloam API as documented publicly: 16 operations. Contract generated from the documentation by API Evangelist (2026-11-10); not the provider's own document.

GitHub OpenAPI

Operations 16

POST /api/partners/attribute Partner program and API #
POST /api/partners/register Register a partner flow #
GET /api/v1 Partner program and API #
GET /api/v1/activity Get recent activity and volume #
POST /api/v1/deposits Report a deposit #
GET /api/v1/me GET /api/v1/me #
POST /api/v1/payment-requests POST /api/v1/payment-requests #
POST /api/v1/proofs/verify POST /api/v1/proofs/verify #
GET /api/v1/relay Get relay status #
POST /api/v1/relay POST /api/v1/relay #
GET /api/v1/stats Partner program and API #
GET /api/v1/swaps List swaps per network #
POST /api/v1/swaps/quote POST /api/v1/swaps/quote #
GET /api/v1/vaults List vaults for all networks #
GET /api/v1/vaults/tempo-mainnet GET /api/v1/vaults/tempo-mainnet #
GET /api/v1/vaults/{network}/leaves Get public leaf list for a vault #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/gloam-trade:gloam-trade-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gloam-trade-openapi-generated.yml Raw ↑
openapi: 3.1.0
info:
  title: Gloam API
  version: '2026-11-10'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-10: 16 operation(s) read from 4 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Gloam has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 6
    documentation: 10
    pages-with-code: 1
    pages-read: 4
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-10'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://www.gloam.trade/docs/sdk/reference
  - https://www.gloam.trade/docs/partners
  - https://www.gloam.trade/docs/private-swaps
  - https://www.gloam.trade/partners
servers:
- url: https://gloam.trade
paths:
  /api/partners/attribute:
    post:
      operationId: post_api_partners_attribute
      tags:
      - Api
      summary: Partner program and API
      x-source: https://www.gloam.trade/docs/partners
      parameters:
      - name: chainId
        in: query
        required: true
        schema:
          type: integer
        description: Chain identifier
      - name: txHash
        in: query
        required: true
        schema:
          type: string
        description: Transaction hash
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiPartnersAttributeRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiPartnersAttributeResponse'
      x-evidence:
        kind: documentation
  /api/partners/register:
    post:
      operationId: post_api_partners_register
      tags:
      - Api
      summary: Register a partner flow
      x-source: https://www.gloam.trade/docs/partners
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer API key
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        description: application/json
      - name: Origin
        in: header
        required: true
        schema:
          type: string
        description: Must be https://gloam.trade
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiPartnersRegisterRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiPartnersRegisterResponse'
      x-evidence:
        kind: documentation
  /api/v1:
    get:
      operationId: get_api_v1
      tags:
      - Api
      summary: Partner program and API
      x-source: https://www.gloam.trade/docs/partners
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        description: Bearer API key (not required for this endpoint)
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1Response'
      x-evidence:
        kind: documentation
  /api/v1/activity:
    get:
      operationId: get_api_v1_activity
      tags:
      - Api
      summary: Get recent activity and volume
      x-source: https://www.gloam.trade/docs/partners
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer API key
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Number of recent items to return
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1ActivityResponse'
      x-evidence:
        kind: documentation
  /api/v1/deposits:
    post:
      operationId: post_api_v1_deposits
      tags:
      - Api
      summary: Report a deposit
      x-source: https://www.gloam.trade/docs/partners
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer API key
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        description: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1DepositsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1DepositsResponse'
      x-evidence:
        kind: documentation
  /api/v1/me:
    get:
      operationId: get_api_v1_me
      tags:
      - Api
      summary: GET /api/v1/me
      x-source: https://www.gloam.trade/docs/partners
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl https://gloam.trade/api/v1/me  -H "Authorization: Bearer $GLOAM_API_KEY" Each key gets 300 requests a minute across every
          endpoint. Responses carry X-RateLimit-Limit , X-RateLimit-Remaining and X-RateLimit-Reset (unix seconds); a 429 adds Retry-After . The
          relay also keeps its own per-sender and per-network caps, and an hourly limit on the gas it pays, of which one sender may use a share.
          You'
  /api/v1/payment-requests:
    post:
      operationId: post_api_v1_payment_requests
      tags:
      - Api
      summary: POST /api/v1/payment-requests
      x-source: https://www.gloam.trade/docs/partners
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1PaymentRequestsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://gloam.trade/api/v1/payment-requests  -H \"Authorization: Bearer $GLOAM_API_KEY\"  -H \"Content-Type: application/json\"\
          \  -d '{ \"to\": \"gloamr1.AbC...\", \"network\": \"robinhood-mainnet\", \"asset\": \"USDG\",\n \"amount\": \"1250\", \"note\": \"Invoice\
          \ 042\", \"name\": \"Acme\",\n \"partnerCode\": \"<your link code>\" }'"
  /api/v1/proofs/verify:
    post:
      operationId: post_api_v1_proofs_verify
      tags:
      - Api
      summary: POST /api/v1/proofs/verify
      x-source: https://www.gloam.trade/docs/partners
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ProofsVerifyRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl https://gloam.trade/api/v1/proofs/verify  -H "Authorization: Bearer $GLOAM_API_KEY"  -H "Content-Type: application/json"  -d
          ''{ "proof": "gloamfunds1:eyJ2IjoxLCJraW5kIjoi..." }'''
  /api/v1/relay:
    get:
      operationId: get_api_v1_relay
      tags:
      - Api
      summary: Get relay status
      x-source: https://www.gloam.trade/docs/partners
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer API key
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1RelayResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v1_relay
      tags:
      - Api
      summary: POST /api/v1/relay
      x-source: https://www.gloam.trade/docs/partners
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1RelayRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://gloam.trade/api/v1/relay  -H \"Authorization: Bearer $GLOAM_API_KEY\"  -H \"Content-Type: application/json\"  -d\
          \ '{\n \"chainId\": 4663,\n \"action\": \"transfer\",\n \"proof\": \"0x...\", \"root\": \"0x...\", \"nullifier\": \"0x...\",\n \"commitments\"\
          : [\"0x...\", \"0x...\"]\n }'"
  /api/v1/stats:
    get:
      operationId: get_api_v1_stats
      tags:
      - Api
      summary: Partner program and API
      x-source: https://www.gloam.trade/docs/partners
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1StatsResponse'
      x-evidence:
        kind: documentation
  /api/v1/swaps:
    get:
      operationId: get_api_v1_swaps
      tags:
      - Api
      summary: List swaps per network
      x-source: https://www.gloam.trade/docs/partners
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer API key
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1SwapsResponse'
      x-evidence:
        kind: documentation
  /api/v1/swaps/quote:
    post:
      operationId: post_api_v1_swaps_quote
      tags:
      - Api
      summary: POST /api/v1/swaps/quote
      x-source: https://www.gloam.trade/docs/partners
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1SwapsQuoteRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1SwapsQuoteResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://gloam.trade/api/v1/swaps/quote -H \"Authorization: Bearer $GLOAM_API_KEY\" -H \"Content-Type: application/json\"\
          \ -d '{ \"network\": \"robinhood-mainnet\", \"assetIn\": \"0x5fc5...d168\", \"assetOut\": \"0x0000000000000000000000000000000000000000\"\
          , \"amountIn\": \"100000000\" }'\n{\n \"v\": 1, \"ok\": true,\n \"data\": {\n \"network\": \"robinhood-mainnet\", \"chainId\": 4663,\n\
          \ \"router\": \"0x...\", \"routerVersion\": 2, \"ve"
  /api/v1/vaults:
    get:
      operationId: get_api_v1_vaults
      tags:
      - Api
      summary: List vaults for all networks
      x-source: https://www.gloam.trade/docs/partners
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer API key
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1VaultsResponse'
      x-evidence:
        kind: documentation
  /api/v1/vaults/tempo-mainnet:
    get:
      operationId: get_api_v1_vaults_tempo_mainnet
      tags:
      - Api
      summary: GET /api/v1/vaults/tempo-mainnet
      x-source: https://www.gloam.trade/docs/partners
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl https://gloam.trade/api/v1/vaults/tempo-mainnet  -H "Authorization: Bearer $GLOAM_API_KEY"'
  /api/v1/vaults/{network}/leaves:
    get:
      operationId: get_api_v1_vaults_network_leaves
      tags:
      - Api
      summary: Get public leaf list for a vault
      x-source: https://www.gloam.trade/docs/partners
      parameters:
      - name: network
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer API key
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1VaultsNetworkLeavesResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiPartnersAttributeRequest:
      type: object
      properties:
        chainId:
          type: integer
          description: Chain identifier
        txHash:
          type: string
          description: Transaction hash
      required:
      - chainId
      - txHash
    PostApiPartnersAttributeResponse:
      type: object
      properties:
        v:
          type: integer
          description: API version
        ok:
          type: boolean
          description: Success flag
        data:
          type: object
          description: Result data (unspecified in docs)
        requestId:
          type: string
          description: Request identifier
    PostApiPartnersRegisterRequest:
      type: object
      properties:
        chainId:
          type: integer
          description: Chain identifier
        nullifierHash:
          type: string
          description: Nullifier hash
        bindHash:
          type: string
          description: Bind hash
        code:
          type: string
          description: Partner code
        flow:
          type: string
          description: '"pay"'
      required:
      - chainId
      - nullifierHash
      - bindHash
      - code
      - flow
    PostApiPartnersRegisterResponse:
      type: object
      properties:
        v:
          type: integer
        ok:
          type: boolean
        data:
          type: object
          description: Result of registration
        requestId:
          type: string
    GetApiV1Response:
      type: object
      properties:
        v:
          type: integer
          description: API version
        ok:
          type: boolean
          description: Success flag
        data:
          type: object
          description: Endpoint‑specific data
        requestId:
          type: string
          description: Unique request identifier
    GetApiV1ActivityResponse:
      type: object
      properties:
        totals:
          type: object
        byNetwork:
          type: object
        byAsset:
          type: array
        daily:
          type: array
        recent:
          type: array
        fees:
          type: object
        charged:
          type: boolean
    PostApiV1DepositsRequest:
      type: object
      properties:
        chainId:
          type: integer
          description: Chain identifier
        txHash:
          type: string
          description: Transaction hash of the deposit
      required:
      - chainId
      - txHash
    PostApiV1DepositsResponse:
      type: object
      properties:
        v:
          type: integer
        ok:
          type: boolean
        data:
          type: object
          description: Deposit activity and charged flag
        requestId:
          type: string
    PostApiV1PaymentRequestsRequest:
      type: object
      properties:
        to:
          type: string
        network:
          type: string
        asset:
          type: string
        amount:
          type: string
        note:
          type: string
        name:
          type: string
        partnerCode:
          type: string
    PostApiV1ProofsVerifyRequest:
      type: object
      properties:
        proof:
          type: string
    GetApiV1RelayResponse:
      type: object
      properties:
        v:
          type: integer
        ok:
          type: boolean
        data:
          type: object
          description: Networks the relay can submit on
        requestId:
          type: string
    PostApiV1RelayRequest:
      type: object
      properties:
        chainId:
          type: integer
        action:
          type: string
        proof:
          type: string
        root:
          type: string
        nullifier:
          type: string
        commitments:
          type: array
          items:
            type: string
    GetApiV1StatsResponse:
      type: object
      properties:
        v:
          type: integer
          description: API version
        ok:
          type: boolean
          description: Success flag
        data:
          type: object
          description: Aggregated vault and activity stats
        requestId:
          type: string
          description: Request identifier
    GetApiV1SwapsResponse:
      type: object
      properties:
        v:
          type: integer
        ok:
          type: boolean
        data:
          type: array
          description: Swap listings
        requestId:
          type: string
    PostApiV1SwapsQuoteRequest:
      type: object
      properties:
        network:
          type: string
        assetIn:
          type: string
        assetOut:
          type: string
        amountIn:
          type: string
    PostApiV1SwapsQuoteResponse:
      type: object
      properties:
        v:
          type: integer
        ok:
          type: boolean
        data:
          type: object
          properties:
            activity:
              type: object
              properties:
                kind:
                  type: string
                symbol:
                  type: string
                amount:
                  type: string
            charged:
              type: boolean
    GetApiV1VaultsResponse:
      type: object
      properties:
        v:
          type: integer
        ok:
          type: boolean
        data:
          type: array
          description: Vault info per network
        requestId:
          type: string
    GetApiV1VaultsNetworkLeavesResponse:
      type: object
      properties:
        v:
          type: integer
        ok:
          type: boolean
        data:
          type: array
          description: Leaves with index, block, txHash, commitment
        requestId:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api