UNPKG

952 BMarkdownView Raw
1[TseTmc.com]: http://www.tsetmc.com
2
3# TseTmc Client Library for NodeJS
4
5[![npm](https://img.shields.io/npm/v/tsetmc-client)](https://www.npmjs.com/package/tsetmc-client)
6[![npm bundle size](https://packagephobia.now.sh/badge?p=tsetmc-client)](https://packagephobia.now.sh/result?p=tsetmc-client)
7
8This library is for getting tehran stock market data from the [TseTmc.com] website.
9
10### Installation
11
12```bash
13npm install tsetmc-client
14```
15
16### 📖 Usage
17
18```javascript
19import { DayDetails } from 'tsetmc-client';
20
21const parameters = {
22 insId: '35331248532537562',
23 dEven: 20230201 // Date in format of YYYYMMDD
24};
25
26DayDetails.getPriceData(parameters).then((data) => {
27 console.log(data); // {"priceChange": 740.00, "low":15630.00, ...}
28});
29```
30
31### 📚 Documentation
32
33For all configuration options, please see [the API docs](https://paka.dev/npm/tsetmc-client/api).
34
35### License
36
37[MIT](LICENSE) © [Shahrad Elahi](https://github.com/shahradelahi)