Polynomial SDK

Official TypeScript SDK for Polynomial Perpetuals

Trade crypto perpetuals with ease using a type-safe SDK

Quick Start • Documentation • Support

✨ Features

• 🚀 Easy to use - Simple, intuitive API for all trading operations
• 🔒 Type-safe - Full TypeScript support with comprehensive type definitions
• 📊 Market data - Real-time market information and statistics
• 💼 Account management - Account and position management
• 📝 Order management - Create, sign, and submit market and limit orders
• 📊 Trade analysis - Post-trade analysis with fees, health factor, and feasibility
• 🛡️ Error handling - Comprehensive error types and handling
• ⚡ High performance - Optimized for speed with minimal dependencies

Installation

npm install polynomialfi

Quick Start

import { PolynomialSDK, parseUnits } from "polynomialfi";

// Initialize the SDK
const sdk = await PolynomialSDK.create({
  apiKey: "your-api-key",
  sessionKey: "0x1234567890abcdef...",
  walletAddress: "0x742d35Cc6634C0532925a3b8D8d9d4B8e2b3c8a7",
});

// Get market data
const markets = await sdk.markets.getMarkets();
console.log(`Found ${markets.length} markets`);

// Create an order
const order = await sdk.createOrder("market-id", parseUnits("0.1"));
console.log("Order created:", order.id);

Documentation

API Reference

• Accounts API - Account and position management
• Orders API - Create and manage trading orders
• Markets API - Market data and statistics

Configuration

Required Credentials

| Credential | Description | How to Get | | ----------------- | ------------------------------ | ------------------------------------------------------------------------------------------ | | apiKey | API authentication (x-api-key) | Get from Discord | | sessionKey | Private key for signing orders | Generate/authorize API wallets from here | | walletAddress | Your trading wallet address | Your Ethereum wallet address |

const sdk = await PolynomialSDK.create({
  apiKey: "your-api-key",
  sessionKey: "0x1234...",
  walletAddress: "0x742d35...",
  chainId: 8008, // Optional: Network chain ID (default: 8008)
});

Getting Help

• Bug Reports: GitHub Issues
• General Questions: Discord Community

This SDK is in beta and actively developed and continuously improved.

License

MIT License - see LICENSE file for details.