Get distribution analytics for NEPT unlocks

GET/api/v1/analytics/nept/unlocks-distribution

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

groups: array of NeptUnlockDistributionGroup { amount, amount_claimable, amount_claimed, 8 more }

amount: string

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: 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.

amount_claimed: string

The amount that has already been successfully claimed by the user

amount_expired: string

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: string

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

amount_locked: string

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: string

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: string

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

amount_unlocked: string

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

percent: object { amount_claimable, amount_claimed, amount_expired, 4 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.

amount_claimable: string

amount_claimed: string

amount_expired: string

amount_locked: string

amount_reclaimed: string

amount_unlocked: string

extra: object { text }

text: object { amount_claimable, amount_claimed, amount_expired, 3 more }

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

amount_claimable: string

amount_claimed: string

amount_expired: string

amount_locked: string

amount_reclaimed: string

amount_unlocked: string

text: object { amount, amount_claimable, amount_claimed, 7 more }

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

amount: string

amount_claimable: string

amount_claimed: string

amount_expired: string

amount_held: string

amount_locked: string

amount_reclaimed: string

amount_staked: string

amount_unlocked: string

member_class: string

value: object { amount, amount_claimable, amount_claimed, 8 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

amount_claimable: string

amount_claimed: string

amount_expired: string

amount_held: string

amount_locked: string

amount_reclaimed: string

amount_staked: string

amount_unlocked: string

extra: object { text }

text: object { amount, amount_claimable, amount_claimed, 7 more }

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

amount: string

amount_claimable: string

amount_claimed: string

amount_expired: string

amount_held: string

amount_locked: string

amount_reclaimed: string

amount_staked: string

amount_unlocked: string

price: string

Text representation of price

price: string

Price used in value calculations

member_class: "team" or "advisor" or "investor"

The group category

One of the following:

"team"

"advisor"

"investor"

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