> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blockworksresearch.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Metrics

> Browse and filter available metrics

## Overview

Use this endpoint to **discover available metrics** and their metadata. Results include the metric name, description, stable `identifier`, supported chains/projects, data type, default interval, and source information.
This is the best place to find the correct `identifier` to use with [Get Single Metric](/api-reference/metrics/get-single).

## Example Request

<CodeGroup>
  ```bash cURL theme={null}
  curl -H "x-api-key: YOUR_API_KEY" \\
    "https://api.blockworks.com/v1/metrics"
  ```

  ```typescript TypeScript theme={null}
  const res = await fetch('https://api.blockworks.com/v1/metrics', {
    headers: { 'x-api-key': 'YOUR_API_KEY' }
  })
  const data = await res.json()
  ```

  ```python Python theme={null}
  import requests
  r = requests.get(
    'https://api.blockworks.com/v1/metrics',
    headers={'x-api-key': 'YOUR_API_KEY'}
  )
  data = r.json()
  ```
</CodeGroup>

## Example Response

A successful response returns a paginated list of metric definitions, with the following fields:

```json theme={null}
{
  "data": [
    {
      "name": "NAV (USD)",
      "description": "Dollar value of crypto assets (does not include cash)",
      "identifier": "treasury-nav-total-usd",
      "project": "CEP",
      "source": "Blockworks",
      "data_type": "timeseries_usd",
      "parameters": {
        "end_date": {
          "type": "date",
          "default": "3000-01-01",
          "description": "End date (inclusive)"
        },
        "start_date": {
          "type": "date",
          "default": "2000-01-01",
          "description": "Start date (inclusive)"
        }
      },
      "interval": "daily",
      "aggregation": "LAST",
      "category": "Treasury",
      "denomination": "USD",
      "updated_at": 1758867864
    }
    // ... 399 other metrics
  ],
  "total": 400,
  "page": 1
}
```

## Supported Options

| Parameter    | Type    | Description                                                  | Example                 |
| ------------ | ------- | ------------------------------------------------------------ | ----------------------- |
| `project`    | string  | Filter by project/chain slug. Supports comma-separated list. | `project=ethereum,base` |
| `identifier` | string  | Filter by exact metric identifier.                           | `identifier=rev-usd`    |
| `limit`      | integer | Page size.                                                   | `limit=100`             |
| `page`       | string  | Page for pagination.                                         | `page=1`                |

## Response Fields

| Field          | Type    | Description                                                                 |
| -------------- | ------- | --------------------------------------------------------------------------- |
| `name`         | string  | Human-readable metric name                                                  |
| `description`  | string  | What the metric measures and how it's intended to be used                   |
| `identifier`   | string  | Stable key used with other endpoints (e.g., `GET /v1/metrics/{identifier}`) |
| `project`      | string  | Chain/project slug this metric definition applies to                        |
| `source`       | string  | Data lineage owner (e.g., Blockworks)                                       |
| `data_type`    | string  | Shape/units of the series (e.g., `timeseries_usd`, `timeseries_float`)      |
| `parameters`   | object  | Supported query parameters for retrieving the series                        |
| `interval`     | string  | Data frequency (e.g., `daily`)                                              |
| `aggregation`  | string  | How values are aggregated (e.g., `SUM`, `LAST`)                             |
| `category`     | string  | Metric classification (e.g., `Financials`, `Treasury`)                      |
| `denomination` | string  | Currency/unit designation (e.g., `USD`, `ETH`)                              |
| `updated_at`   | integer | Unix timestamp of last update                                               |

## Pagination

This endpoint uses **page-based pagination**. Pass `limit` to set page size and `page` to fetch the next page.

```bash theme={null}
curl -H "x-api-key: YOUR_API_KEY" \\
  "https://api.blockworks.com/v1/metrics?limit=100&page=1"
```

## See also

* [Get Single Metric](/api-reference/metrics/get-single)
* [Welcome](/)


## OpenAPI

````yaml GET /v1/metrics
openapi: 3.0.0
info:
  title: Blockworks API
  description: ''
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.blockworks.com
security:
  - x-api-key: []
tags: []
paths:
  /v1/metrics:
    get:
      tags:
        - metrics
      summary: List Metrics
      description: >-
        List available metrics with optional filters `project` and `identifier`.
        Supports pagination via `page` and `limit`.
      operationId: MetricController_list_v1
      parameters:
        - name: page
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 2147483647
            default: 1
            type: integer
        - name: limit
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 100
            type: integer
        - name: project
          required: false
          in: query
          schema:
            maxLength: 255
            example: Bitcoin,Ethereum
            type: array
            items:
              type: string
        - name: identifier
          required: false
          in: query
          schema:
            maxLength: 255
            example: txns,issuance
            type: array
            items:
              type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricPageResponse'
        '400':
          description: Bad Request
      security:
        - x-api-key: []
components:
  schemas:
    MetricPageResponse:
      type: object
      properties:
        page:
          type: integer
          minimum: 1
          maximum: 2147483647
        total:
          type: integer
          minimum: 1
          maximum: 100
        data:
          type: array
          items:
            $ref: '#/components/schemas/MetricResponse'
      required:
        - page
        - total
        - data
    MetricResponse:
      type: object
      properties:
        name:
          type: string
          nullable: true
          maxLength: 65535
        description:
          type: string
          nullable: true
          maxLength: 65535
        identifier:
          type: string
          nullable: true
          example: rev
          maxLength: 65535
        project:
          type: string
          nullable: true
          example: Bitcoin
          maxLength: 65535
        source:
          type: string
          nullable: true
          example: Blockworks
          maxLength: 65535
        data_type:
          type: string
          nullable: true
          example: float
          maxLength: 65535
        parameters:
          type: object
          nullable: true
          example:
            end_date:
              type: date
              required: false
              description: End date (inclusive)
            start_date:
              type: date
              required: false
              description: Start date (inclusive)
        updated_at:
          type: number
          nullable: true
          description: Unix timestamp
        interval:
          type: string
          nullable: true
          example: daily
          maxLength: 65535
        aggregation:
          type: string
          nullable: true
          example: SUM
          maxLength: 65535
        category:
          type: string
          nullable: true
          example: Financials
          maxLength: 65535
        denomination:
          type: string
          nullable: true
          example: USD
          maxLength: 65535
      required:
        - name
        - description
        - identifier
        - project
        - source
        - data_type
        - parameters
        - updated_at
        - interval
        - aggregation
        - category
        - denomination
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key

````