vnstock-js
TypeScript icon, indicating that this package has built-in type declarations

0.3.1 • Public • Published

📈 vnstock-js

vnstock-js is an NPM package for fetching stock market data from source VCI. It provides functionality to retrieve trading data, symbol listings, and more.

inspired by thinh-vu/vnstock

vnstock-js docs

vnstock-js-docs.vercel.app

🚀 Features

  • Support VCI stock market data.
  • Retrieve trading prices, historical quotes and symbols listings.
  • Support Commodity Prices (Gold Price Vietnam).

📦 Installation

To install the package using npm:

npm install vnstock-js

Yarn:

yarn add vnstock-js

⚙️ Usage

Simple usage

import { Vnstock } from "vnstock-js";

const { stock } = new Vnstock();

// Get Symbols Price 
await stock.trading.priceBoard(["VCB"]);

// Get Symbols History 
await stock.quote.history({
  start: "2024-12-01",
  symbols: ["VCB"]
});

// Get All Symbols
await stock.listing.allSymbols();

✅ Testing

Run tests using Jest:

npm test

License

Apache 2.0 License Ⓒ ttqteo 2024

Readme

Keywords

Package Sidebar

Install

npm i vnstock-js

Weekly Downloads

12

Version

0.3.1

License

Apache-2.0

Unpacked Size

102 kB

Total Files

31

Last publish

Collaborators

  • ttqteo