Skip to main content

​
Installation

The Alpha SDK is distributed as an npm package. It requires two peer dependencies: algosdk for Algorand blockchain interaction and @algorandfoundation/algokit-utils for transaction utilities.

​
Package Managers

Install the SDK and peer dependencies using your preferred package manager: 
npm install @alpha-arcade/sdk algosdk @algorandfoundation/algokit-utils

​
Dependencies

​
Required Peer Dependencies

These packages must be installed alongside the SDK:
PackageVersionPurpose
algosdk^3.5.2Algorand client library — handles blockchain communication, transaction signing, and account management
@algorandfoundation/algokit-utils^9.2.0AlgoKit utilities — provides transaction composition and smart contract interaction helpers

​
Included Dependencies

The SDK automatically includes:
PackageVersionPurpose
decimal.js^10.4.3High-precision decimal arithmetic for price and quantity calculations
The SDK is published as an ESM and CommonJS hybrid module. It works in both Node.js and modern bundlers (Webpack, Vite, etc.).

​
Version Requirements

  • Node.js: 18.x or higher recommended
  • TypeScript: 5.0+ (if using TypeScript)
  • Algorand SDK: The SDK requires algosdk v3.5.2 or higher

​
Verify Installation

Check that the SDK is correctly installed: 
npm list @alpha-arcade/sdk algosdk @algorandfoundation/algokit-utils
You should see output similar to: 
[email protected] /path/to/project
├── @algorandfoundation/[email protected]
├── @alpha-arcade/[email protected]
└── [email protected]

​
TypeScript Configuration

If you’re using TypeScript, ensure your tsconfig.json has ESM support:
tsconfig.json
{
  "compilerOptions": {
    "module": "ESNext",
    "moduleResolution": "bundler",
    "target": "ES2022",
    "lib": ["ES2022"],
    "esModuleInterop": true,
    "skipLibCheck": true,
    "strict": true
  }
}
The SDK ships with full TypeScript definitions. You’ll get autocomplete and type checking out of the box.

​
Import Syntax

The SDK uses named exports. Import the AlphaClient and any utility functions you need: 
import { AlphaClient } from '@alpha-arcade/sdk';
import algosdk from 'algosdk';

​
CommonJS

const { AlphaClient } = require('@alpha-arcade/sdk');
const algosdk = require('algosdk');

​
Environment Setup

For development, create a .env file to store sensitive data:
.env
# Optional: Alpha API key for enhanced features
ALPHA_API_KEY=your_api_key_here

# Required for signing transactions
MNEMONIC=your twenty five word mnemonic phrase here
Never commit your .env file to version control. Add it to .gitignore:
.gitignore
.env
.env.local
Load environment variables in your application: 
import dotenv from 'dotenv';
dotenv.config();

const apiKey = process.env.ALPHA_API_KEY;
const mnemonic = process.env.MNEMONIC;

​
Optional: Get an API Key

An API key unlocks enhanced features like market metadata, liquidity rewards, and cross-market order lookups.
1

Sign Up

Go to alphaarcade.com and create an account using email or Google.
2

Navigate to Partners

Open your Account page, then select the Partners tab.
3

Generate Key

Click Create API key and copy the generated key.
4

Add to Environment

Store it in your .env file:
.env
ALPHA_API_KEY=your_api_key_here
The API key is completely optional. The SDK works without it — you’ll just have access to on-chain data only (no images, categories, or volume stats).

​
Next Steps

Quick Start

Learn how to initialize the client and place your first order

Build docs developers (and LLMs) love

Get started for freeTalk to us