User

Get user

client.user.getUser(, ?, ?): UserGetUserResponse { data, error, status, status_text }

GET/api/v1/users/{address}/user

Get user tx history

client.user.getTxHistory(, ?, ?): TxHistoryPage<UserTx { account_address, account_index, action, 10 more } >

GET/api/v1/users/{address}/tx-history

ModelsExpand Collapse

EventAction = "borrow_flash_loan" | "return_flash_loan" | "create_token_unlock" | 16 more

One of the following:

"borrow_flash_loan"

"return_flash_loan"

"create_token_unlock"

"reclaim_token_unlock"

"liquidate"

"borrow"

"return"

"lend"

"redeem"

"deposit_collateral"

"withdraw_collateral"

"claim_war_chest"

"bond"

"unbond"

"claim_unbonded"

"claim_token_unlock"

"claim_rewards"

"cascade"

"send"

User { markets, nept, wallets }

markets: UserMarket { borrow, lend }

User's market contribution overview

borrow: UserBorrowMarket { accounts, totals }

Overview of user borrowing portfolio

accounts: Array<UserBorrowMarketAccount { collaterals, debts, debts_net_rate, 2 more } >

Market sub-accounts for the user

collaterals: Array<UserCollateralAssetPool { amount, asset_info, extra } >

Account collateral allocations

amount: string

Amount of this asset which is actively collateralized

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

debts: Array<UserDebtAssetPool { asset_info, extra, market_rate, 2 more } >

Account debt allocations

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

principal: string

shares: string

value: Value | null

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 }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: string

Text representation of price

principal: string

shares: string

price: string

Price used in value calculations

principal: string

shares: string

market_rate: MarketRate { apr, apy, extra }

Current market borrowing rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

principal: string

Initial amount borrowed (of debts which have not yet been repaid)

shares: string

debts_net_rate: MarketRate { apr, apy, extra }

Account debt net rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

health: UserAccountHealth { base, boost, extra, result } | null

Health data for this account

base: string

Account health value, before any added health boosts

boost: string

Account health boost to be applied

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

base: string

boost: string

result: string

Account health, with boost

index: number

Account index

formatuint8

minimum0

maximum255

totals: UserBorrowMarketPools { collaterals, debts, debts_net_rate }

Collateral/debt totals of all sub-accounts by asset

collaterals: Array<UserCollateralAssetPool { amount, asset_info, extra } >

Account collateral allocations

amount: string

Amount of this asset which is actively collateralized

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

debts: Array<UserDebtAssetPool { asset_info, extra, market_rate, 2 more } >

Account debt allocations

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

principal: string

shares: string

value: Value | null

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 }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: string

Text representation of price

principal: string

shares: string

price: string

Price used in value calculations

principal: string

shares: string

market_rate: MarketRate { apr, apy, extra }

Current market borrowing rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

principal: string

Initial amount borrowed (of debts which have not yet been repaid)

shares: string

debts_net_rate: MarketRate { apr, apy, extra }

Account debt net rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

lend: UserLendMarket { asset_pools, net_rate }

Overview of user lending portfolio

asset_pools: Array<UserLendAssetPool { asset_info, market_rate, origin_equivalent, receipt_amounts } >

User lending allocations

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

market_rate: MarketRate { apr, apy, extra }

Current market lending rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

origin_equivalent: UserLendOriginAmounts { collateralized, extra, held, total }

The lending amounts converted into the equivalent for the receipt token's origin/source asset

collateralized: string

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

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

collateralized: string

held: string

total: string

held: string

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

total: string

Total of held and collateralized equivalent for origin asset

Or, more formally: origin_equivalent_total = receipt_lent_total / receipt_redemption_ratio

receipt_amounts: UserLendReceiptAmounts { collateralized, extra, held, total }

The lending amounts in the original receipt token amounts

collateralized: string

Total amount of receipt token collateralized across this user's borrowing portfolio

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

collateralized: string

held: string

total: string

value: Value | null

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.

collateralized: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

collateralized: string

held: string

price: string

Text representation of price

total: string

held: string

price: string

Price used in value calculations

total: string

held: string

Total amount of receipt token held in address balance

total: string

Sum of receipt amount held and receipt amount collateralized

net_rate: MarketRate { apr, apy, extra }

Account debt net rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

nept: Nept { staking, unlocks }

User's NEPT associations (e.g. stake, unlocks)

staking: UserStake { asset_info, bonding_sum, claimable_rewards, 5 more }

Overview of the user's staking contributions/activity

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

bonding_sum: string

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)

claimable_rewards: string

NEPT rewarded from staking that is available yet not claimed by the user

claimable_unbonding: string

Sum of all unbond/unstake amounts that have completed their lockup period and are ready to be claimed.

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

bonding_sum: string

claimable_rewards: string

claimable_unbonding: string

unclaimed: string

value: Value | null

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_sum: string

claimable_rewards: string

claimable_unbonding: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

bonding_sum: string

claimable_rewards: string

claimable_unbonding: string

price: string

Text representation of price

unclaimed: string

price: string

Price used in value calculations

unclaimed: string

pools: Array<UserStakePool { amount_sum, common, contents, extra } >

User allocations for each staking pool

amount_sum: string

Total staked of all entries

NOTE: this value is affected by active filters, if any (e.g. filtering over account index)

common: StakingPoolFull { duration, extra, index, 2 more }

Staking pool contents along with associated pool state and pool params

duration: number

The lockup duration for this pool in seconds

formatuint64

minimum0

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

duration: string

index: string

index: number

The ordered index (position) of this pool

formatuint8

minimum0

maximum255

params: StakingPoolParams { flash_loan_weight, gov_weight, health_weight, reward_weight }

Staking pool contract parameters

flash_loan_weight: string

The pool's weight (multiplier) for flash loans volume

gov_weight: string

The pool's weight (multiplier) on governance for an associated stake

health_weight: string

The pool's weight (multiplier) on account health for an associated stake

