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

# Overview

> The Blockworks Data API is a single, standardized REST interface to onchain data, market coverage, and research-grade metrics.

The Data API is a single, standardized REST interface to the data behind Intel:
onchain activity, market and asset coverage, protocol and sector fundamentals, and the
curated metrics our analysts use in production. Every endpoint is read-only, served from
`https://api.blockworks.com`, authenticated with one API key, and returns the same
`{ "error": ..., "data": ... }` envelope, so a client written against one product area
works against all of them.

Endpoints come in two model kinds. **Tabular** models are row-shaped: entities, rankings,
and current metrics you filter, sort, and page through. **Timeseries** models are
history-shaped: a metric over time for a given entity, at a granularity you choose in the
path.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/getting-started/quickstart">
    Get a key and make your first authenticated request in under five minutes.
  </Card>

  <Card title="Tabular vs timeseries" icon="book" href="/getting-started/concepts/tabular-vs-timeseries">
    The two model kinds, their URL shapes, and when to reach for each.
  </Card>

  <Card title="Filtering & pagination" icon="filter" href="/getting-started/filtering-pagination">
    Filter operator suffixes, sorting, column selection, paging, and response formats.
  </Card>

  <Card title="The data catalog" icon="list" href="/getting-started/concepts/catalog">
    The API describes itself: enumerate every model, column, filter, and granularity.
  </Card>

  <Card title="Finding an id" icon="key" href="/api-reference/data-api/discovery/finding-an-id">
    Which lookup table gives the series key each timeseries endpoint needs.
  </Card>

  <Card title="Reference" icon="book" href="/api-reference/data-api/market-data">
    Every model with its columns, metrics, examples and errors, grouped by subject. Start with Market Data.
  </Card>
</CardGroup>

## Request shape

Tabular endpoints live under `/query/tabular/<model>`, optionally with an entity
identifier. Timeseries endpoints live under `/query/timeseries/<model>/<granularity>`.

```bash theme={null}
# Tabular: the first page of asset entities.
curl 'https://api.blockworks.com/query/tabular/assets?pageSize=5' \
  --header 'X-Blockworks-API-Key: YOUR_API_KEY'
```

Every request carries the key in the `X-Blockworks-API-Key` header. See
[Authentication](/getting-started/authentication).

The `<model>` segment is the model's catalog slug. A few older slugs keep working as aliases and
resolve to the same endpoint: `asset-entities` for `assets`, `network-entities` and `networks`
for the tabular `blockchains` model, `network` and `networks` for the timeseries one. The
reference documents the canonical slug only.

## What you can build

* **Dashboards and terminals**: asset, protocol, and sector screens backed by
  research-grade metrics rather than scraped aggregates.
* **Quant and research pipelines**: reproducible timeseries pulls with explicit
  granularity and point-in-time semantics.
* **Enrichment services**: resolve symbols, slugs, and identifiers to canonical entities
  before joining Blockworks metrics onto your own records.

## Next steps

<CardGroup cols={3}>
  <Card title="Responses" icon="code" href="/getting-started/responses">
    The envelope, the tabular row shape, and the timeseries series shape.
  </Card>

  <Card title="Errors" icon="alert-triangle" href="/getting-started/errors">
    Status codes, the error envelope, and how to resolve common failures.
  </Card>

  <Card title="Granularity" icon="clock" href="/getting-started/concepts/granularity">
    Choosing an interval and bounding a time window.
  </Card>
</CardGroup>

<Note>
  Need more than a REST endpoint should reasonably return? The same models are available
  natively in your warehouse through [Datashares](/datashare/overview).
</Note>
