Add message support
[cryptoalert.git] / readme
blob0e3fe873b5d232dcfdddd5078e55631aa908bf7d
1 Alert when cryptocurrencies become more or less expensive.
3 Powered by coinmarketcap.com. Get its API key before executing a script.
5 Example
6 =======
8 sample.hjson file is
10         key: 1234-5678
11         watch: [
12                 {
13                         symbol: ETH
14                         when: >2000
15                 }
16                 {
17                         symbol: ETH
18                         when: <100
19                 }
20                 {
21                         symbol: BTC
22                         when: >15000
23                 }
24                 {
25                         symbol: ZEC
26                         when: >60
27                 }
29                 // I don't believe in USDT.
30                 {
31                         symbol: USDT
32                         when: <0.9
33                 }
34                 {
35                         symbol: USDT
36                         when: >1.1
37                 }
38         ]
40 Launch script like this
42         python cryptoalert < sample.hjson
44 Possible output is
46         BTC costs more than it was expected. Its current price is 33444.1234 USD.
47         ZEC costs more than it was expected. Its current price is 85.1267 USD.
49 Nothing is being said about ETH and USDT as their prices are not in specified
50 limits. Nothing can be printed as well.