> ## 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.

# Vesting Allocations

> Returns the unlock breakdown by allocation group (Team, Private Sale, …).<br/><br/>Available from&#58; <Badge color="orange">Pro</Badge><br/>Cost&#58; <Badge color="surface">1 credit per request</Badge>

> [!NOTE]
>
> By default only tracked allocations are returned. `includeUntracked=true` adds allocations without a known unlock schedule, with `isTracked: false` and null unlock fields. `groupDominance` = % of total locked across tracked allocations.


## OpenAPI

````yaml /openapi.json get /v3/currencies/{id}/vesting/allocations
openapi: 3.0.0
info:
  contact:
    email: info@cryptorank.io
    name: Cryptorank Team
    url: https://cryptorank.io
  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.
  title: Cryptorank API V3
  version: 3.0.0
servers:
  - url: https://api.cryptorank.io
security: []
tags: []
paths:
  /v3/currencies/{id}/vesting/allocations:
    get:
      tags:
        - Vesting & Token Unlocks
      summary: Vesting Allocations
      description: >-
        **Description**


        Returns the unlock breakdown by allocation group (Team, Private Sale,
        …).


        > **Note:** By default only tracked allocations are returned.
        `includeUntracked=true` adds allocations without a known unlock
        schedule, with `isTracked: false` and null unlock fields.
        `groupDominance` = % of total locked across tracked allocations.


        **Access**

        - Available from: **Pro**

        - Cost: 1 credit per request
      operationId: VestingController_getVestingAllocations
      parameters:
        - description: >-
            Coin ID. See: [GET
            /v3/currencies/map](https://docs.cryptorank.io/api-reference/currencies/currency-map-id-reference).
          in: path
          name: id
          required: true
          schema:
            example: 1
            type: integer
        - description: >-
            Include allocations without a known unlock schedule. They come with
            `isTracked: false` and null unlock/lock fields. Without it, a coin
            that has only such allocations returns 404.
          in: query
          name: includeUntracked
          required: false
          schema:
            default: false
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/CurrencyVestingAllocationItemDto'
                    type: array
                  status:
                    $ref: '#/components/schemas/ResponseStatusDto'
                required:
                  - data
                  - status
                type: object
          description: ''
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - VALIDATION_ERROR
                        example: VALIDATION_ERROR
                        type: string
                      message:
                        example: Validation failed
                        type: string
                      status:
                        example: 400
                        type: number
                    required:
                      - code
                      - message
                      - status
                    type: object
                required:
                  - error
                type: object
          description: Request validation failed
        '401':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - API_KEY_MISSING
                          - API_KEY_INVALID
                        example: API_KEY_MISSING
                        type: string
                      message:
                        example: API key is missing
                        type: string
                      status:
                        example: 401
                        type: number
                    required:
                      - code
                      - message
                      - status
                    type: object
                required:
                  - error
                type: object
          description: API key is missing or invalid
        '403':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - NO_ACTIVE_SUBSCRIPTION
                          - ENDPOINT_NOT_AVAILABLE
                          - PLAN_LIMIT_EXCEEDED
                        example: NO_ACTIVE_SUBSCRIPTION
                        type: string
                      message:
                        example: No active subscription found
                        type: string
                      status:
                        example: 403
                        type: number
                    required:
                      - code
                      - message
                      - status
                    type: object
                required:
                  - error
                type: object
          description: >-
            No active subscription, the endpoint is not available in your plan,
            or the request goes beyond what your plan allows
        '404':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - NOT_FOUND
                        example: NOT_FOUND
                        type: string
                      message:
                        example: Resource not found
                        type: string
                      status:
                        example: 404
                        type: number
                    required:
                      - code
                      - message
                      - status
                    type: object
                required:
                  - error
                type: object
          description: Currency not found
        '429':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - RATE_LIMIT_EXCEEDED
                          - DAILY_CREDITS_EXCEEDED
                          - MONTHLY_CREDITS_EXCEEDED
                        example: RATE_LIMIT_EXCEEDED
                        type: string
                      message:
                        example: Rate limit exceeded
                        type: string
                      status:
                        example: 429
                        type: number
                    required:
                      - code
                      - message
                      - status
                    type: object
                required:
                  - error
                type: object
          description: Rate limit or credit limit exceeded
        '500':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - INTERNAL_ERROR
                        example: INTERNAL_ERROR
                        type: string
                      message:
                        example: Internal server error
                        type: string
                      status:
                        example: 500
                        type: number
                    required:
                      - code
                      - message
                      - status
                    type: object
                required:
                  - error
                type: object
          description: Internal server error
      security:
        - X-Api-Key: []
components:
  schemas:
    CurrencyVestingAllocationItemDto:
      properties:
        allocationId:
          description: >-
            Allocation ID. Stable; the same allocation has the same allocationId
            in vesting events and schedule.
          example: 17132
          type: number
        allocationName:
          description: Allocation name (e.g. Team, Private Sale).
          example: Private Sale Investors
          type: string
        groupDominance:
          description: >-
            Share of this allocation in the total locked tokens across tracked
            allocations, %. Null for untracked allocations
            (includeUntracked=true).
          example: 12.35
          nullable: true
          type: number
        isTracked:
          description: >-
            Whether the allocation has a known unlock schedule. Always true
            unless includeUntracked=true. Untracked allocations have null
            unlock/lock fields and are excluded from groupDominance.
          example: true
          type: boolean
        lockedPercent:
          description: >-
            Share locked within the allocation, % of its totalTokens. Null for
            untracked allocations (includeUntracked=true).
          example: 66.67
          nullable: true
          type: number
        lockedTokens:
          description: >-
            Allocation tokens still locked. Null for untracked allocations
            (includeUntracked=true).
          example: '10000000'
          nullable: true
          type: string
        nextUnlockDate:
          description: >-
            Closest upcoming unlock date for this allocation (ISO 8601 UTC).
            Null when no upcoming unlock.
          example: '2026-07-01T00:00:00.000Z'
          nullable: true
          type: string
        nextUnlockTokenAmount:
          description: Tokens in the closest upcoming unlock for this allocation.
          example: '125000'
          nullable: true
          type: string
        nextUnlockValue:
          description: USD value of the closest upcoming unlock (tokens × current price).
          example: '8125000'
          nullable: true
          type: string
        percentOfSupply:
          description: Allocation size relative to total supply, in percent.
          example: 15
          nullable: true
          type: number
        totalTokens:
          description: Allocation size — total tokens in this category.
          example: '15000000'
          type: string
        unlockedAmount:
          description: >-
            Tokens already unlocked in this allocation. Null for untracked
            allocations (includeUntracked=true).
          example: '5000000'
          nullable: true
          type: string
        unlockedPercent:
          description: >-
            Share unlocked within the allocation, % of its totalTokens. Null for
            untracked allocations (includeUntracked=true).
          example: 33.33
          nullable: true
          type: number
        vestingType:
          description: >-
            Allocation vesting schedule type. Null for untracked allocations
            (includeUntracked=true).
          enum:
            - linear
            - nonlinear
            - dynamic
          example: linear
          nullable: true
          type: string
      required:
        - allocationId
        - allocationName
        - isTracked
        - totalTokens
        - percentOfSupply
        - unlockedAmount
        - unlockedPercent
        - lockedTokens
        - lockedPercent
        - groupDominance
        - nextUnlockDate
        - nextUnlockTokenAmount
        - nextUnlockValue
        - vestingType
      type: object
    ResponseStatusDto:
      properties:
        timestamp:
          description: Server time of the response. Unix timestamp in milliseconds
          example: 1780000000000
          type: number
        usedCredits:
          description: Credits charged for this request
          example: 1
          type: number
      required:
        - usedCredits
        - timestamp
      type: object
  securitySchemes:
    X-Api-Key:
      in: header
      name: X-Api-Key
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.