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 action
Craft a stake transaction:
- Endpoint:
/api/v1/cosmos/action/stake
Description
This endpoint will craft a stake transaction ready to be signed.
Request body parameters
Returned
Unstake action
Craft an unstake transaction:
- Endpoint:
/api/v1/cosmos/action/ustake
Description
This endpoint will craft an unstake transaction ready to be signed.
Request body parameters
Returned
Claim rewards action
Craft a claim rewards transaction:
- Endpoint:
/api/v1/cosmos/action/claim-rewards
Description
This endpoint will craft a claim rewards transaction ready to be signed.
Request body parameters
Returned
Prepare action
Gathers signature and unsigned tx:
- Endpoint:
/api/v1/cosmos/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/cosmos/action/broadcast
Description
Broadcast a signed transaction. Usually you will brodcast the signed transaction returned in prepare
previous step: