> ## 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 Token Transparency Filing

> One row per published Token Transparency Framework filing, keyed by filingID: project, filing type and version, schema, publish and filing dates, provenance, question and gap counts with a completion label, latest and superseded flags, status and the filing's page URL. Filter by project, ticker, type, status or date.



## OpenAPI

````yaml api-reference/data-api/openapi.json GET /query/tabular/token-transparency-filings/{filingID}
openapi: 3.0.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. It serves two kinds of models: tabular models,
    which return current, filterable, sortable rows for entities such as assets,
    networks, protocols, exchanges, stablecoins, and ETFs; and timeseries
    models, which return historical metric series at a chosen granularity for
    one or many entities. Every endpoint shares the same query grammar (column
    projection, per-column filters, sorting, and pagination) and returns the
    standard `{ "error": ..., "data": ... }` envelope. Authenticate by sending
    your API key in the `X-Blockworks-API-Key` header.
  title: Blockworks Data API
  version: 0.1.0
servers:
  - description: Blockworks API
    url: https://api.blockworks.com
security:
  - apiKey: []
tags:
  - description: 'Models documented under Acquisitions: Acquisition Deals (table).'
    name: Acquisitions
  - description: >-
      Models documented under Assets: Assets (table), Asset Marketcap
      (timeseries), Asset Price (timeseries), Asset Sharpe (timeseries), Asset
      Supply (timeseries), Asset Volatility (timeseries).
    name: Assets
  - description: >-
      Models documented under Blockchains: Blockchains (table), Blockchains
      (timeseries).
    name: Blockchains
  - description: >-
      Models documented under Derivatives: Perpetual Markets (table), Perpetual
      Markets (timeseries).
    name: Derivatives
  - description: >-
      Models documented under Digital Asset Treasuries: DAT Companies (table),
      DAT Company Assets (table), DAT Companies (timeseries), DAT Companies by
      Asset (timeseries).
    name: Digital Asset Treasuries
  - description: >-
      Models documented under ETFs: ETF Assets (table), ETF Providers (table),
      ETF Assets (timeseries), ETF Providers (timeseries).
    name: ETFs
  - description: >-
      Models documented under Exchanges: Exchange Country (timeseries), Exchange
      Region (timeseries), Exchange Type (timeseries), Exchanges (timeseries).
    name: Exchanges
  - description: >-
      Models documented under Funding Rounds: Funding Round Investors (table),
      Funding Rounds (table), Sector Fundraising (timeseries).
    name: Funding Rounds
  - description: >-
      Models documented under Funds & Investors: Fund Managers (table), Funds
      (table).
    name: Funds & Investors
  - description: >-
      Models documented under Launchpads: Launchpad Chains (table), Launchpads
      (table), Launchpads (timeseries), Launchpads by Chain (timeseries).
    name: Launchpads
  - description: >-
      Models documented under Lending Protocols: Lending Protocol Product
      Markets (table), Lending Protocol Products (table), Lending Protocols
      (table), Lending Protocols (timeseries), Lending Protocols by Product
      (timeseries), Lending Protocols by Product Market (timeseries).
    name: Lending Protocols
  - description: >-
      Models documented under Market Overview: Sector Marketdata (timeseries),
      Sub-Sector Marketdata (timeseries).
    name: Market Overview
  - description: 'Models documented under Markets: Market (BQEN) (timeseries).'
    name: Markets
  - description: >-
      Models documented under News & Research: News Feed (table), Research
      Reports (table), Topics (timeseries).
    name: News & Research
  - description: >-
      Models documented under Perp DEXes: Perp DEX Protocols (table), Perp DEX
      Protocols (timeseries).
    name: Perp DEXes
  - description: 'Models documented under Projects & Entities: Projects (timeseries).'
    name: Projects & Entities
  - description: >-
      Models documented under Protocol Revenue: Protocol Revenue (timeseries),
      Protocol Revenue by Product (timeseries).
    name: Protocol Revenue
  - description: >-
      Models documented under Social & Mindshare: Asset Group Sentiment
      (timeseries), Asset Investor Mentions (timeseries), Asset Mindshare
      (timeseries), Asset Sentiment (timeseries), Project Mindshare
      (timeseries), Sector Asset Mindshare (timeseries), Sector Asset Sentiment
      (timeseries), Sector Investor Mentions (timeseries), Sub-Sector Asset
      Mindshare (timeseries), Sub-Sector Asset Sentiment (timeseries).
    name: Social & Mindshare
  - description: >-
      Models documented under Spot DEXes: Spot DEX Protocol Chains (table), Spot
      DEX Protocols (table), Spot DEX Protocols (timeseries), Spot DEX Protocols
      by Chain (timeseries).
    name: Spot DEXes
  - description: >-
      Models documented under Stablecoins: Stablecoin Chains (table), Stablecoin
      Currencies (table), Stablecoin FX Pairs (table), Stablecoin Issuers
      (table), Stablecoin Products (table), Stablecoin Reserve Entities (table),
      Stablecoin FX (timeseries), Stablecoin Reserves (timeseries), Stablecoins
      by Chain (timeseries), Stablecoins by Currency (timeseries), Stablecoins
      by Issuer (timeseries), Stablecoins by Product (timeseries).
    name: Stablecoins
  - description: >-
      Models documented under TCG Platforms: TCG Platform Chains (table), TCG
      Platforms by Chain (timeseries).
    name: TCG Platforms
  - description: >-
      Discovery of the tabular models: one row per entity, with per-column
      filters, sorting and pagination.
    name: Tabular
  - description: >-
      Discovery of the timeseries models: one series per entity, as points at
      the granularities each model declares.
    name: Timeseries
  - description: >-
      Models documented under Token Transparency Framework: Token Transparency
      Filing Questions (table), Token Transparency Filing Schemas (table), Token
      Transparency Filings (table), Token Transparency Projects (table).
    name: Token Transparency Framework
  - description: >-
      Models documented under Tokenized Commodities: Tokenized Commodities
      (table), Tokenized Commodity Chains (table), Tokenized Commodity Issuers
      (table), Tokenized Commodity Products (table), Tokenized Commodities by
      Chain (timeseries), Tokenized Commodities by Commodity (timeseries),
      Tokenized Commodities by Issuer (timeseries), Tokenized Commodities by
      Product (timeseries).
    name: Tokenized Commodities
  - description: >-
      Models documented under Tokenized Equities: Tokenized Equities (table),
      Tokenized Equity Chains (table), Tokenized Equity Issuers (table),
      Tokenized Equity Products (table), Tokenized Equities by Chain
      (timeseries), Tokenized Equities by Equity (timeseries), Tokenized
      Equities by Issuer (timeseries), Tokenized Equities by Product
      (timeseries).
    name: Tokenized Equities
  - description: >-
      Models documented under Vaults: Vault Chains (table), Vault Curators
      (table), Vault Protocols (table), Vault Curators (timeseries), Vault
      Protocols (timeseries), Vaults by Chain (timeseries).
    name: Vaults
