--- 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` - object - `data` UserStake — `UserStake` - `asset_info` AssetInfo, required — `AssetInfo` - `asset` AssetSpec, required — `AssetSpec` 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` 'native' | 'token', required - `group_key` string, required - `metadata` AssetMetadata, required — `AssetMetadata` - `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 — `AssetClassification` --- 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 - `neptune_receipt_asset` AssetSpec — `AssetSpec` 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` 'native' | 'token', required - `group_key` string, required - `kind` 'regular', required - object - `origin_asset` AssetSpec, required — `AssetSpec` 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` 'native' | 'token', required - `group_key` string, required - `kind` 'neptune_receipt_token', required - object - `origin_asset` AssetSpec — `AssetSpec` 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` 'native' | 'token', required - `group_key` string, required - `kind` 'liquid_staking_token', 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 — `UserStakePool[]` --- User allocations for each staking pool - `common` StakingPoolFull, required — `StakingPoolFull` --- Merges `StakingPool` with both `StakingPoolWithParams` and `StakingPoolState` - `index` integer, required — The ordered index (position) of this pool - `duration` Duration, required - `secs` integer, required - `nanos` integer, required - `extra` object, required - `text` object, nullable — Human-readable field variants. Must provide `?with-text=true` - `duration` string, required - `index` string, required - `params` StakingPoolParams, required — `StakingPoolParams` - `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 — `StakingPoolState` - `total_bonded` string, required — The total amount staked to this pool - `extra` object, required - `text` object, nullable — Human-readable field variants. Must provide `?with-text=true` - … - `value` object, nullable — USD values for the corresponding amounts above. Must provide `?with-value=true` - … - `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 — `UserStakeBondingEntry[]` --- 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 - `last_stake_acc` string, required - `extra` object, required - `text` object, nullable — Human-readable field variants. Must provide `?with-text=true` - `amount` string, required - `transition_at` string, required - `value` object, nullable — USD values for the corresponding amounts above. Must provide `?with-value=true` - `amount` string, required - `extra` object, required - … - `extra` object, required - `text` object, nullable — Human-readable field variants. Must provide `?with-text=true` - `amount_sum` string, required - `value` object, nullable — USD values for the corresponding amounts above. Must provide `?with-value=true` - `amount_sum` string, required - `extra` object, required - `text` object, nullable — Human-readable variants of USD values. Must provide `?with-text=true&with-value=true` - … - `unbonding` UserStakeUnbonding, required — `UserStakeUnbonding` - `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 — `UserStakeUnbondingEntry[]` --- 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 — Human-readable field variants. Must provide `?with-text=true` - `amount` string, required - `unlock_at` string, required - `value` object, nullable — USD values for the corresponding amounts above. Must provide `?with-value=true` - `amount` string, required - `extra` object, required - … - `extra` object, required - `text` object, nullable — Human-readable field variants. Must provide `?with-text=true` - `amount_sum` string, required - `value` object, nullable — USD values for the corresponding amounts above. Must provide `?with-value=true` - `amount_sum` string, required - `extra` object, required - `text` object, nullable — Human-readable variants of USD values. Must provide `?with-text=true&with-value=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 — Human-readable field variants. Must provide `?with-text=true` - `claimable_unbonding` string, required - `unclaimed` string, required - `bonding_sum` string, required - `claimable_rewards` string, required - `value` object, nullable — USD values for the corresponding amounts above. Must provide `?with-value=true` - `unclaimed` string, required - `claimable_rewards` string, required - `bonding_sum` string, required - `claimable_unbonding` string, required - `extra` object, required - `text` object, nullable — Human-readable variants of USD values. Must provide `?with-text=true&with-value=true` - `claimable_unbonding` string, required - `claimable_rewards` string, required - `unclaimed` string, required - `bonding_sum` string, required - `error` ErrorData - `scope` 'user' | 'client' | 'server', required - `kind` 'invalid_request' | 'validation' | 'entity_not_found' | 'contract' | 'internal', required - `message` string, required — Error message - `fields` FieldValidationError[], nullable — List of names and error messages for invalid fields. Always set when `error.kind == 'validation'`. Always NULL/unset for all other cases. - `field` string, required - `message` string, required - `status` integer, required — Request status - `status_text` string, required — Request status text --- [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/4b5b35e288d8/schema)