---
title: API index
description: Map of sv3Client namespaces to the pages that document them.
---

> **For AI agents:** the complete documentation index is at [llms.txt](/llms.txt). Append `.md` to any page URL for its markdown version.

Short names on the client. Verbose selectors on chain. The SDK wraps the ABI; it does not invent writes.

<Note>
  Do not pass a market ID, CREATE2 salt, or client nonce into create-market. The factory assigns
  identity.
</Note>

## Get started

- [Getting started](/developers/sdk) — install, initialize, first quote
- [createSv3Client](/developers/create-sv3-client) — parameters and wallet binding
- [parseUsdc](/developers/parse-usdc) — 6dp / 18dp brands

## Reads

- [getQuoteState](/developers/get-quote-state) — frozen `MarketSnapshot`
- [getTradeContext](/developers/get-trade-context) — snapshot + balances
- [getAccountContext](/developers/get-account-context) — plus position

## Actions

- [prepareBuyForReserveBudget](/developers/prepare-buy-for-reserve-budget) — spend at most this USDC
- [prepareBuyExactReserveIn](/developers/prepare-buy-exact-reserve-in) — spend exactly this USDC
- [getRequirements](/developers/get-requirements) — permit or approve, never hidden
- [executePrepared](/developers/execute-prepared) — simulate as wallet, then send
- [wait](/developers/wait) — receipt + decoded events
- [Errors](/developers/errors)

## Floor policy

- [quoteNextRaise](/developers/quote-next-raise) — eligibility, plan, witness
- [raiseIfEligible](/developers/raise-if-eligible) — permissionless raise, including batched sends
- [Floor keeper](/protocol/keeper) — operator client, not a protocol role

## Namespaces

| Namespace                                 | Use                                                                |
| ----------------------------------------- | ------------------------------------------------------------------ |
| `sv3.market`                              | Snapshot and context bundles                                       |
| `sv3.quote`                               | Same math as `/math`, but loads chain state if you pass an address |
| `sv3.trade`                               | `prepare*` for buys, sells, redeem, budget/target helpers          |
| `sv3.position`                            | Position reads, `getMaxActions`                                    |
| `sv3.authorization`                       | `getRequirements`                                                  |
| `sv3.transactions`                        | execute, simulatePrepared, sendPrepared, wait                      |
| `sv3.floor`                               | quote, prepare, simulate, raise, batched Multicall3 raise          |
| `sv3.network`                             | native balance, nonce, block                                       |
| `sv3.errors`                              | `parse` / `toError`                                                |
| `sv3.factory` / `sv3.directory`           | Launch sequence, pause, caps                                       |
| `sv3.math` / `@repo/contract-client/math` | [Math](/developers/math/overview)                                  |
| `sv3.units`                               | [parseUsdc](/developers/parse-usdc)                                |

## Entrypoints

| Import                            | For                                     |
| --------------------------------- | --------------------------------------- |
| `@repo/contract-client`           | Safe app surface                        |
| `@repo/contract-client/math`      | Pure quotes                             |
| `@repo/contract-client/types`     | `asUsdcRaw`, `asAvmAtoms`, `asWad`      |
| `@repo/contract-client/artifacts` | Interface ABIs                          |
| `@repo/contract-client/admin`     | Pause helpers — not for the browser app |
| `@repo/contract-client/testing`   | Local Anvil harness                     |

`@sv3-protocol/sdk` is the future public name. It is not on npm yet.

## What's next

<Columns cols={2}>
  <Card title="Math" icon="square-root-variable" href="/developers/math/overview">
    One page per function.
  </Card>
  <Card title="createSv3Client" icon="plug" href="/developers/create-sv3-client">
    How to construct the client.
  </Card>
</Columns>