User
Get user
Get user tx history
ModelsExpand Collapse
class User: …
User's market contribution overview
User's market contribution overview
Overview of user borrowing portfolio
Overview of user borrowing portfolio
Market sub-accounts for the user
Market sub-accounts for the user
Account collateral allocations
Account collateral allocations
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
Account debt allocations
Account debt allocations
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
Collateral/debt totals of all sub-accounts by asset
Collateral/debt totals of all sub-accounts by asset
Account collateral allocations
Account collateral allocations
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
Account debt allocations
Account debt allocations
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
Overview of user lending portfolio
Overview of user lending portfolio
User lending allocations
User lending allocations
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.
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)
The lending amounts converted into the equivalent for the receipt token's origin/source asset
The lending amounts converted into the equivalent for the receipt token's origin/source asset
Total equivalent amount of origin token collateralized across this user's borrowing portfolio
NOTE: This is not the amount of the origin asset that the user holds, but the amount held in the receipt token rendered as the equivalent amount in the origin asset.
Or, more formally: origin_equivalent_collateralized = receipt_collateralized / receipt_redemption_ratio
Total equivalent amount of origin token held in address balance
NOTE: This is not the amount of the origin asset that the user holds, but the amount held in the receipt token rendered as the equivalent amount in the origin asset.
Or, more formally: origin_equivalent_held = receipt_held / receipt_redemption_ratio
The lending amounts in the original receipt token amounts
The lending amounts in the original receipt token amounts
Total amount of receipt token collateralized across this user's borrowing portfolio
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
nept: NeptUser's NEPT associations (e.g. stake, unlocks)
User's NEPT associations (e.g. stake, unlocks)
Overview of the user's staking contributions/activity
Overview of the user's staking contributions/activity
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.
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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
Overview of the user's unlock arrangements and claim statistics
Overview of the user's unlock arrangements and claim statistics
arrangements: List[Arrangement]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: Extra
percent: Optional[ExtraPercent]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: Optional[ExtraText]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: Optional[ExtraValue]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 time at which the unlock was last claimed, if any
The schedule of the unlock
The schedule of the unlock
class UserUnlockScheduleLinear: …
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: Extra
percent: Optional[ExtraPercent]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: Optional[ExtraText]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: Optional[ExtraValue]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's wallets and balances
User's wallets and balances
Array of each wallet balance
Array of each wallet balance
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)
Derived values and amounts.
Derived values and amounts.
class WalletAssetKnown: …
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
class UserTx: …
Neptune market sub-account index. Will be set for the following event types:
borrow, return, deposit_collateral, withdraw_collateral,
liquidate, bond, unbond.
Otherwise the value is guaranteed to be null.
The relevant amount for the given tx/event.
This value will be set for all currently implemented action types. It is set as nullable for forwards compatibility for future action types which may not have an associated amount.
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.
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)
Destination account address.
Non-null for send/transfer transactions. This field will be null for all other action types.
Internal UUID created when the transaction was first indexed by Neptune.
Primary usage for API clients is tx history pagination offsets.
NOTE: event UUIDs should not be used as a guaranteed method of uniquely identifying a transaction event over extended periods of time.
Future updates to our indexer may infrequently require a full re-index of transactions, resulting in newly generated UUIDs.
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
historic_price: Union[str, float, null]The price of the associated asset at the time of the transaction.
This value will be set for all currently implemented action types.
It is set as nullable for forwards compatibility for future action types which may not have an associated amount.
The price of the associated asset at the time of the transaction.
This value will be set for all currently implemented action types. It is set as nullable for forwards compatibility for future action types which may not have an associated amount.
historic_value: Union[str, float, null]The USD value at the time of the transaction. Derived using the amount and historical price of the associated asset.
This value will be set for all currently implemented action types.
It is set as nullable for forwards compatibility for future action types which may not have an associated amount.
The USD value at the time of the transaction. Derived using the amount and historical price of the associated asset.
This value will be set for all currently implemented action types. It is set as nullable for forwards compatibility for future action types which may not have an associated amount.
The USD value at the time of the transaction. Derived using the amount and historical price of the associated asset.
This value will be set for all currently implemented action types. It is set as nullable for forwards compatibility for future action types which may not have an associated amount.
The USD value at the time of the transaction. Derived using the amount and historical price of the associated asset.
This value will be set for all currently implemented action types. It is set as nullable for forwards compatibility for future action types which may not have an associated amount.
UserMarket
Get user market portfolio
Get user markets for all kinds (lend + borrow debt/collateral), grouped together by asset
Get user's markets (lend + borrow debt/collateral) for a specific asset
ModelsExpand Collapse
class UserMarket: …
Overview of user borrowing portfolio
Overview of user borrowing portfolio
Market sub-accounts for the user
Market sub-accounts for the user
Account collateral allocations
Account collateral allocations
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
Account debt allocations
Account debt allocations
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
Collateral/debt totals of all sub-accounts by asset
Collateral/debt totals of all sub-accounts by asset
Account collateral allocations
Account collateral allocations
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
Account debt allocations
Account debt allocations
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
Overview of user lending portfolio
Overview of user lending portfolio
User lending allocations
User lending allocations
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.
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)
The lending amounts converted into the equivalent for the receipt token's origin/source asset
The lending amounts converted into the equivalent for the receipt token's origin/source asset
Total equivalent amount of origin token collateralized across this user's borrowing portfolio
NOTE: This is not the amount of the origin asset that the user holds, but the amount held in the receipt token rendered as the equivalent amount in the origin asset.
Or, more formally: origin_equivalent_collateralized = receipt_collateralized / receipt_redemption_ratio
Total equivalent amount of origin token held in address balance
NOTE: This is not the amount of the origin asset that the user holds, but the amount held in the receipt token rendered as the equivalent amount in the origin asset.
Or, more formally: origin_equivalent_held = receipt_held / receipt_redemption_ratio
The lending amounts in the original receipt token amounts
The lending amounts in the original receipt token amounts
Total amount of receipt token collateralized across this user's borrowing portfolio
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
class UserMergedMarket: …User market allocations grouped by asset.
Note: because of the inverted structure of merged market accounts, account
health cannot be represented and is excluded in the merged structures.
User market allocations grouped by asset.
Note: because of the inverted structure of merged market accounts, account health cannot be represented and is excluded in the merged structures.
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.
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)
User collateral contribution for asset in borrow market, listed by subaccount
User collateral contribution for asset in borrow market, listed by subaccount
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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 debt contribution for asset in borrow market, listed by subaccount
User debt contribution for asset in borrow market, listed by subaccount
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
lend: Optional[Lend]User contribution for asset's lending market, if one exists
User contribution for asset's lending market, if one exists
The lending amounts converted into the equivalent for the receipt token's origin/source asset
The lending amounts converted into the equivalent for the receipt token's origin/source asset
Total equivalent amount of origin token collateralized across this user's borrowing portfolio
NOTE: This is not the amount of the origin asset that the user holds, but the amount held in the receipt token rendered as the equivalent amount in the origin asset.
Or, more formally: origin_equivalent_collateralized = receipt_collateralized / receipt_redemption_ratio
Total equivalent amount of origin token held in address balance
NOTE: This is not the amount of the origin asset that the user holds, but the amount held in the receipt token rendered as the equivalent amount in the origin asset.
Or, more formally: origin_equivalent_held = receipt_held / receipt_redemption_ratio
The lending amounts in the original receipt token amounts
The lending amounts in the original receipt token amounts
Total amount of receipt token collateralized across this user's borrowing portfolio
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
UserMarketLend
Get user lending portfolio
Lookup user lending distribution by asset
ModelsExpand Collapse
class UserLendAssetPool: …
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.
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)
The lending amounts converted into the equivalent for the receipt token's origin/source asset
The lending amounts converted into the equivalent for the receipt token's origin/source asset
Total equivalent amount of origin token collateralized across this user's borrowing portfolio
NOTE: This is not the amount of the origin asset that the user holds, but the amount held in the receipt token rendered as the equivalent amount in the origin asset.
Or, more formally: origin_equivalent_collateralized = receipt_collateralized / receipt_redemption_ratio
Total equivalent amount of origin token held in address balance
NOTE: This is not the amount of the origin asset that the user holds, but the amount held in the receipt token rendered as the equivalent amount in the origin asset.
Or, more formally: origin_equivalent_held = receipt_held / receipt_redemption_ratio
The lending amounts in the original receipt token amounts
The lending amounts in the original receipt token amounts
Total amount of receipt token collateralized across this user's borrowing portfolio
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
class UserLendMarket: …
User lending allocations
User lending allocations
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.
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)
The lending amounts converted into the equivalent for the receipt token's origin/source asset
The lending amounts converted into the equivalent for the receipt token's origin/source asset
Total equivalent amount of origin token collateralized across this user's borrowing portfolio
NOTE: This is not the amount of the origin asset that the user holds, but the amount held in the receipt token rendered as the equivalent amount in the origin asset.
Or, more formally: origin_equivalent_collateralized = receipt_collateralized / receipt_redemption_ratio
Total equivalent amount of origin token held in address balance
NOTE: This is not the amount of the origin asset that the user holds, but the amount held in the receipt token rendered as the equivalent amount in the origin asset.
Or, more formally: origin_equivalent_held = receipt_held / receipt_redemption_ratio
The lending amounts in the original receipt token amounts
The lending amounts in the original receipt token amounts
Total amount of receipt token collateralized across this user's borrowing portfolio
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
class UserLendOriginAmounts: …
Total equivalent amount of origin token collateralized across this user's borrowing portfolio
NOTE: This is not the amount of the origin asset that the user holds, but the amount held in the receipt token rendered as the equivalent amount in the origin asset.
Or, more formally: origin_equivalent_collateralized = receipt_collateralized / receipt_redemption_ratio
Total equivalent amount of origin token held in address balance
NOTE: This is not the amount of the origin asset that the user holds, but the amount held in the receipt token rendered as the equivalent amount in the origin asset.
Or, more formally: origin_equivalent_held = receipt_held / receipt_redemption_ratio
class UserLendReceiptAmounts: …
Total amount of receipt token collateralized across this user's borrowing portfolio
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
UserMarketBorrow
Get user borrow portfolio
Lookup user borrow market collateral accounts by asset
Lookup user borrow market debt accounts by asset
Get user combined collaterals for all subaccounts
Get user combined debts for all subaccounts
ModelsExpand Collapse
class UserBorrowMarket: …
Market sub-accounts for the user
Market sub-accounts for the user
Account collateral allocations
Account collateral allocations
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
Account debt allocations
Account debt allocations
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
Collateral/debt totals of all sub-accounts by asset
Collateral/debt totals of all sub-accounts by asset
Account collateral allocations
Account collateral allocations
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
Account debt allocations
Account debt allocations
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
class UserBorrowMarketPools: …
Account collateral allocations
Account collateral allocations
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
Account debt allocations
Account debt allocations
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
UserMarketBorrowSubaccount
Get user borrow subaccount
Get user borrow subaccount health
Get user borrow subaccount collaterals
Get user borrow subaccount debts
ModelsExpand Collapse
class UserBorrowMarketAccount: …User borrowing subaccount
User borrowing subaccount
Account collateral allocations
Account collateral allocations
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
Account debt allocations
Account debt allocations
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
class UserCollateralAccountPool: …Associates a subaccount's index with it's inner allocations for a given asset.
This type is identical to UserCollateralAssetPool, except the asset association is interchanged for an account index.
Typically used in contexts where multiple subaccounts with a shared underlying asset are batched together.
Associates a subaccount's index with it's inner allocations for a given asset.
This type is identical to UserCollateralAssetPool, except the asset association is interchanged for an account index.
Typically used in contexts where multiple subaccounts with a shared underlying asset are batched together.
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
class UserCollateralAssetPool: …
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
class UserDebtAccountPool: …Associates a subaccount's index with it's inner allocations for a given asset.
This type is identical to UserDebtAssetPool, except the asset association is interchanged for an account index.
Typically used in contexts where multiple subaccounts with a shared underlying asset are batched together.
Associates a subaccount's index with it's inner allocations for a given asset.
This type is identical to UserDebtAssetPool, except the asset association is interchanged for an account index.
Typically used in contexts where multiple subaccounts with a shared underlying asset are batched together.
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
class UserDebtAssetPool: …
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
UserNept
Get user NEPT unlocks
ModelsExpand Collapse
class UserUnlockAmounts: …
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: Extra
percent: Optional[ExtraPercent]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: Optional[ExtraText]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: Optional[ExtraValue]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.
class UserUnlockOverview: …
arrangements: List[Arrangement]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: Extra
percent: Optional[ExtraPercent]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: Optional[ExtraText]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: Optional[ExtraValue]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 time at which the unlock was last claimed, if any
The schedule of the unlock
The schedule of the unlock
class UserUnlockScheduleLinear: …
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: Extra
percent: Optional[ExtraPercent]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: Optional[ExtraText]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: Optional[ExtraValue]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.
class UserUnlockScheduleLinear: …
class UserUnlockScheduleLinear: …
UserNeptStaking
Get user staking overview
Get user staking pools
Get user staking pool by duration/index
Get user unstaking pool
ModelsExpand Collapse
class UserStake: …
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.
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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
class UserStakeBondingEntry: …
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
class UserStakePool: …
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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
class UserStakeUnbonding: …
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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
class UserStakeUnbondingEntry: …
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
UserWallet
Get user portfolio
Get user balance by asset
ModelsExpand Collapse
class UserWalletPortfolio: …
Array of each wallet balance
Array of each wallet balance
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)
Derived values and amounts.
Derived values and amounts.
class WalletAssetKnown: …
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
class WalletAssetKnown: …
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
class WalletAssetKnown: …
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.
class WalletBalance: …Asset and balance contents for a given wallet
Asset and balance contents for a given wallet
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)
Derived values and amounts.
Derived values and amounts.
class WalletAssetKnown: …
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.
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)
extra: Extra
text: Optional[ExtraText]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: Optional[ExtraValue]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.