Get user tx history

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

Get user tx history

Path ParametersExpand Collapse

address: string

The user account address

Query ParametersExpand Collapse

action: optional EventAction

Optional event/tx action to filter against

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"

limit: optional number

Maximum number of transactions to return.

Optional and defaults to 20 if missing.

formatuint16

minimum1

maximum100

prev_event_uuid: optional string

Optional UUID skip parameter used for pagination.

Providing the last event UUID on a given page will return the next page beginning with the following (unseen) item.

formatuuid

sort_order: optional "asc" or "desc"

Changes the sort order for the returned txs.

Transactions are always sorted by event time, however the direction (e.g. newest to oldest) can be changed using this parameter.

Optional and defaults to desc if missing.

One of the following:

"asc"

"desc"

with_text: optional boolean

Include text variation fields

with_value: optional boolean

Calculate and include USD values for amounts, where applicable

ReturnsExpand Collapse

count: number

Total number of objects irrespective of any pagination parameters.

formatuint16

minimum0

maximum65535

data: array of UserTx { account_address, account_index, action, 10 more }

account_address: string

Account address corresponding to the transaction

account_index: number

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

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

contract_address: string

Address for the event's corresponding contract

destination_address: string

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: object { text, value }

text: object { action, amount, event_time, 2 more }

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: object { amount, extra, price }

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: object { text }

text: object { amount, price }

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

amount: optional string

price: optional string

Text representation of price

price: string

Price used in value calculations

historic_price: string or number

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

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.

number

The price of the associated asset at the time of the transaction.

This value will be set for all currently implemented action types. It is set as nullable for forwards compatibility for future action types which may not have an associated amount.

historic_value: string or number

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

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.

number

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.

tx_hash: string

Transaction hash

error: unknown

Error data. Guaranteed null for successful response.

status: number

HTTP status. Successful responses are guaranteed to be < 400. Conversely, error responses are guaranteed to be >= 400.

formatuint16

minimum0

maximum65535

status_text: string

HTTP status text