reward_weight: string

The pool's weight (multiplier) on rewards for an associated stake

state: StakingPoolState { extra, total_bonded }

Current contract state of staking pool

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

total_bonded: string

value: Value | null

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 }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: string

Text representation of price

total_bonded: string

price: string

Price used in value calculations

total_bonded: string

The total amount staked to this pool

contents: Array<UserStakeBondingEntry { account_index, amount, cascade, 3 more } >

Bonding/stake entries

NOTE: entries that differ only in amount are merged upon creation

account_index: number

User account index

formatuint8

minimum0

maximum255

amount: string

Bonding amount

cascade: boolean

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

transition_at: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

last_stake_acc: string

transition_at: string | null

formatdate-time

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount_sum: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount_sum: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount_sum: string

price: string

Text representation of price

price: string

Price used in value calculations

unbonding: UserStakeUnbonding { amount_sum, contents, extra }

User unstake/unbonding data

amount_sum: string

Total amount of all unbond entries

NOTE: this value is affected by active filters, if any (e.g. filtering over account index)

contents: Array<UserStakeUnbondingEntry { amount, extra, unlock_at } >

Unbonding/unstake entries

NOTE: cascade unbondings from pool >= 2 are contained in the bondings list of the lower adjacent pool from which the unbond occurred.

amount: string

Unbonding amount

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

unlock_at: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

unlock_at: string

Timestamp for when the unstake can be redeemed

formatdate-time

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount_sum: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount_sum: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount_sum: string

price: string

Text representation of price

price: string

Price used in value calculations

unclaimed: string

unlocks: UserUnlockOverview { arrangements, extra, last_claimed_at, totals }

Overview of the user's unlock arrangements and claim statistics

arrangements: Array<Arrangement>

A list of the user's active unlock arrangements

admin: Admin | null

The admin of the unlock, if any

address: string

The address of the unlock arrangement's admin

issued_reclaim: boolean

True if the admin his issued a reclaim on the unlock arrangement

amounts: UserUnlockAmounts { amount, claimable, claimed, 4 more }

Primary unlock amount and other pre-calculated/derived amounts

amount: string

The full unlock amount

This value is immutable and does not change with regards to expiry/reclamation/lock states.

claimable: string

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.

claimed: string

The amount that has already been successfully claimed by the user.

expired: string

The amount that was claimable but has now expired due to the presence and subsequent passing of expires_at

extra: Extra { percent, text, value }

percent: Percent | null

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.

claimable: string

claimed: string

expired: string

extra: Extra { text }

text: Text | null

Human-readable variants of percentages for unlock amounts. Will not be null when query params with_text and with_percent are true.

claimable: string

claimed: string

expired: string

locked: string

reclaimed: string

locked: string

reclaimed: string

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

claimable: string

claimed: string

expired: string

locked: string

reclaimed: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

claimable: string

claimed: string

expired: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

claimable: string

claimed: string

expired: string

locked: string

price: string

Text representation of price

reclaimed: string

locked: string

price: string

Price used in value calculations

reclaimed: string

locked: string

The total amount of NEPT currently awaiting unlock NOTE: any reclaimed unlocks are excluded from the total, regardless of how much the user had claimed prior to reclamation.

reclaimed: string

The amount that has been reclaimed from the unlock arrangement admin

begins_at: string

The time at which the unlock begins

formatdate-time

expires_at: string | null

The time at which the unlock expires, if any

formatdate-time

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

begins_at: string

expires_at: string

last_claimed_at: string

last_claimed_at: string | null

The time at which the unlock was last claimed, if any

formatdate-time

schedule: UserUnlockSchedule

The schedule of the unlock

One of the following:

UserUnlockScheduleLinear { duration, ends_at, extra, kind }

duration: number

The duration of the unlock in seconds

formatuint64

minimum0

ends_at: string

The time at which the unlock has/was/would've completed. This is identical to begins_at + duration.

This timestamp will remain valid even if the unlock has been reclaimed. Therefore, it should not be used as a validity check.

formatdate-time

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

duration: string

ends_at: string

kind: "linear"

UserUnlockScheduleLumpSum { kind }

kind: "lump_sum"

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

last_claimed_at: string

last_claimed_at: string | null

The time at which the most recent unlock claim occurred, if any

formatdate-time

totals: UserUnlockAmounts { amount, claimable, claimed, 4 more }

Contains pre-calculated total amounts for all unlock agreements

amount: string

The full unlock amount

This value is immutable and does not change with regards to expiry/reclamation/lock states.

claimable: string

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.

claimed: string

The amount that has already been successfully claimed by the user.

expired: string

The amount that was claimable but has now expired due to the presence and subsequent passing of expires_at

extra: Extra { percent, text, value }

percent: Percent | null

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.

claimable: string

claimed: string

expired: string

extra: Extra { text }

text: Text | null

Human-readable variants of percentages for unlock amounts. Will not be null when query params with_text and with_percent are true.

claimable: string

claimed: string

expired: string

locked: string

reclaimed: string

locked: string

reclaimed: string

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

claimable: string

claimed: string

expired: string

locked: string

reclaimed: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

claimable: string

claimed: string

expired: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

claimable: string

claimed: string

expired: string

locked: string

price: string

Text representation of price

reclaimed: string

locked: string

price: string

Price used in value calculations

reclaimed: string

locked: string

The total amount of NEPT currently awaiting unlock NOTE: any reclaimed unlocks are excluded from the total, regardless of how much the user had claimed prior to reclamation.

reclaimed: string

The amount that has been reclaimed from the unlock arrangement admin

wallets: UserWalletPortfolio { balances, extra, total_value }

User's wallets and balances

balances: Array<WalletBalance { asset, values } >

Array of each wallet balance

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

values: WalletAsset

Derived values and amounts.

One of the following:

WalletAssetKnown { amount, amount_scaled, asset_info, 2 more }

amount: string

Wallet balance in native denom.

