> ## Documentation Index > Fetch the complete documentation index at: https://docs.arrays.org/llms.txt > Use this file to discover all available pages before exploring further. # Get Token Unlock Events > [OpenAPI JSON Spec](/docs/output/v1_crypto_unlock-events_get.json) Retrieve token unlock events for a specific token **Feature Overview** Get token unlock schedule and events including cliff unlocks and linear unlocks. **Main Use Cases** - **Token Analysis**: Understand token unlock schedules for investment decisions - **Market Impact**: Analyze potential market impact from upcoming unlocks - **Portfolio Management**: Track unlock events for tokens in your portfolio - **Research**: Research tokenomics and vesting schedules **Response Data Structure** Each unlock event includes: - **unlock_date**: ISO 8601 date string of the unlock event - **token_name**: Full name of the token (e.g., "Arbitrum") - **token_symbol**: Token symbol (e.g., "ARB") - **listed_method**: Method of listing (e.g., "INTERNAL") - **data_source**: Source of the data (e.g., "Whitepaper") - **linear_unlocks**: Linear unlock data (can be null) - **cliff_unlocks**: Cliff unlock data (can be null) - **latest_update_date**: When the data was last updated **Unlock Types** - **Cliff Unlocks**: One-time unlock of tokens at a specific date - **Linear Unlocks**: Gradual unlock of tokens over a period **Allocation Breakdown** Each unlock type includes allocation breakdown with: - **allocation_name**: Name of the allocation (e.g., "Investors") - **standard_allocation_name**: Standardized name (e.g., "Private Investors") - **cliff_amount**: Amount of tokens - **cliff_value**: Value in USD - **reference_price**: Reference price used for calculation - **unlock_precision**: Precision of unlock (e.g., "month", "day") **Usage Examples** 1. **Get all unlock events for Arbitrum**: `?token_id=arbitrum` 2. **Get unlock events for a specific date range**: `?token_id=arbitrum&start=2024-01-01&end=2024-12-31` 3. **Get unlock events for Optimism**: `?token_id=optimism` **Important Notes** - token_id is required - start and end dates are optional (format: YYYY-MM-DD) - linear_unlocks and cliff_unlocks can be null if not applicable ## OpenAPI ````yaml /api-reference/openapi.json get /v1/crypto/unlock-events openapi: 3.0.0 info: contact: {} description: >- Welcome to Arrays! Arrays is a unified financial data layer for both financial institutions and retail users, delivering comprehensive market data across crypto and equity markets. Our datasets cover fundamentals, ETFs, options, crypto, and more. Visit [arrays.org](https://arrays.org) to request an API key and start your free trial. You can explore our full API offerings in the documentation below. For any questions regarding APIs or pricing, please contact support@arrays.org. title: Arrays API version: '1.0' servers: - url: https://data-tools.prd.arrays.org/api security: [] paths: /v1/crypto/unlock-events: get: tags: - Crypto summary: Get Token Unlock Events description: >- [OpenAPI JSON Spec](/docs/output/v1_crypto_unlock-events_get.json) Retrieve token unlock events for a specific token **Feature Overview** Get token unlock schedule and events including cliff unlocks and linear unlocks. **Main Use Cases** - **Token Analysis**: Understand token unlock schedules for investment decisions - **Market Impact**: Analyze potential market impact from upcoming unlocks - **Portfolio Management**: Track unlock events for tokens in your portfolio - **Research**: Research tokenomics and vesting schedules **Response Data Structure** Each unlock event includes: - **unlock_date**: ISO 8601 date string of the unlock event - **token_name**: Full name of the token (e.g., "Arbitrum") - **token_symbol**: Token symbol (e.g., "ARB") - **listed_method**: Method of listing (e.g., "INTERNAL") - **data_source**: Source of the data (e.g., "Whitepaper") - **linear_unlocks**: Linear unlock data (can be null) - **cliff_unlocks**: Cliff unlock data (can be null) - **latest_update_date**: When the data was last updated **Unlock Types** - **Cliff Unlocks**: One-time unlock of tokens at a specific date - **Linear Unlocks**: Gradual unlock of tokens over a period **Allocation Breakdown** Each unlock type includes allocation breakdown with: - **allocation_name**: Name of the allocation (e.g., "Investors") - **standard_allocation_name**: Standardized name (e.g., "Private Investors") - **cliff_amount**: Amount of tokens - **cliff_value**: Value in USD - **reference_price**: Reference price used for calculation - **unlock_precision**: Precision of unlock (e.g., "month", "day") **Usage Examples** 1. **Get all unlock events for Arbitrum**: `?token_id=arbitrum` 2. **Get unlock events for a specific date range**: `?token_id=arbitrum&start=2024-01-01&end=2024-12-31` 3. **Get unlock events for Optimism**: `?token_id=optimism` **Important Notes** - token_id is required - start and end dates are optional (format: YYYY-MM-DD) - linear_unlocks and cliff_unlocks can be null if not applicable parameters: - description: Token identifier (e.g., arbitrum, optimism, sui) in: query name: token_id required: true schema: type: string - description: Start date (YYYY-MM-DD format) in: query name: start schema: type: string - description: End date (YYYY-MM-DD format) in: query name: end schema: type: string responses: '200': description: Successfully retrieved unlock events content: application/json: schema: allOf: - $ref: '#/components/schemas/model.APIResponse' - properties: data: items: $ref: '#/components/schemas/model.UnlockEvent' type: array type: object '400': description: Invalid parameters content: application/json: schema: allOf: - $ref: '#/components/schemas/model.APIResponse' - properties: error: $ref: '#/components/schemas/model.APIError' type: object '404': description: Token not found content: application/json: schema: allOf: - $ref: '#/components/schemas/model.APIResponse' - properties: error: $ref: '#/components/schemas/model.APIError' type: object '500': description: Internal server error content: application/json: schema: allOf: - $ref: '#/components/schemas/model.APIResponse' - properties: error: $ref: '#/components/schemas/model.APIError' type: object security: - ApiKeyAuth: [] components: schemas: model.APIResponse: properties: data: {} error: $ref: '#/components/schemas/model.APIError' metadata: {} pagination: {} request_id: type: string success: type: boolean type: object model.UnlockEvent: properties: cliff_unlocks: allOf: - $ref: '#/components/schemas/model.CliffUnlocks' description: Cliff unlock data (can be null) data_source: description: e.g., "Whitepaper" type: string latest_update_date: description: When data was last updated type: string linear_unlocks: allOf: - $ref: '#/components/schemas/model.LinearUnlocks' description: Linear unlock data (can be null) listed_method: description: e.g., "INTERNAL" type: string token_name: description: e.g., "Arbitrum" type: string token_symbol: description: e.g., "ARB" type: string unlock_date: description: ISO 8601 date string type: string type: object model.APIError: properties: code: example: RESOURCE_NOT_FOUND type: string details: items: $ref: '#/components/schemas/model.APIErrorDetail' type: array docs_url: type: string examples: items: type: string type: array hint: type: string message: example: The requested resource was not found. type: string suggestions: items: type: string type: array type: object model.CliffUnlocks: properties: allocation_breakdown: description: Breakdown by allocation items: $ref: '#/components/schemas/model.AllocationBreakdown' type: array cliff_amount: description: Total cliff amount type: number cliff_value: description: Total cliff value in USD type: number value_to_market_cap: description: Percentage of market cap type: number type: object model.LinearUnlocks: properties: allocation_breakdown: description: Breakdown by allocation items: $ref: '#/components/schemas/model.AllocationBreakdown' type: array linear_amount: description: Total linear amount type: number linear_value: description: Total linear value in USD type: number value_to_market_cap: description: Percentage of market cap type: number type: object model.APIErrorDetail: properties: field: type: string got: type: string reason: type: string type: object model.AllocationBreakdown: properties: allocation_name: description: e.g., "Investors", "Team, Future Team + Advisors" type: string cliff_amount: description: Amount of tokens in this allocation type: number cliff_value: description: Value in USD type: number reference_price: description: Reference price used for calculation type: number reference_price_updated_time: description: When reference price was updated type: string standard_allocation_name: description: e.g., "Private Investors", "Founder / Team" type: string unlock_date: description: ISO 8601 date string type: string unlock_precision: description: e.g., "MONTH", "DAY" type: string type: object securitySchemes: ApiKeyAuth: description: 'API Key authentication. Example: "your-api-key-here"' in: header name: X-API-Key type: apiKey ````