paths:
  /query/tabular/token-transparency-filings/{filingID}:
    get:
      tags:
        - Token Transparency Framework
      summary: Get Token Transparency Filing
      description: >-
        One row per published Token Transparency Framework filing, keyed by
        filingID: project, filing type and version, schema, publish and filing
        dates, provenance, question and gap counts with a completion label,
        latest and superseded flags, status and the filing's page URL. Filter by
        project, ticker, type, status or date.
      operationId: getTabularRow_token_transparency_filings
      parameters:
        - description: The Filing ID identifying the row.
          in: path
          name: filingID
          required: true
          schema:
            type: string
        - description: Comma-separated fields to return; defaults to all fields.
          in: query
          name: selections
          schema:
            items:
              enum:
                - filingID
                - bwProjectID
                - bwProjectSlug
                - protocolName
                - protocolTicker
                - projectID
                - projectSlug
                - projectName
                - filingType
                - filingVersion
                - schemaID
                - submissionRound
                - provenance
                - publishAt
                - dateFiled
                - questionCount
                - gapCount
                - completionLabel
                - filingTypeRank
                - isSuperseded
                - isLatestForType
                - filingStatus
                - stalenessTTLMonths
                - stalenessNextDeadline
                - staticURL
              type: string
            type: array
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  bwProjectID: 123
                  bwProjectSlug: <bwProjectSlug>
                  completionLabel: <completionLabel>
                  dateFiled: '2024-01-01T00:00:00Z'
                  filingID: <filingID>
                  filingStatus: <filingStatus>
                  filingType: <filingType>
                  filingTypeRank: 123
                  filingVersion: <filingVersion>
                  gapCount: 123
                  isLatestForType: true
                  isSuperseded: true
                  projectID: <projectID>
                  projectName: <projectName>
                  projectSlug: <projectSlug>
                  protocolName: <protocolName>
                  protocolTicker: <protocolTicker>
                  provenance: <provenance>
                  publishAt: '2024-01-01T00:00:00Z'
                  questionCount: 123
                  schemaID: <schemaID>
                  stalenessNextDeadline: '2024-01-01T00:00:00Z'
                  stalenessTTLMonths: 123
                  staticURL: <staticURL>
                  submissionRound: 123
                error: null
                metadata:
                  matchedField: filingID
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TokenTransparencyFilingsRow'
                  error:
                    nullable: true
                    type: string
                  metadata:
                    description: >-
                      The public field the lookup value matched on: the primary
                      key or an alternative identifier.
                    properties:
                      matchedField:
                        type: string
                    required:
                      - matchedField
                    type: object
                required:
                  - data
                  - metadata
                type: object
          description: The matching row, and which field it matched on.
        '400':
          content:
            application/json:
              example:
                data: null
                error: unknown selection field "nope"
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            The request is malformed: an unknown query parameter, or a
            selections field the model does not have.
        '401':
          content:
            application/json:
              example:
                data: null
                error: this model requires authentication
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: No API key was sent and the model requires one.
        '403':
          content:
            application/json:
              example:
                data: null
                error: >-
                  this model requires the "token_transparency_framework_unified"
                  permission
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            The API key is not valid, or does not hold the
            "token_transparency_framework_unified" permission.
        '404':
          content:
            application/json:
              example:
                data: null
                error: no row found matching "unknown"
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            No row's Filing ID equals the path value, or the path names a model
            that does not exist.
