openapi: 3.1.0
info:
  title: Helius API Catalog Addresses Admin API
  version: 1.0.0
  summary: Machine-readable discovery document for every Helius API surface on Solana.
  description: 'This document is a discovery catalog — not an operational spec. It exists so

    AI agents, codegen tools, and SDK generators can locate the canonical

    OpenAPI document for every Helius API in one request instead of crawling

    the docs site.


    Start with the `x-apis` array: each entry links a Helius API surface to its

    canonical OpenAPI spec (`specUrl`) and human-readable docs (`docsUrl`).

    Follow `externalDocs` for the full developer documentation site.


    ## A note on JSON-RPC APIs


    Several Helius APIs (Solana RPC, DAS, Sender, Mint, Priority Fee,

    ZK Compression) follow the JSON-RPC 2.0 convention where every method POSTs

    to `/` with a `method` field in the request body. For each such API the

    repository ships both per-method fragment YAMLs (used to render the

    Mintlify reference pages) and an auto-generated `_combined.yaml` that

    merges every method into a single OpenAPI document. In the combined

    documents, colliding paths are disambiguated with a URL-fragment suffix

    (e.g. `/#getAccountInfo`) and each operation carries an `x-actual-path`

    extension that records the real request path (`/`). The fragment syntax is

    schema-only — real calls still go to the `url` in `servers`.


    All `specUrl` values below point to raw GitHub files on the `main` branch

    of `helius-labs/docs`. They are stable URLs suitable for downstream tools

    to pin or fetch.

    '
  contact:
    name: Helius Support
    url: https://www.helius.dev/contact
    email: support@helius.dev
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://mainnet.helius-rpc.com
  description: Solana mainnet RPC endpoint (Solana RPC, DAS, Priority Fee, ZK Compression)
- url: https://devnet.helius-rpc.com
  description: Solana devnet RPC endpoint
- url: https://sender.helius-rpc.com
  description: Helius Sender — global transaction submission
- url: https://api.helius.xyz
  description: Helius REST APIs (Wallet API, Enhanced API, Webhooks)
- url: https://admin-api.helius.xyz
  description: Helius Admin API — project usage and billing
- url: https://api-mainnet.helius-rpc.com
  description: Mainnet RPC endpoint
- url: https://api-devnet.helius-rpc.com
  description: Devnet RPC endpoint
- url: http://slc-sender.helius-rpc.com
  description: Salt Lake City
- url: http://ewr-sender.helius-rpc.com
  description: Newark
- url: http://lon-sender.helius-rpc.com
  description: London
- url: http://fra-sender.helius-rpc.com
  description: Frankfurt
- url: http://ams-sender.helius-rpc.com
  description: Amsterdam
- url: http://sg-sender.helius-rpc.com
  description: Singapore
- url: http://tyo-sender.helius-rpc.com
  description: Tokyo
tags:
- name: Admin
paths:
  /v0/admin/projects/{id}/usage:
    get:
      tags:
      - Admin
      summary: Get Project Usage
      operationId: adminApi_getProjectUsage
      description: 'Retrieve credit usage, subscription details, and per-service request counts for a project within the current billing cycle.


        The API key used for authentication must belong to the project specified in the path. Requests where the API key''s project does not match the `id` parameter will return a `400` error.

        '
      parameters:
      - name: id
        in: path
        required: true
        description: The project ID to retrieve usage for. Must match the project associated with the API key.
        schema:
          type: string
          format: uuid
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
      responses:
        '200':
          description: Project usage retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminApi_ProjectUsageResponse'
              example:
                creditsRemaining: 487500
                creditsUsed: 12500
                prepaidCreditsRemaining: 50000
                prepaidCreditsUsed: 0
                subscriptionDetails:
                  billingCycle:
                    start: '2026-04-01'
                    end: '2026-05-01'
                  creditsLimit: 500000
                  plan: business
                usage:
                  api: 1200
                  archival: 0
                  das: 5000
                  grpc: 300
                  grpcGeyser: 0
                  photon: 0
                  rpc: 4500
                  stream: 100
                  webhook: 800
                  websocket: 600
        '400':
          description: Bad Request — the project ID in the path does not match the project associated with the API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminApi_ErrorResponse'
              example:
                statusCode: 400
                message: Invalid project id
                error: Bad Request
        '401':
          description: Unauthorized — API key is missing, malformed, or not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminApi_ErrorResponse'
              example:
                statusCode: 401
                message: Missing or invalid API key
                error: Unauthorized
        '403':
          description: Forbidden — the Admin API is not enabled for this project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminApi_ErrorResponse'
              example:
                statusCode: 403
                message: Admin API not enabled for this project
                error: Forbidden
        '429':
          description: Too Many Requests — rate limit of 5 requests per second exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminApi_ErrorResponse'
              example:
                statusCode: 429
                message: 'ThrottlerException: Too Many Requests'
                error: Too Many Requests
        '500':
          description: Internal Server Error — a server-side error occurred (e.g., missing billing data).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminApi_ErrorResponse'
              example:
                statusCode: 500
                message: Internal server error
                error: Internal Server Error
      servers:
      - url: https://admin-api.helius.xyz
        description: Production server
