Skip to main content

Endpoints

API Usage

Once you have access to the Staking API with a validated user and existing API keys, you can start using this service.

Try it live

tip

Every endpoint on this page can be executed from the interactive Swagger console, using your own X-API-KEY.

The machine-readable OpenAPI schema is available at:

Authentication

In order to use the Staking API 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 > Create API keys section of the documentation.

Header:

NameDescriptionExample valueRequired
X-API-KEYYour api key value<API_KEY_VALUE>
X-NETWORKBlockchain network/chain identifiercelestia
X-IDENTITYCaller-defined identity stored in the audit loguser-1234

X-NETWORK header

Use the X-NETWORK header to tell the API which Celestia network should process the request (e.g., celestia for mainnet, mocha-4 for the Mocha testnet).

info

X-NETWORK accepts the same identifier exposed as chain_id in the Cosmos Chain Registry. When the header is omitted the default Celestia network configured for your account will be used.

tip

Need support for another network? Reach out at [email protected].

X-IDENTITY header

Use the X-IDENTITY header to attribute a request to the end user or account acting through your integration. The value is caller-defined and is stored with the request in the audit log, so activity can be traced back to it later.

info

The header is optional and does not change the response. Prefer an opaque internal identifier such as a user ID or account reference over personal data like emails or names. If you omit it, the request is attributed only to your API key.

List available networks

If you are unsure which Celestia networks are enabled for your account you can ask the API directly.

  • Endpoint: /api/v1/celestia/native/networks

Each object in the response includes:

FieldTypeRequiredDescription
namestringInternal name of the blockchain entry
typestringBlockchain type string (always COSMOS)
chain_idstringChain identifier, same as the Cosmos Chain Registry chain_id
is_defaultbooleantrue when this network is used as fallback

Example

curl "https://staking-api.stakely.io/api/v1/celestia/native/networks" \
-H "X-API-KEY: $STAKELY_API_KEY" \
-H "X-NETWORK: celestia"

Response:

[
{
"name": "celestia",
"type": "COSMOS",
"chain_id": "celestia",
"is_default": true
}
]

Staking information

Get the staking parameters of this protocol:

  • Endpoint: /api/v1/celestia/native/staking-info

Description

Staking parameters for Celestia mainnet: activation, deactivation and withdrawal times in minutes, fees, current APR/APY, slashing risk and stake limits. Served from an in-memory snapshot refreshed hourly.

Returned

FieldTypeRequiredDescription
stake_activation_max_timenumberMaximum time, in minutes, for a new stake to become active and start accruing rewards. 0 means it is effective immediately.
stake_deactivation_max_timenumberMaximum time, in minutes, for an unstake request to complete the unbonding/exit period. 0 means the stake is released immediately.
withdrawal_max_timenumberMaximum time, in minutes, between a completed deactivation and the funds being spendable again. 0 means the funds are available as soon as the deactivation completes.
staking_reward_feenumberAggregate fee charged on staking rewards, as a percentage of the rewards generated (validator commission plus any protocol fee).
withdrawal_feenumberFee charged when withdrawing the stake, as a percentage of the withdrawn amount. Network transaction (gas) costs are not included.
staking_aprnumberCurrent annual percentage rate (rewards without compounding), as a percentage.
staking_apynumberCurrent annual percentage yield (rewards with compounding), as a percentage.
max_slashing_percentagenumberMaximum percentage of the staked amount that the protocol can slash. 0 means the protocol implements no slashing.
min_stake_amountstringMinimum amount that can be staked, as a decimal string in the native token of the chain.
max_stake_amountstringMaximum amount that can be staked, as a decimal string in the native token of the chain. null means the protocol enforces no upper limit.
usersnumberNumber of addresses currently staking with Stakely on this chain. Live figure, refreshed hourly. null on protocol-scoped endpoints (liquid staking, vaults), because the feed only publishes this per chain and the chain-wide figure is not that protocol's.
tvl_usdnumberTotal value staked with Stakely on this chain, in USD. Live figure, refreshed hourly. null on protocol-scoped endpoints, for the same reason as users.
tvl_tokennumberTotal value staked with Stakely on this chain, in the native token of the chain. Live figure, refreshed hourly. null on protocol-scoped endpoints, for the same reason as users.

