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

# Points API

> Programmatic access to points data for developers and builders

<img className="block dark:hidden rounded-lg" src="https://mintcdn.com/portal-cca1aca1/aA8XqHdKiqoPu8Np/images/API_Title_Light.png?fit=max&auto=format&n=aA8XqHdKiqoPu8Np&q=85&s=75aee68237a780c8a0288f0acd1ed2d2" alt="Checkpoint API title image, light theme" draggable="false" style={{ pointerEvents: 'none' }} width="673" height="169" data-path="images/API_Title_Light.png" />

<img className="hidden dark:block rounded-lg" src="https://mintcdn.com/portal-cca1aca1/aA8XqHdKiqoPu8Np/images/API_Title_Dark.png?fit=max&auto=format&n=aA8XqHdKiqoPu8Np&q=85&s=7ae6410c939e07bf40ad24db47003cff" alt="Checkpoint API title image, dark theme" draggable="false" style={{ pointerEvents: 'none' }} width="673" height="169" data-path="images/API_Title_Dark.png" />

# Checkpoint API

The **Points API** provides developers with programmatic access to Checkpoint's points data across all integrated protocols. Query points balances and integrate points tracking directly into your applications with simple REST endpoints.

<img className="block dark:hidden rounded-lg" src="https://mintcdn.com/portal-cca1aca1/70-rr3wSTdbXH-64/images/API_Screen_Dark.png?fit=max&auto=format&n=70-rr3wSTdbXH-64&q=85&s=d3b086035c1e0d0bb8e7de498cf73626" alt="Checkpoint API dashboard screenshot, dark theme" width="1345" height="673" data-path="images/API_Screen_Dark.png" />

<img className="hidden dark:block rounded-lg" src="https://mintcdn.com/portal-cca1aca1/70-rr3wSTdbXH-64/images/API_Screen_Light.png?fit=max&auto=format&n=70-rr3wSTdbXH-64&q=85&s=f93f20c0abf127fc2d8077457f13f372" alt="Checkpoint API dashboard screenshot, light theme" width="1344" height="673" data-path="images/API_Screen_Light.png" />

The API is powered by a modular adapter system: each protocol has a lightweight adapter that fetches raw data and normalizes it into consistent fields.

<Card title="Build with the API" icon="code" href="/api/points-api" horizontal>
  Get familiar with the API technical reference.
</Card>

## Overview

Built for speed and scale, the Points API delivers unified, real‑time points data across protocols with a simple, developer‑friendly interface.

The Points API is built around a few core concepts

<CardGroup cols={2}>
  <Card title="Multi-Protocol Support" icon="layer-group">
    Query points data across 30+ DeFi protocols through a single unified interface
  </Card>

  <Card title="Real-time Data" icon="clock">
    Access up-to-date points balances and rankings for any address
  </Card>

  <Card title="Normalized Data Format" icon="code">
    All points data is normalized into a consistent JSON format across all protocols
  </Card>

  <Card title="Flexible Queries" icon="sliders">
    Query all protocols or specify specific adapters for targeted data retrieval
  </Card>
</CardGroup>

## How It Works

The Points API operates as a data aggregation layer that

<Steps>
  <Step title="Accepts Address Query">
    User submit an address to query points for
  </Step>

  <Step title="Aggregates Protocol Data">
    The API queries multiple protocol adapters simultaneously
  </Step>

  <Step title="Returns Unified Response">
    Points data from all protocols is returned in a consistent JSON format
  </Step>

  <Step title="Supports Selective Queries">
    Optional adapter filtering allows querying specific protocols
  </Step>
</Steps>

## Core Endpoints

The Points API provides two main endpoints

### 1. Get Points for Address

Retrieve points data for a specific Ethereum address across one or more protocols

**GET /adapters/\{address}**

* [Review full documentation →](/api-reference/points/get-points-data-for-a-specific-address)

```json Example Request theme={null}
curl "https://checkpoint.exchange/api/v1/adapters/0x69155e7ca2e688ccdc247f6c4ddf374b3ae77bd6?adapters=sonic,henlo" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json Example Response theme={null}
{
  "success": true,
  "results": {
    "sonic": {
      "total": 1500,
      "rank": 245,
      "data": { ... },
      "claimable": true
    },
    "henlo": {
      "total": 2300,
      "rank": 189,
      "claimable": false
    }
  }
}
```

### 2. List Available Adapters

Get the complete list of supported protocol adapters

**GET /adapters**

* [Review full documentation →](/api-reference/points/list-all-available-adapters)

```bash Example Request theme={null}
GET https://checkpoint.exchange/api/v1/adapters
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json Example Response theme={null}
{
  "success": true,
  "adapters": [
    "avalon",
    "bedrock",
    "corn",
    "dolomite",
    "ethereal",
    "etherfi",
    "henlo",
    "karak",
    "kelpdao",
    "sonic",
    "symbiotic",
    "taiko",
    "veda",
    ...
  ]
}
```

## Authentication

The Points API uses API key-based authentication

<Steps>
  <Step title="Generate API Key">
    Sign in to the [Portal Dashboard <Icon icon="arrow-up-right" />](https://checkpoint.exchange/apikeys) and create a new API key
  </Step>

  <Step title="Specify Authorized Domains">
    Configure which domains are authorized to use your API key
  </Step>

  <Step title="Include in Requests">
    Add your API key to the Authorization header of each request
  </Step>
</Steps>

Include your API key in every request:

```bash theme={null}
Authorization: Bearer YOUR_API_KEY
```

## Rate Limiting

The Points API implements a "soft" rate limit of 50 requests per 10 seconds window. This ensures fair access for all users while allowing burst usage patterns.

<Tip>If you need higher rate limits for your use case, reach out on [<Icon icon="discord" /> Discord](https://discord.gg/fJ5dJbxxTT).</Tip>

## Use Cases

<CardGroup cols={2}>
  <Card title="Points Dashboard" icon="chart-line">
    Build web applications that display points balances and rankings across protocols
  </Card>

  <Card title="Trading Integrations" icon="arrows-repeat">
    Integrate points data into trading platforms and portfolio trackers
  </Card>

  <Card title="Analytics Platforms" icon="magnifying-glass">
    Analyze points distribution, trends, and market data across protocols
  </Card>

  <Card title="Automated Tools" icon="robot">
    Build bots and automation tools that monitor points across multiple users
  </Card>
</CardGroup>

## Getting Started

To start using the Points API:

<Steps>
  <Step title="Get API Key">
    Sign up and generate an API key from the [Portal Dashboard <Icon icon="arrow-up-right" />](https://checkpoint.exchange/apikeys)
  </Step>

  <Step title="Explore Endpoints">
    Review the [Points API Reference](/api/points-api) for detailed endpoint documentation
  </Step>

  <Step title="Test Integration">
    Use the interactive API reference to test endpoints with your API key
  </Step>

  <Step title="Build Your App">
    Integrate the API into your application using the provided examples
  </Step>
</Steps>

<Note>
  **Full Documentation:** Check out the [Points API Reference](/api/points-api) for detailed parameter specifications, response formats, error handling, and code examples.
</Note>