README.md

twstockjs

台股資料library

Install

npm i twstockjs

Usage

const { Basic, Realtime } = require('twstockjs');

API

Basic

getStockList()

取得上市上櫃證券清單

const stockList = await Basic.getStockList();

取得上市證券清單

const stockList = await Basic.getStockList('tse');

取得上櫃證券清單

const stockList = await Basic.getStockList('otc');

getCorpInfo(string)

取得公司資料

await Basic.getCorpInfo('2330');
await Basic.getCorpInfo('台積電');
await Basic.getCorpInfo('0050'); // null

isTradingDay(string)

判斷是否為交易日

await Basic.isTradingDay('2019/12/21'); // false

checkTradingDay(string)

檢查是否為交易日

await Basic.checkTradingDay('2019/12/21');
/*
{
  isTradingDay: false,
  des: 'weekend'
}
*/

Realtime

getByStocks(IStock[])

const realtimeData = await Realtime.getByStocks([
  {code:'2330', type:'tse'},
  {code:'3260', type:'otc'}
]);

History

get(code, year, month)

const realtimeData = await History.get(
  '2330',
  2019,
  12);