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

Header:

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

Stake action

Craft a stake transaction:

Description

This endpoint will craft a stake transaction ready to be signed.

Request body parameters

StakeActionDto

Returned

StakingActionResponseDto


Unstake action

Craft an unstake transaction:

Description

This endpoint will craft an unstake transaction ready to be signed.

Request body parameters

UnstakeActionDto

Returned

StakingActionResponseDto


Claim rewards action

Craft a claim rewards transaction:

Description

This endpoint will craft a claim rewards transaction ready to be signed.

Request body parameters

ClaimRewardsActionDto

Returned

StakingActionResponseDto


Prepare action

Gathers signature and unsigned tx:

Description

Prepare a signed transaction by gathering the provided signatures with the unsigned transaction hex string:

Request body parameters

PrepareActionDto

Returned

PrepareActionResponseDto


Broadcast action

Broadcast a signed transaction

Description

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

Request body parameters

BroadcastActionDto

Returned

BroadcastActionResponseDto