amount_scaled: string

Amount scaled to the asset's standard unit / decimal places.

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

kind: "known"

WalletAssetUnknown { amount, kind }

amount: string

Wallet balance in native denom.

kind: "unknown"

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

total_value: string

total_value: string | null

Sum value in USD. Guaranteed null if value calculation is disabled / guaranteed non-null if calculation is enabled.

NOTE: this only accounts for assets which are internally known & tracked. See the /assets endpoint for a list of supported assets.

UserTx { account_address, account_index, action, 10 more }

account_address: string

Account address corresponding to the transaction

account_index: number | null

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.

formatuint8

minimum0

maximum255

action: EventAction

Neptune event type for the given market/token contract execute call

One of the following:

"borrow_flash_loan"

"return_flash_loan"

"create_token_unlock"

"reclaim_token_unlock"

"liquidate"

"borrow"

"return"

"lend"

"redeem"

"deposit_collateral"

"withdraw_collateral"

"claim_war_chest"

"bond"

"unbond"

"claim_unbonded"

"claim_token_unlock"

"claim_rewards"

"cascade"

"send"

amount: string | 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: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

contract_address: string

Address for the event's corresponding contract

destination_address: string | null

Destination account address. Non-null for send/transfer transactions. This field will be null for all other action types.

event_time: string

Event/transaction block time

formatdate-time

event_uuid: string

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.

formatuuid

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

action: string

amount: string

event_time: string

historic_price: string

historic_value: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string | null

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount?: string | null

price?: string | null

Text representation of price

price: string

Price used in value calculations

historic_price: string | number | 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.

One of the following:

string

number

historic_value: string | number | 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.

One of the following:

string

number

tx_hash: string

Transaction hash

UserMarket

Get user market portfolio

client.user.market.getPortfolio(, ?, ?): MarketGetPortfolioResponse { data, error, status, status_text }

GET/api/v1/users/{address}/markets

Get user markets for all kinds (lend + borrow debt/collateral), grouped together by asset

client.user.market.getMerged(, ?, ?): MarketGetMergedResponse { count, data, error, 2 more }

GET/api/v1/users/{address}/markets/merged

Get user's markets (lend + borrow debt/collateral) for a specific asset

client.user.market.getMergedByAsset(, , ?): MarketGetMergedByAssetResponse { data, error, status, status_text }

GET/api/v1/users/{address}/markets/merged/lookup

ModelsExpand Collapse

UserMarket { borrow, lend }

borrow: UserBorrowMarket { accounts, totals }

Overview of user borrowing portfolio

accounts: Array<UserBorrowMarketAccount { collaterals, debts, debts_net_rate, 2 more } >

Market sub-accounts for the user

collaterals: Array<UserCollateralAssetPool { amount, asset_info, extra } >

Account collateral allocations

amount: string

Amount of this asset which is actively collateralized

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

debts: Array<UserDebtAssetPool { asset_info, extra, market_rate, 2 more } >

Account debt allocations

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

principal: string

shares: string

value: Value | null

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 }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: string

Text representation of price

principal: string

shares: string

price: string

Price used in value calculations

principal: string

shares: string

market_rate: MarketRate { apr, apy, extra }

Current market borrowing rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

principal: string

Initial amount borrowed (of debts which have not yet been repaid)

shares: string

debts_net_rate: MarketRate { apr, apy, extra }

Account debt net rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

health: UserAccountHealth { base, boost, extra, result } | null

Health data for this account

base: string

Account health value, before any added health boosts

boost: string

Account health boost to be applied

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

base: string

boost: string

result: string

Account health, with boost

index: number

Account index

formatuint8

minimum0

maximum255

totals: UserBorrowMarketPools { collaterals, debts, debts_net_rate }

Collateral/debt totals of all sub-accounts by asset

collaterals: Array<UserCollateralAssetPool { amount, asset_info, extra } >

Account collateral allocations

amount: string

Amount of this asset which is actively collateralized

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

debts: Array<UserDebtAssetPool { asset_info, extra, market_rate, 2 more } >

Account debt allocations

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

principal: string

shares: string

value: Value | null

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 }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: string

Text representation of price

principal: string

shares: string

price: string

Price used in value calculations

principal: string

shares: string

market_rate: MarketRate { apr, apy, extra }

Current market borrowing rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

principal: string

Initial amount borrowed (of debts which have not yet been repaid)

shares: string

debts_net_rate: MarketRate { apr, apy, extra }

Account debt net rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

lend: UserLendMarket { asset_pools, net_rate }

Overview of user lending portfolio

asset_pools: Array<UserLendAssetPool { asset_info, market_rate, origin_equivalent, receipt_amounts } >

User lending allocations

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

market_rate: MarketRate { apr, apy, extra }

Current market lending rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

origin_equivalent: UserLendOriginAmounts { collateralized, extra, held, total }

The lending amounts converted into the equivalent for the receipt token's origin/source asset

collateralized: string

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

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

collateralized: string

held: string

total: string

held: string

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

total: string

Total of held and collateralized equivalent for origin asset

Or, more formally: origin_equivalent_total = receipt_lent_total / receipt_redemption_ratio

receipt_amounts: UserLendReceiptAmounts { collateralized, extra, held, total }

The lending amounts in the original receipt token amounts

collateralized: string

Total amount of receipt token collateralized across this user's borrowing portfolio

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

collateralized: string

held: string

total: string

value: Value | null

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.

collateralized: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

collateralized: string

held: string

price: string

Text representation of price

total: string

held: string

price: string

Price used in value calculations

total: string

held: string

Total amount of receipt token held in address balance

total: string

Sum of receipt amount held and receipt amount collateralized

net_rate: MarketRate { apr, apy, extra }

Account debt net rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

UserMergedMarket { asset_info, borrow_collateral, borrow_debt, lend }

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_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

borrow_collateral: Array<UserCollateralAccountPool { amount, extra, index } >

