![](\".ci_badges/npm-version-badge.svg\"){kind=icon}
\n ![](\".ci_badges/npm-dependencies-badge.svg\"){kind=icon}
\n ![](\".ci_badges/npm-devdependencies-badge.svg\"){kind=icon}
\n\n \n \n![\"ts-kraken](\".github/ts_kraken_logo.png\"){kind=logo}
\n\n REST & WebSocket v2 APIs โข Node.js & Browser โข Full Type Safety\n
\n\n\n Features โข\n Quick Start โข\n Playground โข\n Browser Support โข\n Documentation\n
\n\n![\"IDE](\".github/ts_kraken_IDE_2.png\")
\n\n> ๐ก **Full IDE support** with autocomplete for all endpoints, parameters, and response types\n\n![\"IDE](\".github/ts_kraken_IDE.png\")
\n\n---\n\n## ๐ฎ Interactive Playground\n\nClone this repo (the built npm package doesn't bring the playground module).\n\n```bash\ngit clone https://github.com/yeikiu/ts-kraken.git\ncd ts-kraken\nnpm install\n```\n\nLaunch the **browser-based API playground** to test endpoints visually:\n\n```bash\nnpm run watch:web-ui\n```\n\n**Perfect for:**\n- ๐ Testing API endpoints without writing code\n- ๐ Exploring available methods and parameters\n- ๐จ Trading when Kraken's official UI is down\n- ๐ Learning the API structure\n\nThe playground features:\n- **Quick Actions** - Common operations with one click\n- **Method Browser** - All REST & WebSocket endpoints organized by category\n- **Live Terminal** - See real-time responses\n- **Smart Forms** - Auto-generated parameter inputs with validation\n\n---\n\n## ๐ป REPL CLI\n\n### Launch Instantly\n\n```bash\nnpx ts-kraken\n```\n\n### Quick Examples\n\n```bash\n# ๐ Get current server time\n.get Time\n\n# ๐ฑ Get BTC/EUR trading pair info\n.get AssetPairs pair=BTC/EUR\n\n# ๐ฐ Check your balances (requires API keys)\n.post Balance\n\n# ๐ Subscribe to live BTC/USD ticker\n.pubsub ticker symbol[]=BTC/USD\n\n# ๐ Subscribe to your trade executions\n.privsub executions snap_orders=true\n\n# ๐ Unsubscribe from all streams\n.unsuball\n```\n\n\n\n### REPL Commands Reference\n\n| Command | Description | Example |\n|---------|-------------|---------|\n| `.get` | Fetch public REST data | `.get Ticker pair=BTC/USD` |\n| `.post` | Fetch private REST data | `.post OpenOrders` |\n| `.pubsub` | Subscribe to public WebSocket | `.pubsub ticker symbol[]=BTC/USD` |\n| `.privsub` | Subscribe to private WebSocket | `.privsub balances` |\n| `.unsub` | Unsubscribe from specific channel | `.unsub ticker` |\n| `.unsuball` | Unsubscribe from all channels | `.unsuball` |\n| `.setkeys` | Set API credentials (session only) | `.setkeys` |\n| `.showkeys` | Display current credentials | `.showkeys` |\n| `.help` | Show all commands | `.help` |\n| `.exit` | Exit the REPL | `.exit` |\n\n**๐ก Pro tip:** Use `jq` filters and `-table` flag for formatted output:\n```bash\n.get AssetPairs . as $base|keys|map($base[.])|map({wsname,tick_size}) -table\n```\n\n### Set Up API Keys\n\nCreate a `.env` file in your working directory:\n\n```env\nKRAKEN_API_KEY=your-api-key-here\nKRAKEN_API_SECRET=your-api-secret-here\n```\n\n---\n\n## ๐ Browser & Node.js Support\n\n**ts-kraken v5.0+** works seamlessly in both environments with **zero configuration**.\n\n### How It Works\n\nThe library automatically detects your runtime and uses:\n- **Node.js**: Native `crypto` module\n- **Browser**: Web Crypto API (`crypto.subtle`)\n\n### Browser Requirements\n\n- โ
Modern browser (Chrome, Firefox, Safari, Edge)\n- โ
ES2020+ support\n- โ
Web Crypto API (built into all modern browsers)\n\n### Browser Security Best Practices\n\nWhen using ts-kraken in the browser:\n\nโ ๏ธ **NEVER hardcode API keys** in client-side code\n Made with ๐ for the Kraken developer community\n
\n","readmeFilename":"README.md"}