> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blockworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Allocations

> Allocation totals for an asset, broken down by recipient, with the analyst notes and citations behind each tranche.



## OpenAPI

````yaml api-reference/token-unlocks/openapi.json GET /token-unlocks/v1/allocations
openapi: 3.0.0
info:
  title: Blockworks Token Unlocks API
  description: OpenAPI specification for the Blockworks Token Unlocks API.
  version: 1.0.0
servers:
  - url: https://api.blockworks.com
    description: Blockworks API
security:
  - apiKey: []
tags:
  - name: Assets
    description: Coverage, unlock events, and the two timeseries views.
  - name: Allocations
    description: Who holds what, and how much of it has unlocked.
paths:
  /token-unlocks/v1/allocations:
    get:
      tags:
        - Allocations
      summary: Get allocations
      description: >-
        Allocation totals for one asset, broken down by recipient, with the
        analyst description, assumptions, and citations behind each tranche.
        This is the snapshot view: how much was allocated, how much has
        unlocked, and how much is left.
      operationId: getAllocationsByAssetIDs
      parameters:
        - name: assetId
          in: query
          description: Asset to look up. Accepts a slug (`solana`) or the asset UUID.
          schema:
            type: string
            example: solana
          required: true
      responses:
        '200':
          description: >-
            Allocation aggregates for the asset. `data` is `null` when the asset
            has no unlock coverage.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    nullable: true
                    description: '`null` on success.'
                  data:
                    type: array
                    nullable: true
                    items:
                      $ref: '#/components/schemas/AllocationAggregate'
                required:
                  - data
              example:
                error: null
                data:
                  - asset:
                      id: 97775be0-2608-4720-b7af-f85b24c7eb2d
                      name: XRP
                      slug: xrp
                      symbol: XRP
                    genesisDate: '2012-06-01T00:00:00Z'
                    projectedEndDate: '2022-06-01T00:00:00Z'
                    totalAllocationUSD: 238697977801.6666
                    totalAllocationNative: 100000000000
                    cumulativeUnlockedUSD: 238697977801.6666
                    cumulativeUnlockedNative: 100000000000
                    unlocksRemainingUSD: 0
                    unlocksRemainingNative: 0
                    percentOfUnlocksCompleted: 1
                    allocationRecipientCount: 3
                    lastUpdatedAt: '2025-03-08T13:19:53.477266Z'
                    allocations:
                      - allocationRecipient: Founders
                        totalAllocationUSD: 47739595560.33332
                        totalAllocationNative: 20000000000
                        cumulativeUnlockedUSD: 47739595560.33332
                        cumulativeUnlockedNative: 20000000000
                        unlocksRemainingUSD: 0
                        unlocksRemainingNative: 0
                        percentOfUnlocksCompleted: 1
                        description: >-
                          20% allocated to founders. Chris Larsen and Jed
                          McCaleb recieved 9.5 billion XRP each and Aurthur
                          Britto recieved 1 billion XRP.
                        assumptions: ''
                        sources:
                          - sourceType: Third-party Website
                            source: >-
                              https://tokeninsight.com/en/coins/ripple/tokenomics
                      - allocationRecipient: Ripple
                        totalAllocationUSD: 190480986285.72995
                        totalAllocationNative: 79800000000
                        cumulativeUnlockedUSD: 190480986285.72995
                        cumulativeUnlockedNative: 79800000000
                        unlocksRemainingUSD: 0
                        unlocksRemainingNative: 0
                        percentOfUnlocksCompleted: 1
                        description: >-
                          79.8% allocated to Ripple. In December 2017 55 billion
                          XRP were escrowed, with 1 billion XRP released per
                          month.
                        assumptions: >-
                          Monthly unlocks on the first. Ripple is a private
                          company and not a foundation.
                        sources:
                          - sourceType: Third-party Website
                            source: >-
                              https://tokeninsight.com/en/coins/ripple/tokenomics
                      - allocationRecipient: Airdrop
                        totalAllocationUSD: 477395955.6033332
                        totalAllocationNative: 200000000
                        cumulativeUnlockedUSD: 477395955.6033332
                        cumulativeUnlockedNative: 200000000
                        unlocksRemainingUSD: 0
                        unlocksRemainingNative: 0
                        percentOfUnlocksCompleted: 1
                        description: 0.2% allocated to airdrop.
                        assumptions: ''
                        sources:
                          - sourceType: Third-party Website
                            source: >-
                              https://tokeninsight.com/en/coins/ripple/tokenomics
        '400':
          description: >-
            Malformed request, for example an `interval` outside the allowed set
            or an unparseable timestamp.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Missing or invalid API key, or a key without token unlock access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    AllocationAggregate:
      type: object
      description: Allocation totals for one asset, plus the per-recipient breakdown.
      properties:
        asset:
          $ref: '#/components/schemas/AssetBasic'
        genesisDate:
          type: string
          format: date-time
          description: Date the token's vesting timeline begins.
        projectedEndDate:
          type: string
          format: date-time
          description: Date the last scheduled unlock is projected to land.
        totalAllocationUSD:
          type: number
          format: double
          description: Total allocation across every recipient, valued in USD.
        totalAllocationNative:
          type: number
          format: double
          description: Total allocation across every recipient, in native units.
        cumulativeUnlockedUSD:
          type: number
          format: double
          description: Value unlocked to date across every recipient, in USD.
        cumulativeUnlockedNative:
          type: number
          format: double
          description: Tokens unlocked to date across every recipient, in native units.
        unlocksRemainingUSD:
          type: number
          format: double
          description: Value still locked across every recipient, in USD.
        unlocksRemainingNative:
          type: number
          format: double
          description: Tokens still locked across every recipient, in native units.
        percentOfUnlocksCompleted:
          type: number
          format: double
          description: >-
            Share of the total allocation already unlocked, as a decimal
            fraction from 0 to 1. `1` means the schedule has fully unlocked.
          example: 1
        allocationRecipientCount:
          type: integer
          format: int64
          description: Number of entries in `allocations`.
          example: 3
        lastUpdatedAt:
          type: string
          format: date-time
          description: When the analyst team last revised this asset's allocation model.
        allocations:
          type: array
          description: Per-recipient breakdown.
          items:
            $ref: '#/components/schemas/AllocationTranche'
      required:
        - asset
        - allocations
        - allocationRecipientCount
        - totalAllocationNative
        - cumulativeUnlockedNative
        - unlocksRemainingNative
        - percentOfUnlocksCompleted
    Error:
      type: object
      description: Failure envelope. `error` carries the message and `data` is `null`.
      properties:
        error:
          type: string
          description: Error message.
          example: invalid auth mechanism
        data:
          nullable: true
          description: Always `null` on failure.
      required:
        - data
    AssetBasic:
      type: object
      description: >-
        The asset an unlock payload belongs to. The `id` is the same asset UUID
        the Data API and Monitoring API use, so unlock data joins to the rest of
        the platform without a mapping table.
      properties:
        id:
          type: string
          format: uuid
          description: Asset UUID, shared across Blockworks APIs.
          example: b3d5d66c-26a2-404c-9325-91dc714a722b
        name:
          type: string
          description: Display name.
          example: Solana
        slug:
          type: string
          description: URL-safe identifier.
          example: solana
        symbol:
          type: string
          description: Ticker symbol.
          example: SOL
      required:
        - id
        - name
        - slug
        - symbol
    AllocationTranche:
      type: object
      description: >-
        One recipient's share of the total allocation, with the analyst notes
        and citations behind it.
      properties:
        allocationRecipient:
          type: string
          description: >-
            Recipient bucket, for example `Team`, `Community Reserve`, or
            `Coinlist Auction Sale`.
          example: Founders
        totalAllocationUSD:
          type: number
          format: double
          description: Total tokens allocated to this recipient, valued in USD.
        totalAllocationNative:
          type: number
          format: double
          description: Total tokens allocated to this recipient, in native units.
        cumulativeUnlockedUSD:
          type: number
          format: double
          description: Value unlocked to date, in USD.
        cumulativeUnlockedNative:
          type: number
          format: double
          description: Tokens unlocked to date, in native units.
        unlocksRemainingUSD:
          type: number
          format: double
          description: Value still locked, in USD.
        unlocksRemainingNative:
          type: number
          format: double
          description: Tokens still locked, in native units.
        percentOfUnlocksCompleted:
          type: number
          format: double
          description: >-
            Share of this recipient's allocation already unlocked, as a decimal
            fraction from 0 to 1.
          example: 1
        description:
          type: string
          description: >-
            Analyst description of the allocation. Empty string when none was
            recorded.
        assumptions:
          type: string
          description: >-
            Assumptions the analyst applied when modeling this tranche. Empty
            string when none were recorded.
        sources:
          type: array
          description: Citations backing the tranche.
          items:
            $ref: '#/components/schemas/AllocationSource'
      required:
        - allocationRecipient
        - totalAllocationNative
        - cumulativeUnlockedNative
        - unlocksRemainingNative
        - percentOfUnlocksCompleted
    AllocationSource:
      type: object
      description: Citation backing an allocation tranche.
      properties:
        sourceType:
          type: string
          description: >-
            Kind of source, for example `Third-party Website` or `Official
            Documentation`.
          example: Third-party Website
        source:
          type: string
          description: URL or reference for the source.
          example: https://tokeninsight.com/en/coins/ripple/tokenomics
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Blockworks-API-Key

````