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 Apr API
  version: '2.0'
tags:
- name: Apr
paths:
  /v2/apr:
    get:
      description: Get personalized staking APR based on user's BTC and BABY stake amounts
      parameters:
      - description: Total satoshis staked (confirmed + pending)
        in: query
        name: satoshis_staked
        schema:
          type: integer
          default: 0
      - description: Total ubbn staked (confirmed + pending)
        in: query
        name: ubbn_staked
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.PublicResponse-v2service_StakingAPRPublic'
        '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 personalized staking APR
      tags:
      - Apr
      operationId: getV2Apr
      x-operation-id-source: derived
components:
  schemas:
    handler.PublicResponse-v2service_StakingAPRPublic:
      properties:
        data:
          $ref: '#/components/schemas/v2service.StakingAPRPublic'
        pagination:
          $ref: '#/components/schemas/handler.paginationResponse'
      type: object
    v2service.StakingAPRPublic:
      properties:
        additional_baby_needed_for_boost:
          type: number
        boost:
          $ref: '#/components/schemas/v2service.apr'
        current:
          $ref: '#/components/schemas/v2service.apr'
      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.apr:
      properties:
        baby_staking_apr:
          type: number
        btc_staking_apr:
          type: number
        co_staking_apr:
          type: number
        total_apr:
          type: number
      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