---
description: >-
  An API for retrieving information about NCG's total and circulating supply, as
  well as individual balances.
---

# API References

<mark style="color:blue;">`GET`</mark> `https://supply-api-9c.herokuapp.com/ncg/circulating-supply`

Return circulating supply of [NCG](https://docs.nine-chronicles.com/introduction/intro/nine-chronicles-gold-ncg)

#### Query Parameters

| Name  | Type    | Description                             |
| ----- | ------- | --------------------------------------- |
| hash  | String  | Block hash for which data is requested  |
| index | Integer | Block index for which data is requested |

{% tabs %}
{% tab title="200: OK plaintext circulating supply number" %}
```
186849623.92
```
{% endtab %}
{% endtabs %}

<mark style="color:blue;">`GET`</mark> `https://supply-api-9c.herokuapp.com/ncg/total-supply`

Return total supply of [NCG](https://docs.nine-chronicles.com/introduction/intro/nine-chronicles-gold-ncg)

#### Query Parameters

| Name        | Type    | Description                                                                                                                                                                             |
| ----------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| hash        | String  | Block hash for which data is requested                                                                                                                                                  |
| index       | Integer | Block index for which data is requested                                                                                                                                                 |
| soft-lockup | Boolean | Set `true` if the response need to apply [soft lockup announcement](https://ninechronicles.medium.com/vesting-extended-for-team-investors-minting-for-binance-partnership-c06f531cc494) |

{% tabs %}
{% tab title="200: OK plaintext total supply number" %}
```
350726622.11
```
{% endtab %}
{% endtabs %}

<mark style="color:blue;">`GET`</mark> `https://supply-api-9c.herokuapp.com/ncg/balance/{address}`

Return given account's amount of [NCG](https://docs.nine-chronicles.com/introduction/intro/nine-chronicles-gold-ncg)

#### Path Parameters

| Name                                      | Type   | Description                                           |
| ----------------------------------------- | ------ | ----------------------------------------------------- |
| address<mark style="color:red;">\*</mark> | String | account address (0x...) which want to get NCG balance |

#### Query Parameters

| Name  | Type    | Description                             |
| ----- | ------- | --------------------------------------- |
| hash  | String  | Block hash for which data is requested  |
| index | Integer | Block index for which data is requested |

{% tabs %}
{% tab title="200: OK plaintext balance number" %}
```
4056.03
```
{% endtab %}
{% endtabs %}
