---
title: "Get NEPT token state"
method: GET
path: "/api/v1/nept/state"
tags: ["NEPT"]
---

# Get NEPT token state

`GET /api/v1/nept/state`

## Query parameters

- `with_text` boolean — Include text variation fields
- `with_value` boolean — Calculate and include USD values for amounts, where applicable

## Response `200`

- object
  - `data` NeptState, required
    - `total_issued` string, required — Total amount of NEPT issued, either locked or unlocked Includes initial balances and all claimed or claimable rewards
    - `total_claimed` string, required — Total amount of NEPT claimed, either locked or unlocked Includes initial balances and claimed rewards but not unclaimed rewards
    - `total_locked` string, required — Total amount of NEPT locked Inlcudes unlocks which have not yet been claimed
    - `total_supply` string, required — Total supply of NEPT Includes locked and unissued tokens
    - `staking` StakingPoolWithState[], required — Staking pools (current pool state is included)
      - `index` integer, required — The ordered index (position) of this pool
      - `duration` integer, required — The lockup duration for this pool in seconds
      - `extra` object, required
        - `text` object, nullable, required — Human-readable field variants. Will not be null when query param `with_text` is `true`.
          - `index` string, required
          - `duration` string, required
      - `state` StakingPoolState, required
        - `total_bonded` string, required — The total amount staked to this pool
        - `extra` object, required
          - `text` object, nullable, required — Human-readable field variants. Will not be null when query param `with_text` is `true`.
            - `total_bonded` string, required
          - `value` object, nullable, required — USD values for the corresponding amounts above. Will not be null when query param `with_value` is `true`.
            - `total_bonded` string, required
            - `extra` object, required
              - …
    - `extra` object, required
      - `text` object, nullable, required — Human-readable field variants. Will not be null when query param `with_text` is `true`.
        - `total_claimed` string, required
        - `total_locked` string, required
        - `total_issued` string, required
        - `total_supply` string, required
      - `value` object, nullable, required — USD values for the corresponding amounts above. Will not be null when query param `with_value` is `true`.
        - `total_locked` string, required
        - `total_issued` string, required
        - `total_claimed` string, required
        - `total_supply` string, required
        - `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`.
            - `total_locked` string, required
            - `total_supply` string, required
            - `total_claimed` string, required
            - `total_issued` string, required
  - `error` ErrorData, required
    - `scope` union, required
      - 'user'
      - 'client'
      - 'server'
    - `kind` union, required
      - 'invalid_request'
      - 'validation'
      - 'entity_not_found'
      - 'contract'
      - 'internal'
    - `message` string, required — Error message
    - `fields` FieldValidationError[], nullable, required — List of names and error messages for invalid fields. Never NULL when `error.kind == 'validation'`. Always NULL for all other cases.
      - `field` string, required
      - `message` string, required
  - `status` integer, required — Request status
  - `status_text` string, required — Request status text

## Changes

- **2026-03-01** `9048b9a34641` — 5 breaking, 29 info
  - added `subschema #1: Invalid request, subschema #2: Validation error, subschema #3: Requested entity not found, subschema #4: Contract error, subschema #5: Internal server error` to the `error/anyOf[#/components/schemas/ErrorData]/kind/allOf[#/components/schemas/ErrorKind]/` response property `oneOf` list for the response status `200`
  - added `subschema #1: User error, subschema #2: Client error, subschema #3: Server error` to the `error/anyOf[#/components/schemas/ErrorData]/scope/allOf[#/components/schemas/ErrorScope]/` response property `oneOf` list for the response status `200`
  - the `data/anyOf[#/components/schemas/NeptState]/staking/items/duration` response's property type/format changed from ``/`` to `integer`/`uint64` for status `200`
  - the `error/anyOf[#/components/schemas/ErrorData]/kind/allOf[#/components/schemas/ErrorKind]/` response's property type/format changed from `string`/`` to ``/`` for status `200`
  - …30 more

[Change history](https://skmtc.dev/cryptechdev/apis/neptune-api-v2/changes/api/v1/nept/state/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/9048b9a34641/schema)