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

# Protocol Stats

> Aggregate protocol statistics including total supply, borrow, TVL, and market counts.



## OpenAPI

````yaml GET /stats
openapi: 3.0.3
info:
  title: Circular API
  description: >-
    DeFi risk intelligence API by Rosetta — markets, vaults, positions, risk
    analysis, credit ratings, and portfolio management across Morpho Blue, Aave
    V3, and other lending protocols.
  version: 1.0.0
  contact:
    name: Rosetta
    url: https://rosetta.sh
servers:
  - url: https://api.circular.rosetta.sh/api/v1
    description: Production
security:
  - BearerApiKey: []
tags:
  - name: Markets
    description: Lending market data — overview, search, compare, history, positions
  - name: Tokens
    description: Token metadata and oracle feeds
  - name: Vaults
    description: Vault data — overview, concentration, depositors
  - name: Positions
    description: Position scanning — wallet positions, loops, vault positions
  - name: Risk
    description: >-
      Risk analysis — dashboard, concentration, depeg simulation, protocol
      health
  - name: Liquidations
    description: Liquidation feed and history
  - name: Analytics
    description: Strategy breakdown, trends, yield opportunities, whale monitoring
  - name: Research
    description: Deep market research, deployment analysis, borrow strategy
  - name: Ratings
    description: Credit ratings — methodology, market ratings, vault ratings
  - name: Portfolios
    description: Portfolio management — overview, risk, yield, alerts, liquidity
  - name: Health
    description: API health check
  - name: Agent
    description: Agent risk API — risk checks and policy defaults
  - name: Client
    description: Client self-service — profile, API keys, usage, quota dashboard
paths:
  /stats:
    get:
      tags:
        - Analytics
      summary: Get protocol statistics
      description: >-
        Aggregate protocol statistics including total supply, borrow, TVL, and
        market counts.
      operationId: protocolStats
      responses:
        '200':
          description: Protocol statistics
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ProtocolStats'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '400':
          description: Handler error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HandlerErrorResponse'
components:
  schemas:
    ProtocolStats:
      type: object
      properties:
        protocol:
          type: string
        totalSupplyUsd:
          type: number
        totalBorrowUsd:
          type: number
        tvl:
          type: number
          description: Supply-side only, no borrow
        marketCount:
          type: integer
        vaultCount:
          type: integer
        avgUtilization:
          type: number
          description: totalBorrow / totalSupply
        chains:
          type: array
          items:
            type: integer
    Meta:
      type: object
      properties:
        latencyMs:
          type: number
          description: Server-side processing time in milliseconds
        freshness:
          type: string
          description: Data freshness indicator (live, cached, snapshot)
        source:
          type: string
          description: Which protocol(s) provided data
    HandlerErrorResponse:
      type: object
      description: Returned when a handler returns success false (HTTP 400)
      properties:
        error:
          type: string
          description: Error message from the handler
        meta:
          $ref: '#/components/schemas/Meta'
  securitySchemes:
    BearerApiKey:
      type: http
      scheme: bearer
      description: API key in format circ_live_* or circ_test_*

````