Location>code7788 >text

Use the StockTV Global Financial Market Data API

Popularity：22 ℃/2025-03-05 18:53:42

Use the StockTV Global Financial Market Data API

summary: This article details how to quickly access StockTV's global financial market data API through the client library, covering real-time market acquisition and historical data query of stocks, foreign exchange, futures and cryptocurrencies. Through this article, developers can master core functions such as REST API calls, WebSocket real-time subscription, etc.

1. Project Overview

StockTV API client is a lightweight SDK that provides standardized access to four major financial markets around the world:

  • Support market types

    • 📈 Stocks (supports 10+ countries including India, the United States, China, etc.)
    • 💱 Forex (main currency pair + cross exchange rate)
    • 📉 Futures (Commodity Futures + Financial Futures)
    • ₿ Cryptocurrency (real-time data on mainstream exchanges)

  • Core features

    • Dual protocol support: REST API + WebSocket
    • Automatic retry mechanism (automatic recovery of network fluctuations)
    • Intelligent rate limiting processing
    • TypeScript type support (v2.0+)

2. Environmental preparation

1. Operating environment requirements

  • ≥
  • npm ≥ or yarn ≥ 1.

2. Apply for API key

accessStockTV Developer Portal, contact customer service and create an application to obtain the API Key.

3. Quick access guide

1. Install the client library

# Install using npm
 npm install stocktv-api-node --save

 # or use yarn
 yarn add stocktv-api-node

2. Initialize the client

const { StockAPI, CryptoAPI } = require('stocktv-api-node');

 // Stock client example
 const stockClient = new StockAPI({
   apiKey: 'YOUR_API_KEY', // Replace with the actual API key
   timeout: 10000, // Request timeout (ms)
 });

 // Cryptocurrency client instance
 const cryptoClient = new CryptoAPI('YOUR_API_KEY');

4. Core API usage examples

1. Obtain stock market data

Query the list of Indian stocks

async function fetchIndianStocks() {
   try {
     const response = await (
       14, // Country ID (India)
       20, // Quantity per page
       1 // Page number
     );
     ('Market data:', );
   } catch (error) {
     ('Request failed:', );
   }
 }

Get minute-level K-line

const klineData = await (
   7310, // Product ID
   'PT1M', // Time granularity (1 minute)
   {
     startTime: 1719831120000, // Start timestamp (optional)
     endTime: 1719834720000 // End timestamp (optional)
   }
 );

2. Subscribe to real-time quotes (WebSocket)

const { StockTVWebSocket } = require('stocktv-api-node');

 const ws = new StockTVWebSocket('YOUR_API_KEY');

 // Create a connection
 ((rawData) => {
   const data = (rawData);
  
   // Print key market information
   (`[${}] Latest price: ${} Rate: ${}%`);
 });

 // Error handling
 ((err) => {
   ('WebSocket error:', err);
 });

V. Advanced configuration

1. Custom request header

class CustomStockAPI extends StockAPI {
  constructor(apiKey) {
    super(apiKey);
     = {
      'X-Custom-Header': 'value',
      'Accept-Language': 'zh-CN'
    };
  }
}

2. Agent configuration

const axios = require('axios');
const { StockAPI } = require('stocktv-api-node');

const proxyClient = ({
  proxy: {
    host: '127.0.0.1',
    port: 1080,
    protocol: 'socks5'
  }
});

const proxiedStockAPI = new StockAPI('YOUR_API_KEY', {
  axiosInstance: proxyClient
});

6. Error handling best practices

1. Common error types

Status code Error Type Handling suggestions
403 Authentication failed Check API key validity
500 Internal server error Contact Technical Support

2. Implement the retry mechanism

const { StockAPI } = require('stocktv-api-node');
 const retry = require('async-retry');

 const stockAPI = new StockAPI('YOUR_API_KEY');

 async function reliableRequest() {
   return retry(async (bail) => {
     try {
       return await (14);
     } catch (error) {
       if ( === 401) bail(error); // The authentication error terminates directly
       throw error;
     }
   }, {
     retries: 5,
     minTimeout: 1000
   });
 }

7. Performance optimization suggestions

  1. Connection pool configuration
const axios = require('axios');
const httpsAgent = new ({
  keepAlive: true,
  maxSockets: 20
});

const optimizedClient = new StockAPI('YOUR_API_KEY', {
  axiosInstance: ({ httpsAgent })
});
  1. Data Caching Policy
const NodeCache = require('node-cache');
const cache = new NodeCache({ stdTTL: 60 });

async function getCachedIndices() {
  const cacheKey = 'indices_data';
  let data = (cacheKey);
  
  if (!data) {
    data = await (14);
    (cacheKey, data);
  }
  
  return data;
}

8. FAQ

Q1: How to get the country ID list?
pass/stock/stocksThe response of the interfacecountryIdField enumeration values, or check the official country code table.

Q2: How to automatically reconnect if WebSocket is disconnected?

function connectWebSocket() {
   const ws = new StockTVWebSocket('YOUR_API_KEY');
  
   (() => {
     ('The connection is disconnected, reconnect after 5 seconds...');
     setTimeout(connectWebSocket, 5000);
   });

   ();
 }

Q3: How to deal with historical data pagination?
In the callgetKlineWhen the method is used,startTimeandendTimeParameters implement time range pagination query.

9. Resource links

  • StockTV official API documentation
  • GitHub project repository
  • Best Practice Guide

Through this article's guidance, developers can quickly integrate StockTV global financial market data into their applications. It is recommended to combine official documents and code examples for in-depth customization and development to meet the financial data needs of different scenarios.

<Previous Next>