For the complete documentation index, see llms.txt. This page is also available as Markdown.

Whuffies

Get WHUF balance for an address

get
Path parameters
addressstringRequired

Ethereum address (0x-prefixed, 20 bytes)

Responses
200

Successful response

application/json
balanceinteger · int64Required
get/whuffies/balance/{address}
GET /api/v2/whuffies/balance/{address} HTTP/1.1
Host: api.ethos.network
Accept: */*
{
  "balance": 1
}

Get WHUF circulating supply

get

Total supply less every wallet held out of circulation, as an exact decimal token amount. Add ?format=plain for the bare number as text/plain. The excluded wallets and the formula are published at https://whitepaper.ethos.network.

Query parameters
formatstring · enumOptionalPossible values:
Responses
200

Successful response

application/json
resultstringRequired
get/whuffies/circulating-supply
GET /api/v2/whuffies/circulating-supply HTTP/1.1
Host: api.ethos.network
Accept: */*
{
  "result": "text"
}

Get the current WHUF reward rate and pool state

get

The contract’s current reward rate in basis points (rewardRateBps) with the pool-wide accounting behind it, read at one block and cached for 60 seconds.

Responses
200

Successful response

application/json
accountedRewardBalanceinteger · int64Required
blockNumberinteger · int64Required
emissionRateBpsinteger · max: 9007199254740991Required
rewardRateBpsinteger · max: 9007199254740991Required
timestampinteger · max: 9007199254740991Required
totalAccruedNotPaidinteger · int64Required
totalCommittedinteger · int64Required
get/whuffies/reward-pool
GET /api/v2/whuffies/reward-pool HTTP/1.1
Host: api.ethos.network
Accept: */*
{
  "accountedRewardBalance": 1,
  "blockNumber": 1,
  "emissionRateBps": 1,
  "rewardRateBps": 1,
  "timestamp": 1,
  "totalAccruedNotPaid": 1,
  "totalCommitted": 1
}

Get WHUF token metadata

get
Responses
200

Successful response

application/json
decimalsinteger · max: 9007199254740991Required
namestringRequired
symbolstringRequired
get/whuffies/token-metadata
GET /api/v2/whuffies/token-metadata HTTP/1.1
Host: api.ethos.network
Accept: */*
{
  "decimals": 1,
  "name": "text",
  "symbol": "text"
}

Get the current phase of the WHUF token sale

get
Responses
200

Successful response

application/json
or
or
get/whuffies/token-sale-state
GET /api/v2/whuffies/token-sale-state HTTP/1.1
Host: api.ethos.network
Accept: */*
{
  "phase": "text"
}

Get WHUF total supply

get

Every WHUF in existence, as an exact decimal token amount. Add ?format=plain for the bare number as text/plain. The formula is published at https://whitepaper.ethos.network.

Query parameters
formatstring · enumOptionalPossible values:
Responses
200

Successful response

application/json
resultstringRequired
get/whuffies/total-supply
GET /api/v2/whuffies/total-supply HTTP/1.1
Host: api.ethos.network
Accept: */*
{
  "result": "text"
}

Last updated