--- title: "Get distribution analytics for NEPT unlocks" method: GET path: "/api/v1/analytics/nept/unlocks-distribution" tags: ["Analytics"] --- # Get distribution analytics for NEPT unlocks `GET /api/v1/analytics/nept/unlocks-distribution` ## Query parameters - `with_text` boolean — Include text variation fields - `with_value` boolean — Calculate and include USD values for amounts, where applicable - `with_percent` boolean — Calculate and include proportional percentages, where applicable ## Response `200` Success response - NeptDistributionObjResponse - `data` NeptDistribution, required - `groups` NeptUnlockDistributionGroup[], required - `member_class` 'team' | 'advisor' | 'investor', required — The group category - `amount` string, required — 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_claimed` string, required — The amount that has already been successfully claimed by the user - `amount_claimable` string, required — 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_unlocked` string, required — 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. - `amount_locked` string, required — 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, required — 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_expired` string, required — 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_staked` string, required — The total amount of NEPT current staked by the addresses in this group. - `amount_held` string, required — The total amount of NEPT currently held by the addresses in this group. - `extra` object, required - `text` object, nullable, required — Human-readable field variants. Will not be null when query param `with_text` is `true`. - `amount_reclaimed` string, required - `amount` string, required - `amount_claimed` string, required - `amount_expired` string, required - `amount_staked` string, required - `amount_locked` string, required - `amount_unlocked` string, required - `amount_claimable` string, required - `amount_held` string, required - `member_class` string, required - `percent` object, nullable, required — 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, required - `amount_unlocked` string, required - `amount_reclaimed` string, required - `amount_claimed` string, required - `amount_locked` string, required - `amount_expired` string, required - `extra` object, required - `text` object, nullable, required — Human-readable variants of percentages for unlock amounts. Will not be null when query params `with_text` and `with_percent` are `true`. - … - `value` object, nullable, required — 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_claimable` string, required - `amount_claimed` string, required - `amount` string, required - `amount_expired` string, required - `amount_staked` string, required - `amount_held` string, required - `amount_locked` string, required - `amount_unlocked` string, required - `amount_reclaimed` string, required - `price` string, required — Price used in value calculations - `extra` object, required - `text` object, nullable, required — Human-readable variants of USD values. Will not be null when query params `with_text` and `with_value` are `true`. - … - `error` unknown, required - `status` integer, required — HTTP status. Successful responses are guaranteed to be < `400`. Conversely, error responses are guaranteed to be >= `400`. - `status_text` string, required — HTTP status text ## Other responses - `500` — Server error response - `default` ## Changes - **2026-04-02** `3e68b318eeaa` — 2 info - added the required property `data/groups/items/extra/value/extra/text/price` to the response with the `200` status - added the required property `data/groups/items/extra/value/price` to the response with the `200` status - …earlier changes not shown [Full history](https://skmtc.dev/cryptechdev/apis/neptune-api-v2/changes/api/v1/analytics/nept/unlocks-distribution/get.md) --- [API](https://skmtc.dev/cryptechdev/apis/neptune-api-v2.md) · [All operations](https://skmtc.dev/cryptechdev/apis/neptune-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cryptechdev/neptune-api-v2/revisions/05e0ec4b9b94/schema)