components:
  schemas:
    AdminApi_ProjectUsageResponse:
      type: object
      properties:
        creditsRemaining:
          type: number
          description: Number of credits remaining in the current billing cycle. Calculated as `creditsLimit - regularCreditsUsed`, floored at 0.
          example: 487500
        creditsUsed:
          type: number
          description: Total credits consumed in the current billing cycle, including both regular and prepaid credits.
          example: 12500
        prepaidCreditsRemaining:
          type: number
          description: Number of prepaid credits remaining.
          example: 50000
        prepaidCreditsUsed:
          type: number
          description: Number of prepaid credits consumed in the current billing cycle.
          example: 0
        subscriptionDetails:
          type: object
          description: Details about the project's subscription plan and current billing cycle.
          properties:
            billingCycle:
              type: object
              description: Start and end dates of the current billing cycle.
              properties:
                start:
                  type: string
                  description: Billing cycle start date.
                  example: '2026-04-01'
                end:
                  type: string
                  description: Billing cycle end date.
                  example: '2026-05-01'
            creditsLimit:
              type: number
              description: Total credit allowance for the current billing cycle based on the plan.
              example: 500000
            plan:
              type: string
              description: The name of the subscription plan.
              example: business
        usage:
          type: object
          description: Request counts broken down by service type for the current billing cycle.
          properties:
            api:
              type: number
              description: Number of Enhanced API requests (e.g., parsed transactions, token metadata).
              example: 1200
            archival:
              type: number
              description: Number of archival RPC requests.
              example: 0
            das:
              type: number
              description: Number of DAS (Digital Asset Standard) API requests.
              example: 5000
            grpc:
              type: number
              description: Number of gRPC streaming requests.
              example: 300
            grpcGeyser:
              type: number
              description: Number of Geyser gRPC requests.
              example: 0
            photon:
              type: number
              description: Number of ZK Compression (Photon) requests.
              example: 0
            rpc:
              type: number
              description: Number of standard Solana RPC requests.
              example: 4500
            stream:
              type: number
              description: Number of LaserStream data streaming requests.
              example: 100
            webhook:
              type: number
              description: Number of webhook delivery events.
              example: 800
            websocket:
              type: number
              description: Number of WebSocket subscription requests.
              example: 600
    AdminApi_ErrorResponse:
      type: object
      properties:
        statusCode:
          type: integer
          description: HTTP status code.
        message:
          type: string
          description: Human-readable error message.
        error:
          type: string
          description: HTTP error name.
  securitySchemes:
    ApiKeyQuery:
      type: apiKey
      in: query
      name: api-key
      description: Your Helius API key. You can get one for free in the [dashboard](https://dashboard.helius.dev/api-keys).
    ApiKeyHeader:
      type: apiKey
      in: header
      name: X-Api-Key
      description: API key passed in request header
externalDocs:
  description: Helius Documentation (canonical)
  url: https://www.helius.dev/docs
x-apis:
- id: rpc-http
  name: Solana RPC (HTTP)
  description: JSON-RPC 2.0 methods for Solana mainnet and devnet, plus Helius extensions such as `getTransactionsForAddress` with server-side filtering and token account helpers (`getTokenAccountsByOwnerV2`, `getProgramAccountsV2`).
  specUrl: https://www.helius.dev/openapi/rpc-http.json
  docsUrl: https://www.helius.dev/docs/rpc/overview
  tags:
  - rpc
  - json-rpc
  - solana
  - accounts
  - transactions
  status: stable
  x-specFragments: https://github.com/helius-labs/docs/tree/main/openapi/rpc-http
- id: das-api
  name: Digital Asset Standard (DAS) API
  description: Unified NFT and token queries for Solana — regular NFTs, compressed NFTs, and fungible tokens — indexed for fast lookups by owner, creator, authority, collection, or search.
  specUrl: https://www.helius.dev/openapi/das-api.json
  docsUrl: https://www.helius.dev/docs/das-api
  tags:
  - nft
  - tokens
  - compressed-nft
  - digital-assets
  - json-rpc
  status: stable
  x-specFragments: https://github.com/helius-labs/docs/tree/main/openapi/das-api
- id: sender-api
  name: Helius Sender
  description: Ultra-low-latency transaction submission with dual routing to validators and Jito infrastructure. Regional endpoints for Salt Lake City, Newark, London, Frankfurt, Amsterdam, Singapore, and Tokyo.
  specUrl: https://www.helius.dev/openapi/sender-api.json
  docsUrl: https://www.helius.dev/docs/sending-transactions/sender
  tags:
  - transactions
  - sender
  - low-latency
  - jito
  status: stable
  x-specFragments: https://github.com/helius-labs/docs/tree/main/openapi/sender-api
- id: wallet-api
  name: Wallet API
  description: High-performance REST API for Solana wallet data — identity, balances, transaction history, transfers, and funding lineage. Returns pre-indexed results suitable for wallet and portfolio UIs.
  specUrl: https://www.helius.dev/openapi/wallet-api.json
  docsUrl: https://www.helius.dev/docs/wallet-api/overview
  tags:
  - wallet
  - portfolio
  - history
  - rest
  status: beta
- id: priority-fee-api
  name: Priority Fee API
  description: Real-time priority fee recommendations across multiple priority levels, derived from recent network activity. Accepts either account keys or a serialized transaction.
  specUrl: https://www.helius.dev/openapi/priority-fee-api.json
  docsUrl: https://www.helius.dev/docs/priority-fee-api
  tags:
  - priority-fee
  - transactions
  - fees
  - json-rpc
  status: stable
  x-specFragments: https://github.com/helius-labs/docs/tree/main/openapi/priority-fee-api
- id: zk-compression
  name: ZK Compression Indexer
  description: Indexer API for Solana state compression — compressed accounts, compressed token balances, Merkle proofs, and validity proofs. Enables up to 1000x lower storage costs relative to regular accounts.
  specUrl: https://www.helius.dev/openapi/zk-compression.json
  docsUrl: https://www.helius.dev/docs/zk-compression/introduction
  tags:
  - zk-compression
  - state-compression
  - accounts
  - proofs
  - json-rpc
  status: stable
  x-specFragments: https://github.com/helius-labs/docs/tree/main/openapi/zk-compression
- id: admin-api
  name: Admin API
  description: Programmatic access to Helius project usage and billing data — credits consumed, credits remaining, prepaid balances, and subscription details for the current billing cycle.
  specUrl: https://www.helius.dev/openapi/admin-api.json
  docsUrl: https://www.helius.dev/docs/api-reference/admin
  tags:
  - admin
  - billing
  - usage
  - rest
  status: stable
  x-specFragments: https://github.com/helius-labs/docs/tree/main/openapi/admin-api
- id: enhanced-api
  name: Enhanced API
  description: Decoded, human-readable transaction history, NFT events, and address activity on Solana. Returns typed, parsed data instead of raw instruction bytes.
  specUrl: https://www.helius.dev/openapi/enhanced-api.json
  docsUrl: https://www.helius.dev/docs/enhanced-transactions/overview
  tags:
  - enhanced
  - parsed-transactions
  - nft-events
  - history
  - rest
  status: stable
- id: webhooks
  name: Helius Webhooks
  description: Real-time HTTP notifications for Solana on-chain events — configure account, transaction, or NFT event subscriptions and receive parsed payloads via HTTPS POST.
  specUrl: https://www.helius.dev/openapi/webhooks.json
  docsUrl: https://www.helius.dev/docs/webhooks
  tags:
  - webhooks
  - events
  - notifications
  - rest
  status: stable