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

# API Reference Overview

> How the Criffy REST reference is organized and what to expect from generated endpoint pages.

# API Reference Overview

This section is generated from a checked-in OpenAPI document and organized into:

* Platforms
* Offers
* Public data schemas, examples, and shared errors

## Base URL

All documented REST endpoints use:

```text theme={null}
https://criffy.com
```

The public data namespace lives under:

```text theme={null}
/api/v1/*
```

## Authentication summary

* Every documented `/api/v1/*` public data endpoint requires `Authorization: Bearer <api_key>` and an active Criffy `Pro+` subscription.
* Buy or upgrade to Pro+ from [Pricing](https://criffy.com/pricing).
* API keys are created, rotated, revoked, and monitored from [Settings -> API](https://criffy.com/settings/api) in the Criffy dashboard.
* Pro+ API keys currently include 60 requests per minute and 100,000 requests per calendar month. Monthly quota resets on the 1st day of each month at `00:00 UTC`.
* Dashboard key management is separate from the Bearer-auth public data API. External integrations should use Bearer authentication only.

## Resource families

* Platform resources: exchanges, wallets, protocols
* Currency resources: currencies plus related offers on detail
* Offer resources: earn, borrow, collateral
* History resources: time-series data for earn and borrow offers

## Contract highlights

* List endpoints return `{ data, pagination }`.
* Decimal monetary, APY, TVL, and LTV values are serialized as strings when precision matters.
* Detail endpoints for slug-based resources can return `301 Moved Permanently` with a `Location` header when the slug was renamed.
* `GET /api/v1/currencies/{slug}` embeds related `earn_offers`, `borrow_offers`, and `collateral_offers`.
* `GET /api/v1/collateral/{id}/history` is included for contract consistency but currently returns `404 not_found`.

## Visibility and offer status

Platform and currency indexes include only published, non-delisted resources. Public offer indexes include published offers; runtime status is reported in the response instead of being used as a visibility filter.

Use `available` on earn offers and `is_active` on borrow or collateral offers to decide whether a returned offer is currently usable. These fields can be `false` on list responses, detail responses, and offers embedded in `GET /api/v1/currencies/{slug}`.

## Generated pages

Mintlify generates the endpoint pages in this section directly from the OpenAPI spec, including:

* Request parameters
* Authentication controls in the API playground
* Response schemas
* Shared error responses
* Reusable examples