components:
  schemas:
    TokenTransparencyFilingsRow:
      properties:
        bwProjectID:
          description: The Blockworks research project id the filing belongs to.
          format: int64
          nullable: true
          type: integer
        bwProjectSlug:
          description: >-
            The Blockworks research project slug, used to group filings by
            project and in the filing's static URL.
          nullable: true
          type: string
        completionLabel:
          description: >-
            Completion label derived from the gap count: complete, or partial
            with the number of gaps.
          nullable: true
          type: string
        dateFiled:
          description: The UTC date the filing was published.
          format: date-time
          nullable: true
          type: string
        filingID:
          description: The unique identifier of the filing.
          nullable: true
          type: string
        filingStatus:
          description: >-
            current, or stale when the filing is superseded or past its
            staleness deadline.
          nullable: true
          type: string
        filingType:
          description: The filing type (e.g. B1, B2).
          nullable: true
          type: string
        filingTypeRank:
          description: >-
            Rank of the filing among the project's filings of the same type,
            newest first; 1 is the latest.
          format: int32
          nullable: true
          type: integer
        filingVersion:
          description: >-
            The version of the filing schema the filing was answered against
            (e.g. 2.0).
          nullable: true
          type: string
        gapCount:
          description: >-
            Number of questions with a gap: unanswered, unscored, or scored
            below complete.
          format: int32
          nullable: true
          type: integer
        isLatestForType:
          description: >-
            True for the newest filing of each type per project; filter on it to
            get one filing per type.
          nullable: true
          type: boolean
        isSuperseded:
          description: True when a newer filing of the same type exists for the project.
          nullable: true
          type: boolean
        projectID:
          description: >-
            The identifier of the mapped project record, when the research
            project is mapped to one.
          nullable: true
          type: string
        projectName:
          description: >-
            The name of the mapped project record, when the research project is
            mapped to one.
          nullable: true
          type: string
        projectSlug:
          description: >-
            The project's slug elsewhere in the API, when the research project
            is mapped to a project record.
          nullable: true
          type: string
        protocolName:
          description: The display name of the project's protocol.
          nullable: true
          type: string
        protocolTicker:
          description: >-
            The asset ticker of the project's protocol; null when the project
            has no asset.
          nullable: true
          type: string
        provenance:
          description: 'Who compiled the filing: issuer-filed or blockworks-compiled.'
          nullable: true
          type: string
        publishAt:
          description: When the filing was published, in UTC.
          format: date-time
          nullable: true
          type: string
        questionCount:
          description: Number of questions in the filing's schema.
          format: int32
          nullable: true
          type: integer
        schemaID:
          description: >-
            The identifier of the filing schema, joinable to the Token
            Transparency Filing Schemas model.
          nullable: true
          type: string
        stalenessNextDeadline:
          description: >-
            The next recurring deadline after the filing date, for filing types
            governed by deadline rules; the filing goes stale once it passes.
          format: date-time
          nullable: true
          type: string
        stalenessTTLMonths:
          description: >-
            Months after the filing date before the filing goes stale, for
            filing types governed by a time-to-live rule.
          format: int32
          nullable: true
          type: integer
        staticURL:
          description: The public URL of the filing on blockworks.com.
          nullable: true
          type: string
        submissionRound:
          description: The submission round that was published.
          format: int32
          nullable: true
          type: integer
      type: object
    ErrorResponse:
      properties:
        data:
          description: Always null on an error.
          nullable: true
          type: object
        error:
          description: What went wrong, in one sentence.
          type: string
      required:
        - error
        - data
      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

````