Installation

Package Manager

npm

npm install stock-sdk

yarn

yarn add stock-sdk

pnpm

pnpm add stock-sdk

CDN

For browser usage, you can use unpkg or jsDelivr:

<!-- unpkg -->
<script type="module">
  import { StockSDK } from 'https://unpkg.com/stock-sdk/dist/index.js';
  const sdk = new StockSDK();
</script>

<!-- jsDelivr -->
<script type="module">
  import { StockSDK } from 'https://cdn.jsdelivr.net/npm/stock-sdk/dist/index.js';
  const sdk = new StockSDK();
</script>

Requirements

• Node.js: >= 18.0.0
• Browser: Modern browsers with ES Module support

TypeScript

Stock SDK is written in TypeScript and provides complete type definitions. No additional @types packages needed.

import { StockSDK, FullQuote, KlineData } from 'stock-sdk';

const sdk = new StockSDK();
const quotes: FullQuote[] = await sdk.getFullQuotes(['sz000858']);

Next Steps

• Quick Start - Start using Stock SDK
• Browser Usage - Using in browser environment