User collateral contribution for asset in borrow market, listed by subaccount

amount: string

Amount of this asset which is actively collateralized

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

index: number

Account index

formatuint8

minimum0

maximum255

borrow_debt: Array<UserDebtAccountPool { extra, index, principal, shares } >

User debt contribution for asset in borrow market, listed by subaccount

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

principal: string

shares: string

value: Value | null

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 }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: string

Text representation of price

principal: string

shares: string

price: string

Price used in value calculations

principal: string

shares: string

index: number

Account index

formatuint8

minimum0

maximum255

principal: string

Initial amount borrowed (of debts which have not yet been repaid)

shares: string

lend?: Lend | null

User contribution for asset's lending market, if one exists

origin_equivalent: UserLendOriginAmounts { collateralized, extra, held, total }

The lending amounts converted into the equivalent for the receipt token's origin/source asset

collateralized: string

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

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

collateralized: string

held: string

total: string

held: string

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

total: string

Total of held and collateralized equivalent for origin asset

Or, more formally: origin_equivalent_total = receipt_lent_total / receipt_redemption_ratio

receipt_amounts: UserLendReceiptAmounts { collateralized, extra, held, total }

The lending amounts in the original receipt token amounts

collateralized: string

Total amount of receipt token collateralized across this user's borrowing portfolio

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

collateralized: string

held: string

total: string

value: Value | null

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.

collateralized: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

collateralized: string

held: string

price: string

Text representation of price

total: string

held: string

price: string

Price used in value calculations

total: string

held: string

Total amount of receipt token held in address balance

total: string

Sum of receipt amount held and receipt amount collateralized

UserMarketLend

Get user lending portfolio

client.user.market.lend.list(, ?, ?): LendListResponse { data, error, status, status_text }

GET/api/v1/users/{address}/markets/lend

Lookup user lending distribution by asset

client.user.market.lend.getByAsset(, , ?): LendGetByAssetResponse { data, error, status, status_text }

GET/api/v1/users/{address}/markets/lend/lookup

ModelsExpand Collapse

UserLendAssetPool { asset_info, market_rate, origin_equivalent, receipt_amounts }

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

market_rate: MarketRate { apr, apy, extra }

Current market lending rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

origin_equivalent: UserLendOriginAmounts { collateralized, extra, held, total }

The lending amounts converted into the equivalent for the receipt token's origin/source asset

collateralized: string

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

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

collateralized: string

held: string

total: string

held: string

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

total: string

Total of held and collateralized equivalent for origin asset

Or, more formally: origin_equivalent_total = receipt_lent_total / receipt_redemption_ratio

receipt_amounts: UserLendReceiptAmounts { collateralized, extra, held, total }

The lending amounts in the original receipt token amounts

collateralized: string

Total amount of receipt token collateralized across this user's borrowing portfolio

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

collateralized: string

held: string

total: string

value: Value | null

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.

collateralized: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

collateralized: string

held: string

price: string

Text representation of price

total: string

held: string

price: string

Price used in value calculations

total: string

held: string

Total amount of receipt token held in address balance

total: string

Sum of receipt amount held and receipt amount collateralized

UserLendMarket { asset_pools, net_rate }

asset_pools: Array<UserLendAssetPool { asset_info, market_rate, origin_equivalent, receipt_amounts } >

User lending allocations

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

market_rate: MarketRate { apr, apy, extra }

Current market lending rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

origin_equivalent: UserLendOriginAmounts { collateralized, extra, held, total }

The lending amounts converted into the equivalent for the receipt token's origin/source asset

collateralized: string

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

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

collateralized: string

held: string

total: string

held: string

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

total: string

Total of held and collateralized equivalent for origin asset

Or, more formally: origin_equivalent_total = receipt_lent_total / receipt_redemption_ratio

receipt_amounts: UserLendReceiptAmounts { collateralized, extra, held, total }

The lending amounts in the original receipt token amounts

collateralized: string

Total amount of receipt token collateralized across this user's borrowing portfolio

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

collateralized: string

held: string

total: string

value: Value | null

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.

collateralized: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

collateralized: string

held: string

price: string

Text representation of price

total: string

held: string

price: string

Price used in value calculations

total: string

held: string

Total amount of receipt token held in address balance

total: string

Sum of receipt amount held and receipt amount collateralized

net_rate: MarketRate { apr, apy, extra }

Account debt net rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

UserLendOriginAmounts { collateralized, extra, held, total }

collateralized: string

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

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

collateralized: string

held: string

total: string

held: string

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

total: string

Total of held and collateralized equivalent for origin asset

Or, more formally: origin_equivalent_total = receipt_lent_total / receipt_redemption_ratio

UserLendReceiptAmounts { collateralized, extra, held, total }

collateralized: string

Total amount of receipt token collateralized across this user's borrowing portfolio

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

collateralized: string

held: string

total: string

value: Value | null

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.

collateralized: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

collateralized: string

held: string

price: string

Text representation of price

total: string

held: string

price: string

Price used in value calculations

total: string

held: string

Total amount of receipt token held in address balance

total: string

Sum of receipt amount held and receipt amount collateralized

UserMarketBorrow

Get user borrow portfolio

client.user.market.borrow.getPortfolio(, ?, ?): BorrowGetPortfolioResponse { data, error, status, status_text }

GET/api/v1/users/{address}/markets/borrow

Lookup user borrow market collateral accounts by asset

client.user.market.borrow.getCollateralAccountsByAsset(, , ?): BorrowGetCollateralAccountsByAssetResponse { data, error, status, status_text }

GET/api/v1/users/{address}/markets/borrow/lookup/collateral

Lookup user borrow market debt accounts by asset

client.user.market.borrow.getDebtAccountsByAsset(, , ?): BorrowGetDebtAccountsByAssetResponse { data, error, status, status_text }

GET/api/v1/users/{address}/markets/borrow/lookup/debt

Get user combined collaterals for all subaccounts

