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

# Get protocol information

> Returns protocol-wide token metrics including RAM supply, xRAM staking, emissions, and voting information. Data is cached for 30 seconds.



## OpenAPI

````yaml https://gateway.ramses.xyz/v3/hyperevm/swagger/json get /protocol-info
openapi: 3.1.0
info:
  title: Ramses API - HyperEVM
  description: |-
    REST API for the Ramses DEX on HyperEVM.

    ## Rate Limiting

    - **30 requests per 30 seconds** per client IP address

    ## Caching

    Some endpoints are cached to improve performance:
    - `/stats`: 60 seconds
    - `/protocol-info`: 30 seconds
    - `/hyperram-data`: 30 seconds
    - `/circ_supply`, `/fdv`, `/hyperram_fdv`: 5 minutes
  version: 4.0.0
  contact:
    name: Ramses
    url: https://gateway.ramses.xyz/v3/hyperevm
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://gateway.ramses.xyz/v3/hyperevm
    description: Production
security: []
tags:
  - name: Health
    description: API and indexer health status
  - name: Pools
    description: Liquidity pool data, TVL, APRs, and rewards
  - name: Tokens
    description: Token information and prices
  - name: Stats
    description: Historical protocol and pool statistics
  - name: Protocol
    description: Protocol-wide token supply, emissions, and voting metrics
  - name: Positions
    description: User position data
  - name: HyperRAM
    description: X33 token compound/rebase data and APR calculations
  - name: CoinGecko
    description: Endpoints for CoinGecko integration (supply data)
  - name: Fee Launcher
    description: Dynamic fee schedules for new pool launches
paths:
  /protocol-info:
    get:
      tags:
        - Protocol
      summary: Get protocol information
      description: >-
        Returns protocol-wide token metrics including RAM supply, xRAM staking,
        emissions, and voting information. Data is cached for 30 seconds.
      operationId: getProtocol-info
      responses:
        '200':
          description: Protocol-wide token and voting information
          content:
            application/json:
              schema:
                description: Protocol-wide token and voting information
                examples:
                  - ramTotalSupply: 1000000
                    ramTotalSupplyUSD: 1500000
                    ramCirculating: 500000
                    ramCirculatingUSD: 750000
                    xramSupply: 300000
                    xramSupplyUSD: 450000
                    xramStaked: 200000
                    xramStakedUSD: 300000
                    currentEpochEmissions: 10000
                    currentEpochEmissionsUSD: 15000
                    nextEpochEmissions: 9500
                    nextEpochEmissionsUSD: 14250
                    ramPriceUSD: 1.5
                    totalVotes: 150000
                    totalVotesUSD: 225000
                    pctVoted: 0.75
                    firstPeriod: 1
                    currentPeriod: 52
                type: object
                properties:
                  ramTotalSupply:
                    description: Total emission token supply
                    type: number
                  ramTotalSupplyUSD:
                    description: Total emission token supply value in USD
                    type: number
                  ramCirculating:
                    description: Circulating emission token supply
                    type: number
                  ramCirculatingUSD:
                    description: Circulating emission token supply value in USD
                    type: number
                  xramSupply:
                    description: Total staking token supply
                    type: number
                  xramSupplyUSD:
                    description: Total staking token supply value in USD
                    type: number
                  xramStaked:
                    description: Staking tokens locked in vote module
                    type: number
                  xramStakedUSD:
                    description: Staked tokens value in USD
                    type: number
                  currentEpochEmissions:
                    description: Current epoch token emissions
                    type: number
                  currentEpochEmissionsUSD:
                    description: Current epoch emissions value in USD
                    type: number
                  nextEpochEmissions:
                    description: Next epoch token emissions
                    type: number
                  nextEpochEmissionsUSD:
                    description: Next epoch emissions value in USD
                    type: number
                  ramPriceUSD:
                    description: Current emission token price in USD
                    type: number
                  totalVotes:
                    description: Total votes for next epoch
                    type: number
                  totalVotesUSD:
                    description: Total votes value in USD
                    type: number
                  pctVoted:
                    description: Percentage of staked tokens that have voted
                    type: number
                  firstPeriod:
                    description: First voting period number
                    type: number
                  currentPeriod:
                    description: Current voting period number
                    type: number
                required:
                  - ramTotalSupply
                  - ramTotalSupplyUSD
                  - ramCirculating
                  - ramCirculatingUSD
                  - xramSupply
                  - xramSupplyUSD
                  - xramStaked
                  - xramStakedUSD
                  - currentEpochEmissions
                  - currentEpochEmissionsUSD
                  - nextEpochEmissions
                  - nextEpochEmissionsUSD
                  - ramPriceUSD
                  - totalVotes
                  - totalVotesUSD
                  - pctVoted
                  - firstPeriod
                  - currentPeriod
                additionalProperties: false

````