Endpoints
API Usage
Once you already have access to the Staking API with a validated user and existing apikeys you can start using this service.
API Reference docs
You can check the Staking API Reference here:
- Rendered doc page.
- Staking OpenApi
Authentication
In order to use staking api related endpoints you need to include your API KEY
Header:
| Name | Description | Example value | Required |
|---|---|---|---|
X-API-KEY | Your api key value | <API_KEY_VALUE> | ✅ |
Stake into stakewise vault
Craft a stake transaction:
- Endpoint:
/api/v1/eth/stakewise/action/stake
Description
This endpoint will craft a stake transaction ready to be signed.
Request body parameters
Returned
StakewiseStakingActionResponseDto
Unstake action
Craft a unstake transaction
- Endpoint:
/api/v1/eth/stakewise/action/unstake
Description
This endpoint will build an "enter exit queue" unstake transaction ready to be signed. The exited assets needs to mature for a given period before there are claimable
Request param
Returned
StakewiseStakingActionResponseDto
Withdraw action
Craft a withdraw transaction
- Endpoint:
/api/v1/eth/stakewise/action/withdraw
Description
Once the assets in queue are ready to be claimable you can claim them. This action will craft a withdraw transaction of the withdrawable assets.
Returned
StakewiseStakingActionResponseDto
Prepare action
Gathers signature and unsigned tx:
- Endpoint:
/api/v1/eth/stakewise/action/prepare
Description
Prepare a signed transaction by gathering the provided signatures with the unsigned transaction hex string:
Request body parameters
Returned
Broadcast action
Broadcast a signed transaction
- Endpoint:
/api/v1/eth/stakewise/action/broadcast
Description
Broadcast a signed transaction. Usually you will brodcast the signted transaction returned in prepare previous step:
Request body parameters
Returned
Historic
Get stakewise actions history for the given address
Description
Get stakewise actions history for the given address. It will return all historic actions of different kind of actions.
Request parameters
At url param you will need to pass the address you want to retrieve actions from
Returned
Array of StakewiseGetActionResponseDto
Stake balance
Get stakewise stake balance for the given address
Description
Get stakewise stake balance for the given address.
Request parameters
At url param you will need to pass the address you want to retrieve actions from
Returned
Array of StakewiseGetStakeBalanceResponseDto
Exited balance
Get stakewise exited balance for the given address
Description
Get stakewise exited balance for the given address.
Request parameters
At url param you will need to pass the address you want to retrieve actions from
Returned
Array of StakewiseGetExitedBalanceResponseDto