Example

curl "https://staking-api.stakely.io/api/v1/celestia/native/staking-info" \
-H "X-API-KEY: $STAKELY_API_KEY"

Response:

{
"stake_activation_max_time": 0,
"stake_deactivation_max_time": 20220,
"withdrawal_max_time": 0,
"staking_reward_fee": 14,
"withdrawal_fee": 0,
"staking_apr": 5.19,
"staking_apy": 5.33,
"max_slashing_percentage": 2,
"min_stake_amount": "0.000001",
"max_stake_amount": null,
"users": 2691,
"tvl_usd": 1398203.66,
"tvl_token": 4383083.576
}

Stake action

Craft a stake transaction:

  • Endpoint: /api/v1/celestia/native/action/stake

Description

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

Request body parameters

FieldTypeRequiredDescription
pubkeystringpubkey string compressed or uncompressed of the address that will perform the staking action
amountnumberAmount of stake to perform in TIA

Returned

FieldTypeRequiredDescription
unsigned_tx_hexstringUnsigned craft transaction hex string
tx_auth_info_hexstringTransaction auth info hex string
unsigned_tx_hash_hexstringUnasigned tx hash hex string, ready to be signed by external integrations

Example

curl -X POST "https://staking-api.stakely.io/api/v1/celestia/native/action/stake" \
-H "X-API-KEY: $STAKELY_API_KEY" \
-H "X-NETWORK: celestia" \
-H "Content-Type: application/json" \
-d '{
"pubkey": "025a2146590b80d1f0d97cc7104e702011afff21bfaf817f5c7002446369ba9ddc",
"amount": 0.1
}'

Response:

{
"unsigned_tx_hex": "03b8ef9558b9a2d9f2d4c1f4f8bafce1a6df628d6c521474d6823b6e3223d9e8af",
"tx_auth_info_hex": "0a4c0a440a1f2f636f736d6f732e63727970746f...303010c0cf24",
"unsigned_tx_hash_hex": "1a6edb7358323bafca52b1755f3ad985754dc23887110b65429373ed83321500"
}

Unstake action

Craft an unstake transaction:

  • Endpoint: /api/v1/celestia/native/action/unstake

Description

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

Request body parameters

FieldTypeRequiredDescription
pubkeystringpubkey string compressed or uncompressed of the address that will perform the staking action
amountnumberAmount of unstake to perform in TIA

Returned

FieldTypeRequiredDescription
unsigned_tx_hexstringUnsigned craft transaction hex string
tx_auth_info_hexstringTransaction auth info hex string
unsigned_tx_hash_hexstringUnasigned tx hash hex string, ready to be signed by external integrations

Example

curl -X POST "https://staking-api.stakely.io/api/v1/celestia/native/action/unstake" \
-H "X-API-KEY: $STAKELY_API_KEY" \
-H "X-NETWORK: celestia" \
-H "Content-Type: application/json" \
-d '{
"pubkey": "025a2146590b80d1f0d97cc7104e702011afff21bfaf817f5c7002446369ba9ddc",
"amount": 0.1
}'

Response:

{
"unsigned_tx_hex": "03b8ef9558b9a2d9f2d4c1f4f8bafce1a6df628d6c521474d6823b6e3223d9e8af",
"tx_auth_info_hex": "0a4c0a440a1f2f636f736d6f732e63727970746f...303010c0cf24",
"unsigned_tx_hash_hex": "1a6edb7358323bafca52b1755f3ad985754dc23887110b65429373ed83321500"
}

Claim rewards action

Craft a claim rewards transaction:

  • Endpoint: /api/v1/celestia/native/action/claim-rewards

Description

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

Request body parameters

