Getting started
Token List
Weekly Emission
Unlock Events
Upcoming Unlock Events
Burn
Buyback
Copy
curl -X 'GET' \
'https://api.unlocks.app/v1/token/list' \
-H 'x-api-key: $YOUR_API_KEY'
Copy
{
"metadata": {
"queryDate": "2024-08-19T11:50:53Z"
},
"status": true,
"data": [
{
"id": "optimism",
"name": "Optimism",
"symbol": "OP",
"circulatingSupply": 1187596466,
"marketCap": 1603255229.1000001,
"maxSupply": 4294967296,
"totalLockedAmount": 856358024.1999991,
"tbdLockedAmount": 2231937452,
"unlockedAmount": 1206671819.0000002,
"untrackedAmount": 0.8000006675720215,
"hasStandardAllocation": true,
"websiteUrl": "https://token.unlocks.app/optimism",
"lastUpdatedDate": "2024-06-18T09:07:49Z"
}
]
}
Token List
Token List API v1
Get a list of all tokenID to use for calling following API’s
GET
/
v1
/
token
/
list
Copy
curl -X 'GET' \
'https://api.unlocks.app/v1/token/list' \
-H 'x-api-key: $YOUR_API_KEY'
Copy
{
"metadata": {
"queryDate": "2024-08-19T11:50:53Z"
},
"status": true,
"data": [
{
"id": "optimism",
"name": "Optimism",
"symbol": "OP",
"circulatingSupply": 1187596466,
"marketCap": 1603255229.1000001,
"maxSupply": 4294967296,
"totalLockedAmount": 856358024.1999991,
"tbdLockedAmount": 2231937452,
"unlockedAmount": 1206671819.0000002,
"untrackedAmount": 0.8000006675720215,
"hasStandardAllocation": true,
"websiteUrl": "https://token.unlocks.app/optimism",
"lastUpdatedDate": "2024-06-18T09:07:49Z"
}
]
}
Start here to get a list of all tokenID to use for calling following API’s. You can then use the required tokenID to call each endpoint.
Response
Request status
Show data fields
Show data fields
Identifier to call for a dataset
Token Name
Token Symbol
Circulating supply of the token provided by external source (Will be null if no data present)
Market cap of the token provided by external source (Will be null if no data present)
Max. Supply (Will be null if no data is present)
Total current locked token amount
Total current TBD locked token amount
Total current unlocked token amount
Total current untracked token amount
Data set identifier for standard allocation dataset
Link to Tokenomist token page
Last updated date of token
Copy
curl -X 'GET' \
'https://api.unlocks.app/v1/token/list' \
-H 'x-api-key: $YOUR_API_KEY'
Copy
{
"metadata": {
"queryDate": "2024-08-19T11:50:53Z"
},
"status": true,
"data": [
{
"id": "optimism",
"name": "Optimism",
"symbol": "OP",
"circulatingSupply": 1187596466,
"marketCap": 1603255229.1000001,
"maxSupply": 4294967296,
"totalLockedAmount": 856358024.1999991,
"tbdLockedAmount": 2231937452,
"unlockedAmount": 1206671819.0000002,
"untrackedAmount": 0.8000006675720215,
"hasStandardAllocation": true,
"websiteUrl": "https://token.unlocks.app/optimism",
"lastUpdatedDate": "2024-06-18T09:07:49Z"
}
]
}
⌘I