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

# Token Transparency Filings

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

|               |                                                      |
| ------------- | ---------------------------------------------------- |
| Access        | Token\_transparency\_framework\_unified              |
| Tabular model | `token-transparency-filings`: primary key `filingID` |

## Endpoints

<CardGroup cols={2}>
  <Card title="List Token Transparency Filings" icon="arrow-right" href="/api-reference/data-api/token-transparency-framework/tabular-token-transparency-filings">
    One page of rows with per-column filters, sorting and pagination.
  </Card>

  <Card title="Get Token Transparency Filing" icon="arrow-right" href="/api-reference/data-api/token-transparency-framework/tabular-token-transparency-filings-by-id">
    One row by `filingID`.
  </Card>
</CardGroup>

## Columns

Use the `Field` value in `selections`, `sortBy`, and as the base of a filter parameter (`Field` plus one of its `Filters` suffixes).

| Field                   | Type   | Filters                        | Sort    | Description                                                                                                                           |
| ----------------------- | ------ | ------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `filingID`              | string | `Eq`, `IsOneOf`                |         | The unique identifier of the filing. (primary key)                                                                                    |
| `bwProjectID`           | int64  | `Eq`, `IsOneOf`                |         | The Blockworks research project id the filing belongs to.                                                                             |
| `bwProjectSlug`         | string | `Eq`, `IsOneOf`, `IsNotOneOf`  | yes     | The Blockworks research project slug, used to group filings by project and in the filing's static URL.                                |
| `protocolName`          | string | `Eq`, `IsOneOf`, `Contains`    | yes     | The display name of the project's protocol.                                                                                           |
| `protocolTicker`        | string | `Eq`, `IsOneOf`, `IsNotOneOf`  |         | The asset ticker of the project's protocol; null when the project has no asset.                                                       |
| `projectID`             | string | `Eq`, `IsOneOf`                |         | The identifier of the mapped project record, when the research project is mapped to one.                                              |
| `projectSlug`           | string | `Eq`, `IsOneOf`                |         | The project's slug elsewhere in the API, when the research project is mapped to a project record.                                     |
| `projectName`           | string |                                |         | The name of the mapped project record, when the research project is mapped to one.                                                    |
| `filingType`            | string | `Eq`, `IsOneOf`, `IsNotOneOf`  | yes     | The filing type (e.g. B1, B2).                                                                                                        |
| `filingVersion`         | string | `Eq`, `IsOneOf`                |         | The version of the filing schema the filing was answered against (e.g. 2.0).                                                          |
| `schemaID`              | string | `Eq`, `IsOneOf`                |         | The identifier of the filing schema, joinable to the Token Transparency Filing Schemas model.                                         |
| `submissionRound`       | int32  |                                |         | The submission round that was published.                                                                                              |
| `provenance`            | string | `Eq`, `IsOneOf`                |         | Who compiled the filing: issuer-filed or blockworks-compiled.                                                                         |
| `publishAt`             | time   | `Gt`, `Gte`, `Lt`, `Lte`       | default | When the filing was published, in UTC.                                                                                                |
| `dateFiled`             | time   | `Eq`, `Gt`, `Gte`, `Lt`, `Lte` | yes     | The UTC date the filing was published.                                                                                                |
| `questionCount`         | int32  |                                |         | Number of questions in the filing's schema.                                                                                           |
| `gapCount`              | int32  | `Eq`, `Gt`, `Gte`, `Lt`, `Lte` | yes     | Number of questions with a gap: unanswered, unscored, or scored below complete.                                                       |
| `completionLabel`       | string | `Eq`, `IsOneOf`                |         | Completion label derived from the gap count: complete, or partial with the number of gaps.                                            |
| `filingTypeRank`        | int32  | `Eq`, `Lte`                    |         | Rank of the filing among the project's filings of the same type, newest first; 1 is the latest.                                       |
| `isSuperseded`          | bool   | `Eq`                           |         | True when a newer filing of the same type exists for the project.                                                                     |
| `isLatestForType`       | bool   | `Eq`                           |         | True for the newest filing of each type per project; filter on it to get one filing per type.                                         |
| `filingStatus`          | string | `Eq`, `IsOneOf`                |         | current, or stale when the filing is superseded or past its staleness deadline.                                                       |
| `stalenessTTLMonths`    | int32  |                                |         | Months after the filing date before the filing goes stale, for filing types governed by a time-to-live rule.                          |
| `stalenessNextDeadline` | time   |                                |         | The next recurring deadline after the filing date, for filing types governed by deadline rules; the filing goes stale once it passes. |
| `staticURL`             | string |                                |         | The public URL of the filing on blockworks.com.                                                                                       |

## Example

```bash curl theme={null}
curl "https://api.blockworks.com/query/tabular/token-transparency-filings?pageSize=3&selections=filingID,bwProjectID,bwProjectSlug,protocolName" \
  -H "X-Blockworks-API-Key: $BLOCKWORKS_API_KEY"
```

See [List Token Transparency Filings](/api-reference/data-api/token-transparency-framework/tabular-token-transparency-filings) for the response and the errors.
