> ## 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. # Unlock Events > Chronological list of token unlock events for a currency.

Available from: Pro
Cost: 1 credit per request Filterable by all / upcoming / past. Amounts are in the project's native token; USD figures use the current price. ## OpenAPI ````yaml https://api.cryptorank.io/v3/documentation-json get /v3/currencies/{id}/vesting/events openapi: 3.0.0 info: title: Cryptorank API V3 description: > # Overview Cryptorank Public API v3 — comprehensive cryptocurrency data for B2B clients and partners. Useful Links: - [API Plans](https://cryptorank.io/public-api) - [Dashboard](https://cryptorank.io/public-api/dashboard) # Getting Started Primary Server URL: [https://api.cryptorank.io/v3/](https://api.cryptorank.io/v3/) **Authentication** Generate an API key in the [dashboard](https://cryptorank.io/public-api/dashboard) and pass it in the `X-Api-Key` header. Keep your keys secret — never commit them to public repositories or expose them in client-side code. version: 3.0.0 contact: name: Cryptorank Team url: https://cryptorank.io email: info@cryptorank.io servers: - url: https://api.cryptorank.io security: [] tags: [] paths: /v3/currencies/{id}/vesting/events: get: tags: - Vesting & Token Unlocks summary: Unlock Events description: >- **Description** Chronological list of token unlock events for a currency. > **Note:** Filterable by all / upcoming / past. Amounts are in the project's native token; USD figures use the current price. **Access** - Available from: **Pro** - Cost: 1 credit per request operationId: VestingController_getVestingEvents parameters: - name: id required: true in: path description: Numeric coin id. schema: example: 1 type: integer - name: page required: false in: query description: Page number (1-based). Returns up to 50 items per page. schema: minimum: 1 maximum: 1000 default: 1 type: number - name: filter required: false in: query description: Limit events to upcoming or past ones, or return the full history. schema: default: upcoming type: string enum: - all - upcoming - past - name: sortBy required: false in: query description: Sort field. schema: default: time type: string enum: - time - unlockValue - percentOfMcap - name: sortOrder required: false in: query description: Sort direction. schema: default: asc type: string enum: - asc - desc - name: convert required: false in: query description: Fiat currency for unlock-value conversion (default USD). schema: default: USD type: string enum: - EUR - USD responses: '200': description: '' content: application/json: schema: type: object required: - data - meta - status properties: data: type: array items: $ref: '#/components/schemas/CurrencyVestingEventItemDto' meta: $ref: '#/components/schemas/ListMetaDto' status: $ref: '#/components/schemas/ResponseStatusDto' '400': description: Request validation failed content: application/json: schema: type: object required: - error properties: error: type: object required: - code - message - status properties: code: type: string enum: - VALIDATION_ERROR example: VALIDATION_ERROR message: type: string example: Validation failed status: type: number example: 400 '401': description: API key is missing or invalid content: application/json: schema: type: object required: - error properties: error: type: object required: - code - message - status properties: code: type: string enum: - API_KEY_MISSING - API_KEY_INVALID example: API_KEY_MISSING message: type: string example: API key is missing status: type: number example: 401 '403': description: >- No active subscription, the endpoint is not available in your plan, or the request goes beyond what your plan allows content: application/json: schema: type: object required: - error properties: error: type: object required: - code - message - status properties: code: type: string enum: - NO_ACTIVE_SUBSCRIPTION - ENDPOINT_NOT_AVAILABLE - PLAN_LIMIT_EXCEEDED example: NO_ACTIVE_SUBSCRIPTION message: type: string example: No active subscription found status: type: number example: 403 '404': description: Currency not found content: application/json: schema: type: object required: - error properties: error: type: object required: - code - message - status properties: code: type: string enum: - NOT_FOUND example: NOT_FOUND message: type: string example: Resource not found status: type: number example: 404 '429': description: Rate limit or credit limit exceeded content: application/json: schema: type: object required: - error properties: error: type: object required: - code - message - status properties: code: type: string enum: - RATE_LIMIT_EXCEEDED - DAILY_CREDITS_EXCEEDED - MONTHLY_CREDITS_EXCEEDED example: RATE_LIMIT_EXCEEDED message: type: string example: Rate limit exceeded status: type: number example: 429 '500': description: Internal server error content: application/json: schema: type: object required: - error properties: error: type: object required: - code - message - status properties: code: type: string enum: - INTERNAL_ERROR example: INTERNAL_ERROR message: type: string example: Internal server error status: type: number example: 500 security: - X-Api-Key: [] components: schemas: CurrencyVestingEventItemDto: type: object properties: time: type: number example: 1715000000000 description: Unlock date — Unix milliseconds (start of day, UTC). allocationName: type: string example: Private Sale Investors description: Allocation (round) name. unlockTokens: type: string example: '125000' description: Tokens unlocked by this event (raw token units). percentOfSupply: type: number example: 0.08 description: >- Unlock token amount as a percent of total supply (max supply with a fallback to total supply). unlockValue: type: string nullable: true example: '462500' description: >- Unlock value at the current price in the `convert` currency, rounded to a whole amount. `null` when the coin price is unavailable. percentOfMcap: type: number nullable: true example: 0.42 description: >- Unlock token amount as a percent of market cap (current circulating supply). `null` when circulating supply is unavailable. percentOfAllocation: type: number example: 1.37 description: Percent of the allocation released by this event. cumulativeUnlockedPercent: type: number example: 84 description: Share of total supply unlocked after this event, %. cumulativeUnlockedTokens: type: string example: '527400000' description: Total tokens unlocked after this event (raw token units). cumulativeUnlockedValue: type: string nullable: true example: '36370000000' description: >- 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. required: - time - allocationName - unlockTokens - percentOfSupply - unlockValue - percentOfMcap - percentOfAllocation - cumulativeUnlockedPercent - cumulativeUnlockedTokens - cumulativeUnlockedValue ListMetaDto: type: object properties: page: type: number example: 1 description: Current page number (1-based) pageSize: type: number example: 25 description: >- Fixed number of items per page for this endpoint (varies per endpoint) hasNextPage: type: boolean example: true description: Whether a further page of results exists required: - page - pageSize - hasNextPage ResponseStatusDto: type: object properties: usedCredits: type: number example: 1 description: Credits charged for this request timestamp: type: number example: 1780000000000 description: Server time of the response. Unix timestamp in milliseconds required: - usedCredits - timestamp securitySchemes: X-Api-Key: name: X-Api-Key type: apiKey in: header ````