Get user NEPT unlocks

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

Path ParametersExpand Collapse

address: string

The user account address

Query ParametersExpand Collapse

with_percent: optional boolean

Calculate and include proportional percentages, where applicable

with_text: optional boolean

Include text variation fields

with_value: optional boolean

Calculate and include USD values for amounts, where applicable

ReturnsExpand Collapse

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

arrangements: array of object { admin, amounts, begins_at, 4 more }

A list of the user's active unlock arrangements

admin: object { address, issued_reclaim }

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

percent: object { claimable, claimed, expired, 3 more }

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

text: object { claimable, claimed, expired, 2 more }

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: object { amount, claimable, claimed, 3 more }

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: object { amount, claimable, claimed, 5 more }

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

text: object { amount, claimable, claimed, 4 more }

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

The time at which the unlock expires, if any

formatdate-time

extra: object { text }

text: object { begins_at, expires_at, last_claimed_at }

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

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

text: object { duration, ends_at }

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

duration: string

ends_at: string

kind: "linear"

UserUnlockScheduleLumpSum = object { kind }

kind: "lump_sum"

extra: object { text }

text: object { last_claimed_at }

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

last_claimed_at: string

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

percent: object { claimable, claimed, expired, 3 more }

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

text: object { claimable, claimed, expired, 2 more }

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: object { amount, claimable, claimed, 3 more }

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: object { amount, claimable, claimed, 5 more }

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

text: object { amount, claimable, claimed, 4 more }

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

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