FieldTypeRequiredDescription
pubkeystringpubkey string compressed or uncompressed of the address that will perform the staking action

Returned

FieldTypeRequiredDescription
unsigned_tx_hexstringUnsigned craft transaction hex string
tx_auth_info_hexstringTransaction auth info hex string
unsigned_tx_hash_hexstringUnasigned tx hash hex string, ready to be signed by external integrations

Example

curl -X POST "https://staking-api.stakely.io/api/v1/celestia/native/action/claim-rewards" \
-H "X-API-KEY: $STAKELY_API_KEY" \
-H "X-NETWORK: celestia" \
-H "Content-Type: application/json" \
-d '{
"pubkey": "025a2146590b80d1f0d97cc7104e702011afff21bfaf817f5c7002446369ba9ddc"
}'

Response:

{
"unsigned_tx_hex": "03b8ef9558b9a2d9f2d4c1f4f8bafce1a6df628d6c521474d6823b6e3223d9e8af",
"tx_auth_info_hex": "0a4c0a440a1f2f636f736d6f732e63727970746f...303010c0cf24",
"unsigned_tx_hash_hex": "1a6edb7358323bafca52b1755f3ad985754dc23887110b65429373ed83321500"
}

Prepare action

Gathers signature and unsigned tx:

  • Endpoint: /api/v1/celestia/native/action/prepare

Description

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

Request body parameters

FieldTypeRequiredDescription
tx_body_hexstringUnsigned transaction body hex string
tx_auth_info_hexstringTransaction auth info hex string
signature_hexstringTransaction signatures hex string

Returned

FieldTypeRequiredDescription
signed_tx_hexstringSigned transaction string (hex encoded) ready to be broadcasted

Example

curl -X POST "https://staking-api.stakely.io/api/v1/celestia/native/action/prepare" \
-H "X-API-KEY: $STAKELY_API_KEY" \
-H "X-NETWORK: celestia" \
-H "Content-Type: application/json" \
-d '{
"tx_body_hex": "0a8e010a8b010a1c2f636f736d6f732e62616e6b...6d1203323530",
"tx_auth_info_hex": "0a4c0a440a1f2f636f736d6f732e63727970746f...303010c0cf24",
"signature_hex": "a1b2c3d4e5f6...<signature hex>"
}'

Response:

{
"signed_tx_hex": "03b8ef9558b9a2d9f2d4c1f4f8bafce1a6df628d6c521474d6823b6e3223d9e8af"
}

Broadcast action

Broadcast a signed transaction

  • Endpoint: /api/v1/celestia/native/action/broadcast

Description

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

Request body parameters

FieldTypeRequiredDescription
signed_tx_hexstringSigned transaction string (hex encoded) to be broadcasted

Returned

FieldTypeRequiredDescription
tx_hashstringTransaction hash of the broadcasted transaction

Example

curl -X POST "https://staking-api.stakely.io/api/v1/celestia/native/action/broadcast" \
-H "X-API-KEY: $STAKELY_API_KEY" \
-H "X-NETWORK: celestia" \
-H "Content-Type: application/json" \
-d '{
"signed_tx_hex": "0a8e010a8b010a1c2f636f736d6f732e62616e6b...f736d6f73120"
}'

Response:

{
"tx_hash": "03b8ef9558b9a2d9f2d4c1f4f8bafce1a6df628d6c521474d6823b6e3223d9e8af"
}

Unified staking balance

Get the staking balance for the given address in the unified cross-protocol shape:

  • Endpoint: /api/v1/celestia/native/staking-balance/{address}

Description

Staking balance for an address in the unified cross-protocol shape, in TIA. Delegations are effective in the next block and unbonded funds are credited automatically, so activation and withdrawing are null. Each unbonding entry is listed as a staking object with its completion time; delegations have no id of their own and unstaking is amount-based, so the active stake contributes no objects.

Amounts are in TIA. The field names are the same on every protocol Stakely supports, so a single integration can read a position on any of them; a bucket that does not apply here is null.

