Skip to main content

/extended/v1/stx_supply/legacy_format REST API Endpoint

Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.

Updated on
Oct 4, 2023

/extended/v1/stx_supply/legacy_format REST API Endpoint

Query Parameters

height
number
The block height at which to query supply details from, if not provided then the latest block height is used.

Returns

object
object
GET request that returns network target block times
unlockedPercent
string
A string representation of the decimal number indicating the percentage of STX that have unlocked.
totalStacks
string
A string representation of the decimal number indicating the total possible number of STX.
totalStacksFormatted
string
Same as totalStacks but formatted with comma thousands separators.
unlockedSupply
string
A string representation of the decimal number indicating the STX that have been mined or unlocked.
unlockedSupplyFormatted
string
Same as unlockedSupply but formatted with comma thousands separators.
blockHeight
string
The block height at which this information was queried.
Request
1
curl -X 'GET' \
2
    'https://docs-demo.stacks-mainnet.quiknode.pro/extended/v1/stx_supply/legacy_format' \
3
    -H 'Content-Type: application/json'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free