client.user.market.borrow.getCollateralTotals(, ?, ?): BorrowGetCollateralTotalsResponse { count, data, error, 2 more }

GET/api/v1/users/{address}/markets/borrow/sum/collaterals

Get user combined debts for all subaccounts

client.user.market.borrow.getDebtsTotals(, ?, ?): BorrowGetDebtsTotalsResponse { count, data, error, 2 more }

GET/api/v1/users/{address}/markets/borrow/sum/debts

ModelsExpand Collapse

UserBorrowMarket { accounts, totals }

accounts: Array<UserBorrowMarketAccount { collaterals, debts, debts_net_rate, 2 more } >

Market sub-accounts for the user

collaterals: Array<UserCollateralAssetPool { amount, asset_info, extra } >

Account collateral allocations

amount: string

Amount of this asset which is actively collateralized

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

debts: Array<UserDebtAssetPool { asset_info, extra, market_rate, 2 more } >

Account debt allocations

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

principal: string

shares: string

value: Value | null

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 }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: string

Text representation of price

principal: string

shares: string

price: string

Price used in value calculations

principal: string

shares: string

market_rate: MarketRate { apr, apy, extra }

Current market borrowing rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

principal: string

Initial amount borrowed (of debts which have not yet been repaid)

shares: string

debts_net_rate: MarketRate { apr, apy, extra }

Account debt net rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

health: UserAccountHealth { base, boost, extra, result } | null

Health data for this account

base: string

Account health value, before any added health boosts

boost: string

Account health boost to be applied

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

base: string

boost: string

result: string

Account health, with boost

index: number

Account index

formatuint8

minimum0

maximum255

totals: UserBorrowMarketPools { collaterals, debts, debts_net_rate }

Collateral/debt totals of all sub-accounts by asset

collaterals: Array<UserCollateralAssetPool { amount, asset_info, extra } >

Account collateral allocations

amount: string

Amount of this asset which is actively collateralized

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

debts: Array<UserDebtAssetPool { asset_info, extra, market_rate, 2 more } >

Account debt allocations

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

principal: string

shares: string

value: Value | null

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 }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: string

Text representation of price

principal: string

shares: string

price: string

Price used in value calculations

principal: string

shares: string

market_rate: MarketRate { apr, apy, extra }

Current market borrowing rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

principal: string

Initial amount borrowed (of debts which have not yet been repaid)

shares: string

debts_net_rate: MarketRate { apr, apy, extra }

Account debt net rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

UserBorrowMarketPools { collaterals, debts, debts_net_rate }

collaterals: Array<UserCollateralAssetPool { amount, asset_info, extra } >

Account collateral allocations

amount: string

Amount of this asset which is actively collateralized

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

debts: Array<UserDebtAssetPool { asset_info, extra, market_rate, 2 more } >

Account debt allocations

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

principal: string

shares: string

value: Value | null

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 }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: string

Text representation of price

principal: string

shares: string

price: string

Price used in value calculations

principal: string

shares: string

market_rate: MarketRate { apr, apy, extra }

Current market borrowing rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

principal: string

Initial amount borrowed (of debts which have not yet been repaid)

shares: string

debts_net_rate: MarketRate { apr, apy, extra }

Account debt net rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

UserMarketBorrowSubaccount

Get user borrow subaccount

client.user.market.borrow.subaccount.getSubaccount(, , ?): SubaccountGetSubaccountResponse { data, error, status, status_text }

GET/api/v1/users/{address}/markets/borrow/accounts/{index}

Get user borrow subaccount health

client.user.market.borrow.subaccount.getSubaccountHealth(, , ?): SubaccountGetSubaccountHealthResponse { data, error, status, status_text }

GET/api/v1/users/{address}/markets/borrow/accounts/{index}/health

Get user borrow subaccount collaterals

client.user.market.borrow.subaccount.getSubaccountCollaterals(, , ?): SubaccountGetSubaccountCollateralsResponse { count, data, error, 2 more }

GET/api/v1/users/{address}/markets/borrow/accounts/{index}/collaterals

Get user borrow subaccount debts

client.user.market.borrow.subaccount.getSubaccountDebts(, , ?): SubaccountGetSubaccountDebtsResponse { count, data, error, 2 more }

GET/api/v1/users/{address}/markets/borrow/accounts/{index}/debts

ModelsExpand Collapse

UserAccountHealth { base, boost, extra, result }

base: string

Account health value, before any added health boosts

boost: string

Account health boost to be applied

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

base: string

boost: string

result: string

Account health, with boost

UserBorrowMarketAccount { collaterals, debts, debts_net_rate, 2 more }

User borrowing subaccount

collaterals: Array<UserCollateralAssetPool { amount, asset_info, extra } >

Account collateral allocations

amount: string

Amount of this asset which is actively collateralized

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

debts: Array<UserDebtAssetPool { asset_info, extra, market_rate, 2 more } >

Account debt allocations

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

principal: string

shares: string

value: Value | null

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 }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: string

Text representation of price

principal: string

shares: string

price: string

Price used in value calculations

principal: string

shares: string

market_rate: MarketRate { apr, apy, extra }

Current market borrowing rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

principal: string

Initial amount borrowed (of debts which have not yet been repaid)

shares: string

debts_net_rate: MarketRate { apr, apy, extra }

Account debt net rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

health: UserAccountHealth { base, boost, extra, result } | null

Health data for this account

base: string

Account health value, before any added health boosts

boost: string

Account health boost to be applied

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

base: string

boost: string

result: string

Account health, with boost

index: number

Account index

formatuint8

minimum0

maximum255

UserCollateralAccountPool { amount, extra, index }

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.

amount: string

Amount of this asset which is actively collateralized

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

index: number

Account index

formatuint8

minimum0

maximum255

UserCollateralAssetPool { amount, asset_info, extra }

amount: string

Amount of this asset which is actively collateralized

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

UserDebtAccountPool { extra, index, principal, shares }

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, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

principal: string