Request parameters

ParameterInTypeRequiredDescription
addresspathstringCelestia wallet address

Returned

FieldTypeRequiredDescription
staked_amountnumberStake that is currently active and earning rewards, in native token units.
stake_activation_amountnumberStake that has been delegated but is still warming up, in native token units. null when the protocol activates stake immediately.
stake_deactivation_amountnumberStake that is unbonding and has not completed its deactivation period yet, in native token units. null when the protocol has no unbonding period.
stake_withdrawing_amountnumberStake that finished deactivating and is waiting for a withdrawal transaction, in native token units. null when the protocol releases the funds automatically.
stake_rewards_amountnumberRewards that can be claimed, in native token units. null when the protocol compounds rewards into staked_amount instead of accruing them separately.
staking_objectsStakingObjectDto[]Individually addressable units that make up the position, normalised across protocols. The amounts above are the aggregate; these are the handles needed to act on the position, because protocols such as Solana and Sui require an object id to craft an unstake or withdraw transaction. null means the protocol exposes no addressable objects at all and every action is amount-based; an empty array means it does expose them and the address currently holds none. An object is only listed when the protocol publishes a real identifier for it, so the listed objects do not necessarily add up to the totals above.

Each item in staking_objects is a StakingObjectDto:

FieldTypeRequiredDescription
idstringIdentifier of this object on its protocol, passed back to the action endpoints of that protocol (see below).
typeStakingObjectTypeWhether the object holds stake (delegation) or represents an exit already requested (withdrawal_request).
statusStakingObjectStatusLifecycle phase of the object. Objects sharing a status add up to the matching amount bucket of the response.
amountnumberPrincipal held by this object, in native token units. null when it could not be read.
rewards_amountnumberRewards accrued by this object on top of its principal, in native token units. null when the protocol reports rewards only at address level, compounds them into the principal, or when they could not be derived.
validator_addressstringValidator this object is delegated to, in the protocol native format (a vote account on Solana, a validator address on Sui). null when the protocol does not attribute the object to a single validator.
activation_epochnumberEpoch at which this object starts earning rewards. null on protocols that do not track activation per object.
withdrawable_epochnumberEpoch from which this object can be withdrawn. null on protocols whose withdrawal is time-based or that release funds automatically.
withdrawable_atstringISO-8601 instant from which this object can be withdrawn. null on protocols whose withdrawal is epoch-based or that release funds automatically.

On Celestia the id is the unbonding entry id. Delegations have no id of their own and unstaking is amount-based, so the active stake contributes no objects and the listed ids are informational.

type values:

ValueDescription
delegationThe object holds stake.
withdrawal_requestThe object represents an exit that has already been requested.

status values:

ValueDescription
activatingWarming up, not earning rewards yet. Adds up to stake_activation_amount.
activeLive and earning rewards. Adds up to staked_amount.
deactivatingUnbonding, deactivation period not finished. Adds up to stake_deactivation_amount.
withdrawableDeactivated and waiting for a withdrawal transaction. Adds up to stake_withdrawing_amount.
unknownThe lifecycle phase could not be derived from the protocol data.

Example

curl "https://staking-api.stakely.io/api/v1/celestia/native/staking-balance/celestia1sjllsnramtg3ewxqwwrwjxfgc4n4ef9u0h9wu4" \
-H "X-API-KEY: $STAKELY_API_KEY" \
-H "X-NETWORK: celestia"

Response:

{
"staked_amount": 120.5,
"stake_activation_amount": null,
"stake_deactivation_amount": 10,
"stake_withdrawing_amount": null,
"stake_rewards_amount": 1.284302,
"staking_objects": [
{
"id": "482911",
"type": "withdrawal_request",
"status": "deactivating",
"amount": 10,
"rewards_amount": null,
"validator_address": null,
"activation_epoch": null,
"withdrawable_epoch": null,
"withdrawable_at": "2026-08-12T17:41:05.000Z"
}
]
}