OBobol
Cluster Lock

Retrieve a list of Distributed Validator Clusters for a given network

Changed on

This endpoint fetches a number of cluster lock objects for a given network.

get/v1/lock/network/{network}

Request

  • Base URL
    https://api.obol.tech
  • Auth
    none declared

Path parameters

networkstring required

The network to retrieve clusters on

Query parameters

pageinteger required

The page number to retrieve.

limitinteger required

The number of cluster lock objects to return.

sortBystring

numerical field to sort by

sortOrderstring

order of sorting the field

poolstring

cluster type or pool

detailsstring required

The flag to populate cluster definition information.

Response

A paged list of Distributed Validator Clusters on this network

cluster_locksstring[] required
total_active_stake_ethnumber nullable

Null when the operator has locks but no recent metrics snapshot is available.

total_active_stake_usdnumber nullable

Null when the operator has locks but no recent metrics snapshot is available.

unique_validators_countnumber nullable

Null when the operator has locks but no recent metrics snapshot is available.

total_countnumber required
total_pagesnumber required

Example response

{
  "total_active_stake_eth": 128.5,
  "total_active_stake_usd": 128.5,
  "unique_validators_count": 10,
  "total_count": 2,
  "total_pages": 4
}

Changes

  • c545dd14c211Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

  • 0d29878f15b5Revision changes
    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status