Skip to main content
GET
/
v2
/
amplify
/
supplyCaps
List vault deposit-cap utilization
curl --request GET \
  --url https://api.example.com/v2/amplify/supplyCaps \
  --header 'x-api-key: <api-key>'
{
  "supplyCaps": [
    {
      "vaultAddress": "0xbbbb000000000000000000000000000000000001",
      "chainId": 84532,
      "totalSupplyInBase": "1037.937273",
      "supplyCap": "5000000.00",
      "percentageFilled": "20.3893"
    }
  ],
  "nextPageToken": "eyJvZmZzZXQiOjI1fQ=="
}

Documentation Index

Fetch the complete documentation index at: https://developers.paxoslabs.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key in format: pxl_<public_id>_

Query Parameters

​
pageSize
number
default:25

Maximum items per page. Default: 25. Min: 1, max: 100.

Required range: 1 <= x <= 100
Example:

25

​
pageToken
string

Opaque token for the next page. Omit for the first page.

​
filter
string

Filter string. Optional flags: vaultAddress (hex), chainId (number). Example: vaultAddress=0xbbbb000000000000000000000000000000000001 AND chainId=84532

Example:

"vaultAddress=0xbbbb000000000000000000000000000000000001 AND chainId=84532"

Response

List of supply-cap entries

​
supplyCaps
object[]
required

One entry per chain deployment.

​
nextPageToken
string | null
required

Token for the next page. null when there are no more results. Always present.

Example:

"eyJvZmZzZXQiOjI1fQ=="