> 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/readme.md).

# Introduction

Welcome to the Madjik API documentation. Access real-time and historical cryptocurrency market metrics designed for professional traders.

## Quick Start

```bash
curl -X GET "https://api.madjik.io/v1/metrics/ME10001" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

## Base URL

```
https://api.madjik.io/v1
```

## Features

* **34 Metrics** across 11 categories
* **Real-time & Historical** data
* **Standardized Dimensions** - consistent value/relchg/score variants
* **Multiple Time Frames** - from real-time to 30-day lookback
* **Trading Hypotheses** - each metric linked to actionable research

## Metric Categories

| Category                                                                                                           | Metrics    | Description                                  |
| ------------------------------------------------------------------------------------------------------------------ | ---------- | -------------------------------------------- |
| [Stablecoin & Tether](https://github.com/madjik-io/madjik-api-docs/blob/main/metrics/stablecoin-tether.md)         | ME10001-04 | Peg health, Tether flows, backing risk       |
| [Exchange & Counterparty](https://github.com/madjik-io/madjik-api-docs/blob/main/metrics/exchange-counterparty.md) | ME10005-06 | Exchange solvency, manipulation detection    |
| [Volume & Liquidity](https://github.com/madjik-io/madjik-api-docs/blob/main/metrics/volume-liquidity.md)           | ME10007-09 | Authentic volume, order book integrity       |
| [Whale & Flow](https://github.com/madjik-io/madjik-api-docs/blob/main/metrics/whale-flow.md)                       | ME10010-13 | Smart money, unlocks, address classification |
| [Derivatives](https://github.com/madjik-io/madjik-api-docs/blob/main/metrics/derivatives.md)                       | ME10014-17 | Funding, OI, liquidations, basis             |
| [Volatility & Risk](https://github.com/madjik-io/madjik-api-docs/blob/main/metrics/volatility-risk.md)             | ME10018-21 | Regime, tail risk, correlations              |
| [Market Structure](https://github.com/madjik-io/madjik-api-docs/blob/main/metrics/market-structure.md)             | ME10022-24 | Valuation, regime, arbitrage                 |
| [Security & Protocol](https://github.com/madjik-io/madjik-api-docs/blob/main/metrics/security-protocol.md)         | ME10025-27 | Protocol audits, DeFi health                 |
| [Regulatory & Compliance](https://github.com/madjik-io/madjik-api-docs/blob/main/metrics/regulatory-compliance.md) | ME10028-29 | Regulatory risk, AML exposure                |
| [Sentiment & Social](https://github.com/madjik-io/madjik-api-docs/blob/main/metrics/sentiment-social.md)           | ME10030-31 | Social sentiment, influencer activity        |
| [On-Chain & Transparency](https://github.com/madjik-io/madjik-api-docs/blob/main/metrics/onchain-transparency.md)  | ME10032-34 | Transparency, NFTs, forks                    |

## Get Started

1. [Get your API key](https://madjik.io/pricing)
2. [Review authentication](/getting-started/authentication.md)
3. [Explore metrics](https://github.com/madjik-io/madjik-api-docs/blob/main/metrics/README.md)

## Support

* Email: <support@madjik.io>
* Website: [madjik.io](https://madjik.io)


---

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