/pool

/pool/active?<token>&<pkh>

Get list of active pools for given token and/or user.

User is 20 byte hash of a users public key, same as encoded in their cashaddr.

Token is the 32 byte token ID.

Example results

Query: /cauldron/pool/active/?token=b79bfc8246b5fc4707e7c7dedcb6619ef1ab91f494a790c20b0f4c422ed95b92

{
  "active": [
    {
      "owner_p2pkh_addr": "bitcoincash:zqmvqqsd6w08e4nvy8er0hzn6wzxvxj40u7tlk8wl3",
      "owner_pkh": "36c0020dd39e7cd66c21f237dc53d384661a557f",
      "sats": 776661580,
      "token_id": "b79bfc8246b5fc4707e7c7dedcb6619ef1ab91f494a790c20b0f4c422ed95b92",
      "tokens": 16,
      "tx_pos": 0,
      "txid": "94a933a0fa55093a0965eb867f1b9cac2bb07488ced4825bc31f86c9371f76aa"
    }
  ]
}

/pool/list_by_apy

List of pools ordered by highest APY.

Query: /cauldron/pool/list_by_apy

{
  "pools": [
    {
      "apy": 1329.314599388565,
      "pool_yield": 223.5651398319447,
      "sats": 1761,
      "token_id": "750743caae9c2bbd57934409f73c0eb2083a79254fcae6e7781b78800b1c4b13",
      "tokens": 214875,
      "tx_pos": 9,
      "txid": "2c373f46c73714920386e9372b687dad41ef806adaf63f9380c4269c582b1082"
    },
  ]
}

/pool/aggregated_apy?<token>&<pkh>&<start>&<end>

token: The 32 byte token ID

pkh: Public key hash for wallet account

start: Unix timestamp for period start (default 30 days)

end: Unix timestamp for period end (default NOW)

Fetch apy for a token and/or an account within a given time interval. All variables are optional. A query with no variables will return the AAPY based on all users and all tokens aggregated.

Example results

AAPY from MUSDv1 the last 30 days.

Query: /cauldron/pool/aggregated_apy?token=b38a33f750f84c5c169a6f23cb873e6e79605021585d4f3408789689ed87f366

{
  "apy":"17.53540060038928169876942871",
  "pools":133
}