Nept
Get user NEPT unlocks
ModelsExpand Collapse
UserUnlockAmounts = object { amount, claimable, claimed, 4 more }
The full unlock amount
This value is immutable and does not change with regards to expiry/reclamation/lock states.
The amount currently claimable
This takes into account: reclamation, lock state, expiry, and previously claimed. In other words, this is an accurate representation of what the user can currently claim.
The amount that was claimable but has now expired due to the presence and subsequent passing of expires_at
extra: object { percent, text, value }
percent: object { claimable, claimed, expired, 3 more } Percentages for unlock amounts. These do not factor in the amount_staked or amount_held values. Will not be null when query param with_percent is true.
Percentages for unlock amounts. These do not factor in the amount_staked or amount_held values. Will not be null when query param with_percent is true.
text: object { amount, claimable, claimed, 3 more } Human-readable field variants. Will not be null when query param with_text is true.
Human-readable field variants. Will not be null when query param with_text is true.
value: object { amount, claimable, claimed, 5 more } 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.
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.
UserUnlockOverview = object { arrangements, extra, last_claimed_at, totals }
arrangements: array of object { admin, amounts, begins_at, 4 more } A list of the user's active unlock arrangements
A list of the user's active unlock arrangements
Primary unlock amount and other pre-calculated/derived amounts
Primary unlock amount and other pre-calculated/derived amounts
The full unlock amount
This value is immutable and does not change with regards to expiry/reclamation/lock states.
The amount currently claimable
This takes into account: reclamation, lock state, expiry, and previously claimed. In other words, this is an accurate representation of what the user can currently claim.
The amount that was claimable but has now expired due to the presence and subsequent passing of expires_at
extra: object { percent, text, value }
percent: object { claimable, claimed, expired, 3 more } Percentages for unlock amounts. These do not factor in the amount_staked or amount_held values. Will not be null when query param with_percent is true.
Percentages for unlock amounts. These do not factor in the amount_staked or amount_held values. Will not be null when query param with_percent is true.
text: object { amount, claimable, claimed, 3 more } Human-readable field variants. Will not be null when query param with_text is true.
Human-readable field variants. Will not be null when query param with_text is true.
value: object { amount, claimable, claimed, 5 more } 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.
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.
The schedule of the unlock
The schedule of the unlock
UserUnlockScheduleLinear = object { duration, ends_at, extra, kind }
The time at which the most recent unlock claim occurred, if any
Contains pre-calculated total amounts for all unlock agreements
Contains pre-calculated total amounts for all unlock agreements
The full unlock amount
This value is immutable and does not change with regards to expiry/reclamation/lock states.
The amount currently claimable
This takes into account: reclamation, lock state, expiry, and previously claimed. In other words, this is an accurate representation of what the user can currently claim.
The amount that was claimable but has now expired due to the presence and subsequent passing of expires_at
extra: object { percent, text, value }
percent: object { claimable, claimed, expired, 3 more } Percentages for unlock amounts. These do not factor in the amount_staked or amount_held values. Will not be null when query param with_percent is true.
Percentages for unlock amounts. These do not factor in the amount_staked or amount_held values. Will not be null when query param with_percent is true.
text: object { amount, claimable, claimed, 3 more } Human-readable field variants. Will not be null when query param with_text is true.
Human-readable field variants. Will not be null when query param with_text is true.
value: object { amount, claimable, claimed, 5 more } 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.
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.
UserUnlockSchedule = UserUnlockScheduleLinear { duration, ends_at, extra, kind } or UserUnlockScheduleLumpSum { kind }
UserUnlockScheduleLinear = object { duration, ends_at, extra, kind }
UserUnlockScheduleLinear = object { duration, ends_at, extra, kind }
NeptStaking
Get user staking overview
Get user staking pools
Get user staking pool by duration/index
Get user unstaking pool
ModelsExpand Collapse
UserStake = object { asset_info, bonding_sum, claimable_rewards, 5 more }
Asset identifiers with associated metadata
Asset identifiers with associated metadata
Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)
Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)
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.
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.
Regular = object { kind, neptune_receipt_asset }
NeptuneReceiptToken = object { kind, origin_asset }
Additional metadata for assets
Additional metadata for assets
Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)
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)
Sum of all unbond/unstake amounts that have completed their lockup period and are ready to be claimed.
extra: object { text, value }
text: object { bonding_sum, claimable_rewards, claimable_unbonding, unclaimed } Human-readable field variants. Will not be null when query param with_text is true.
Human-readable field variants. Will not be null when query param with_text is true.
value: object { bonding_sum, claimable_rewards, claimable_unbonding, 3 more } 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.
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.
User allocations for each staking pool
User allocations for each staking pool
Total staked of all entries
NOTE: this value is affected by active filters, if any (e.g. filtering over account index)
Staking pool contents along with associated pool state and pool params
Staking pool contents along with associated pool state and pool params
Current contract state of staking pool
Current contract state of staking pool
extra: object { text, value }
text: object { total_bonded } Human-readable field variants. Will not be null when query param with_text is true.
Human-readable field variants. Will not be null when query param with_text is true.
value: object { extra, price, total_bonded } 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.
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.
Bonding/stake entries
NOTE: entries that differ only in amount are merged upon creation
Bonding/stake entries
NOTE: entries that differ only in amount are merged upon creation
extra: object { text, value }
text: object { amount, transition_at } Human-readable field variants. Will not be null when query param with_text is true.
Human-readable field variants. Will not be null when query param with_text is true.
value: object { amount, extra, price } 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.
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.
extra: object { text, value }
text: object { amount_sum } Human-readable field variants. Will not be null when query param with_text is true.
Human-readable field variants. Will not be null when query param with_text is true.
value: object { amount_sum, extra, price } 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.
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.
User unstake/unbonding data
User unstake/unbonding data
Total amount of all unbond entries
NOTE: this value is affected by active filters, if any (e.g. filtering over account index)
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.
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.
extra: object { text, value }
text: object { amount, unlock_at } Human-readable field variants. Will not be null when query param with_text is true.
Human-readable field variants. Will not be null when query param with_text is true.
value: object { amount, extra, price } 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.
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.
extra: object { text, value }
text: object { amount_sum } Human-readable field variants. Will not be null when query param with_text is true.
Human-readable field variants. Will not be null when query param with_text is true.
value: object { amount_sum, extra, price } 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.
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.
UserStakeBondingEntry = object { account_index, amount, cascade, 3 more }
extra: object { text, value }
text: object { amount, transition_at } Human-readable field variants. Will not be null when query param with_text is true.
Human-readable field variants. Will not be null when query param with_text is true.
value: object { amount, extra, price } 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.
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.
UserStakePool = object { amount_sum, common, contents, extra }
Total staked of all entries
NOTE: this value is affected by active filters, if any (e.g. filtering over account index)
Staking pool contents along with associated pool state and pool params
Staking pool contents along with associated pool state and pool params
Current contract state of staking pool
Current contract state of staking pool
extra: object { text, value }
text: object { total_bonded } Human-readable field variants. Will not be null when query param with_text is true.
Human-readable field variants. Will not be null when query param with_text is true.
value: object { extra, price, total_bonded } 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.
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.
Bonding/stake entries
NOTE: entries that differ only in amount are merged upon creation
Bonding/stake entries
NOTE: entries that differ only in amount are merged upon creation
extra: object { text, value }
text: object { amount, transition_at } Human-readable field variants. Will not be null when query param with_text is true.
Human-readable field variants. Will not be null when query param with_text is true.
value: object { amount, extra, price } 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.
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.
extra: object { text, value }
text: object { amount_sum } Human-readable field variants. Will not be null when query param with_text is true.
Human-readable field variants. Will not be null when query param with_text is true.
value: object { amount_sum, extra, price } 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.
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.
UserStakeUnbonding = object { amount_sum, contents, extra }
Total amount of all unbond entries
NOTE: this value is affected by active filters, if any (e.g. filtering over account index)
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.
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.
extra: object { text, value }
text: object { amount, unlock_at } Human-readable field variants. Will not be null when query param with_text is true.
Human-readable field variants. Will not be null when query param with_text is true.
value: object { amount, extra, price } 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.
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.
extra: object { text, value }
text: object { amount_sum } Human-readable field variants. Will not be null when query param with_text is true.
Human-readable field variants. Will not be null when query param with_text is true.
value: object { amount_sum, extra, price } 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.
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.
UserStakeUnbondingEntry = object { amount, extra, unlock_at }
extra: object { text, value }
text: object { amount, unlock_at } Human-readable field variants. Will not be null when query param with_text is true.
Human-readable field variants. Will not be null when query param with_text is true.
value: object { amount, extra, price } 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.
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.