--- title: "Get user staking overview" method: GET path: "/api/v1/users/{address}/nept/staking" tags: ["User"] --- # Get user staking overview `GET /api/v1/users/{address}/nept/staking` ## Path parameters - `address` string, required — The user account address ## Query parameters - `with_text` boolean — Include text variation fields - `with_value` boolean — Calculate and include USD values for amounts, where applicable ## Response `200` Success response - UserStakeObjResponse - `data` UserStake, required - `asset_info` AssetInfo, required — Asset identifiers with associated metadata - `asset` AssetSpec, required — Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc) - `id` string, required - `group` union, required - 'native' - 'token' - `group_key` string, required - `metadata` AssetMetadata, required — Additional metadata for assets - `name` string, required — Full name of the asset - `symbol` string, required — Symbol of the asset, e.g.: `NEPT` `INJ` - `symbol_denom` string, required — Denom symbol for the asset (e.g. `inj` for `INJ`, `sat` for `BTC`) - `decimals_denom` integer, required — Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. `18` for `INJ`) - `decimals_display` integer, required — Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations) - `classification` union, required — The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.) Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification. While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change. - object - `kind` 'regular', required - `neptune_receipt_asset` AssetSpec, required — Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc) - `id` string, required - `group` union, required - … - `group_key` string, required - object - `kind` 'neptune_receipt_token', required - `origin_asset` AssetSpec, required — Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc) - `id` string, required - `group` union, required - … - `group_key` string, required - object - `kind` 'liquid_staking_token', required - `origin_asset` AssetSpec, required — Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc) - `id` string, required - `group` union, required - … - `group_key` string, required - `bonding_sum` string, required — Total staked of all entries across all listed pools **NOTE:** this value is affected by active filters, if any (e.g. filtering over account index) - `pools` UserStakePool[], required — User allocations for each staking pool - `common` StakingPoolFull, required — Staking pool contents along with associated pool state and pool params - `index` integer, required — The ordered index (position) of this pool - `duration` integer, required — The lockup duration for this pool in seconds - `extra` object, required - `text` object, nullable, required — Human-readable field variants. Will not be null when query param `with_text` is `true`. - `duration` string, required - `index` string, required - `params` StakingPoolParams, required - `reward_weight` string, required — The pool's weight (multiplier) on rewards for an associated stake - `gov_weight` string, required — The pool's weight (multiplier) on governance for an associated stake - `health_weight` string, required — The pool's weight (multiplier) on account health for an associated stake - `flash_loan_weight` string, required — The pool's weight (multiplier) for flash loans volume - `state` StakingPoolState, required - `total_bonded` string, required — The total amount staked to this pool - `extra` object, required - `text` object, nullable, required — Human-readable field variants. Will not be null when query param `with_text` is `true`. - … - `value` object, nullable, required — USD values for the corresponding amounts above. Will not be null when query param `with_value` is `true`. ### Note This variant group contains an additional `price` field (set to the number used in value calculation). The embedded text group will contain the text variant if `with_text` was specified as well. - … - `amount_sum` string, required — Total staked of all entries **NOTE:** this value is affected by active filters, if any (e.g. filtering over account index) - `contents` UserStakeBondingEntry[], required — Bonding/stake entries **NOTE:** entries that differ only in amount are merged upon creation - `account_index` integer, required — User account index - `amount` string, required — Bonding amount - `cascade` boolean, required - `transition_at` string, date-time, nullable, required - `last_stake_acc` string, required - `extra` object, required - `text` object, nullable, required — Human-readable field variants. Will not be null when query param `with_text` is `true`. - `transition_at` string, required - `amount` string, required - `value` object, nullable, required — USD values for the corresponding amounts above. Will not be null when query param `with_value` is `true`. ### Note This variant group contains an additional `price` field (set to the number used in value calculation). The embedded text group will contain the text variant if `with_text` was specified as well. - `price` string, required — Price used in value calculations - `amount` string, required - `extra` object, required - … - `extra` object, required - `text` object, nullable, required — Human-readable field variants. Will not be null when query param `with_text` is `true`. - `amount_sum` string, required - `value` object, nullable, required — USD values for the corresponding amounts above. Will not be null when query param `with_value` is `true`. ### Note This variant group contains an additional `price` field (set to the number used in value calculation). The embedded text group will contain the text variant if `with_text` was specified as well. - `amount_sum` string, required - `price` string, required — Price used in value calculations - `extra` object, required - `text` object, nullable, required — Human-readable variants of USD values. Will not be null when query params `with_text` and `with_value` are `true`. - … - `unbonding` UserStakeUnbonding, required - `amount_sum` string, required — Total amount of all unbond entries **NOTE:** this value is affected by active filters, if any (e.g. filtering over account index) - `contents` UserStakeUnbondingEntry[], required — Unbonding/unstake entries **NOTE:** cascade unbondings from pool >= 2 are contained in the bondings list of the lower adjacent pool from which the unbond occurred. - `amount` string, required — Unbonding amount - `unlock_at` string, date-time, required — Timestamp for when the unstake can be redeemed - `extra` object, required - `text` object, nullable, required — Human-readable field variants. Will not be null when query param `with_text` is `true`. - `amount` string, required - `unlock_at` string, required - `value` object, nullable, required — USD values for the corresponding amounts above. Will not be null when query param `with_value` is `true`. ### Note This variant group contains an additional `price` field (set to the number used in value calculation). The embedded text group will contain the text variant if `with_text` was specified as well. - `price` string, required — Price used in value calculations - `amount` string, required - `extra` object, required - … - `extra` object, required - `text` object, nullable, required — Human-readable field variants. Will not be null when query param `with_text` is `true`. - `amount_sum` string, required - `value` object, nullable, required — USD values for the corresponding amounts above. Will not be null when query param `with_value` is `true`. ### Note This variant group contains an additional `price` field (set to the number used in value calculation). The embedded text group will contain the text variant if `with_text` was specified as well. - `amount_sum` string, required - `price` string, required — Price used in value calculations - `extra` object, required - `text` object, nullable, required — Human-readable variants of USD values. Will not be null when query params `with_text` and `with_value` are `true`. - … - `unclaimed` string, required - `claimable_rewards` string, required — NEPT rewarded from staking that is available yet not claimed by the user - `claimable_unbonding` string, required — Sum of all unbond/unstake amounts that have completed their lockup period and are ready to be claimed. - `extra` object, required - `text` object, nullable, required — Human-readable field variants. Will not be null when query param `with_text` is `true`. - `bonding_sum` string, required - `unclaimed` string, required - `claimable_unbonding` string, required - `claimable_rewards` string, required - `value` object, nullable, required — USD values for the corresponding amounts above. Will not be null when query param `with_value` is `true`. ### Note This variant group contains an additional `price` field (set to the number used in value calculation). The embedded text group will contain the text variant if `with_text` was specified as well. - `unclaimed` string, required - `claimable_rewards` string, required - `price` string, required — Price used in value calculations - `claimable_unbonding` string, required - `bonding_sum` string, required - `extra` object, required - `text` object, nullable, required — Human-readable variants of USD values. Will not be null when query params `with_text` and `with_value` are `true`. - `claimable_unbonding` string, required - `price` string, required — Text representation of price - `claimable_rewards` string, required - `bonding_sum` string, required - `unclaimed` string, required - `error` unknown, required - `status` integer, required — HTTP status. Successful responses are guaranteed to be < `400`. Conversely, error responses are guaranteed to be >= `400`. - `status_text` string, required — HTTP status text ## Other responses - `500` — Server error response - `default` ## Changes - **2026-04-02** `3e68b318eeaa` — 12 info - added the required property `data/extra/value/extra/text/price` to the response with the `200` status - added the required property `data/extra/value/price` to the response with the `200` status - added the required property `data/pools/items/common/allOf[#/components/schemas/StakingPoolFull]/state/allOf[#/components/schemas/StakingPoolState]/extra/value/extra/text/price` to the response with the `200` status - added the required property `data/pools/items/common/allOf[#/components/schemas/StakingPoolFull]/state/allOf[#/components/schemas/StakingPoolState]/extra/value/price` to the response with the `200` status - …8 more - …earlier changes not shown [Full history](https://skmtc.dev/cryptechdev/apis/neptune-api-v2/changes/api/v1/users/:address/nept/staking/get.md) --- [API](https://skmtc.dev/cryptechdev/apis/neptune-api-v2.md) · [All operations](https://skmtc.dev/cryptechdev/apis/neptune-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cryptechdev/neptune-api-v2/revisions/05e0ec4b9b94/schema)