⚒️Manage Validators [API]

Manage your validators via API

To modify the validator dashboard via API, make sure to have an active Orca subscription. After creating a validator dashboard and the desired validator groups through the User Interface, you can add and assign validators to groups using our API.

  • For mainnet, please adjust the base URL to: v2-beta-mainnet.beaconcha.in

  • The Group ID can be found in the Group Manage modal on the Dashboard

  • The Dashboard ID is visible in the Dashboard URL

  • During our beta the API key will only be visible in the account settings on https://beaconcha.in/user/settings#api

  • Pass the API key as a parameter api_key

    • https://v2-beta-mainnet.beaconcha.in/api/v2/validator-dashboards/{dashboard_id}/validators?api_key=KEY

Please adjust the base URL from the examples below based on the network. Holesky: v2-beta-holesky.beaconcha.in Mainnet: v2-beta-mainnet.beaconcha.in Gnosis: v2-beta-gnosis.beaconcha.in

post

Add new validators to a specified dashboard or update the group of already-added validators. This endpoint will always add as many validators as possible, even if more validators are provided than allowed by the subscription plan. The response will contain a list of added validators.

Authorizations
Path parameters
dashboard_idintegerRequired

The ID of the dashboard.

Body
deposit_addressstringOptional
graffitistringOptional
group_idintegerOptional
validatorsobject[]Optional
withdrawal_credentialstringOptional
Responses
201
Returns a list of added validators.
application/json
post
POST /api/v2/validator-dashboards/{dashboard_id}/validators HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "deposit_address": "text",
  "graffiti": "text",
  "group_id": 1,
  "validators": [
    {}
  ],
  "withdrawal_credential": "text"
}
{
  "data": [
    {
      "group_id": 1,
      "index": 1
    }
  ]
}
delete

Delete all validators from a specified group in a specified validator dashboard.

Authorizations
Path parameters
dashboard_idintegerRequired

The ID of the dashboard.

group_idintegerRequired

The ID of the group.

Responses
204
Validators removed successfully.
delete
DELETE /api/v2/validator-dashboards/{dashboard_id}/groups/{group_id}/validators HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content
post

Remove specific validators from a specified dashboard in bulk.

Authorizations
Path parameters
dashboard_idintegerRequired

The ID of the dashboard.

Body
validatorsobject[]Optional
Responses
204
Validators removed successfully.
post
POST /api/v2/validator-dashboards/{dashboard_id}/validators/bulk-deletions HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "validators": [
    {}
  ]
}
No content

Last updated

Was this helpful?