> For the complete documentation index, see [llms.txt](https://docs.creditcoop.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.creditcoop.xyz/platform-api/credit-coop-platform-v3-api.md).

# Credit Coop Platform v3 API

The Platform API provides programmatic access to Credit Coop platform data: credit facilities, borrowers, vaults, curators, depositors, positions, benchmarks, and the ledger.

**Base URL:** `https://api.creditcoop.xyz`

### Authentication

Three schemes are supported:

* **API key** — header `x-api-key: cc_xxx_yyy` (customer API routes)
* **Bearer token** — Clerk session JWT or Clerk OAuth access token
* **OAuth 2.0** — authorization-code flow via `https://clerk.creditcoop.xyz/oauth/authorize`

### Conventions

* Networks are identified by CAIP-2 ids (e.g. `eip155:1` for Ethereum, `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp` for Solana)
* List endpoints paginate with `limit`/`offset` and return a `pagination` object
* Expensive relations are opt-in via the `expand` query parameter on each endpoint
* Facilities carry a `protocolVersion` (`v1`, `v2`, or `v3`) — fields that only exist for certain generations are documented per-field and are `null` otherwise

Browse the endpoint reference in the pages of this section.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.creditcoop.xyz/platform-api/credit-coop-platform-v3-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.