API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Assets

Get info for all assets

assets.list() -> AssetListResponse

GET/api/v1/assets

Get all asset prices

assets.list_prices(AssetListPricesParams**kwargs) -> AssetListPricesResponse

GET/api/v1/assets/prices

Get historical prices for assets

assets.get_price_history(AssetGetPriceHistoryParams**kwargs) -> AssetGetPriceHistoryResponse

GET/api/v1/assets/price-history

ModelsExpand Collapse

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

class 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)

class 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)

class AssetPrice: …

Note: Prices are sourced from Neptune's Price Oracle

extra: Extra

text: Optional[ExtraText]

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

last_updated_at: str

price: str

last_updated_at: datetime

Asset price value, as per Neptune Price Oracle

formatdate-time

price: str

Asset price

class AssetPriceHistory: …

Historical prices for assets

pagination: Pagination

Values used for paginating the time series data

interval_count: int

The total number of intervals/buckets for the provided interval parameters (size, period, start, end)

formatuint64

minimum0

next_offset: Optional[int]

The offset a client should use to fetch the next page of intervals (so long as limit remains unchanged)

formatuint64

minimum0

range: Range

Provides values for the requested range in it's entire width, regardless of page/limit.

end: datetime

formatdate-time

interval: Interval

Interval period & size

unit: IntervalUnit

One of the following:

"h"

"d"

"w"

"m"

"y"

value: int

formatint64

start: datetime

formatdate-time

series: List[Series]

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

points: List[SeriesPoint]

t: datetime

formatdate-time

v: Optional[str]

class AssetRateHistory: …

Historical rates for assets

pagination: Pagination

Values used for paginating the time series data

interval_count: int

The total number of intervals/buckets for the provided interval parameters (size, period, start, end)

formatuint64

minimum0

next_offset: Optional[int]

The offset a client should use to fetch the next page of intervals (so long as limit remains unchanged)

formatuint64

minimum0

range: Range

Provides values for the requested range in it's entire width, regardless of page/limit.

end: datetime

formatdate-time

interval: Interval

Interval period & size

unit: IntervalUnit

One of the following:

"h"

"d"

"w"

"m"

"y"

value: int

formatint64

start: datetime

formatdate-time

series: List[Series]

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

points: List[SeriesPoint]

t: datetime

formatdate-time

v: Optional[str]

class 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