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

# SDK installation

> Install and add @alphscan/sdk to your project

## Repository & package

|            | Link                                                                           |
| ---------- | ------------------------------------------------------------------------------ |
| **GitHub** | [github.com/AlphScan/sdk](https://github.com/AlphScan/sdk)                     |
| **npm**    | [npmjs.com/package/@alphscan/sdk](https://www.npmjs.com/package/@alphscan/sdk) |

All SDK repos are under [AlphScan](https://github.com/AlphScan/). npm packages are private until release.

## npm / pnpm

```bash theme={null}
npm install @alphscan/sdk
# or
pnpm add @alphscan/sdk
```

## From workspace (monorepo)

If the SDK lives in your monorepo (e.g. `external/sdk`):

```json theme={null}
{
  "dependencies": {
    "@alphscan/sdk": "workspace:*"
  }
}
```

## Requirements

* **Node**: >= 18 (or a bundler that supports `fetch` and ES modules)
* **TypeScript**: optional; types are included

## Build

The package ships compiled JS and `.d.ts`. If you clone the source and depend on it via `file:` or `workspace:*`, build it first:

```bash theme={null}
cd external/sdk
pnpm run build
```

## Next

<Card title="Client & settings" icon="gear" href="/sdk/client-and-settings">
  Create the client and set API URL and API key.
</Card>