Skip to main content
GET
/
v3
/
currencies
/
{id}
/
vesting
/
events
Unlock Events
curl --request GET \
  --url https://api.cryptorank.io/v3/currencies/{id}/vesting/events \
  --header 'X-Api-Key: <api-key>'
[
  {
    "time": 1715000000000,
    "allocationName": "Private Sale Investors",
    "unlockTokens": "125000",
    "percentOfTotalSupply": 0.08,
    "unlock": "462500",
    "percentOfMcap": 0.42,
    "percentOfAllocation": 1.37,
    "cumulativeUnlockedPercent": 84,
    "cumulativeUnlockedTokens": "527400000",
    "cumulativeUnlocked": "36370000000"
  }
]
Filterable by all / upcoming / past. Amounts are in the project’s native token; USD figures use the current price.

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
id
integer
required

Numeric coin id.

Example:

1

Query Parameters

​
page
number
default:1

Page number (1-based). Returns up to 50 items per page.

Required range: 1 <= x <= 1000
​
filter
enum<string>
default:upcoming

Limit events to upcoming or past ones, or return the full history.

Available options:
all,
upcoming,
past
​
sortBy
enum<string>
default:time
Available options:
time,
unlock,
percentOfMcap
​
sortOrder
enum<string>
default:asc
Available options:
asc,
desc
​
convert
enum<string>
default:USD

Fiat currency for unlock-value conversion (default USD).

Available options:
EUR,
USD

Response

​
time
number
required

Unlock date — Unix milliseconds (start of day, UTC).

Example:

1715000000000

​
allocationName
string
required

Allocation (round) name.

Example:

"Private Sale Investors"

​
unlockTokens
string
required

Tokens unlocked by this event (raw token units).

Example:

"125000"

​
percentOfTotalSupply
number
required

Unlock token amount as a percent of total supply (max supply with a fallback to total supply).

Example:

0.08

​
unlock
string | null
required

Unlock value at the current price in the convert currency, rounded to a whole amount. null when the coin price is unavailable.

Example:

"462500"

​
percentOfMcap
number | null
required

Unlock token amount as a percent of market cap (current circulating supply). null when circulating supply is unavailable.

Example:

0.42

​
percentOfAllocation
number
required

Percent of the allocation released by this event.

Example:

1.37

​
cumulativeUnlockedPercent
number
required

Share of total supply unlocked after this event, %.

Example:

84

​
cumulativeUnlockedTokens
string
required

Total tokens unlocked after this event (raw token units).

Example:

"527400000"

​
cumulativeUnlocked
string | null
required

Value of the cumulative unlocked tokens at the current price in the convert currency, rounded to a whole amount. null when the coin price is unavailable.

Example:

"36370000000"