---
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 — `NeptState`
    - `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 — `StakingPool[]` --- Staking pools (current pool state is included)
      - `index` integer, required — The ordered index (position) of this pool
      - `duration` Duration, required
        - `secs` integer, required
        - `nanos` integer, required
      - `extra` object, required
        - `text` object, nullable — Human-readable field variants. Must provide `?with-text=true`
          - `duration` string, required
          - `index` string, required
      - `state` StakingPoolState, required — `StakingPoolState`
        - `total_bonded` string, required — The total amount staked to this pool
        - `extra` object, required
          - `text` object, nullable — Human-readable field variants. Must provide `?with-text=true`
            - `total_bonded` string, required
          - `value` object, nullable — USD values for the corresponding amounts above. Must provide `?with-value=true`
            - `total_bonded` string, required
            - `extra` object, required
              - …
    - `extra` object, required
      - `text` object, nullable — Human-readable field variants. Must provide `?with-text=true`
        - `total_issued` string, required
        - `total_supply` string, required
        - `total_locked` string, required
        - `total_claimed` string, required
      - `value` object, nullable — USD values for the corresponding amounts above. Must provide `?with-value=true`
        - `total_locked` string, required
        - `total_supply` string, required
        - `total_issued` string, required
        - `total_claimed` string, required
        - `extra` object, required
          - `text` object, nullable — Human-readable variants of USD values. Must provide `?with-text=true&with-value=true`
            - `total_locked` string, required
            - `total_issued` string, required
            - `total_supply` string, required
            - `total_claimed` string, required
  - `error` ErrorData
    - `scope` 'user' | 'client' | 'server', required
    - `kind` 'invalid_request' | 'validation' | 'entity_not_found' | 'contract' | 'internal', required
    - `message` string, required — Error message
    - `fields` FieldValidationError[], nullable — List of names and error messages for invalid fields. Always set when `error.kind == 'validation'`. Always NULL/unset for all other cases.
      - `field` string, required
      - `message` string, required
  - `status` integer, required — Request status
  - `status_text` string, required — Request status text

---

[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/4b5b35e288d8/schema)