> ## 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 Unlocks Timeseries

> Tokens unlocked per interval, in total and per recipient. The flow view of a vesting schedule.



## OpenAPI

````yaml api-reference/token-unlocks/openapi.json GET /token-unlocks/v1/assets/{assetId}/unlocks
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/assets/{assetId}/unlocks:
    get:
      tags:
        - Assets
      summary: Get unlocks timeseries
      description: >-
        How many tokens unlock per interval, in total and per recipient. This is
        the flow series: each snapshot covers one bucket and does not carry a
        running total. `interval` is required.
      operationId: getUnlocksTimeseries
      parameters:
        - name: assetId
          in: path
          description: Asset to look up. Accepts a slug (`solana`) or the asset UUID.
          schema:
            type: string
            example: solana
          required: true
        - name: interval
          in: query
          description: Bucket size the unlock amounts are aggregated to.
          schema:
            type: string
            enum:
              - DAILY
              - WEEKLY
              - MONTHLY
              - QUARTERLY
              - YEARLY
            example: MONTHLY
          required: true
        - name: startTime
          in: query
          description: RFC 3339 timestamp for the start of the window.
          schema:
            type: string
            format: date-time
            example: '2025-01-01T00:00:00Z'
        - name: endTime
          in: query
          description: >-
            RFC 3339 timestamp for the end of the window. Future dates are
            valid: the schedule is projected forward.
          schema:
            type: string
            format: date-time
            example: '2025-04-01T00:00:00Z'
      responses:
        '200':
          description: Interval-bucketed unlock flow for the asset.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    nullable: true
                    description: '`null` on success.'
                  data:
                    $ref: '#/components/schemas/Unlock'
                required:
                  - data
              example:
                error: null
                data:
                  asset:
                    id: b3d5d66c-26a2-404c-9325-91dc714a722b
                    name: Solana
                    slug: solana
                    symbol: SOL
                  genesisDate: '2020-04-07T00:00:00Z'
                  projectedEndDate: '2029-03-01T00:00:00Z'
                  startDate: '2020-04-07T00:00:00Z'
                  endDate: '2021-04-07T00:00:00Z'
                  interval: MONTHLY
                  totalSnapshots:
                    - timestamp: '2020-04-07T00:00:00Z'
                      unlockedInPeriodUSD: 1553853121.763593
                      unlockedInPeriodNative: 8225000
                    - timestamp: '2020-05-07T00:00:00Z'
                      unlockedInPeriodUSD: 1546768685.038227
                      unlockedInPeriodNative: 8187500
                    - timestamp: '2020-06-07T00:00:00Z'
                      unlockedInPeriodUSD: 1546768685.038227
                      unlockedInPeriodNative: 8187500
                  allocations:
                    - allocationRecipient: Team
                      dailySnapshots:
                        - timestamp: '2020-04-07T00:00:00Z'
                          unlockedInPeriodUSD: 0
                          unlockedInPeriodNative: 0
                        - timestamp: '2020-05-07T00:00:00Z'
                          unlockedInPeriodUSD: 0
                          unlockedInPeriodNative: 0
                        - timestamp: '2020-06-07T00:00:00Z'
                          unlockedInPeriodUSD: 0
                          unlockedInPeriodNative: 0
                    - allocationRecipient: Strategic Sale
                      dailySnapshots:
                        - timestamp: '2020-04-07T00:00:00Z'
                          unlockedInPeriodUSD: 0
                          unlockedInPeriodNative: 0
                        - timestamp: '2020-05-07T00:00:00Z'
                          unlockedInPeriodUSD: 0
                          unlockedInPeriodNative: 0
                        - timestamp: '2020-06-07T00:00:00Z'
                          unlockedInPeriodUSD: 0
                          unlockedInPeriodNative: 0
                    - allocationRecipient: Coinlist Auction Sale
                      dailySnapshots:
                        - timestamp: '2020-04-07T00:00:00Z'
                          unlockedInPeriodUSD: 1549130163.9466825
                          unlockedInPeriodNative: 8200000
                        - timestamp: '2020-05-07T00:00:00Z'
                          unlockedInPeriodUSD: 0
                          unlockedInPeriodNative: 0
                        - timestamp: '2020-06-07T00:00:00Z'
                          unlockedInPeriodUSD: 0
                          unlockedInPeriodNative: 0
        '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:
    Unlock:
      type: object
      description: Interval-bucketed unlock flow for one asset, in total and per recipient.
      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.
        startDate:
          type: string
          format: date-time
          description: Start of the returned window.
        endDate:
          type: string
          format: date-time
          description: End of the returned window.
        interval:
          type: string
          enum:
            - DAILY
            - WEEKLY
            - MONTHLY
            - QUARTERLY
            - YEARLY
          description: >-
            Bucket size the snapshots are aggregated to. Echoes the requested
            `interval`.
        totalSnapshots:
          type: array
          description: Unlock flow across every recipient, one entry per interval.
          items:
            $ref: '#/components/schemas/UnlockSnapshot'
        allocations:
          type: array
          description: >-
            The same series split by recipient. The per-recipient snapshots sum
            to `totalSnapshots`.
          items:
            $ref: '#/components/schemas/AllocationUnlockTranche'
      required:
        - asset
        - startDate
        - endDate
        - interval
        - totalSnapshots
        - allocations
    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
    UnlockSnapshot:
      type: object
      description: >-
        Tokens unlocked during a single interval. Flow, not a running total: use
        the vesting schedule for cumulative figures.
      properties:
        timestamp:
          type: string
          format: date-time
          description: Start of the interval.
        unlockedInPeriodUSD:
          type: number
          format: double
          description: Value unlocked during the interval, in USD.
        unlockedInPeriodNative:
          type: number
          format: double
          description: Tokens unlocked during the interval, in native units.
      required:
        - timestamp
        - unlockedInPeriodNative
    AllocationUnlockTranche:
      type: object
      description: Per-interval unlock flow for one recipient.
      properties:
        allocationRecipient:
          type: string
          description: Recipient bucket.
          example: Team
        dailySnapshots:
          type: array
          description: >-
            One entry per interval, on the same timestamps as `totalSnapshots`.
            Named `dailySnapshots` regardless of the `interval` requested.
          items:
            $ref: '#/components/schemas/UnlockSnapshot'
      required:
        - allocationRecipient
        - dailySnapshots
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Blockworks-API-Key

````