> For the complete documentation index, see [llms.txt](https://haven-11.gitbook.io/haven-ai-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://haven-11.gitbook.io/haven-ai-docs/integration/api.md).

# API Reference

> Direct REST API access to Haven's yield data and execution capabilities.

***

## Base URL

```
https://api.haven.financial/v1
```

***

## Authentication

All API requests require a Bearer token in the Authorization header.

```http
Authorization: Bearer YOUR_HAVEN_API_KEY
Content-Type: application/json
```

API keys are available to registered developers. Apply at [haven.financial](https://www.haven.financial).

***

## Endpoints

### GET /v1/yield/paths

Returns ranked yield opportunities across all supported protocols.

**Request body:**

```json
{
  "filter": {
    "min_score": 70,
    "min_apy": 5.0,
    "asset": "USDC",
    "chain": "arbitrum"
  }
}
```

**Response:**

```json
{
  "paths": [
    {
      "protocol": "Aave V3",
      "asset": "USDC",
      "apy": 6.8,
      "haven_score": 88,
      "chain": "arbitrum",
      "tvl_usd": 420000000
    }
  ]
}
```

***

### GET /v1/score/:protocol\_id

Returns the current HavenScore and signal breakdown for a specific protocol.

**Example:**

```
GET /v1/score/aave-v3-arbitrum
```

**Response:**

```json
{
  "protocol_id": "aave-v3-arbitrum",
  "score": 88,
  "tier": "safe",
  "signals": {
    "whale_activity": 91,
    "market_health": 85,
    "sentiment": 87,
    "contract_risk": 90
  },
  "updated_at": "2026-04-02T10:00:00Z"
}
```

***

### POST /v1/strategy/execute

Submit a strategy for on-chain execution via HavenClaw.

**Request body:**

```json
{
  "wallet": "0xYOUR_WALLET_ADDRESS",
  "allocations": {
    "aave-v3-arbitrum": 0.55,
    "tbill-tokenized-eth": 0.30,
    "delta-neutral-base": 0.15
  },
  "rebalance_trigger": "5%",
  "compound_freq": "daily"
}
```

**Response:**

```json
{
  "strategy_id": "str_abc123",
  "status": "pending_confirmation",
  "simulation": {
    "estimated_apy": "6.8%",
    "gas_estimate_usd": 4.20
  }
}
```

***

### GET /v1/position/:vault\_id

Returns the current status and performance of an active vault position.

***

## Rate Limits

| Plan       | Requests / minute |
| ---------- | ----------------- |
| Free       | 30                |
| Developer  | 300               |
| Enterprise | Unlimited         |

***

## Related

* [HavenSkill — OpenClaw SDK (higher-level abstraction)](/haven-ai-docs/core-products/havenskill.md)
* [OpenClaw Framework](/haven-ai-docs/integration/openclaw.md)


---

# 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://haven-11.gitbook.io/haven-ai-docs/integration/api.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.