shares: string

value: Value | null

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 }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: string

Text representation of price

principal: string

shares: string

price: string

Price used in value calculations

principal: string

shares: string

index: number

Account index

formatuint8

minimum0

maximum255

principal: string

Initial amount borrowed (of debts which have not yet been repaid)

shares: string

UserDebtAssetPool { asset_info, extra, market_rate, 2 more }

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

principal: string

shares: string

value: Value | null

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 }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: string

Text representation of price

principal: string

shares: string

price: string

Price used in value calculations

principal: string

shares: string

market_rate: MarketRate { apr, apy, extra }

Current market borrowing rate

apr: string

Market rate in APR standard as a decimal percentage

apy: string

Market rate in APY standard as a decimal percentage

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

apr: string

apy: string

principal: string

Initial amount borrowed (of debts which have not yet been repaid)

shares: string

UserNept

Get user NEPT unlocks

client.user.nept.getUnlocks(, ?, ?): NeptGetUnlocksResponse { data, error, status, status_text }

GET/api/v1/users/{address}/nept/unlocks

ModelsExpand Collapse

UserUnlockAmounts { amount, claimable, claimed, 4 more }

amount: string

The full unlock amount

This value is immutable and does not change with regards to expiry/reclamation/lock states.

claimable: string

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.

claimed: string

The amount that has already been successfully claimed by the user.

expired: string

The amount that was claimable but has now expired due to the presence and subsequent passing of expires_at

extra: Extra { percent, text, value }

percent: Percent | null

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.

claimable: string

claimed: string

expired: string

extra: Extra { text }

text: Text | null

Human-readable variants of percentages for unlock amounts. Will not be null when query params with_text and with_percent are true.

claimable: string

claimed: string

expired: string

locked: string

reclaimed: string

locked: string

reclaimed: string

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

claimable: string

claimed: string

expired: string

locked: string

reclaimed: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

claimable: string

claimed: string

expired: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

claimable: string

claimed: string

expired: string

locked: string

price: string

Text representation of price

reclaimed: string

locked: string

price: string

Price used in value calculations

reclaimed: string

locked: string

The total amount of NEPT currently awaiting unlock NOTE: any reclaimed unlocks are excluded from the total, regardless of how much the user had claimed prior to reclamation.

reclaimed: string

The amount that has been reclaimed from the unlock arrangement admin

UserUnlockOverview { arrangements, extra, last_claimed_at, totals }

arrangements: Array<Arrangement>

A list of the user's active unlock arrangements

admin: Admin | null

The admin of the unlock, if any

address: string

The address of the unlock arrangement's admin

issued_reclaim: boolean

True if the admin his issued a reclaim on the unlock arrangement

amounts: UserUnlockAmounts { amount, claimable, claimed, 4 more }

Primary unlock amount and other pre-calculated/derived amounts

amount: string

The full unlock amount

This value is immutable and does not change with regards to expiry/reclamation/lock states.

claimable: string

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.

claimed: string

The amount that has already been successfully claimed by the user.

expired: string

The amount that was claimable but has now expired due to the presence and subsequent passing of expires_at

extra: Extra { percent, text, value }

percent: Percent | null

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.

claimable: string

claimed: string

expired: string

extra: Extra { text }

text: Text | null

Human-readable variants of percentages for unlock amounts. Will not be null when query params with_text and with_percent are true.

claimable: string

claimed: string

expired: string

locked: string

reclaimed: string

locked: string

reclaimed: string

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

claimable: string

claimed: string

expired: string

locked: string

reclaimed: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

claimable: string

claimed: string

expired: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

claimable: string

claimed: string

expired: string

locked: string

price: string

Text representation of price

reclaimed: string

locked: string

price: string

Price used in value calculations

reclaimed: string

locked: string

The total amount of NEPT currently awaiting unlock NOTE: any reclaimed unlocks are excluded from the total, regardless of how much the user had claimed prior to reclamation.

reclaimed: string

The amount that has been reclaimed from the unlock arrangement admin

begins_at: string

The time at which the unlock begins

formatdate-time

expires_at: string | null

The time at which the unlock expires, if any

formatdate-time

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

begins_at: string

expires_at: string

last_claimed_at: string

last_claimed_at: string | null

The time at which the unlock was last claimed, if any

formatdate-time

schedule: UserUnlockSchedule

The schedule of the unlock

One of the following:

UserUnlockScheduleLinear { duration, ends_at, extra, kind }

duration: number

The duration of the unlock in seconds

formatuint64

minimum0

ends_at: string

The time at which the unlock has/was/would've completed. This is identical to begins_at + duration.

This timestamp will remain valid even if the unlock has been reclaimed. Therefore, it should not be used as a validity check.

formatdate-time

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

duration: string

ends_at: string

kind: "linear"

UserUnlockScheduleLumpSum { kind }

kind: "lump_sum"

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

last_claimed_at: string

last_claimed_at: string | null

The time at which the most recent unlock claim occurred, if any

formatdate-time

totals: UserUnlockAmounts { amount, claimable, claimed, 4 more }

Contains pre-calculated total amounts for all unlock agreements

amount: string

The full unlock amount

This value is immutable and does not change with regards to expiry/reclamation/lock states.

claimable: string

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.

claimed: string

The amount that has already been successfully claimed by the user.

expired: string

The amount that was claimable but has now expired due to the presence and subsequent passing of expires_at

extra: Extra { percent, text, value }

percent: Percent | null

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.

claimable: string

claimed: string

expired: string

extra: Extra { text }

text: Text | null

Human-readable variants of percentages for unlock amounts. Will not be null when query params with_text and with_percent are true.

claimable: string

claimed: string

expired: string

locked: string

reclaimed: string

locked: string

reclaimed: string

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

claimable: string

claimed: string

expired: string

locked: string

reclaimed: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

claimable: string

claimed: string

expired: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

claimable: string

claimed: string

expired: string

locked: string

price: string

