Skip to content

Get supply info for a specific time.

GET
/ledgers/supply_info

Returns supply information about the Xahau Network of the closest available ledger for the given time.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
date
string format: date-time

Return latest available supply info by the specified time. The default is the current time.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Returns supply information about the Xahau Network.

  • ledger = ledger index of supply information

  • closeTimeHuman = close time of the ledger in human readable time

  • accounts = number of accounts

  • xahExisting = total number of existing XAH

  • xah.xahTotalSupply = Circulating supply of XAH (Total amount of XAH in accounts minus account reserve, minus non transient reserves, minus blackholed accounts and minus treasury locked funds)

  • xah.xahTotalReserved = Total number of XAH reserved in Accounts and Objects

  • xah.xahTotalTransientReserves = Total number of XAH in transient objects like Offers

  • xah.xahInEscrow = Amount of XAH locked in Escrows

  • xah.xahInTreasury = Amount of XAH in accounts which have the two Treasury hooks installed

  • xah.xahInTreasuryLocked = Amount of XAH in accounts which have the two Treasury hooks installed AND the account is blackholed!

  • xah.xahInBlackholedAccounts = Amount of XAH in accounts which have been blackholed and therefore the funds are inaccessible. This excludes amounts from xahInTreasuryLocked!

  • xah.xahInCirculation = Circulating supply of XAH (Total amount of XAH in accounts minus account reserve, minus non transient reserves, minus blackholed accounts and minus treasury locked funds)

SupplyInfo
object
ledger
required
number format: integer
closeTimeHuman
required
string
accounts
required
number format: integer
xahExisting
required
number format: float
xah
required
object
xahTotalSupply
number format: float
xahTotalReserved
number format: float
xahTotalTransientReserves
number format: float
xahInEscrow
number format: float
xahInTreasury
number format: float
xahInTreasuryLocked
number format: float
xahInBlackholedAccounts
number format: float
xahInCirculation
number format: float

400

Section titled “400 ”

Query input malformed

ValidationError
object
message
required
string
code
string
path
string

Headers

Section titled “Headers ”
x-ratelimit-limit
integer

Maximum number of requests in the rate limit window.

x-ratelimit-remaining
integer

Number of remaining request in current rate limit window.

x-ratelimit-reset
integer

The seconds until the current rate limit window resets.

429

Section titled “429 ”

Too Many Requests

Headers

Section titled “Headers ”
x-ratelimit-limit
integer

Maximum number of requests in the rate limit window.

x-ratelimit-remaining
integer

Number of remaining request in current rate limit window.

x-ratelimit-reset
integer

The seconds until the current rate limit window resets.