> ## Documentation Index
> Fetch the complete documentation index at: https://docs.portalhq.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get gas sponsors

> Retrieves all gas sponsors and their usage information across all chains for
your Portal environment. Solana entries also include the gas sponsor's
on-chain address and current balance.

**Filtering:** Pass the optional `chains` query parameter to narrow the
response to a subset of chains. Each entry may be either a friendly
chain slug (for example `solana`, `solana-devnet`, `base`, `ethereum`)
or a full CAIP-2 chain ID (for example `eip155:1`,
`solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp`).

**Tip — speed up your request:** Only need a subset of chains?
Passing `chains` skips the data fetches for every chain you leave out,
which can reduce response times from several seconds to a few
hundred milliseconds. For example, if you only care about Solana
gas sponsor info, pass `chains=solana,solana-devnet`.

**Note:** Gas sponsorship must be enabled for your Portal environment.




## OpenAPI

````yaml /openapi/custodian-api.yaml get /custodians/me/gas-sponsorship/chains
openapi: 3.1.0
info:
  title: Portal Custodian API
  version: '3.0'
  description: >
    The Portal Custodian API provides endpoints for managing clients, building
    transactions,

    retrieving wallet data, managing delegations, alert webhooks, and gas
    sponsorship.

    All endpoints require authentication via a Portal API Key (also known as a
    Custodian API Key)

    passed as a Bearer token.


    ## Base URL

    `https://api.portalhq.io/api/v3`


    ## Authentication

    Include your Portal API Key as a Bearer token in the `Authorization` header
    of every request.


    ## Chain ID Format

    Chain parameters use either friendly names (e.g. `ethereum`, `solana`) or
    CAIP-2 format

    (e.g. `eip155:1`, `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp`). When using
    CAIP-2 format

    in URLs, ensure the colon is URI-encoded (`%3A`).
servers:
  - url: https://api.portalhq.io/api/v3
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Clients
    description: Create and manage Portal clients
  - name: Transactions
    description: Build and evaluate blockchain transactions
  - name: Wallet Metadata
    description: Retrieve wallet balances and NFTs
  - name: Wallet Shares
    description: Manage backup shares and wallet ejection
  - name: Delegations
    description: Manage token delegations and delegated transfers
  - name: Session Keys
    description: Build and send EIP-7702 session key user operations
  - name: Alert Webhooks
    description: Manage alert webhooks, external addresses, and replay failed events
  - name: Gas Sponsorship
    description: View and manage gas sponsorship across chains
paths:
  /custodians/me/gas-sponsorship/chains:
    get:
      tags:
        - Gas Sponsorship
      summary: Get gas sponsors
      description: >
        Retrieves all gas sponsors and their usage information across all chains
        for

        your Portal environment. Solana entries also include the gas sponsor's

        on-chain address and current balance.


        **Filtering:** Pass the optional `chains` query parameter to narrow the

        response to a subset of chains. Each entry may be either a friendly

        chain slug (for example `solana`, `solana-devnet`, `base`, `ethereum`)

        or a full CAIP-2 chain ID (for example `eip155:1`,

        `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp`).


        **Tip — speed up your request:** Only need a subset of chains?

        Passing `chains` skips the data fetches for every chain you leave out,

        which can reduce response times from several seconds to a few

        hundred milliseconds. For example, if you only care about Solana

        gas sponsor info, pass `chains=solana,solana-devnet`.


        **Note:** Gas sponsorship must be enabled for your Portal environment.
      operationId: getGasSponsors
      parameters:
        - in: query
          name: chains
          required: false
          description: |
            Comma-separated list of chains to include in the response. Each
            entry may be a friendly slug (e.g. `solana`, `base`) or a full
            CAIP-2 chain ID (e.g. `eip155:1`). When omitted, every configured
            chain is returned.
          schema:
            type: string
          examples:
            solanaOnly:
              summary: Solana mainnet + devnet only
              value: solana,solana-devnet
            mixed:
              summary: Mix of slugs and CAIP-2 ids
              value: base,eip155:1,solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp
      responses:
        '200':
          description: Gas sponsors retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GasSponsorChainsResponse'
              example:
                - chainId: eip155:11155111
                  currentPeriod:
                    gasAllowanceLimit: '499'
                    gasUsage: '0.35080714673101143'
                    transactionCount: '3005'
                    endsAt: '2026-02-13T17:49:43.000Z'
                - chainId: solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1
                  currentPeriod:
                    gasAllowanceLimit: '5'
                    gasUsage: '0.0053'
                    transactionCount: '12'
                    endsAt: '2026-02-13T17:49:43.000Z'
                  gasSponsor:
                    address: 8K1q5fZcHz3bVExampleSolanaGasSponsorPublicKey
                    balance: '4.927'
                    balanceInBaseUnits: '4927000000'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - invalid or missing authentication token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    GasSponsorChainsResponse:
      type: array
      items:
        $ref: '#/components/schemas/GasSponsorChainResponse'
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
    GasSponsorChainResponse:
      type: object
      properties:
        chainId:
          type: string
        currentPeriod:
          type: object
          properties:
            gasAllowanceLimit:
              type: string
            gasUsage:
              type: string
            transactionCount:
              type: string
              description: |
                Stringified integer count of sponsored transactions in the
                current period.
            endsAt:
              type: string
              format: date-time
        gasSponsor:
          nullable: true
          description: |
            Only present on Solana entries. `null` when no gas sponsor has
            been configured for that chain yet. The `balance` and
            `balanceInBaseUnits` fields are `null` when the RPC balance
            lookup fails (the sponsor address is still returned).
          type: object
          properties:
            address:
              type: string
              description: The gas sponsor's on-chain address.
            balance:
              type: string
              nullable: true
              description: |
                Human-readable native-token balance (e.g. SOL on Solana),
                formatted from `balanceInBaseUnits` using the chain's
                decimal precision.
            balanceInBaseUnits:
              type: string
              nullable: true
              description: |
                Stringified integer balance in the chain's base units
                (lamports on Solana).
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Portal API Key (Custodian API Key). Pass as a Bearer token in the
        Authorization header.

````