Text representation of price

reclaimed: string

locked: string

price: string

Price used in value calculations

reclaimed: string

locked: string

The total amount of NEPT currently awaiting unlock NOTE: any reclaimed unlocks are excluded from the total, regardless of how much the user had claimed prior to reclamation.

reclaimed: string

The amount that has been reclaimed from the unlock arrangement admin

UserUnlockSchedule = UserUnlockScheduleLinear { duration, ends_at, extra, kind } | UserUnlockScheduleLumpSum { kind }

One of the following:

UserUnlockScheduleLinear { duration, ends_at, extra, kind }

duration: number

The duration of the unlock in seconds

formatuint64

minimum0

ends_at: string

The time at which the unlock has/was/would've completed. This is identical to begins_at + duration.

This timestamp will remain valid even if the unlock has been reclaimed. Therefore, it should not be used as a validity check.

formatdate-time

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

duration: string

ends_at: string

kind: "linear"

UserUnlockScheduleLumpSum { kind }

kind: "lump_sum"

UserUnlockScheduleLinear { duration, ends_at, extra, kind }

duration: number

The duration of the unlock in seconds

formatuint64

minimum0

ends_at: string

The time at which the unlock has/was/would've completed. This is identical to begins_at + duration.

This timestamp will remain valid even if the unlock has been reclaimed. Therefore, it should not be used as a validity check.

formatdate-time

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

duration: string

ends_at: string

kind: "linear"

UserUnlockScheduleLumpSum { kind }

kind: "lump_sum"

UserNeptStaking

Get user staking overview

client.user.nept.staking.getOverview(, ?, ?): StakingGetOverviewResponse { data, error, status, status_text }

GET/api/v1/users/{address}/nept/staking

Get user staking pools

client.user.nept.staking.getStakingPools(, ?, ?): StakingGetStakingPoolsResponse { count, data, error, 2 more }

GET/api/v1/users/{address}/nept/staking/pools

Get user staking pool by duration/index

client.user.nept.staking.getStakingPool(, ?, ?): StakingGetStakingPoolResponse { data, error, status, status_text }

GET/api/v1/users/{address}/nept/staking/pools/lookup

Get user unstaking pool

client.user.nept.staking.getUnstaking(, ?, ?): StakingGetUnstakingResponse { data, error, status, status_text }

GET/api/v1/users/{address}/nept/staking/unstaking

ModelsExpand Collapse

UserStake { asset_info, bonding_sum, claimable_rewards, 5 more }

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

bonding_sum: string

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)

claimable_rewards: string

NEPT rewarded from staking that is available yet not claimed by the user

claimable_unbonding: string

Sum of all unbond/unstake amounts that have completed their lockup period and are ready to be claimed.

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

bonding_sum: string

claimable_rewards: string

claimable_unbonding: string

unclaimed: string

value: Value | null

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_sum: string

claimable_rewards: string

claimable_unbonding: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

bonding_sum: string

claimable_rewards: string

claimable_unbonding: string

price: string

Text representation of price

unclaimed: string

price: string

Price used in value calculations

unclaimed: string

pools: Array<UserStakePool { amount_sum, common, contents, extra } >

User allocations for each staking pool

amount_sum: string

Total staked of all entries

NOTE: this value is affected by active filters, if any (e.g. filtering over account index)

common: StakingPoolFull { duration, extra, index, 2 more }

Staking pool contents along with associated pool state and pool params

duration: number

The lockup duration for this pool in seconds

formatuint64

minimum0

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

duration: string

index: string

index: number

The ordered index (position) of this pool

formatuint8

minimum0

maximum255

params: StakingPoolParams { flash_loan_weight, gov_weight, health_weight, reward_weight }

Staking pool contract parameters

flash_loan_weight: string

The pool's weight (multiplier) for flash loans volume

gov_weight: string

The pool's weight (multiplier) on governance for an associated stake

health_weight: string

The pool's weight (multiplier) on account health for an associated stake

reward_weight: string

The pool's weight (multiplier) on rewards for an associated stake

state: StakingPoolState { extra, total_bonded }

Current contract state of staking pool

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

total_bonded: string

value: Value | null

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 }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: string

Text representation of price

total_bonded: string

price: string

Price used in value calculations

total_bonded: string

The total amount staked to this pool

contents: Array<UserStakeBondingEntry { account_index, amount, cascade, 3 more } >

Bonding/stake entries

NOTE: entries that differ only in amount are merged upon creation

account_index: number

User account index

formatuint8

minimum0

maximum255

amount: string

Bonding amount

cascade: boolean

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

transition_at: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

last_stake_acc: string

transition_at: string | null

formatdate-time

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount_sum: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount_sum: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount_sum: string

price: string

Text representation of price

price: string

Price used in value calculations

unbonding: UserStakeUnbonding { amount_sum, contents, extra }

User unstake/unbonding data

amount_sum: string

Total amount of all unbond entries

NOTE: this value is affected by active filters, if any (e.g. filtering over account index)

contents: Array<UserStakeUnbondingEntry { amount, extra, unlock_at } >

Unbonding/unstake entries

NOTE: cascade unbondings from pool >= 2 are contained in the bondings list of the lower adjacent pool from which the unbond occurred.

amount: string

Unbonding amount

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

unlock_at: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

unlock_at: string

Timestamp for when the unstake can be redeemed

formatdate-time

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount_sum: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount_sum: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount_sum: string

price: string

Text representation of price

price: string

Price used in value calculations

unclaimed: string

UserStakeBondingEntry { account_index, amount, cascade, 3 more }

account_index: number

User account index

formatuint8

minimum0

maximum255

amount: string

Bonding amount

cascade: boolean

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

transition_at: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

last_stake_acc: string

transition_at: string | null

formatdate-time

UserStakePool { amount_sum, common, contents, extra }

amount_sum: string

Total staked of all entries

NOTE: this value is affected by active filters, if any (e.g. filtering over account index)

