📔Token List API

Overview

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.

Getting Started

Base URL

https://api.unlocks.app

Authentication

Provide your api key in the x-api-key header.

GET https://api.unlocks.app/v1/token/list
HEADER: x-api-key: <YOUR_API_KEY>

Endpoints: Token List

Parameters

No parameters required.

Example:

curl -X 'GET' \
  'https://api.unlocks.app/v1/token/list' \
  -H 'x-api-key: $YOUR_API_KEY'

Response

{
    "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"
        },
        {
            "id": "arbitrum",
            "name": "Arbitrum",
            "symbol": "ARB",
            "circulatingSupply": 3339278542,
            "marketCap": 1767580310.63686,
            "maxSupply": 10000000000,
            "totalLockedAmount": 3337041635.2724714,
            "tbdLockedAmount": 3403750000,
            "unlockedAmount": 3259208364.7275305,
            "untrackedAmount": 0,
            "hasStandardAllocation": true,
            "websiteUrl": "https://token.unlocks.app/arbitrum",
            "lastUpdatedDate": "2024-06-11T08:49:27Z"
        },
        {
            "id": "aptos",
            "name": "Aptos",
            "symbol": "APT",
            "circulatingSupply": 483688317.525007,
            "marketCap": 2815066007.995541,
            "maxSupply": null,
            "totalLockedAmount": 621184773.949999,
            "tbdLockedAmount": 0,
            "unlockedAmount": 378815226.04999995,
            "untrackedAmount": 0,
            "hasStandardAllocation": true,
            "websiteUrl": "https://token.unlocks.app/aptos",
            "lastUpdatedDate": "2024-06-11T07:03:20Z"
        },
        ....
    ]
}

The response includes time series data with the date (in UTC timezone), with granularity at the level of week.

Return Fields Explanation

Fields	Data Type	Description
id	string	Identifier to call for a dataset
name	string	Token Name
symbol	string	Token Symbol
circulatingSupply	number	Circulating supply of the token provided by external source (Will be null if no data present)
marketCap	number	Market cap of the token provided by external source (Will be null if no data present)
maxSupply	number	Max. Supply (Will be null if no data is present)
totalLockedAmount	number	Total current locked token amount
tbdLockedAmount	number	Total current TBD locked token amount
unlockedAmount	number	Total current unlocked token amount
untrackedAmount	number	Total current untracked token amount
hasStandardAllocation	boolean	Data set identifier for standard allocation dataset
websiteUrl	string	Link to TokenUnlocks token page
lastUpdatedDate	timestamp	Last updated date of token