README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

<h1 align="center">Welcome to Binance Spot Order Notifier via Telegram👋</h1>
<h2>Binance order notification when order created, cancelled or filled etc.. With this repo you will receive telegram notification for your binance spot order status.</h2>
<p>
  <img alt="Version" src="https://img.shields.io/badge/version-1.0-blue.svg?cacheSeconds=2592000" />
  <a href="https://github.com/PiyushDixit96/binance-order-notifier/blob/main/LICENSE" target="_blank">
    <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
  </a>
  <a href="https://twitter.com/PiyushDixit_" target="_blank">
    <img alt="Twitter: PiyushDixit_" src="https://img.shields.io/twitter/follow/PiyushDixit_.svg?style=social" />
  </a>
</p>

> This repo sends TELEGRAM ALERTS for BINANCE ORDER STATUS like CREATED, PARTIALLY FILLED, FILLED, CANCELLED, PENDING CANCEL, REJECTED, EXPIRED etc.

<h2>Deploy to Heroku</h2>

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/PiyushDixit96/binance-order-notifier)


```diff
- when new commit/update happens, you need to create new heroku app using Deploy to heroku button,
- So that you can use the new feature.
```
------------
<h2>Setup before Deploy to Heroku</h2>

<h4>SETUP TELEGRAM BOT</h4>

1. Create account on Telegram (skip if you have)
2. Create Telegram Bot Goto [Bot help](https://core.telegram.org/bots#3-how-do-i-create-a-bot) follow steps at the END Copy **TOKEN**
3. Open created Bot and click **START**
4. Goto [@getuseridbot](https://t.me/getuseridbot) and click **START** and copy **NUMERIC VALUE** this is your **CHAT ID**

<h4>SETUP BINANCE ACCOUNT</h4>

1. [Signup](https://www.binance.com/en/register?ref=35219097) for Binance (skip if you have)
2. Enable Two-factor Authentication (skip if you're done already)
3. Go API Center, [Create New](https://www.binance.com/en/my/settings/api-management?ref=35219097) Api Key and follow steps and at the END, SET API restrictions to  **ENABLE READING ** only
4. **Copy API Key and Secret Key** save and Notepad for later use

<h4>DEPLOY TO HEROKU</h4>

1. Create account on Heroku (skip if you have)
2. Login to Heroku (if you are not)
3. Click [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/PiyushDixit96/binance-order-notifier)

![fullUntitled](https://user-images.githubusercontent.com/79581397/117697809-89587b00-b1e0-11eb-98d3-3086f973ce84.jpg)

5. Give any name in "App name" field
6. Fill required fields in "Config Vars"
7. Click "Deploy app"
8. When you see , "Your app was successfully deployed." then your bot started automatically.
9. `important step for preventing idling heroku app`. Click "View" and copy URL when new tab open in your browser

![DSCapture](https://user-images.githubusercontent.com/79581397/117698015-d1779d80-b1e0-11eb-8b57-0224ab96e3ee.JPG)

10. Goto [UptimeRobot](https://uptimerobot.com/) and Create free account
11. Click "Add New Monitor"
12. Monitor Type : HTTPS
13. Friendly Name : any name
14. URL (or IP): paste URL of your app. (you copy URL in Step 8)
15. Monitoring Interval : 20 minutes
16. Click " Create Monitor "
17. Now Enjoy
------------
> <h3>Give a ⭐️ if this project helped you!</h3>
------------
### Run Locally
- Download and install NodeJs
- Download Repo and open Repo root folder.
- Create .env in root folder and copy , paste below code
 ```sh
TELEGRAM_TOKEN="you telegram token"
TELEGRAM_CHAT_ID="your telegram chat id"
BINANCE_API_KEY="binance api key"
BINANCE_SECRET_KEY="binance api secret"
TIME_ZONE_STRING="your time zone string"

Time zone string example "Asia/Kolkata"
```
- Edit required fields in .env file and save
- Open terminal on current folder 
- Run this command to install `npm install`
- Run this to start `npm start`

## Author

👤 **Piyush Dixit**

* Twitter: [@PiyushDixit\_](https://twitter.com/PiyushDixit_)
* Github: [@PiyushDixit96](https://github.com/PiyushDixit96)
* Telegram: [@Killer_PD](https://t.me/Killer_PD)

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2021 [@PiyushDixit96](https://github.com/PiyushDixit96).<br />
This project is [MIT](https://github.com/PiyushDixit96/binance-order-notifier/blob/main/LICENSE) licensed.
***