Skip to main content
GET
Unlock Events List v5
Cliff unlock events of every token between minUnlockDate and maxUnlockDate, grouped by token and sorted by tokenId. Both dates default to your plan’s window, counted from today. Use the filters to keep large or high-impact unlocks only. For one token’s events, use Unlock Events v5.

Authorizations

x-api-key
string
header
required

Your Tokenomist API key

Query Parameters

minUnlockDate
string<date>

Earliest unlock date (YYYY-MM-DD). Defaults to the start of your plan's window (today minus its years back). Outside the window: 422 "unlock date must be within the allowed range: A to B".

maxUnlockDate
string<date>

Latest unlock date (YYYY-MM-DD) = 00:00 UTC that day: an unlock at exactly 00:00 is included, a later one that day is not. Defaults to the end of your plan's window (today plus its years ahead). Outside the window, or before minUnlockDate: 422.

minMarketCap
number

Minimum current market cap, in USD. When set, tokens without a market cap are left out.

minReleasedPercentage
number

Minimum releasedPercentage of the token, in percent (0-100).

minTotalUnlockAmount
number

Keep only events whose totalCliffAmount is at least this many tokens (not USD).

minValueToMarketCap
number

Keep only events whose valueToMarketCap is at least this percent (5 means 5%). When set, events without a market cap are left out.

standardAllocation
string

Comma-separated standard allocations to keep. Allowed values: community, founderTeam, privateInvestors, publicInvestors, others, reserve; another value: 422. An event without a matching allocation is dropped; totalCliffAmount and totalCliffValue are recalculated from the kept allocations, valueToMarketCap is not.

page
integer

Page number, 1-based. 0 or omitted: page 1. A page past the last returns the last page again, so stop at metadata.totalPages. Negative: 400.

Required range: x >= 0
pageSize
integer

Rows per page. 0 or omitted: 20. No maximum. Negative: 400.

Required range: x >= 0

Response

Successful response

metadata
object
status
boolean
data
object[]