> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orica.markets/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install the Orica SDK and its dependencies.

## TypeScript SDK

Install the SDK and required peer dependencies:

```bash bun theme={"dark"}
bun add @neko/orica-sdk @solana/web3.js @coral-xyz/anchor
```

```bash npm theme={"dark"}
npm install @neko/orica-sdk @solana/web3.js @coral-xyz/anchor
```

```bash yarn theme={"dark"}
yarn add @neko/orica-sdk @solana/web3.js @coral-xyz/anchor
```

```bash pnpm theme={"dark"}
pnpm add @neko/orica-sdk @solana/web3.js @coral-xyz/anchor
```

### TypeScript Dependencies

| Package | Purpose |
| - | - |
| `@neko/orica-sdk` | Orica SDK |
| `@solana/web3.js` | Solana JavaScript API |
| `@coral-xyz/anchor` | Anchor framework for Solana |

For trading operations, you may also need:

```bash theme={"dark"}
bun add @solana/spl-token
```

### Node Version

Requires Node.js 18 or higher.

***

## Python SDK

Install directly from GitHub:

```bash uv theme={"dark"}
uv add git+https://github.com/neko/orica-py-sdk
```

```bash pip theme={"dark"}
pip install git+https://github.com/neko/orica-py-sdk
```

Or clone and install locally:

```bash theme={"dark"}
git clone https://github.com/neko/orica-py-sdk
cd orica-py-sdk
uv pip install -e .
```

### Python Requirements

* Python 3.12+
* `uv` for package management (recommended)

Install `uv`:

```bash theme={"dark"}
curl -LsSf https://astral.sh/uv/install.sh | sh
```

### Python Dependencies

| Package | Purpose |
| - | - |
| `anchorpy` | Anchor framework for Python |
| `solders` | Solana data structures |
| `solana` | Solana Python SDK |
| `httpx` | HTTP client |

***

## TypeScript Configuration

Recommended `tsconfig.json` settings:

```json theme={"dark"}
{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "esModuleInterop": true,
    "strict": true
  }
}
```

***

## Verifying Installation

> [tab] TypeScript
>
> ```typescript theme={"dark"}
> import { OricaSDK } from "@neko/orica-sdk";
> import { Connection } from "@solana/web3.js";
>
> async function test() {
>   const connection = new Connection("https://api.mainnet-beta.solana.com");
>   const sdk = await OricaSDK.createFromChain(connection);
>
>   console.log("SDK initialized successfully");
>
>   const globalState = await sdk.orica.fetchGlobalState();
>   console.log("Market count:", globalState.marketCount.toString());
> }
>
> test().catch(console.error);
> ```
>
> Run with:
>
> ```bash Bun theme={"dark"}
> bun run test.ts
> ```
>
> ```bash Node theme={"dark"}
> npx ts-node test.ts
> ```

> [tab] Python
>
> ```python theme={"dark"}
> import asyncio
> from orica_sdk import OricaSDK
> from solana.rpc.async_api import AsyncClient
>
> async def test():
>     connection = AsyncClient("https://api.mainnet-beta.solana.com")
>     sdk = await OricaSDK.create(connection)
>
>     print("SDK initialized successfully")
>
>     global_state = await sdk.orica.fetch_global_state()
>     print(f"Market count: {global_state.market_count}")
>
> asyncio.run(test())
> ```
>
> Run with:
>
> ```bash theme={"dark"}
> uv run test.py
> ```

***

## Links

* **TypeScript**: [GitHub](https://github.com/neko/orica-ts-sdk) · [Docs](https://neko.github.io/orica-ts-sdk/) · [NPM](https://github.com/neko/orica-ts-sdk/pkgs/npm/orica-sdk)
* **Python**: [GitHub](https://github.com/neko/orica-py-sdk) · [Docs](https://neko.github.io/orica-py-sdk/)

***

## Next Steps

> [card] [Configuration](https://docs.orica.markets/sdk/configuration.md)
>
> Configure the SDK for different environments.

> [card] [Markets](https://docs.orica.markets/sdk/markets.md)
>
> Start fetching market data.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.