> For the complete documentation index, see [llms.txt](https://docs.trybasket.live/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.trybasket.live/developers-and-api/api-reference.md).

# API reference

This page defines the public API surface Basket should publish and marks what is still undecided.

### Base URL

`TBD`

### Endpoint groups

| Group            | Purpose                                   |
| ---------------- | ----------------------------------------- |
| Discovery        | List and filter baskets                   |
| Basket detail    | Read metadata, composition, and addresses |
| Holdings and NAV | Read current basket state                 |
| Creator          | Resolve creator-linked basket data        |
| Quotes           | Estimate invest and redeem outputs        |

### Stub endpoints

<details>

<summary>Discovery</summary>

* `GET` `TBD` — list baskets
* `GET` `TBD` — filter by official, creator, category, or status
* Pagination, sorting, and query params are `TBD`

</details>

<details>

<summary>Basket detail</summary>

* `GET` `TBD` — get basket metadata
* `GET` `TBD` — get token and pool addresses
* `GET` `TBD` — get current composition and target weights

</details>

<details>

<summary>Holdings and NAV</summary>

* `GET` `TBD` — get current holdings
* `GET` `TBD` — get NAV inputs and per-token NAV
* Freshness, pricing source, and update cadence are `TBD`

</details>

<details>

<summary>Creator</summary>

* `GET` `TBD` — get creator profile
* `GET` `TBD` — list baskets by creator
* Identity schema and verification fields are `TBD`

</details>

<details>

<summary>Quotes and execution</summary>

* `GET` or `POST` `TBD` — quote invest
* `GET` or `POST` `TBD` — quote redeem
* Transaction building and execution handoff are `TBD`

</details>

### Auth and rate limits

Authentication policy is `TBD`.

Rate-limit policy is `TBD`.

The final reference should disclose:

| Topic            | Why it matters                                          |
| ---------------- | ------------------------------------------------------- |
| Auth requirement | Determines onboarding path                              |
| Limit scope      | Determines whether limits apply per key, IP, or account |
| Window and quota | Determines cache and retry design                       |
| Error codes      | Determines failure handling                             |

### Events and indexing

If Basket publishes indexed event surfaces or a subgraph, this page should link them.

Memo conventions, event names, and endpoint URLs are still `TBD`.

### What is required before launch

Before this API is treated as public, Basket should publish:

* base URL
* versioning policy
* field definitions
* pagination rules
* error shapes


---

# 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.trybasket.live/developers-and-api/api-reference.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.