Skip to main content
GET
/
v3
/
currencies
/
{id}
/
vesting
/
events
Currency vesting events
curl --request GET \
  --url https://api.cryptorank.io/v3/currencies/{id}/vesting/events \
  --header 'X-Api-Key: <api-key>'
[
  {
    "date": 1715000000000,
    "type": "linear-tick",
    "allocationName": "Private Sale Investors",
    "tokenAmount": "125000",
    "usdAmount": "462500",
    "percentOfSupply": 0.1234,
    "percentOfMcap": 0.42,
    "isPast": false
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.cryptorank.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
id
integer
required

Numeric coin id.

Example:

1

Query Parameters

​
offset
number
default:0
Required range: 0 <= x <= 50000
​
limit
number
default:100
Required range: 1 <= x <= 500
​
from
string

Range start, inclusive (ISO 8601 or Unix timestamp). Filters events by date.

Example:

"2025-01-01"

​
to
string

Range end, inclusive (ISO 8601 or Unix timestamp). Filters events by date.

Example:

"2030-01-01"

​
type
enum<string>

Filter events by type.

Available options:
cliff,
linear-start,
linear-tick,
dynamic

Response

​
date
number
required

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

Example:

1715000000000

​
type
enum<string>
required

Event type. linear-start — TGE unlock of a linear allocation. linear-tick — periodic unlock of a linear allocation. cliff — single non-linear unlock. dynamic — event on an allocation with a dynamic vesting schedule.

Available options:
cliff,
linear-start,
linear-tick,
dynamic
Example:

"linear-tick"

​
allocationName
string
required
Example:

"Private Sale Investors"

​
tokenAmount
string
required

Tokens unlocked on date for this allocation (raw token units).

Example:

"125000"

​
usdAmount
string | null
required

USD value of the unlock — tokenAmount * current price, rounded to whole dollars. null when the coin price is unavailable.

Example:

"462500"

​
percentOfSupply
number
required

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

Example:

0.1234

​
percentOfMcap
object
required

Unlock token amount as a percent of current circulating supply. null when circulating supply is unavailable.

Example:

0.42

​
isPast
boolean
required

true when date is before today (UTC).

Example:

false