openapi: 3.2.0
info:
  contact:
    email: contact@babylonlabs.io
  description: 'The Babylon Staking API offers information about the state of the Babylon BTC Staking system.

    Your access and use is governed by the API Access License linked to below.'
  license:
    name: API Access License
    url: https://docs.babylonlabs.io/assets/files/api-access-license.pdf
  title: Babylon Staking Stats API
  version: '2.0'
tags:
- name: Stats
paths:
  /v1/stats:
    get:
      deprecated: true
      description: '[DEPRECATED] Fetches overall stats for babylon staking including tvl, total delegations, active tvl, active delegations and total stakers. Please use /v2/stats instead.'
      responses:
        '200':
          description: Overall stats for babylon staking
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.PublicResponse-v1service_OverallStatsPublic'
      summary: Get Overall Stats (Deprecated)
      tags:
      - Stats
      operationId: getV1Stats
      x-operation-id-source: derived
  /v1/stats/staker:
    get:
      deprecated: true
      description: '[DEPRECATED] Fetches staker stats for babylon staking including tvl, total delegations, active tvl and active delegations. Please use /v2/staker/stats instead.

        If staker_btc_pk query parameter is provided, it will return stats for the specific staker.

        Otherwise, it will return the top stakers ranked by active tvl.'
      parameters:
      - description: Public key of the staker to fetch
        in: query
        name: staker_btc_pk
        schema:
          type: string
      - description: Pagination key to fetch the next page of top stakers
        in: query
        name: pagination_key
        schema:
          type: string
      responses:
        '200':
          description: List of top stakers by active tvl
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.PublicResponse-array_v1service_StakerStatsPublic'
        '400':
          description: 'Error: Bad Request'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_babylonlabs-io_staking-api-service_internal_shared_types.Error'
      summary: Get Staker Stats (Deprecated)
      tags:
      - Stats
      operationId: getV1StatsStaker
      x-operation-id-source: derived
  /v2/stats:
    get:
      description: Overall system stats including max staking APR (BTC + co-staking)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.PublicResponse-v2service_OverallStatsPublic'
        '400':
          description: 'Error: Bad Request'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_babylonlabs-io_staking-api-service_internal_shared_types.Error'
      tags:
      - Stats
      summary: Get stats
      x-summary-source: derived
      operationId: getV2Stats
      x-operation-id-source: derived
components:
  schemas:
    handler.PublicResponse-v2service_OverallStatsPublic:
      properties:
        data:
          $ref: '#/components/schemas/v2service.OverallStatsPublic'
        pagination:
          $ref: '#/components/schemas/handler.paginationResponse'
      type: object
    handler.PublicResponse-v1service_OverallStatsPublic:
      properties:
        data:
          $ref: '#/components/schemas/v1service.OverallStatsPublic'
        pagination:
          $ref: '#/components/schemas/handler.paginationResponse'
      type: object
    v1service.StakerStatsPublic:
      properties:
        active_delegations:
          type: integer
        active_tvl:
          type: integer
        staker_pk_hex:
          type: string
        total_delegations:
          type: integer
        total_tvl:
          type: integer
      type: object
    types.ErrorCode:
      enum:
      - INTERNAL_SERVICE_ERROR
      - VALIDATION_ERROR
      - NOT_FOUND
      - BAD_REQUEST
      - FORBIDDEN
      - UNPROCESSABLE_ENTITY
      - REQUEST_TIMEOUT
      type: string
      x-enum-varnames:
      - InternalServiceError
      - ValidationError
      - NotFound
      - BadRequest
      - Forbidden
      - UnprocessableEntity
      - RequestTimeout
    handler.paginationResponse:
      properties:
        next_key:
          type: string
      type: object
    v2service.OverallStatsPublic:
      properties:
        active_delegations:
          type: integer
        active_finality_providers:
          type: integer
        active_tvl:
          type: integer
        btc_staking_apr:
          description: Represents the APR for BTC staking as a decimal (e.g., 0.035 = 3.5%)
          type: number
        max_staking_apr:
          description: Represents the max staking APR (BTC + Co-staking) as a decimal
          type: number
        total_active_delegations:
          description: 'This represents the total active delegations on BTC chain which includes

            both phase-1 and phase-2 active delegations'
          type: integer
        total_active_tvl:
          description: 'This represents the total active tvl on BTC chain which includes

            both phase-1 and phase-2 active tvl'
          type: integer
        total_finality_providers:
          type: integer
      type: object
    github_com_babylonlabs-io_staking-api-service_internal_shared_types.Error:
      properties:
        err: {}
        errorCode:
          $ref: '#/components/schemas/types.ErrorCode'
        statusCode:
          type: integer
      type: object
    handler.PublicResponse-array_v1service_StakerStatsPublic:
      properties:
        data:
          items:
            $ref: '#/components/schemas/v1service.StakerStatsPublic'
          type: array
        pagination:
          $ref: '#/components/schemas/handler.paginationResponse'
      type: object
    v1service.OverallStatsPublic:
      properties:
        active_delegations:
          type: integer
        active_tvl:
          type: integer
        btc_price_usd:
          description: Optional field
          type: number
        pending_tvl:
          type: integer
        total_delegations:
          type: integer
        total_stakers:
          type: integer
        total_tvl:
          type: integer
        unconfirmed_tvl:
          type: integer
      type: object