# Ethereum ## Provision Validators > The staking endpoint must be invoked by the client to facilitate the staking action. When a request to provision more than 100 validators is received, it will be split into batches, each containing a maximum of 100 validators, and then processed. A total of 1,000 validators can be provisioned per request, across 10 batches. ```json {"openapi":"3.0.1","info":{"title":"Ethereum API Specification","version":"1.117.0"},"tags":[{"name":"Ethereum"}],"servers":[{"url":"http://localhost","description":"Generated server url"}],"security":[{"AuthorizationToken":[]},{"APIKey":[]}],"components":{"securitySchemes":{"AuthorizationToken":{"type":"http","description":"","scheme":"bearer","bearerFormat":"JWT"},"APIKey":{"name":"X-API-KEY","type":"apiKey","in":"header"}},"schemas":{"StakingRequest":{"title":"Staking Request","type":"object","required":["client_req_id","network","validator_count","withdrawal_address"],"properties":{"client_req_id":{"type":"string","description":"A unique identifier for the staking request generated by the client."},"network":{"type":"string","description":"The network on which validators should be created. Supported values are;\r\n- mainnet\r\n- hoodi","enum":["mainnet","hoodi"]},"withdrawal_credentials_type":{"enum":["0x01","0x02"],"description":"The withdrawal credential type of the validator(s) to be created. Supported values are;\r\n- 0x01 (Default)\r\n- 0x02","default":"0x01"},"amounts_unit":{"description":"The unit in which the staking amount is specified for withdrawal_credential_type = 0x02 validators in the amounts field. Supported values are:\r\n- ETH\r\n- GWEI\r\n\r\nConditionally required if the withdrawal_credential_type = 0x02.","enum":["ETH","GWEI"]},"amounts":{"type":"array","description":"The Ethereum amounts to be staked, specified in either ETH or GWEI. This is required if the withdrawal credentials type is 0x02. \r\n\r\n- When specified in ETH, up to 9 decimal places are supported.\r\n- When specified in GWEI, only whole numbers are supported.\r\n- Any additional decimal places will be ignored.","items":{"type":"integer","format":"int32"}},"validator_count":{"type":"integer","description":"The number of validators required. A maximum of 1000 validators are supported","format":"int32"},"withdrawal_address":{"type":"string","description":"The ETH account (wallet) used for the withdrawal credentials of the validators. This is the address that will receive consensus rewards and unstaked ETH after exiting."},"fee_recipient_address":{"type":"string","description":"The ETH account (wallet) that will receive the execution layer rewards. If not provided, this will be defaulted to the withdrawal address."},"region":{"type":"string","description":"The geographic region where the validator will be created. Supported values are;\r\n- US\r\n- EU (Default)\r\n- KR","default":"EU","enum":["US","EU","KR"]},"account":{"type":"string","description":"The account name registered on the platform that is associated with the client's customer. If not provided, requests will be assigned to a default account.\n"}}},"StakingResponse":{"title":"Staking Response","type":"object","properties":{"client_req_id":{"type":"string","description":"The client_req_id of the staking request addressed by this response message."},"staking_ref_id":{"type":"string","description":"A unique reference ID generated by the staking infrastructure for the staking request."},"network":{"type":"string","description":"The network on which validators should be created. Supported values are;\r\n- mainnet\r\n- hoodi","enum":["mainnet","hoodi"]},"withdrawal_credentials_type":{"enum":["0x01","0x02"],"description":"The withdrawal credential type of the validator(s) that will be created. Applicable values are;\r\n- 0x01\r\n- 0x02"},"withdrawal_address":{"type":"string","description":"The specified address to which funds will be withdrawn, as mentioned in the staking request."},"fee_recipient_address":{"type":"string","description":"The fee recipient address that receives Execution Layer fees, as mentioned in the staking request."},"region":{"type":"string","description":"The geographic region where the validator will be created. Supported values are;\r\n- US\r\n- EU\r\n- KR","enum":["US","EU","KR"]},"provisioned_at":{"type":"string","description":"The date and time when the validator was provisioned by the staking infrastructure.","format":"date-time"},"data":{"type":"array","description":"A block that contains validator batches. Each batch includes details of 100 validators and the associated funding transaction.","items":{"$ref":"#/components/schemas/BatchData"}}}},"BatchData":{"title":"Staking Response Batch","type":"object","properties":{"batch_id":{"type":"integer","description":"Identifier of the validator batch.","format":"int32","enum":[1,2,3,4,5,6,7,8,9,10]},"deposit_data":{"type":"array","description":"An array of validator details in this batch.","items":{"$ref":"#/components/schemas/DepositData"}},"deposit_transaction":{"$ref":"#/components/schemas/DepositTransaction"}},"description":"A block that contains validator batches. Each batch includes details of 250 validators and the associated funding transaction."},"DepositData":{"title":"Staking Response Batch Deposit Data","type":"object","description":"An array of validator details in this batch.","properties":{"pubkey":{"type":"string","description":"Public key of the validator."},"amount":{"type":"number","description":"The amount of ETH in GWEI required to be deposited.","format":"double"},"withdrawal_credentials":{"type":"string","description":"Withdrawal credentials for the validator funds to be withdrawn upon exit."},"signature":{"type":"string","description":"A “proof of possession” which signs over pubkey, withdrawal_credentials, and amount using the validator private key."},"deposit_data_root":{"type":"string","description":"Merkle root hash of the deposit data."},"deposit_message_root":{"type":"string","description":"Merkle root hash of the deposit message."},"fork_version":{"type":"string","description":"The genesis fork version."},"deposit_cli_version":{"type":"string","description":"Staking deposit cli version."}}},"DepositTransaction":{"title":"Staking Response Batch Deposit Transaction","type":"object","description":"The JSON object that contains the funding transaction details of all validators belonging to this batch.","properties":{"deposit_amount_wei":{"type":"string","description":"The total amount of ETH to be staked for the batch in WEI."},"deposit_address":{"type":"string","description":"Batch deposit contract address."},"contract_call_data":{"type":"string","description":"Encoded function call data to be broadcasted to the Batch Deposit Contract. "}}},"StakingErrorListResponse":{"title":"Error List","type":"object","properties":{"client_req_id":{"type":"string","description":"The client_req_id of the request addressed by this response message."},"errors":{"type":"array","description":"An array of errors that resulted from this request.","items":{"$ref":"#/components/schemas/ErrorMessage"}}}},"ErrorMessage":{"title":"Error Message","type":"object","description":"An array of errors that resulted from this request.","required":["code","message"],"properties":{"code":{"type":"integer","description":"The code related to the error being reported.","format":"int32"},"message":{"type":"string","description":"The description related to the error being reported."}}},"InternalServerStakingErrorListResponse":{"title":"Error List","type":"object","properties":{"client_req_id":{"type":"string","description":"The client_req_id of the request addressed by this response message."},"errors":{"type":"array","description":"An array of errors that resulted from this request.","items":{"$ref":"#/components/schemas/InternalServerErrorMessage"}}},"description":""},"InternalServerErrorMessage":{"title":"Error Message","type":"object","description":"An array of errors that resulted from this request.","required":["message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"The description related to the error being reported."}}}}},"paths":{"/v1/ethereum/validators":{"post":{"tags":["Ethereum"],"summary":"Provision Validators","description":"The staking endpoint must be invoked by the client to facilitate the staking action. When a request to provision more than 100 validators is received, it will be split into batches, each containing a maximum of 100 validators, and then processed. A total of 1,000 validators can be provisioned per request, across 10 batches. ","operationId":"validators","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StakingRequest"}}},"required":true},"responses":{"200":{"description":"Sample success response payload. See Response schema below for wrapper","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StakingResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StakingErrorListResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerStakingErrorListResponse"}}}}}}}}} ``` ## Exit Validators > The exit endpoint enables clients to initiate validator withdrawals by broadcasting voluntary exit messages to the beacon chain. It can be enabled in three ways. > \ > \- \*\*Validator Public Keys\*\*: Exit from the network using the specified validator public addresses. > \ > \- \*\*Validator Indexes\*\*: Exit from the network using the specified validator indexes. > \ > \- \*\*Withdrawal Address with Validator Count\*\*: Exit from the network using the specified withdrawal address and validator count. Only type 0x01 validators can be exited using this method. > \\ > > \ > Each request type can handle exiting only up to 250 validators at once. ```json {"openapi":"3.0.1","info":{"title":"Ethereum API Specification","version":"1.117.0"},"tags":[{"name":"Ethereum"}],"servers":[{"url":"http://localhost","description":"Generated server url"}],"security":[{"AuthorizationToken":[]},{"APIKey":[]}],"components":{"securitySchemes":{"AuthorizationToken":{"type":"http","description":"","scheme":"bearer","bearerFormat":"JWT"},"APIKey":{"name":"X-API-KEY","type":"apiKey","in":"header"}},"schemas":{"ValidatorExitRequest":{"title":"Validator Exit Request","type":"object","required":["client_req_id","network","type"],"properties":{"client_req_id":{"type":"string","description":"A unique identifier generated and sent by the client for the exit request. Refer Client Request Identifier for further details."},"network":{"type":"string","description":"The network on which validators were created. Supported values are;\r\n- mainnet\r\n- hoodi","enum":["mainnet","hoodi"]},"type":{"type":"integer","description":"Indicates the type of attribute used to identify the validators to exit. The possible values are,\n- 1 (pubkey)\n- 2 (validator_index)\n- 3 (withdrawal_address)","format":"int32","enum":[1,2,3]},"pubkeys":{"type":"array","items":{"type":"string","description":"List of validator public keys to be exited. \nThis is required if the exit type is 1. \nA maximum of 250 public keys can be specified."}},"validator_indexes":{"type":"array","items":{"type":"integer","description":"The list of validator indexes to be exited. \nRequired if exit type is 2. \nA maximum of 250 validator indexes can be specified.","format":"int32"}},"withdrawal_address":{"type":"string","description":"The withdrawal address of the validators that should be exited.\nRequired if exit type is 3"},"validator_count":{"type":"integer","description":"Required if exit type is 3. \nThe Max count should be 250.","format":"int32"}}},"ValidatorExitResponse":{"title":"Validator Exit Response","type":"object","properties":{"client_req_id":{"type":"string","description":"Unique identifier specified in the request."},"network":{"type":"string","description":"Network specified in the request. Supported values are;\r\n- mainnet\r\n- hoodi","enum":["mainnet","hoodi"]},"data":{"type":"array","description":"An array which contains the details of the validators to be exited.","items":{"$ref":"#/components/schemas/ValidatorExitData"}}}},"ValidatorExitData":{"title":"Validator Exit Data","type":"object","description":"An array which contains the details of the validators to be exited.","properties":{"pubkey":{"type":"string","description":"Public key of the validator."},"validator_index":{"type":"integer","description":"Index of the corresponding validator.","format":"int32"},"withdrawal_address":{"type":"string","description":"Withdrawal address of the corresponding validator. "},"status":{"type":"string","description":"Current status of the validator.","enum":["STAKING_INITIATED","PENDING_DEPOSIT","DEPOSITED","DEPOSIT_FAILED","ACTIVE","SLASHING","SLASHED","EXIT_INITIATED","EXITING","EXITED","WITHDRAWABLE","WITHDRAWN"]}}},"StakingErrorListResponse":{"title":"Error List","type":"object","properties":{"client_req_id":{"type":"string","description":"The client_req_id of the request addressed by this response message."},"errors":{"type":"array","description":"An array of errors that resulted from this request.","items":{"$ref":"#/components/schemas/ErrorMessage"}}}},"ErrorMessage":{"title":"Error Message","type":"object","description":"An array of errors that resulted from this request.","required":["code","message"],"properties":{"code":{"type":"integer","description":"The code related to the error being reported.","format":"int32"},"message":{"type":"string","description":"The description related to the error being reported."}}},"InternalServerStakingErrorListResponse":{"title":"Error List","type":"object","properties":{"client_req_id":{"type":"string","description":"The client_req_id of the request addressed by this response message."},"errors":{"type":"array","description":"An array of errors that resulted from this request.","items":{"$ref":"#/components/schemas/InternalServerErrorMessage"}}},"description":""},"InternalServerErrorMessage":{"title":"Error Message","type":"object","description":"An array of errors that resulted from this request.","required":["message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"The description related to the error being reported."}}}}},"paths":{"/v1/ethereum/validators/exit":{"post":{"tags":["Ethereum"],"summary":"Exit Validators","description":"The exit endpoint enables clients to initiate validator withdrawals by broadcasting voluntary exit messages to the beacon chain. It can be enabled in three ways. \r\n- **Validator Public Keys**: Exit from the network using the specified validator public addresses.\r\n- **Validator Indexes**: Exit from the network using the specified validator indexes. \r\n- **Withdrawal Address with Validator Count**: Exit from the network using the specified withdrawal address and validator count. Only type 0x01 validators can be exited using this method.\r\n\r\nEach request type can handle exiting only up to 250 validators at once. ","operationId":"exit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidatorExitRequest"}}},"required":true},"responses":{"200":{"description":"Sample success response payload. See Response schema below for wrapper","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidatorExitResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StakingErrorListResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerStakingErrorListResponse"}}}}}}}}} ``` ## Derive Pre-Signed Exit Message > The pre-signed exit endpoint enables clients to request pre-signed exit messages for validators. When clients decide to exit their validators, the pre-signed exit message can be independently broadcasted to the consensus node. The validators must be in an active state for at-least 256 epochs in order to derive the encrypted pre-signed exit message.\
\
Before calling this endpoint, the client must create an RSA4096 key pair.This is a separate key pair from the one used for JWT signature generation.The client needs to share the public key from this new key pair with the platform. The platform will use this public key to encrypt the pre-signed exit message with the RSA\_OAEP\_SHA\_256 algorithm. ```json {"openapi":"3.0.1","info":{"title":"Ethereum API Specification","version":"1.117.0"},"tags":[{"name":"Ethereum"}],"servers":[{"url":"http://localhost","description":"Generated server url"}],"security":[{"AuthorizationToken":[]},{"APIKey":[]}],"components":{"securitySchemes":{"AuthorizationToken":{"type":"http","description":"","scheme":"bearer","bearerFormat":"JWT"},"APIKey":{"name":"X-API-KEY","type":"apiKey","in":"header"}},"schemas":{"ValidatorExitRequest":{"title":"Validator Exit Request","type":"object","required":["client_req_id","network","type"],"properties":{"client_req_id":{"type":"string","description":"A unique identifier generated and sent by the client for the exit request. Refer Client Request Identifier for further details."},"network":{"type":"string","description":"The network on which validators were created. Supported values are;\r\n- mainnet\r\n- hoodi","enum":["mainnet","hoodi"]},"type":{"type":"integer","description":"Indicates the type of attribute used to identify the validators to exit. The possible values are,\n- 1 (pubkey)\n- 2 (validator_index)\n- 3 (withdrawal_address)","format":"int32","enum":[1,2,3]},"pubkeys":{"type":"array","items":{"type":"string","description":"List of validator public keys to be exited. \nThis is required if the exit type is 1. \nA maximum of 250 public keys can be specified."}},"validator_indexes":{"type":"array","items":{"type":"integer","description":"The list of validator indexes to be exited. \nRequired if exit type is 2. \nA maximum of 250 validator indexes can be specified.","format":"int32"}},"withdrawal_address":{"type":"string","description":"The withdrawal address of the validators that should be exited.\nRequired if exit type is 3"},"validator_count":{"type":"integer","description":"Required if exit type is 3. \nThe Max count should be 250.","format":"int32"}}},"ValidatorPreSignedExitResponse":{"title":"Validator Pre-signed Exit Response","type":"object","properties":{"network":{"type":"string","description":"Network specified in the request.","enum":["mainnet","hoodi"]},"data":{"type":"array","description":"An array which contains the details of the validators to be exited.","items":{"$ref":"#/components/schemas/PreSignedExitDBO"}}}},"PreSignedExitDBO":{"title":"Validator Pre-signed Exit Data","type":"object","description":"An array which contains the details of the validators to be exited.","properties":{"pubkey":{"type":"string","description":"Public key of the validator."},"validator_index":{"type":"integer","description":"Index of the corresponding validator.","format":"int32"},"withdrawal_address":{"type":"string","description":"Withdrawal address of the corresponding validator."},"encrypted_exit_message":{"type":"string","description":"The encrypted pre-signed exit message.The client can decrypt this message using their private key."},"fork_version":{"type":"string","description":"The genesis fork version used when generating the pre-signed exit message."},"status":{"type":"string","description":"Current status of the validator.","enum":["STAKING_INITIATED","PENDING_DEPOSIT","DEPOSITED","DEPOSIT_FAILED","ACTIVE","SLASHING","SLASHED","EXIT_INITIATED","EXITING","EXITED","WITHDRAWABLE","WITHDRAWN"]}}},"StakingErrorListResponse":{"title":"Error List","type":"object","properties":{"client_req_id":{"type":"string","description":"The client_req_id of the request addressed by this response message."},"errors":{"type":"array","description":"An array of errors that resulted from this request.","items":{"$ref":"#/components/schemas/ErrorMessage"}}}},"ErrorMessage":{"title":"Error Message","type":"object","description":"An array of errors that resulted from this request.","required":["code","message"],"properties":{"code":{"type":"integer","description":"The code related to the error being reported.","format":"int32"},"message":{"type":"string","description":"The description related to the error being reported."}}},"InternalServerStakingErrorListResponse":{"title":"Error List","type":"object","properties":{"client_req_id":{"type":"string","description":"The client_req_id of the request addressed by this response message."},"errors":{"type":"array","description":"An array of errors that resulted from this request.","items":{"$ref":"#/components/schemas/InternalServerErrorMessage"}}},"description":""},"InternalServerErrorMessage":{"title":"Error Message","type":"object","description":"An array of errors that resulted from this request.","required":["message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"The description related to the error being reported."}}}}},"paths":{"/v1/ethereum/validators/exit/pre-signed":{"post":{"tags":["Ethereum"],"summary":"Derive Pre-Signed Exit Message","description":"The pre-signed exit endpoint enables clients to request pre-signed exit messages for validators. When clients decide to exit their validators, the pre-signed exit message can be independently broadcasted to the consensus node. The validators must be in an active state for at-least 256 epochs in order to derive the encrypted pre-signed exit message.

Before calling this endpoint, the client must create an RSA4096 key pair.This is a separate key pair from the one used for JWT signature generation.The client needs to share the public key from this new key pair with the platform. The platform will use this public key to encrypt the pre-signed exit message with the RSA_OAEP_SHA_256 algorithm.","operationId":"pre-signed","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidatorExitRequest"}}},"required":true},"responses":{"200":{"description":"Sample success response payload. See Response schema below for wrapper","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidatorPreSignedExitResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StakingErrorListResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerStakingErrorListResponse"}}}}}}}}} ``` ## Get All Validators or by Staking Reference ID > The get all validators endpoint returns the details of the validators provisioned for the given client for the specified network in a paginated manner. This endpoint can also be used to return the details of the validators belonging to the given client for the specified network and staking reference ID. All timestamp fields in the response are provided in UTC timezone. ```json {"openapi":"3.0.1","info":{"title":"Ethereum API Specification","version":"1.117.0"},"tags":[{"name":"Ethereum"}],"servers":[{"url":"http://localhost","description":"Generated server url"}],"security":[{"AuthorizationToken":[]},{"APIKey":[]}],"components":{"securitySchemes":{"AuthorizationToken":{"type":"http","description":"","scheme":"bearer","bearerFormat":"JWT"},"APIKey":{"name":"X-API-KEY","type":"apiKey","in":"header"}},"schemas":{"ValidatorsInfoResponse":{"title":"Validator Info Response","type":"object","properties":{"network":{"type":"string","description":"Network specified in the request.","enum":["mainnet","hoodi"]},"page":{"type":"integer","description":"The current page number sent in the request.","format":"int32"},"total":{"type":"integer","description":"Total number of validators provisioned for the given client and the network.","format":"int32"},"data":{"type":"array","description":"An array that contains the details about validators.","items":{"$ref":"#/components/schemas/ValidatorInfoData"}}}},"ValidatorInfoData":{"title":"Validator Info Data","type":"object","description":"An array that contains the details about validators.","properties":{"epoch":{"type":"integer","description":"The specific blockchain epoch to which the returned validator details correspond.","format":"int32"},"status":{"type":"string","description":"Current status of the validator.","enum":["STAKING_INITIATED","PENDING_DEPOSIT","DEPOSITED","DEPOSIT_FAILED","ACTIVE","SLASHING","SLASHED","EXIT_INITIATED","EXITING","EXITED","WITHDRAWABLE","WITHDRAWN"]},"pubkey":{"type":"string","description":"Public key of the validator."},"region":{"type":"string","description":"The geographic region where the validator will be created.","enum":["US","EU","KR"]},"validator_index":{"type":"integer","description":"Validator index.","format":"int32"},"withdrawal_credential_type":{"type":"string","description":"Withdrawal credential type of the validator. Applicable values are:\r\n- 0x00\r\n- 0x01\r\n- 0x02"},"withdrawal_address":{"type":"string","description":"Withdrawal address of the corresponding validator. "},"fee_recipient_address":{"type":"string","description":"The fee recipient address belongs to the validator."},"estimated_activation_at":{"type":"string","description":"Estimate of when the validator will become active and start earning rewards. This will be populated since the validator is transitioned to DEPOSITED status. Until then, it will be null. It will be in the format of “YYYY-MM-DD HH:mm:ss”."},"estimated_exit_at":{"type":"string","description":"Estimate of when the validator will exit and stop earning rewards. This will be populated since the validator is transitioned to EXIT_INITIATED status. Until then, it will be null. It will be in the format of “YYYY-MM-DD HH:mm:ss”."},"estimated_withdrawal_at":{"type":"string","description":"Estimate of when the validator’s principal will become withdrawable. This will be populated since the validator is transitioned to EXITED status. Until then, it will be null. It will be in the format of “YYYY-MM-DD HH:mm:ss”."},"balance_in_wei":{"type":"string","description":"Current balance of the validator in WEI."},"balance_in_eth":{"type":"number","description":"Current balance of the validator in ETH.","format":"double"},"status_history":{"type":"array","items":{"$ref":"#/components/schemas/StatusHistoryData"}},"voluntary_exit":{"$ref":"#/components/schemas/VoluntaryExitData"},"presigned_exit":{"$ref":"#/components/schemas/PresignedExitData"},"staking_request_info":{"$ref":"#/components/schemas/StakingRequestInfo"}}},"StatusHistoryData":{"title":"Status History Data","type":"object","properties":{"status":{"type":"string","description":"Status of the validator.","enum":["STAKING_INITIATED","PENDING_DEPOSIT","DEPOSITED","DEPOSIT_FAILED","ACTIVE","SLASHING","SLASHED","EXIT_INITIATED","EXITING","EXITED","WITHDRAWABLE","WITHDRAWN"]},"transitioned_at":{"type":"string","description":"The date and time the validator transitioned into the given status. It will be in the format of “YYYY-MM-DD HH:mm:ss”."}},"description":"An array that contains the state transition of the validator. "},"VoluntaryExitData":{"title":"Voluntary Exit Data","type":"object","properties":{"request_id":{"type":"string","description":"Unique request id sent by the client when requesting the voluntary exit."},"requested_at":{"type":"string","description":"The date and time the exit request was received. It will be in the format of “YYYY-MM-DD HH:mm:ss”."},"submitted_at":{"type":"string","description":"The date and time the validator’s exit message was broadcasted to the beacon node. It will be in the format of “YYYY-MM-DD HH:mm:ss”."}},"description":"JSON object that contains on demand exit related information if the validator has initiated the voluntary exit. Otherwise, it will be null."},"PresignedExitData":{"title":"Pre-signed Exit Data","type":"object","properties":{"fork_version":{"type":"string","description":"The genesis fork version used when generating the pre-signed exit message."},"encrypted_exit_message":{"type":"string","description":"The encrypted pre-signed exit message. The client can decrypt this message using their private key."}},"description":"This JSON object will be populated if the include_presigned_exit query parameter is set to “true” and the validator is in active status for at-least 256 epochs. Otherwise, it will be set to null."},"StakingRequestInfo":{"title":"Staking Request Data","type":"object","properties":{"staking_ref_id":{"type":"string","description":"A unique reference ID generated by the staking infrastructure for the staking request."},"provisioned_at":{"type":"string","description":"The date and time when the validator was provisioned by the staking infrastructure. It will be in the format of “YYYY-MM-DD HH:mm:ss”."}},"description":"JSON object that contains the staking request id and validators provisioned date and time. This should be set to ‘null’ for externally provisioned validators."},"ValidatorErrorListResponse":{"title":"Validator Error Response","type":"object","properties":{"error":{"type":"array","items":{"$ref":"#/components/schemas/ValidatorErrorMessage"}}}},"ValidatorErrorMessage":{"title":"Validator Error Message","type":"object","description":"An array of errors that resulted from this request.","required":["code","message"],"properties":{"code":{"type":"integer","description":"The code related to the error being reported.","format":"int32"},"message":{"type":"string","description":"The description related to the error being reported."}}},"InternalServerInfoErrorMessage":{"title":"Error Message","type":"object","description":"An array of errors that resulted from this request.","required":["message"],"properties":{"message":{"type":"string","description":"The description related to the error being reported."}}}}},"paths":{"/v1/ethereum/{network}/validators":{"get":{"tags":["Ethereum"],"summary":"Get All Validators or by Staking Reference ID","description":"The get all validators endpoint returns the details of the validators provisioned for the given client for the specified network in a paginated manner. This endpoint can also be used to return the details of the validators belonging to the given client for the specified network and staking reference ID. All timestamp fields in the response are provided in UTC timezone.","operationId":"get-validators","parameters":[{"name":"network","in":"path","description":"Applicable values are mainnet and hoodi","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The current page number requested by the client, if not specified, should be defaulted to 1.","required":false,"schema":{"type":"string"}},{"name":"size","in":"query","description":"The number of entries per page, if not presented in the request, should be defaulted to the maximum value of 250.","required":false,"schema":{"type":"string"}},{"name":"staking_ref_id","in":"query","description":"The staking reference ID returned for the staking request.","required":false,"schema":{"type":"string"}},{"name":"include_presigned_exit","in":"query","description":"This indicates whether the pre-signed exit message to be included in the response or not. It’s a boolean parameter, defaulted to \"false\".","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sample success response payload. See Response schema below for wrapper","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidatorsInfoResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidatorErrorListResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerInfoErrorMessage"}}}}}}}}} ``` ## Get a Single Validator > The get single validator endpoint returns the validator information for the specified validator’s public key. All timestamp fields in the response are provided in UTC timezone. ```json {"openapi":"3.0.1","info":{"title":"Ethereum API Specification","version":"1.117.0"},"tags":[{"name":"Ethereum"}],"servers":[{"url":"http://localhost","description":"Generated server url"}],"security":[{"AuthorizationToken":[]},{"APIKey":[]}],"components":{"securitySchemes":{"AuthorizationToken":{"type":"http","description":"","scheme":"bearer","bearerFormat":"JWT"},"APIKey":{"name":"X-API-KEY","type":"apiKey","in":"header"}},"schemas":{"ValidatorInfoResponse":{"title":"Validator Info","type":"object","properties":{"network":{"type":"string","description":"The network on which validators were created.","enum":["mainnet","hoodi"]},"epoch":{"type":"integer","description":"The specific blockchain epoch to which the returned validator details correspond.","format":"int32"},"status":{"type":"string","description":"Current status of the validator.","enum":["STAKING_INITIATED","PENDING_DEPOSIT","DEPOSITED","DEPOSIT_FAILED","ACTIVE","SLASHING","SLASHED","EXIT_INITIATED","EXITING","EXITED","WITHDRAWABLE","WITHDRAWN"]},"pubkey":{"type":"string","description":"Public key of the validator."},"region":{"type":"string","description":"The geographic region where the validator will be created.","enum":["US","EU","KR"]},"validator_index":{"type":"integer","description":"Validator index.","format":"int32"},"withdrawal_credential_type":{"type":"string","description":"Withdrawal credential type of the validator. Applicable values are:\r\n- 0x00\r\n- 0x01\r\n- 0x02"},"withdrawal_address":{"type":"string","description":"Withdrawal address of the corresponding validator. "},"fee_recipient_address":{"type":"string","description":"The fee recipient address belongs to the validator."},"estimated_activation_at":{"type":"string","description":"Estimate of when the validator will become active and start earning rewards. This will be populated since the validator is transitioned to DEPOSITED status. Until then, it will be null. It will be in the format of “YYYY-MM-DD HH:mm:ss”."},"estimated_exit_at":{"type":"string","description":"Estimate of when the validator will exit and stop earning rewards. This will be populated since the validator is transitioned to EXIT_INITIATED status. Until then, it will be null. It will be in the format of “YYYY-MM-DD HH:mm:ss”."},"estimated_withdrawal_at":{"type":"string","description":"Estimate of when the validator’s principal will become withdrawable. This will be populated since the validator is transitioned to EXITED status. Until then, it will be null. It will be in the format of “YYYY-MM-DD HH:mm:ss”."},"balance_in_wei":{"type":"string","description":"Current balance of the validator in WEI."},"balance_in_eth":{"type":"number","description":"Current balance of the validator in ETH.","format":"double"},"status_history":{"type":"array","items":{"$ref":"#/components/schemas/StatusHistoryData"}},"voluntary_exit":{"$ref":"#/components/schemas/VoluntaryExitData"},"presigned_exit":{"$ref":"#/components/schemas/PresignedExitData"},"staking_request_info":{"$ref":"#/components/schemas/StakingRequestInfo"}}},"StatusHistoryData":{"title":"Status History Data","type":"object","properties":{"status":{"type":"string","description":"Status of the validator.","enum":["STAKING_INITIATED","PENDING_DEPOSIT","DEPOSITED","DEPOSIT_FAILED","ACTIVE","SLASHING","SLASHED","EXIT_INITIATED","EXITING","EXITED","WITHDRAWABLE","WITHDRAWN"]},"transitioned_at":{"type":"string","description":"The date and time the validator transitioned into the given status. It will be in the format of “YYYY-MM-DD HH:mm:ss”."}},"description":"An array that contains the state transition of the validator. "},"VoluntaryExitData":{"title":"Voluntary Exit Data","type":"object","properties":{"request_id":{"type":"string","description":"Unique request id sent by the client when requesting the voluntary exit."},"requested_at":{"type":"string","description":"The date and time the exit request was received. It will be in the format of “YYYY-MM-DD HH:mm:ss”."},"submitted_at":{"type":"string","description":"The date and time the validator’s exit message was broadcasted to the beacon node. It will be in the format of “YYYY-MM-DD HH:mm:ss”."}},"description":"JSON object that contains on demand exit related information if the validator has initiated the voluntary exit. Otherwise, it will be null."},"PresignedExitData":{"title":"Pre-signed Exit Data","type":"object","properties":{"fork_version":{"type":"string","description":"The genesis fork version used when generating the pre-signed exit message."},"encrypted_exit_message":{"type":"string","description":"The encrypted pre-signed exit message. The client can decrypt this message using their private key."}},"description":"This JSON object will be populated if the include_presigned_exit query parameter is set to “true” and the validator is in active status for at-least 256 epochs. Otherwise, it will be set to null."},"StakingRequestInfo":{"title":"Staking Request Data","type":"object","properties":{"staking_ref_id":{"type":"string","description":"A unique reference ID generated by the staking infrastructure for the staking request."},"provisioned_at":{"type":"string","description":"The date and time when the validator was provisioned by the staking infrastructure. It will be in the format of “YYYY-MM-DD HH:mm:ss”."}},"description":"JSON object that contains the staking request id and validators provisioned date and time. This should be set to ‘null’ for externally provisioned validators."},"ValidatorErrorListResponse":{"title":"Validator Error Response","type":"object","properties":{"error":{"type":"array","items":{"$ref":"#/components/schemas/ValidatorErrorMessage"}}}},"ValidatorErrorMessage":{"title":"Validator Error Message","type":"object","description":"An array of errors that resulted from this request.","required":["code","message"],"properties":{"code":{"type":"integer","description":"The code related to the error being reported.","format":"int32"},"message":{"type":"string","description":"The description related to the error being reported."}}},"InternalServerInfoErrorMessage":{"title":"Error Message","type":"object","description":"An array of errors that resulted from this request.","required":["message"],"properties":{"message":{"type":"string","description":"The description related to the error being reported."}}}}},"paths":{"/v1/ethereum/{network}/validators/{pubkey}":{"get":{"tags":["Ethereum"],"summary":"Get a Single Validator","description":"The get single validator endpoint returns the validator information for the specified validator’s public key. All timestamp fields in the response are provided in UTC timezone.","operationId":"get-validator","parameters":[{"name":"network","in":"path","description":"Applicable values are mainnet and hoodi.","required":true,"schema":{"type":"string"}},{"name":"pubkey","in":"path","description":"The public key of the validator","required":true,"schema":{"type":"string"}},{"name":"include_presigned_exit","in":"query","description":"This indicates whether the pre-signed exit message to be included in the response or not. It’s a boolean parameter, defaulted to “false”.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sample success response payload. See Response schema below for wrapper","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidatorInfoResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidatorErrorListResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerInfoErrorMessage"}}}}}}}}} ``` ## Get Validators Summary > This endpoint returns the summary of the validator count by status belonging to the staking partner associated with the given API Key. ```json {"openapi":"3.0.1","info":{"title":"Ethereum API Specification","version":"1.117.0"},"tags":[{"name":"Ethereum"}],"servers":[{"url":"http://localhost","description":"Generated server url"}],"security":[{"AuthorizationToken":[]},{"APIKey":[]}],"components":{"securitySchemes":{"AuthorizationToken":{"type":"http","description":"","scheme":"bearer","bearerFormat":"JWT"},"APIKey":{"name":"X-API-KEY","type":"apiKey","in":"header"}},"schemas":{"ValidatorsSummaryResponse":{"title":"Validator Summary Response","type":"object","properties":{"network":{"type":"string","description":"Network specified in the request.","enum":["mainnet","hoodi"]},"total":{"type":"integer","description":"Total number of validators provisioned for the given client and the network.","format":"int64"},"data":{"type":"array","description":"An array that contains validators summary.","items":{"$ref":"#/components/schemas/SummaryData"}}}},"SummaryData":{"title":"Summary Data","type":"object","properties":{"status":{"type":"string","description":"Status of the validator.","enum":["STAKING_INITIATED","PENDING_DEPOSIT","DEPOSITED","DEPOSIT_FAILED","ACTIVE","SLASHING","SLASHED","EXIT_INITIATED","EXITING","EXITED","WITHDRAWABLE","WITHDRAWN"]},"count":{"type":"integer","description":"The number of validators in the corresponding status. ","format":"int64"}},"description":"An array that contains validators summary."},"ValidatorErrorListResponse":{"title":"Validator Error Response","type":"object","properties":{"error":{"type":"array","items":{"$ref":"#/components/schemas/ValidatorErrorMessage"}}}},"ValidatorErrorMessage":{"title":"Validator Error Message","type":"object","description":"An array of errors that resulted from this request.","required":["code","message"],"properties":{"code":{"type":"integer","description":"The code related to the error being reported.","format":"int32"},"message":{"type":"string","description":"The description related to the error being reported."}}},"InternalServerInfoErrorMessage":{"title":"Error Message","type":"object","description":"An array of errors that resulted from this request.","required":["message"],"properties":{"message":{"type":"string","description":"The description related to the error being reported."}}}}},"paths":{"/v1/ethereum/{network}/validators/summary":{"get":{"tags":["Ethereum"],"summary":"Get Validators Summary","description":"This endpoint returns the summary of the validator count by status belonging to the staking partner associated with the given API Key. ","operationId":"validators-summary","parameters":[{"name":"network","in":"path","description":"Applicable values are mainnet and hoodi.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sample success response payload. See Response schema below for wrapper","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidatorsSummaryResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidatorErrorListResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerInfoErrorMessage"}}}}}}}}} ``` ## Withdrawals > The withdrawals endpoint returns a history of withdrawals (partial and full) from the consensus layer to the execution layer. ```json {"openapi":"3.0.1","info":{"title":"Ethereum API Specification","version":"1.117.0"},"tags":[{"name":"Ethereum"}],"servers":[{"url":"http://localhost","description":"Generated server url"}],"security":[{"AuthorizationToken":[]},{"APIKey":[]}],"components":{"securitySchemes":{"AuthorizationToken":{"type":"http","description":"","scheme":"bearer","bearerFormat":"JWT"},"APIKey":{"name":"X-API-KEY","type":"apiKey","in":"header"}},"schemas":{"EthEpochLevelInfoRequest":{"title":"Rewards Request","type":"object","required":["network","start","end","rollup_type"],"properties":{"network":{"type":"string","description":"The network on which validators should be created. Supported values are;\r\n- mainnet\r\n- hoodi","enum":["mainnet","hoodi"]},"start":{"type":"string","description":"It specifies the start epoch if the type is 1, or the start date in the \"YYYY-MM-DD\" format (UTC timezone) if the type is 2"},"end":{"type":"string","description":"It specifies the end epoch if the type is 1, or the end date in the \"YYYY-MM-DD\" format (UTC timezone) if the type is 2"},"rollup_type":{"type":"string","description":"Denotes the granularity of rewards breakdown. The applicable values are,\n