Unlock Events API v4

⬆️ v4 update: Show only cliff unlocks, remove start of Linear unlocks and unlocks event with mining rewards and yield farming distribution methods. See below link for definition of Release Mechanism

📦Release Mechanism

Getting Started

Base URL

https://api.unlocks.app

Authentication

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

GET https://api.unlocks.app/v4/unlock/events
HEADER: x-api-key: <YOUR_API_KEY>

Parameters

Note: tokenID needs to be specified.

• tokenId (required): Get tokenId from Token List API

• start (optional): The start date for time filtering in the format YYYY-MM-DD. Defaults is the earliest available date.

• end (optional): The end date for time filtering in the format YYYY-MM-DD. Defaults is the furthest available date.

Example:

curl -X 'GET' \
  'https://api.unlocks.app/v4/unlock/events?tokenId=arbitrum' \
  -H 'x-api-key: $YOUR_API_KEY'

Response

{
    "metadata": {
        "queryDate": "2024-08-20T08:19:20Z"
    },
    "status": true,
    "data": [
        {
            "unlockDate": "2024-09-16T13:00:00Z",
            "tokenName": "Arbitrum",
            "tokenSymbol": "ARB",
            "listedMethod": "INTERNAL",
            "dataSource": "Whitepaper",
            "linearUnlocks": null,
            "cliffUnlocks": {
                "cliffAmount": 92645833.29999995,
                "cliffValue": 49929711.58620228,
                "valueToMarketCap": 2.7744266354166256,
                "allocationBreakdown": [
                    {
                        "unlockDate": "2024-09-16T13:00:00Z",
                        "allocationName": "Investors",
                        "standardAllocationName": "Private Investors",
                        "cliffAmount": 36520833.29999995,
                        "cliffValue": 19682209.211202275,
                        "referencePrice": 0.538931,
                        "referencePriceUpdatedTime": "2024-08-19T07:30:24Z",
                        "unlockPrecision": "month"
                    },
                    {
                        "unlockDate": "2024-09-16T13:00:00Z",
                        "allocationName": "Team, Future Team + Advisors",
                        "standardAllocationName": "Founder / Team",
                        "cliffAmount": 56125000,
                        "cliffValue": 30247502.375000004,
                        "referencePrice": 0.538931,
                        "referencePriceUpdatedTime": "2024-08-19T07:30:24Z",
                        "unlockPrecision": "month"
                    }
                ]
            },
            "latestUpdateDate": "2024-06-11T08:49:27Z"
        },
        ...
    ]
}

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

Return Fields Explanation

Fields	Data Type	Description
unlockDate	timestamp	Date of the Unlock Event
tokenName	string	Token Name
tokenSymbol	string	Token Symbol
listedMethod	string	Human/AI
dataSource	string	Data Source of the Token
cliffUnlocks	object array	Cliff Unlocks in this unlock event
latestUpdateDate	timestamp	Unlocks Data Latest Update time

Return Fields Explanation: Cliff Unlocks

Fields	Data Type	Description
cliffAmount	number	Total Unlock Amount Denominated in token
cliffValue	number	Total Unlock Value Denominated in USD
valueToMarketCap	number	Value / M.Cap in Percentage
allocationBreakdown	object array	Allocation Breakdown

Return Fields Explanation: Cliff Allocation Breakdown

Fields	Data Type	Description
unlockDate	timestamp	Cliff unlock date
allocationName	string	Allocation Name
standardAllocationName	string	Standard allocation of this allocation
cliffAmount	number	Unlock Amount Denominated in Token
cliffValue	number	Unlock Value Denominated in USD
referencePrice	number	Reference Price used in total unlocks value calculation
referencePriceUpdatedTime	timestamp	Reference Price Last Updated Time
unlockPrecision	string	Precision of Unlock. Example: second, hour, day, week, unknown(for AI listed token only), etc