> ## Documentation Index
> Fetch the complete documentation index at: https://docs.soo.network/llms.txt
> Use this file to discover all available pages before exploring further.

# GetSupply

## getSupply RPC Method

Returns information about the current supply.

<div className="grid grid-cols-2 gap-1 mt-2">
  <div className="col-span-1">
    #### Parameters

    `object` **optional**\
    Configuration object containing the following fields:

    **commitment** `string` **optional**\
    The level of commitment desired when querying state

    **excludeNonCirculatingAccountsList** `bool` **optional**\
    Exclude non-circulating accounts list from response
  </div>

  <div className="col-span-1">
    #### Code Sample

    ```bash theme={"system"}
    curl https://rpc.testnet.soo.network/rpc \
    -X POST \
    -H "Content-Type: application/json" \
    -d '{
      "jsonrpc": "2.0",
      "id": 1,
      "method": "getSupply",
      "params": [{
        "commitment": "finalized",
        "excludeNonCirculatingAccountsList": false
      }]
    }'
    ```

    #### Response

    ```json theme={"system"}
    {
      "jsonrpc": "2.0",
      "result": {
        "context": {
          "slot": 369624
        },
        "value": {
          "total": 1000000000,
          "circulating": 500000000,
          "nonCirculating": 500000000,
          "nonCirculatingAccounts": [
            "5ThJTCxpdn54bk3gBAWKZS4K9ogHEX56WooYbXQDnm3Q"
          ]
        }
      },
      "id": 1
    }
    ```
  </div>
</div>

#### Result Details

The result is an RpcResponse JSON object with `value` containing:

* `total: <u64>`
  * Total supply in lamports
  * Represents the entire token supply of the blockchain

* `circulating: <u64>`
  * Circulating supply in lamports
  * Represents the number of tokens currently in circulation

* `nonCirculating: <u64>`
  * Non-circulating supply in lamports
  * Represents tokens not currently available for trading or use

* `nonCirculatingAccounts: <array>`
  * List of account addresses with non-circulating tokens
  * Returned as an array of strings
  * Will be an empty array if `excludeNonCirculatingAccountsList` is set to `true`
