API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Assets

Get info for all assets

GET/api/v1/assets

Get all asset prices

GET/api/v1/assets/prices

Get historical prices for assets

GET/api/v1/assets/price-history

ModelsExpand Collapse

AssetClassification = object { kind, neptune_receipt_asset } or object { kind, origin_asset } or object { kind, origin_asset }

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 = object { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_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" or "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken = object { 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" or "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken = object { kind, origin_asset }

kind: "liquid_staking_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" or "token"

One of the following:

"native"

"token"

group_key: string

AssetInfo = object { 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" or "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 = object { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_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" or "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken = object { 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" or "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken = object { kind, origin_asset }

kind: "liquid_staking_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" or "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

name: string

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)

AssetMetadata = object { 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

name: string

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)

AssetPrice = object { extra, last_updated_at, price }

Note: Prices are sourced from Neptune's Price Oracle

extra: object { text }

text: object { last_updated_at, price }

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

last_updated_at: string

price: string

last_updated_at: string

Asset price value, as per Neptune Price Oracle

formatdate-time

price: string

Asset price

AssetPriceHistory = object { pagination, range, series }

Historical prices for assets

pagination: object { interval_count, next_offset }

Values used for paginating the time series data

interval_count: number

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

formatuint64

minimum0

next_offset: number

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

formatuint64

minimum0

range: object { end, interval, start }

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

end: string

formatdate-time

interval: Interval { unit, value }

Interval period & size

unit: IntervalUnit

One of the following:

"h"

"d"

"w"

"m"

"y"

value: number

formatint64

start: string

formatdate-time

series: array of object { asset, points }

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" or "token"

One of the following:

"native"

"token"

group_key: string

points: array of object { t, v }

t: string

formatdate-time

v: string

AssetRateHistory = object { pagination, range, series }

Historical rates for assets

pagination: object { interval_count, next_offset }

Values used for paginating the time series data

interval_count: number

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

formatuint64

minimum0

next_offset: number

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

formatuint64

minimum0

range: object { end, interval, start }

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

end: string

formatdate-time

interval: Interval { unit, value }

Interval period & size

unit: IntervalUnit

One of the following:

"h"

"d"

"w"

"m"

"y"

value: number

formatint64

start: string

formatdate-time

series: array of object { asset, points }

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" or "token"

One of the following:

"native"

"token"

group_key: string

points: array of object { t, v }

t: string

formatdate-time

v: string

AssetSpec = object { 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" or "token"

One of the following:

"native"

"token"

group_key: string