Skip to content
Neptune API v2
Get started
API Reference

Nept

Get NEPT token params
nept.get_params(NeptGetParamsParams**kwargs) -> NeptGetParamsResponse
GET/api/v1/nept/params
Get NEPT token state
nept.get_state(NeptGetStateParams**kwargs) -> NeptGetStateResponse
GET/api/v1/nept/state
Get NEPT staking overview (incl. state + params)
nept.get_staking_overview(NeptGetStakingOverviewParams**kwargs) -> NeptGetStakingOverviewResponse
GET/api/v1/nept/staking
ModelsExpand Collapse
class NeptParams: …
asset_info: AssetInfo

Asset identifiers with associated metadata

asset: AssetSpec

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

id: str
group: Literal["native", "token"]
One of the following:
"native"
"token"
group_key: str
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:
class Regular: …
kind: Literal["regular"]
neptune_receipt_asset: Optional[AssetSpec]

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

id: str
group: Literal["native", "token"]
One of the following:
"native"
"token"
group_key: str
class NeptuneReceiptToken: …
kind: Literal["neptune_receipt_token"]
origin_asset: AssetSpec

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

id: str
group: Literal["native", "token"]
One of the following:
"native"
"token"
group_key: str
class LiquidStakingToken: …
kind: Literal["liquid_staking_token"]
origin_asset: Optional[AssetSpec]

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

id: str
group: Literal["native", "token"]
One of the following:
"native"
"token"
group_key: str
metadata: AssetMetadata

Additional metadata for assets

decimals_denom: int

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

formatuint32
minimum0
decimals_display: int

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

formatuint32
minimum0
name: str

Full name of the asset

symbol: str

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

symbol_denom: str

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

emission_rate: str

The emission rate of NEPT in tokens per year

extra: Extra
text: Optional[ExtraText]

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

emission_rate: str
value: Optional[ExtraValue]

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

Note

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

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

emission_rate: str
extra: ExtraValueExtra
text: Optional[ExtraValueExtraText]

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

emission_rate: str
price: str

Text representation of price

price: str

Price used in value calculations

staking_pools: List[StakingPool]

Staking pools

duration: int

The lockup duration for this pool in seconds

formatuint64
minimum0
extra: StakingPoolExtra
text: Optional[StakingPoolExtraText]

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

duration: str
index: str
index: int

The ordered index (position) of this pool

formatuint8
minimum0
maximum255
params: StakingPoolParams

Staking pool contract parameters

flash_loan_weight: str

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

gov_weight: str

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

health_weight: str

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

reward_weight: str

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

tokens_per_weight: int

Weight:token scaling factor

This is defined in the contract spec to mitigate library type restrictions

formatuint64
minimum0
class NeptState: …
extra: Extra
text: Optional[ExtraText]

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

total_claimed: str
total_issued: str
total_locked: str
total_supply: str
value: Optional[ExtraValue]

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

Note

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

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

extra: ExtraValueExtra
text: Optional[ExtraValueExtraText]

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

price: str

Text representation of price

total_claimed: str
total_issued: str
total_locked: str
total_supply: str
price: str

Price used in value calculations

total_claimed: str
total_issued: str
total_locked: str
total_supply: str
staking: List[Staking]

Staking pools (current pool state is included)

duration: int

The lockup duration for this pool in seconds

formatuint64
minimum0
extra: StakingExtra
text: Optional[StakingExtraText]

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

duration: str
index: str
index: int

The ordered index (position) of this pool

formatuint8
minimum0
maximum255
state: StakingPoolState

Current contract state of staking pool

extra: Extra
text: Optional[ExtraText]

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

total_bonded: str
value: Optional[ExtraValue]

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

Note

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

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

extra: ExtraValueExtra
text: Optional[ExtraValueExtraText]

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

price: str

Text representation of price

total_bonded: str
price: str

Price used in value calculations

total_bonded: str
total_bonded: str

The total amount staked to this pool

total_claimed: str

Total amount of NEPT claimed, either locked or unlocked

Includes initial balances and claimed rewards but not unclaimed rewards

total_issued: str

Total amount of NEPT issued, either locked or unlocked

Includes initial balances and all claimed or claimable rewards

total_locked: str

Total amount of NEPT locked

Inlcudes unlocks which have not yet been claimed

total_supply: str

Total supply of NEPT

Includes locked and unissued tokens

class NeptUnlockDistributionGroup: …
amount: str

The sum of all token distribution unlock amounts for this group.

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

