> For the complete documentation index, see [llms.txt](https://docs.madjik.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.madjik.io/getting-started/response-format.md).

# Response Format

## Standard Response

All successful responses follow this structure:

```json
{
  "metric_id": "ME10001",
  "metric_name": "Stablecoin Health Index",
  "timestamp": "2026-01-28T12:00:00Z",
  "data": {
    "value": 0.9985,
    "relchg": -0.15,
    "score": 72
  },
  "time_dimension": "now",
  "asset": "USDT"
}
```

## Fields

| Field            | Type   | Description                              |
| ---------------- | ------ | ---------------------------------------- |
| `metric_id`      | string | Unique metric identifier (e.g., ME10001) |
| `metric_name`    | string | Human-readable metric name               |
| `timestamp`      | string | ISO 8601 timestamp of data               |
| `data`           | object | Metric values (see below)                |
| `time_dimension` | string | Requested time period                    |
| `asset`          | string | Asset/pair if applicable                 |

## Data Object

The `data` object contains up to three variants:

| Variant  | Type   | Description            |
| -------- | ------ | ---------------------- |
| `value`  | number | Absolute/raw value     |
| `relchg` | number | Relative change (%)    |
| `score`  | number | Normalized 0-100 score |

## Request Specific Variants

Request only the variant you need:

```bash
# Get only score
GET /v1/metrics/ME10001?variant=score

# Response
{
  "metric_id": "ME10001",
  "data": {
    "score": 72
  }
}
```

## Time Dimensions

| Parameter | Description           |
| --------- | --------------------- |
| `now`     | Current/real-time     |
| `past1h`  | Past 1 hour average   |
| `past4h`  | Past 4 hours average  |
| `past8h`  | Past 8 hours average  |
| `past24h` | Past 24 hours average |
| `past7d`  | Past 7 days average   |
| `past30d` | Past 30 days average  |

## Error Response

```json
{
  "error": "invalid_metric",
  "message": "Metric ID 'ME99999' not found",
  "code": 404
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.madjik.io/getting-started/response-format.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.