State

Retrieve the Validator states for a cluster

Changed on

This endpoint is used to retrieve the states of all validators in a DV Cluster

get/v1/state/{lockHash}

Request

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

Path parameters

lockHashstring required

The lock_hash calculated for a cluster lock.

Response

A map of pubkeys to DVState

indexstring nullable required

Validator index. Null while the validator is only in the pending deposit queue (status pending_deposit).

statusstring required

Beacon API validator status (pending_initialized, pending_queued, active_ongoing, active_exiting, active_slashed, exited_unslashed, exited_slashed, withdrawal_possible, withdrawal_done), or pending_deposit when the pubkey is not yet in the validator registry but has a deposit in the pending deposit queue (EIP-6110). Pubkeys in neither are omitted from the response.

balancestring nullable required

Balance in ETH. Null for status pending_deposit.

effective_balancestring nullable required

Effective balance in ETH. Null for status pending_deposit.

withdrawal_credentialsstring nullable required

Withdrawal credentials. For status pending_deposit, those of the first queued deposit with a valid signature, which the validator will be created with (the beacon chain drops queued deposits with an invalid signature for a pubkey not yet in the registry). Null for status pending_deposit when no queued deposit has a valid signature, or while the signatures up to the first valid one are not checked yet (checked in the background, usually within a slot; retry).

pending_partial_withdrawalsstring nullable required

Queued partial withdrawals in ETH. Null for status pending_deposit or when the queue is unavailable.

pending_partial_depositsstring nullable required

Sum of queued deposits for this pubkey in ETH (top-ups, or for status pending_deposit the initial deposit). If the queue cannot be read the request fails with 502.

is_not_within_committeeboolean nullable required

Indicates if validator has been active for at least 256 epochs and is not within the committee period. Null when unknown, including for status pending_deposit.

credentials_conflictboolean nullable required

True when the pubkey is only in the pending deposit queue (status pending_deposit) and its queued deposits with valid signatures carry different withdrawal credentials: someone able to sign for the key signed a deposit for other credentials. Only the first valid one applies. Always false for a validator already in the registry. Null while the API has not yet checked every queued deposit signature for the pubkey (checked in the background, usually within a slot).

Example response

{
  "index": "12345",
  "status": "active_ongoing",
  "balance": "32",
  "effective_balance": "32",
  "withdrawal_credentials": "0x01000000000000000000000086b8145c98e5bd25ba722645b15ed65f024a87ec",
  "pending_partial_withdrawals": "3",
  "pending_partial_deposits": "3",
  "is_not_within_committee": true
}

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

    • info

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

    • info

      added the required property //// to the response with the status