Skip to main content

Repository & package

All SDK repos are under AlphScan. npm packages are private until release.

npm / pnpm

npm install @alphscan/sdk
# or
pnpm add @alphscan/sdk

From workspace (monorepo)

If the SDK lives in your monorepo (e.g. external/sdk):
{
  "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:
cd external/sdk
pnpm run build

Next

Client & settings

Create the client and set API URL and API key.