amount_claimable: str

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.

amount_claimed: str

The amount that has already been successfully claimed by the user

amount_expired: str

The amount that has expired.

This will be the remaining unclaimed amount (if any) once the time specified by the expires_at is past (if one is set).

NOTE: Reclaimed amouts take priority.

  • If the remaining amount is reclaimed prior to a configured expires_at, this will remain at 0 and will not change even after the expires_at time is reached.
amount_held: str

The total amount of NEPT currently held by the addresses in this group.

amount_locked: str

The total amount of NEPT currently time-locked.

NOTE: This does not factor in reclaimed or expired states.

  • For linear unlock schedules:

    • This represents how much NEPT is time-locked by the begins_at and the ends_at properties.

  • For lump sum unlocks:

    • This will be the full amount prior to the begins_at unlock property.
    • Once the time indicated by the begins_at property has been reached, this value will be 0.
amount_reclaimed: str

The amount that has been reclaimed from the unlock arrangement admin

This will be the amount of the remaining unclaimed and locked at the time the reclaim is issued.

amount_staked: str

The total amount of NEPT current staked by the addresses in this group.

amount_unlocked: str

The total amount of NEPT currently unlocked

NOTE: This does not factor in reclaimed or expired states.

  • For linear unlock schedules:

    • This represents the "progress" of unlocked NEPT from the time range between the begins_at and the ends_at properties.

  • For lump sum unlocks:

    • This will be 0 at any given time prior to the timestamp provided by the begins_at unlock property.
    • Once the time indicated by the begins_at property has been reached, this value will be the full amount of the unlock.
extra: Extra
percent: Optional[ExtraPercent]

Percentages for unlock amounts. These do not factor in the amount_staked or amount_held values. Will not be null when query param with_percent is true.

amount_claimable: str
amount_claimed: str
amount_expired: str
amount_locked: str
amount_reclaimed: str
amount_unlocked: str
extra: ExtraPercentExtra
text: Optional[ExtraPercentExtraText]

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

amount_claimable: str
amount_claimed: str
amount_expired: str
amount_locked: str
amount_reclaimed: str
amount_unlocked: str
text: Optional[ExtraText]

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

amount: str
amount_claimable: str
amount_claimed: str
amount_expired: str
amount_held: str
amount_locked: str
amount_reclaimed: str
amount_staked: str
amount_unlocked: str
member_class: str
value: Optional[ExtraValue]

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

Note

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

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

amount: str
amount_claimable: str
amount_claimed: str
amount_expired: str
amount_held: str
amount_locked: str
amount_reclaimed: str
amount_staked: str
amount_unlocked: str
extra: ExtraValueExtra
text: Optional[ExtraValueExtraText]

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

amount: str
amount_claimable: str
amount_claimed: str
amount_expired: str
amount_held: str
amount_locked: str
amount_reclaimed: str
amount_staked: str
amount_unlocked: str
price: str

Text representation of price

price: str

Price used in value calculations

member_class: Literal["team", "advisor", "investor"]

The group category

One of the following:
"team"
"advisor"
"investor"
class StakingPoolFull: …

Staking pool contents along with associated pool state and pool params

duration: int

The lockup duration for this pool in seconds

formatuint64
minimum0
extra: Extra
text: Optional[ExtraText]

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

duration: str
index: str
index: int

The ordered index (position) of this pool

formatuint8
minimum0
maximum255
params: StakingPoolParams

Staking pool contract parameters

flash_loan_weight: str

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

gov_weight: str

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

health_weight: str

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

reward_weight: str

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

state: StakingPoolState

Current contract state of staking pool

extra: Extra
text: Optional[ExtraText]

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

total_bonded: str
value: Optional[ExtraValue]

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

Note

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

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

extra: ExtraValueExtra
text: Optional[ExtraValueExtraText]

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

price: str

Text representation of price

total_bonded: str
price: str

Price used in value calculations

total_bonded: str
total_bonded: str

The total amount staked to this pool

class StakingPoolParams: …
flash_loan_weight: str

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

gov_weight: str

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

health_weight: str

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

reward_weight: str

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

class StakingPoolState: …
extra: Extra
text: Optional[ExtraText]

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

total_bonded: str
value: Optional[ExtraValue]

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

Note

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

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

extra: ExtraValueExtra
text: Optional[ExtraValueExtraText]

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

price: str

Text representation of price

total_bonded: str
price: str

Price used in value calculations

total_bonded: str
total_bonded: str

The total amount staked to this pool