Skip to main content

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

tip

You can check the Staking API Reference here:

Authentication

In order to use staking api related endpoints you need to include your API KEY

tip

Heads up! To obtain a valid API key required for authentication, please refer to the Authentication > Auth section of the documentation.

Header:

NameDescriptionExample valueRequired
X-API-KEYYour api key value<API_KEY_VALUE>

Delegate action

Craft a delegate transaction:

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

MonadStakeActionDto

Returned

MonadActionResponseDto


Undelegate action

Craft an undelegate transaction:

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

MonadUndelegateActionDto

Returned

MonadActionResponseDto


Withdraw action

Craft a withdraw transaction:

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

MonadWithdrawActionDto

Returned

MonadActionResponseDto


Claim rewards action

Craft a claim rewards transaction:

Description

This endpoint will craft a claim rewards transaction ready to be signed. It allows you to claim accumulated staking rewards.

Request body parameters

MonadClaimRewardsActionDto

Returned

MonadActionResponseDto


Compound action

Craft a compound rewards transaction:

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

MonadCompoundActionDto

Returned

MonadActionResponseDto


Prepare action

Gathers signature and unsigned tx:

Description

Prepare a signed transaction by gathering the provided signatures (r, s, v) with the unsigned transaction hex string:

Request body parameters

EthPrepareActionDto

Returned

EthPrepareActionResponseDto


Broadcast action

Broadcast a signed transaction:

Description

Broadcast a signed transaction. Usually you will broadcast the signed transaction returned in prepare previous step:

Request body parameters

EthBroadcastActionDto

Returned

EthBroadcastActionResponseDto


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

GetStakeBalanceResponseDto


Withdrawal requests

Get withdrawal requests for the given 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

MonadWithdrawalQueryDto

  • 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

MonadWithdrawalParamsDto

  • address: Delegator address
  • withdrawId: Withdrawal slot identifier (0-255)

Returned

GetWithdrawalRequestResponseDto