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

# Get BTC delegator state information

> This endpoint returns information about a BTC delegator's state including active stake. Use this endpoint to retrieve historical state data for a specific delegator.

Using this endpoint, you can query the historical daily stake balance of a delegator by their unique Babylon Genesis address. The results are per individual finality provider that the delegator has staked to.

You can use the `fromDate` and `toDate` parameters to query a range of days.


## OpenAPI

````yaml get /v1/babylon/btcDelegators/{delegator_address}/state
openapi: 3.1.0
info:
  title: Rated API
  description: >

    Welcome to Rated API Swagger doc for developers! This doc outlines the Rated
    API functionality and API architecture.


    V0: It is separated into seven categories:


    -   **Validators**: Endpoints to query into individual validator indices or
    aggregations of validator indices.

    -   **Operators**: Endpoints to query into pre-materialized operator
    groupings.

    -   **Network**: Endpoints to query into network aggregate stats.

    -   **Slashings**: Endpoints to query into network aggregate stats.

    -   **Withdrawals (beta)**: Endpoints to query into when a withdrawal is
    expected to land.

    -   **Self Report (beta)**: Endpoint to query into all slashed validators
    and individual slashed validator indices


    V1: It is separated into six categories:

    -   **Overview**: Endpoints encapsulating the current status of operators,
    pools and validators.

    -   **Performance**: Endpoints that dive into performance and effectiveness
    metrics on execution and consensus layer for operators, pools and
    validators.

    -   **Rewards**: Endpoints that dive into relevant metrics around rewards
    and penalties for operators, pools and validators.

    -   **Private Sets**: Endpoints that aggregate custom group of validators
    privately for performance and reward drill downs.

    -   **Metadata**: Endpoints that provide metadata about mappings, slashings
    and APRs for validators, pools and operators.

    -   **Network**: Endpoints that provide network level metrics about
    performance, rewards, and distributions.


    [Terms of Use](https://docs.rated.network/legal/terms/api-terms-of-service)


    [API
    Reference](https://docs.rated.network/rated-api/api-reference/introduction)
  version: '1.0'
servers: []
security: []
paths:
  /v1/babylon/btcDelegators/{delegator_address}/state:
    get:
      tags:
        - Babylon Performance
      summary: Get BTC delegator state information
      description: >-
        This endpoint returns information about a BTC delegator's state
        including active stake. Use this endpoint to retrieve historical state
        data for a specific delegator.
      operationId: >-
        get_btc_delegator_stake_v1_babylon_btcDelegators__delegator_address__state_get
      parameters:
        - name: delegator_address
          in: path
          required: true
          schema:
            type: string
            title: Delegator Address
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            description: The number of results returned per page
            default: 10
            title: Limit
          description: The number of results returned per page
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            description: The number of results to skip before starting to return
            default: 0
            title: Offset
          description: The number of results to skip before starting to return
        - name: fromDate
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date
              - type: 'null'
            description: Start date
            examples:
              - '2023-01-01'
            title: Fromdate
          description: Start date
        - name: toDate
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date
              - type: 'null'
            description: End date
            examples:
              - '2023-12-31'
            title: Todate
          description: End date
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/api__schemas__paginator__paginated_response_for_result_model___locals___PaginatedResponseWithResultModel__79
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
      security:
        - HTTPBearer: []
components:
  schemas:
    api__schemas__paginator__paginated_response_for_result_model___locals___PaginatedResponseWithResultModel__79:
      properties:
        previous:
          anyOf:
            - type: string
            - type: 'null'
          title: Previous
        next:
          anyOf:
            - type: string
            - type: 'null'
          title: Next
        pages:
          type: integer
          minimum: 0
          title: Pages
        results:
          items:
            properties:
              day:
                type: string
                format: date
                title: Day
              fromBabylonHeight:
                type: integer
                title: Frombabylonheight
              toBabylonHeight:
                type: integer
                title: Tobabylonheight
              fromBtcHeight:
                type: integer
                title: Frombtcheight
              toBtcHeight:
                type: integer
                title: Tobtcheight
              delegator:
                type: string
                title: Delegator
              delegatorBtcPubkey:
                type: string
                title: Delegatorbtcpubkey
              delegatorBtcAddress:
                type: string
                title: Delegatorbtcaddress
              finalityProviderAddress:
                type: string
                title: Finalityprovideraddress
              finalityProviderBtcAddress:
                type: string
                title: Finalityproviderbtcaddress
              finalityProviderBtcPubkey:
                type: string
                title: Finalityproviderbtcpubkey
              activeStake:
                anyOf:
                  - type: number
                  - type: string
                title: Activestake
            type: object
            required:
              - day
              - fromBabylonHeight
              - toBabylonHeight
              - fromBtcHeight
              - toBtcHeight
              - delegator
              - delegatorBtcPubkey
              - delegatorBtcAddress
              - finalityProviderAddress
              - finalityProviderBtcAddress
              - finalityProviderBtcPubkey
              - activeStake
            title: BabylonBtcDelegatorStake
            examples:
              - activeStake: 1.5
                day: '2025-01-21'
                delegator: bbn1g6tgaz3pmk03gvgndh8rwrv5yktrjhvvvyaplq
                delegatorBtcAddress: bc1p7cs5gfwqk6gz7dgw5du4fp7y9hxw73d3lxr52lwtp99q2uzvx3sq60fs0q
                delegatorBtcPubkey: >-
                  035cd78812a37267f17f8c9b21df5c0e3f85c79bb9c410fe567b2633f35f7092c8
                finalityProviderAddress: bbn19cy5ndzllcqlrcyggsqjg4mu59kw8ewwwhhcxe
                finalityProviderBtcAddress: bc1p0hsx4l7hscn5ffy2q0k4w3kp2dh0u7jq2ryjc8k2u2gf8qpnzexqxgxkj5
                finalityProviderBtcPubkey: >-
                  99cab14570d12633326afede842d3a9db729f671d2fa1b8a46585d3f62395c1c
                fromBabylonHeight: 100001
                fromBtcHeight: 40000
                toBabylonHeight: 107701
                toBtcHeight: 40001
          type: array
          title: Results
      type: object
      required:
        - previous
        - next
        - pages
        - results
      title: PaginatedV1BabylonBtcDelegatorStake
      examples:
        - next: >-
            https://api.rated.network//v1/babylon/btcDelegators/{delegator_address}/state?limit=10&offset=30
          pages: 10
          previous: >-
            https://api.rated.network//v1/babylon/btcDelegators/{delegator_address}/state?limit=10&offset=10
          results:
            - - activeStake: 1.5
                day: '2025-01-21'
                delegator: bbn1g6tgaz3pmk03gvgndh8rwrv5yktrjhvvvyaplq
                delegatorBtcAddress: bc1p7cs5gfwqk6gz7dgw5du4fp7y9hxw73d3lxr52lwtp99q2uzvx3sq60fs0q
                delegatorBtcPubkey: >-
                  035cd78812a37267f17f8c9b21df5c0e3f85c79bb9c410fe567b2633f35f7092c8
                finalityProviderAddress: bbn19cy5ndzllcqlrcyggsqjg4mu59kw8ewwwhhcxe
                finalityProviderBtcAddress: bc1p0hsx4l7hscn5ffy2q0k4w3kp2dh0u7jq2ryjc8k2u2gf8qpnzexqxgxkj5
                finalityProviderBtcPubkey: >-
                  99cab14570d12633326afede842d3a9db729f671d2fa1b8a46585d3f62395c1c
                fromBabylonHeight: 100001
                fromBtcHeight: 40000
                toBabylonHeight: 107701
                toBtcHeight: 40001
    ErrorResponse:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/Error'
          type: array
          title: Detail
      type: object
      required:
        - detail
      title: ErrorResponse
    Error:
      properties:
        loc:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Loc
        msg:
          type: string
          title: Msg
        type:
          type: string
          title: Type
      type: object
      required:
        - msg
        - type
      title: Error
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````