API Overview

This page helps you quickly locate Stock SDK features and specific interfaces.

SDK Initialization

typescript

import { StockSDK } from 'stock-sdk';

const sdk = new StockSDK(options?);

Configuration Options

Option	Type	Default	Description
`baseUrl`	`string`	`'https://qt.gtimg.cn'`	Tencent API endpoint (can use proxy)
`timeout`	`number`	`30000`	Request timeout (ms)
`retry`	`RetryOptions`	See below	Retry configuration
`headers`	`Record<string, string>`	-	Custom request headers
`userAgent`	`string`	-	Custom User-Agent (may be ignored in browsers)
`rateLimit`	`RateLimitOptions`	-	Rate limiting (prevent rate limit errors)
`rotateUserAgent`	`boolean`	`false`	Enable UA rotation (Node.js only)
`circuitBreaker`	`CircuitBreakerOptions`	-	Circuit breaker (pause on consecutive failures)

Retry Options (RetryOptions)

Option	Type	Default	Description
`maxRetries`	`number`	`3`	Maximum retry attempts
`baseDelay`	`number`	`1000`	Initial backoff delay (ms)
`maxDelay`	`number`	`30000`	Maximum backoff delay (ms)
`backoffMultiplier`	`number`	`2`	Backoff multiplier
`retryableStatusCodes`	`number[]`	`[408, 429, 500, 502, 503, 504]`	HTTP status codes to retry
`retryOnNetworkError`	`boolean`	`true`	Retry on network errors
`retryOnTimeout`	`boolean`	`true`	Retry on timeout
`onRetry`	`function`	-	Retry callback `(attempt, error, delay) => void`

Rate Limit Options (RateLimitOptions)

Option	Type	Default	Description
`requestsPerSecond`	`number`	`5`	Maximum requests per second
`maxBurst`	`number`	`= requestsPerSecond`	Token bucket capacity (burst limit)

Recommendation

Configure requestsPerSecond: 3~5 to avoid triggering Eastmoney's rate limits.

Circuit Breaker Options (CircuitBreakerOptions)

Disabled by Default

The circuit breaker is disabled by default and must be explicitly configured. Recommended for production environments to prevent cascade failures.

Option	Type	Default	Description
`failureThreshold`	`number`	`5`	Number of consecutive failures to trigger open state
`resetTimeout`	`number`	`30000`	Time in ms before transitioning to half-open
`halfOpenRequests`	`number`	`1`	Number of probe requests allowed in half-open state
`onStateChange`	`function`	-	State change callback `(from, to) => void`

Circuit Breaker States:

CLOSED: Normal state, all requests allowed
OPEN: Circuit is open, all requests rejected with CircuitBreakerError
HALF_OPEN: Allows limited probe requests to test if service recovered

Full Configuration Example

typescript

const sdk = new StockSDK({
  timeout: 10000,
  headers: {
    'X-Request-Source': 'my-app',
  },
  userAgent: 'StockSDK/1.6',
  
  // Retry configuration
  retry: {
    maxRetries: 5,
    baseDelay: 500,
    onRetry: (attempt, error, delay) => {
      console.log(`Retry ${attempt}, waiting ${delay}ms`);
    }
  },
  
  // Rate limiting (recommended)
  rateLimit: {
    requestsPerSecond: 5,
    maxBurst: 10,
  },
  
  // UA rotation (Node.js only)
  rotateUserAgent: true,
  
  // Circuit breaker (optional, recommended for production)
  circuitBreaker: {
    failureThreshold: 5,
    resetTimeout: 30000,
    onStateChange: (from, to) => {
      console.log(`Circuit breaker: ${from} -> ${to}`);
    }
  }
});

See Error Handling & Retry for details.

Real-time Quotes

K-Line Data

Technical Indicators

Industry Sectors

Industry Sectors

Concept Sectors

Concept Sectors

Batch & Extended

Code Lists
Search
Batch Query
Extended Data (Fund Flow, Trading Calendar, etc.)
Dividend Details

API Overview ​

SDK Initialization ​

Configuration Options ​

Retry Options (RetryOptions) ​

Rate Limit Options (RateLimitOptions) ​

Circuit Breaker Options (CircuitBreakerOptions) ​

Full Configuration Example ​

Real-time Quotes ​

K-Line Data ​

Technical Indicators ​

Industry Sectors ​

Concept Sectors ​

Batch & Extended ​