common: StakingPoolFull { duration, extra, index, 2 more }

Staking pool contents along with associated pool state and pool params

duration: number

The lockup duration for this pool in seconds

formatuint64

minimum0

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

duration: string

index: string

index: number

The ordered index (position) of this pool

formatuint8

minimum0

maximum255

params: StakingPoolParams { flash_loan_weight, gov_weight, health_weight, reward_weight }

Staking pool contract parameters

flash_loan_weight: string

The pool's weight (multiplier) for flash loans volume

gov_weight: string

The pool's weight (multiplier) on governance for an associated stake

health_weight: string

The pool's weight (multiplier) on account health for an associated stake

reward_weight: string

The pool's weight (multiplier) on rewards for an associated stake

state: StakingPoolState { extra, total_bonded }

Current contract state of staking pool

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

total_bonded: string

value: Value | null

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 }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: string

Text representation of price

total_bonded: string

price: string

Price used in value calculations

total_bonded: string

The total amount staked to this pool

contents: Array<UserStakeBondingEntry { account_index, amount, cascade, 3 more } >

Bonding/stake entries

NOTE: entries that differ only in amount are merged upon creation

account_index: number

User account index

formatuint8

minimum0

maximum255

amount: string

Bonding amount

cascade: boolean

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

transition_at: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

last_stake_acc: string

transition_at: string | null

formatdate-time

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount_sum: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount_sum: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount_sum: string

price: string

Text representation of price

price: string

Price used in value calculations

UserStakeUnbonding { amount_sum, contents, extra }

amount_sum: string

Total amount of all unbond entries

NOTE: this value is affected by active filters, if any (e.g. filtering over account index)

contents: Array<UserStakeUnbondingEntry { amount, extra, unlock_at } >

Unbonding/unstake entries

NOTE: cascade unbondings from pool >= 2 are contained in the bondings list of the lower adjacent pool from which the unbond occurred.

amount: string

Unbonding amount

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

unlock_at: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

unlock_at: string

Timestamp for when the unstake can be redeemed

formatdate-time

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount_sum: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount_sum: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount_sum: string

price: string

Text representation of price

price: string

Price used in value calculations

UserStakeUnbondingEntry { amount, extra, unlock_at }

amount: string

Unbonding amount

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

unlock_at: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

unlock_at: string

Timestamp for when the unstake can be redeemed

formatdate-time

UserWallet

Get user portfolio

client.user.wallet.getBalances(, ?, ?): WalletGetBalancesResponse { data, error, status, status_text }

GET/api/v1/users/{address}/wallet/balances

Get user balance by asset

client.user.wallet.getBalanceByAsset(, , ?): WalletGetBalanceByAssetResponse { data, error, status, status_text }

GET/api/v1/users/{address}/wallet/balance

ModelsExpand Collapse

UserWalletPortfolio { balances, extra, total_value }

balances: Array<WalletBalance { asset, values } >

Array of each wallet balance

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

values: WalletAsset

Derived values and amounts.

One of the following:

WalletAssetKnown { amount, amount_scaled, asset_info, 2 more }

amount: string

Wallet balance in native denom.

amount_scaled: string

Amount scaled to the asset's standard unit / decimal places.

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

kind: "known"

WalletAssetUnknown { amount, kind }

amount: string

Wallet balance in native denom.

kind: "unknown"

extra: Extra { text }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

total_value: string

total_value: string | null

Sum value in USD. Guaranteed null if value calculation is disabled / guaranteed non-null if calculation is enabled.

NOTE: this only accounts for assets which are internally known & tracked. See the /assets endpoint for a list of supported assets.

WalletAsset = WalletAssetKnown { amount, amount_scaled, asset_info, 2 more } | WalletAssetUnknown { amount, kind }

One of the following:

WalletAssetKnown { amount, amount_scaled, asset_info, 2 more }

amount: string

Wallet balance in native denom.

amount_scaled: string

Amount scaled to the asset's standard unit / decimal places.

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

kind: "known"

WalletAssetUnknown { amount, kind }

amount: string

Wallet balance in native denom.

kind: "unknown"

WalletAssetKnown { amount, amount_scaled, asset_info, 2 more }

amount: string

Wallet balance in native denom.

amount_scaled: string

Amount scaled to the asset's standard unit / decimal places.

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

kind: "known"

WalletAssetUnknown { amount, kind }

amount: string

Wallet balance in native denom.

kind: "unknown"

WalletBalance { asset, values }

Asset and balance contents for a given wallet

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

values: WalletAsset

Derived values and amounts.

One of the following:

WalletAssetKnown { amount, amount_scaled, asset_info, 2 more }

amount: string

Wallet balance in native denom.

amount_scaled: string

Amount scaled to the asset's standard unit / decimal places.

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

Regular { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key } | null

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: string

group: "native" | "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: number

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

Full name of the asset

symbol: string

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: string

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra { text, value }

text: Text | null

Human-readable field variants. Will not be null when query param with_text is true.

amount: string

value: Value | null

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

amount: string

extra: Extra { text }

text: Text | null

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

amount: string

price: string

Text representation of price

price: string

Price used in value calculations

kind: "known"

WalletAssetUnknown { amount, kind }

amount: string

Wallet balance in native denom.

kind: "unknown"

User

ModelsExpand Collapse

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

UserMarket

ModelsExpand Collapse

Note

Note

Note

Note

Note

Note

Note

Note

UserMarketLend

ModelsExpand Collapse

Note

Note

Note

UserMarketBorrow

ModelsExpand Collapse

Note

Note

Note

Note

Note

Note

UserMarketBorrowSubaccount

ModelsExpand Collapse

Note

Note

Note

Note

Note

Note

UserNept

ModelsExpand Collapse

Note

Note

Note

UserNeptStaking

ModelsExpand Collapse

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

UserWallet

ModelsExpand Collapse

Note

Note

Note

Note

What can I help you with?

Suggestions