Blockworks Time Series API

openapi: 3.2.0
info:
  description: The Blockworks Data API is a unified, read-only REST interface to Blockworks' warehouse-modeled crypto dataset, powered by Messari's research and data infrastructure.
  title: Blockworks Data Timeseries API
  version: 0.1.0
servers:
- description: Blockworks API
  url: https://api.blockworks.com
security:
- apiKey: []
tags:
- description: 'Discovery of the timeseries models: one series per entity, as points at the granularities each model declares.'
  name: Time Series
paths:
  /query/timeseries/catalog:
    get:
      description: Returns the catalog of timeseries models and their columns. By default every model is listed; pass publicOnly=true to list only models published to the public API, or accessible=true to list only the models your key may query.
      operationId: getTimeseriesCatalog
      parameters:
      - description: When true, list only models published to the public API. Defaults to false, which lists every model.
        in: query
        name: publicOnly
        schema:
          default: false
          type: boolean
      - description: When true, list only the models this API key may query, by the same rules the data endpoints apply. Defaults to false, which lists every model whether or not it is queryable.
        in: query
        name: accessible
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TimeseriesCatalogResponse'
                  error:
                    type: string
                required:
                - data
                type: object
          description: Default response
      summary: Get timeseries catalog
      tags:
      - Time Series
      x-mint:
        metadata:
          sidebarTitle: Timeseries catalog
          title: Timeseries catalog
components:
  schemas:
    ModelEntity:
      properties:
        plural:
          type: string
        singular:
          type: string
      required:
      - plural
      - singular
      type: object
    TimeseriesCatalogResponse:
      properties:
        models:
          items:
            $ref: '#/components/schemas/TimeseriesModel'
          type: array
      required:
      - models
      type: object
    TimeseriesColumn:
      properties:
        description:
          type: string
        field:
          type: string
        name:
          type: string
        seriesKey:
          type: boolean
        time:
          type: boolean
        type:
          type: string
        unit:
          type: string
      required:
      - field
      - name
      - seriesKey
      - time
      - type
      type: object
    TimeseriesModel:
      properties:
        access:
          $ref: '#/components/schemas/ModelAccess'
        allowAllSeries:
          type: boolean
        columns:
          items:
            $ref: '#/components/schemas/TimeseriesColumn'
          type: array
        description:
          type: string
        entity:
          $ref: '#/components/schemas/ModelEntity'
        intervals:
          items:
            type: string
          type: array
        name:
          type: string
        slug:
          type: string
      required:
      - access
      - allowAllSeries
      - columns
      - entity
      - intervals
      - name
      - slug
      type: object
    ModelAccess:
      properties:
        permissionSlug:
          type: string
        tier:
          type: string
      required:
      - tier
      type: object
  securitySchemes:
    apiKey:
      description: API key sent in the `X-Blockworks-API-Key` header; `x-messari-api-key` is accepted for existing integrations. The catalog endpoints and models on the public access tier need no key.
      in: header
      name: X-Blockworks-API-Key
      type: apiKey
x-tagGroups:
- name: Meta
  tags:
  - Tabular
  - Timeseries
- name: Market Data
  tags:
  - Assets
  - Markets
  - Exchanges
  - Derivatives
  - Market Overview
- name: Blockchains
  tags:
  - Blockchains
- name: Projects & Protocols
  tags:
  - Projects & Entities
  - Protocol Revenue
  - Lending Protocols
  - Spot DEXes
  - Perp DEXes
  - Vaults
  - Launchpads
  - TCG Platforms
- name: Real World Assets
  tags:
  - Stablecoins
  - Tokenized Equities
  - Tokenized Commodities
- name: Institutional
  tags:
  - ETFs
  - Digital Asset Treasuries
- name: Fundraising
  tags:
  - Funding Rounds
  - Funds & Investors
  - Acquisitions
- name: Social & Mindshare
  tags:
  - Social & Mindshare
- name: News & Research
  tags:
  - News & Research
- name: Token Transparency Framework
  tags:
  - Token Transparency Framework