📈Unlock Events API

Available for Elite API users only.

Overview

Unlock Events API includes 60 days of future events for all tokens from the current date. Unlock event includes cliff and linear unlocks start date. This dataset is the only dataset with timestamp information of the unlocks

This does not include linear unlocks rate change event and excludes ongoing linear unlocks.

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/unlock/events
HEADER: x-api-key: <YOUR_API_KEY>

Endpoints: Allocations

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 to the earliest available date.

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

Example:

curl -X 'GET' \
  'https://api.unlocks.app/v1/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",
            "dataSource": "Whitepaper",
            "linearUnlocks": null,
            "cliffUnlocks": {
                "cliffAmount": 92645833.29999995,
                "cliffValue": 49929711.58620228,
                "referencePrice": 0.538931,
                "referencePriceUpdatedTime": "2024-08-19T07:30:24Z",
                "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
dataSource	string	Data Source of the Token
linearUnlocks	object array	Linear Unlocks in this unlock event
cliffUnlocks	object array	Cliff Unlocks in this unlock event
latestUpdateDate	timestamp	Unlocks Data Latest Update time

Return Fields Explanation: Linear Unlocks

Fields	Data Type	Description
linearAmount	number	Linear Unlocks Amount Denominated in Token
linearValue	number	Linear Unlocks Amount Denominated in USD
dailyAmount	number	Daily Linear Unlocks Amount Denominated in Token
dailyValue	number	Daily Linear Unlocks Amount Denominated in USD
referencePrice	number	Reference Price used in daily value calculation
referencePriceUpdatedTime	timestamp	Reference Price Last Updated Time
allocationBreakdown	object array	Unlocks data breakdown by each allocation
allocationName	string	Allocation Name
standardAllocationName	string	Standard allocation of this allocation
linearAmount	number	Total Linear Unlocks Amount in token
linearValue	number	Total Linear Unlocks Value in USD
durationOfRate	number	Duration of Linear Rate
beginDate	timestamp	Begin date of the linear unlock
endDate	timestamp	End date of the linear unlock
unlockPrecision	string	Precision of Unlock. Example: second, hour, day, week etc

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
referencePrice	number	Reference Price used in total unlocks value calculation
referencePriceUpdatedTime	timestamp	Reference Price Last Updated Time
valueToMarketCap	number	Value / M.Cap in Percentage
allocationBreakdown	object array	Allocation Breakdown
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
unlockPrecision	string	Precision of Unlock. Example: second, hour, day, week etc