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
Heads up! To obtain a valid API key required for authentication, please refer to the Authentication > Auth section of the documentation.
Header:
| Name | Description | Example value | Required |
|---|---|---|---|
X-API-KEY | Your api key value | <API_KEY_VALUE> | ✅ |
Delegate action
Craft a delegate transaction:
- Endpoint:
/api/v1/eth/monad/action/delegate
Description
This endpoint will craft a delegate transaction ready to be signed. The transaction will delegate the specified amount to the validator.
Request body parameters
Returned
Undelegate action
Craft an undelegate transaction:
- Endpoint:
/api/v1/eth/monad/action/undelegate
Description
This endpoint will craft an undelegate transaction ready to be signed. The undelegated amount will be placed in a withdrawal slot and can be withdrawn after the withdrawal epoch.
Request body parameters
Returned
Withdraw action
Craft a withdraw transaction:
- Endpoint:
/api/v1/eth/monad/action/withdraw
Description
Once the withdrawal is available (after the withdrawal epoch), you can claim it. This action will craft a withdraw transaction for the specified withdrawal slot.
Request body parameters
Returned
Claim rewards action
Craft a claim rewards transaction:
- Endpoint:
/api/v1/eth/monad/action/claim-rewards
Description
This endpoint will craft a claim rewards transaction ready to be signed. It allows you to claim accumulated staking rewards.
Request body parameters
Returned
Compound action
Craft a compound rewards transaction:
- Endpoint:
/api/v1/eth/monad/action/compound
Description
This endpoint will craft a compound rewards transaction ready to be signed. It automatically reinvests your accumulated rewards back into your stake position.
Request body parameters
Returned
Prepare action
Gathers signature and unsigned tx:
- Endpoint:
/api/v1/eth/monad/action/prepare
Description
Prepare a signed transaction by gathering the provided signatures (r, s, v) with the unsigned transaction hex string:
Request body parameters
Returned
Broadcast action
Broadcast a signed transaction:
- Endpoint:
/api/v1/eth/monad/action/broadcast
Description
Broadcast a signed transaction. Usually you will broadcast the signed transaction returned in prepare previous step:
Request body parameters
Returned
Stake balance
Get stake balance for the given address:
Description
Get stake balance and rewards information for the given delegator address. All values are returned in ether units.
Request parameters
At url param you will need to pass the address you want to retrieve stake balance from
Returned
Withdrawal requests
Get withdrawal requests for the given address:
- Endpoint:
/api/v1/eth/monad/withdrawals/{address}
Description
Get withdrawal requests for the given delegator address. You can optionally filter by withdrawal ID range using query parameters. All values are returned in ether units.
Request parameters
At url param you will need to pass the address you want to retrieve withdrawal requests from
Query parameters
startWithdrawId(optional): Start withdrawal ID in the range (0-255, defaults to 0)endWithdrawId(optional): End withdrawal ID in the range (0-255, defaults to 255)
Returned
GetWithdrawalRequestsResponseDto
Withdrawal request
Get a single withdrawal request:
Description
Get a single withdrawal request for the given delegator address and withdrawal slot ID. All values are returned in ether units.
Request parameters
address: Delegator addresswithdrawId: Withdrawal slot identifier (0-255)
Returned
GetWithdrawalRequestResponseDto