> For the complete documentation index, see [llms.txt](https://docs.enzyme.finance/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.enzyme.finance/onyx-sdk/faq.md).

# FAQ

Common questions about the Enzyme Onyx SDK and API.

***

## When should I use SDK vs API?

| Aspect              | API                                    | SDK                                  |
| ------------------- | -------------------------------------- | ------------------------------------ |
| **Read Data**       | Indexed, cached, fast (\~10s cache)    | Direct RPC, real-time but slower     |
| **Write Data**      | Not supported                          | Full transaction support             |
| **Historical Data** | Time-series financials, past deposits  | Current state only                   |
| **Rate Limits**     | Per IP (capacity reviewed regularly)   | RPC provider limits                  |
| **Authentication**  | None required                          | Wallet signature for writes          |
| **Use Case**        | Dashboards, analytics, read-heavy apps | Deposits, redemptions, admin actions |
| **Dependencies**    | None (REST/fetch)                      | viem, wallet provider, RPC           |
| **Offline Support** | Can cache responses                    | Requires live RPC                    |

**Recommendation:** Use a hybrid approach:

* **API** for reading vault data (metrics, deposits, history) - it's faster and doesn't count against RPC limits
* **SDK** for user transactions (deposits, redemptions, approvals) - required for blockchain writes

**Example Architecture:**

```
Your App
├── Display vault list → API (GET /vaults)
├── Show vault metrics → API (GET /vaults/{id})
├── Show user balance → API (GET /vaults/{id}/deposits/{wallet})
├── Request deposit → SDK (Components.ERC7540LikeDepositQueue.requestDeposit)
└── Approve tokens → SDK (Asset.approve)
```

***

## What networks are supported?

| Network          | Chain ID |
| ---------------- | -------- |
| Ethereum Mainnet | 1        |
| Arbitrum One     | 42161    |
| Base             | 8453     |
| Plume Mainnet    | 98866    |

***

## Do I need an API key?

**No.** The Onyx Public API requires no authentication. You can start making requests immediately.

***

## What's the rate limit?

The API is rate-limited per IP address. Capacity is reviewed regularly.


---

# 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.enzyme.finance/onyx-sdk/faq.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.