{"_id":"@arbit-x/bitkub-sdk","_rev":"3-cd411ebe4f084159979f862ff2e328fd","name":"@arbit-x/bitkub-sdk","dist-tags":{"latest":"0.1.2"},"versions":{"0.1.0":{"name":"@arbit-x/bitkub-sdk","version":"0.1.0","keywords":["bitkub","cryptocurrency","exchange","api","sdk"],"author":"","license":"MIT","_id":"@arbit-x/bitkub-sdk@0.1.0","maintainers":[{"name":"arbit-x","email":"tanakorn.karode@gmail.com"}],"dist":{"shasum":"4ca29de574ed5e7810176d0b899251ba9f072b26","tarball":"https://registry.npmjs.org/@arbit-x/bitkub-sdk/-/bitkub-sdk-0.1.0.tgz","fileCount":3,"integrity":"sha512-mOWZs5zPyY+NGQBOzC4V1HYMOWKOB3BWncNAUucg1WIhFNdG6dbp+eS6I/puT2mSMdvAZrL9xX/nTv581NY39A==","signatures":[{"sig":"MEYCIQCc6LLUg0TP3UyKgjK6XyTxuLc91MEVSBo6M5APwPtqeAIhAPkAuSvsMrIiBMsr2DEyR4KPb4xWZSZNv6ZkqEgkGNT4","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":2276},"main":"dist/index.js","types":"dist/index.d.ts","scripts":{"lint":"eslint . --ext .ts","test":"jest","build":"tsc","clean":"rimraf dist","format":"prettier --write \"src/**/*.ts\"","prebuild":"npm run clean"},"_npmUser":{"name":"arbit-x","email":"tanakorn.karode@gmail.com"},"_npmVersion":"10.9.2","description":"TypeScript SDK for Bitkub Exchange API","directories":{},"_nodeVersion":"22.14.0","dependencies":{"ws":"^8.16.0","axios":"^1.6.7"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","rimraf":"^5.0.5","prettier":"^3.2.5","typescript":"^5.3.3","@types/node":"^20.11.24","@typescript-eslint/parser":"^7.1.0","@typescript-eslint/eslint-plugin":"^7.1.0"},"_npmOperationalInternal":{"tmp":"tmp/bitkub-sdk_0.1.0_1748618071162_0.09326550543101142","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@arbit-x/bitkub-sdk","version":"0.1.1","keywords":["bitkub","cryptocurrency","exchange","api","sdk"],"author":"","license":"MIT","_id":"@arbit-x/bitkub-sdk@0.1.1","maintainers":[{"name":"arbit-x","email":"tanakorn.karode@gmail.com"}],"dist":{"shasum":"48c07d1520b26aa096d3a8afd398f71a29828852","tarball":"https://registry.npmjs.org/@arbit-x/bitkub-sdk/-/bitkub-sdk-0.1.1.tgz","fileCount":5,"integrity":"sha512-ujbwpsvUVXiRttcRYgub4GuGH4niySgaB8/OjdkxquBBx1KshtovuQiOuBBYmlHk40u6aPP/hxEtiMz7dV6gjg==","signatures":[{"sig":"MEUCIHYCuGva1Vy4+3swqCZ8BHCBBQAuACONa9TH9u5ysTJxAiEA0Go2Jpu66FdlcbsbnnUplFqcOJjY3CkGj/gxVSL71FI=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":5854},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"f15f8df12bda35fc4901ec1835f2b55edf08938c","scripts":{"lint":"eslint . --ext .ts","test":"jest","build":"tsc","clean":"rimraf dist","format":"prettier --write \"src/**/*.ts\"","prebuild":"npm run clean"},"_npmUser":{"name":"arbit-x","email":"tanakorn.karode@gmail.com"},"_npmVersion":"10.9.2","description":"TypeScript SDK for Bitkub Exchange API","directories":{},"_nodeVersion":"22.14.0","dependencies":{"ws":"^8.16.0","axios":"^1.6.7"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","rimraf":"^5.0.5","prettier":"^3.2.5","typescript":"^5.3.3","@types/node":"^20.11.24","@typescript-eslint/parser":"^7.1.0","@typescript-eslint/eslint-plugin":"^7.1.0"},"_npmOperationalInternal":{"tmp":"tmp/bitkub-sdk_0.1.1_1748619317290_0.1995345830937727","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@arbit-x/bitkub-sdk","version":"0.1.2","description":"TypeScript SDK for Bitkub Exchange API","repository":{"type":"git","url":"git+https://github.com/SainyTK/bitkub-sdk.git"},"main":"dist/index.js","types":"dist/index.d.ts","scripts":{"build":"tsc","clean":"rimraf dist","prebuild":"npm run clean","test":"jest","lint":"eslint . --ext .ts","format":"prettier --write \"src/**/*.ts\""},"keywords":["bitkub","cryptocurrency","exchange","api","sdk"],"author":"","license":"MIT","devDependencies":{"@types/jest":"^29.5.14","@types/node":"^20.11.24","@types/ws":"^8.18.1","@typescript-eslint/eslint-plugin":"^7.1.0","@typescript-eslint/parser":"^7.1.0","eslint":"^8.57.0","jest":"^29.7.0","prettier":"^3.2.5","rimraf":"^5.0.5","ts-jest":"^29.3.4","typescript":"^5.3.3"},"dependencies":{"axios":"^1.6.7","isomorphic-ws":"^5.0.0","ws":"^8.16.0"},"_id":"@arbit-x/bitkub-sdk@0.1.2","gitHead":"d301885ed4acc972ac9bdfca10500da62cbe7835","bugs":{"url":"https://github.com/SainyTK/bitkub-sdk/issues"},"homepage":"https://github.com/SainyTK/bitkub-sdk#readme","_nodeVersion":"22.14.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-J+TgXxPkKS4xyhOU0hfxLCWaJ/Lp+4BT+novqCObuif8LyjcIJXiUcpgrcfNxXAL5b2qm3p8jG2sY7NvXsK8sw==","shasum":"e47715b2ec6724ede13cc4802485ed4b3d0560f2","tarball":"https://registry.npmjs.org/@arbit-x/bitkub-sdk/-/bitkub-sdk-0.1.2.tgz","fileCount":11,"unpackedSize":14991,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIGoEK1/Tuzdtb89X5n5P+TVj82e/HRtVa/w7IS1cNCuPAiEAiGoabXJ6VOYXEv+Uih1bJiZyJBrU/0pAt6kPOiCgwPQ="}]},"_npmUser":{"name":"arbit-x","email":"tanakorn.karode@gmail.com"},"directories":{},"maintainers":[{"name":"arbit-x","email":"tanakorn.karode@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/bitkub-sdk_0.1.2_1748625127940_0.7286411299082327"},"_hasShrinkwrap":false}},"time":{"created":"2025-05-30T15:14:31.072Z","modified":"2025-05-30T17:12:08.312Z","0.1.0":"2025-05-30T15:14:31.352Z","0.1.1":"2025-05-30T15:35:17.461Z","0.1.2":"2025-05-30T17:12:08.132Z"},"license":"MIT","keywords":["bitkub","cryptocurrency","exchange","api","sdk"],"description":"TypeScript SDK for Bitkub Exchange API","maintainers":[{"name":"arbit-x","email":"tanakorn.karode@gmail.com"}],"readme":"# Bitkub SDK\n\n[![npm version](https://img.shields.io/npm/v/@arbit-x/bitkub-sdk.svg)](https://www.npmjs.com/package/@arbit-x/bitkub-sdk)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)\n\nA modern TypeScript SDK for the Bitkub Exchange API, providing both REST and WebSocket interfaces for cryptocurrency trading and market data.\n\nA TypeScript SDK for the Bitkub Exchange API, providing both REST and WebSocket interfaces for cryptocurrency trading and market data.\n\n---\n\n## Table of Contents\n\n- [Overview](#overview)\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Project Structure](#project-structure)\n- [Development](#development)\n- [Next Steps](#next-steps)\n- [Known Issues](#known-issues)\n- [Future Considerations](#future-considerations)\n- [Notes](#notes)\n- [License](#license)\n\n---\n\n## Overview\n\n**Bitkub SDK** is a TypeScript SDK that simplifies interaction with the Bitkub exchange API. It provides easy-to-use methods for both REST and WebSocket endpoints, enabling developers to access market data and trading features with minimal setup.\n\n---\n\n## Features\n\n- Fetch available market symbols\n- Basic error handling\n- TypeScript type definitions\n- Configurable API and WebSocket URLs\n- Support for authenticated requests (API key/secret)\n- Order book, ticker, trading history, real-time data, trading actions\n\n---\n\n## Installation\n```bash\nnpm install @arbit-x/bitkub-sdk\n```\n\n---\n\n## Usage\n\n```typescript\nimport { BitkubSDK } from '@arbit-x/bitkub-sdk';\n\n// Initialize SDK (API key/secret are optional for public endpoints)\nconst bitkubSDK = new BitkubSDK({\n  baseUrl: 'https://api.bitkub.com',\n  baseWsUrl: 'wss://api.bitkub.com/websocket-api',\n  // apiKey: 'your-api-key',\n  // apiSecret: 'your-api-secret',\n});\n\n// --- REST Example: Fetch market symbols ---\nconst marketSymbols = await bitkubSDK.fetchMarketSymbols();\nconsole.log('Market symbols:', marketSymbols);\n\n// --- REST Example: Fetch order books for symbols ---\nconst orderBooks = await bitkubSDK.fetchOrderBooks(['BTC_THB', 'ETH_THB']);\nconst btcOrderBook = orderBooks['BTC_THB']\nconst ethOrderBook = orderBooks['ETH_THB']\nconsole.log('Order books:', orderBooks);\n\n// --- WebSocket Example: Subscribe to real-time order book updates ---\nconst subscriptionId = await bitkubSDK.subscribeOrderBooks(['BTC_THB'], (orderBooks) => {\n    const { bids, asks } = orderBooks['BTC_THB']\n    console.log('Live order book update:', bids, asks);\n});\n\n// ...later, to unsubscribe from updates:\nbitkubSDK.unsubscribeOrderBooks(subscriptionId);\n```\n\n---\n\n## License\n\nMIT\n\n## Author\nSainyTK\nCreator and maintainer of @arbit-x/bitkub-sdk\nFeel free to reach out for questions, suggestions, or contributions!\n\n","readmeFilename":"Readme.md","homepage":"https://github.com/SainyTK/bitkub-sdk#readme","repository":{"type":"git","url":"git+https://github.com/SainyTK/bitkub-sdk.git"},"bugs":{"url":"https://github.com/SainyTK/bitkub-sdk/issues"}}