Skip to content

Command line interface that interacts with the Exbitron platform via their API

License

Notifications You must be signed in to change notification settings

DanielBoye/exbitron-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Exbitron API CLI

Exbitron

Command line interface to the website Exbitron


Exbitron is expected to be up and running this month, so I will work more on this project when Exbitron 2.0 is launched.

For latest news and announcements please join their social networks: Discord, Telegram


Translations | EN | NO |

Contents

API Documentation

The API that is used is based upon the API Exbitron has. All information and statistics are coming from here. To build out this CLI to every function they have, a person just need to add more endpoints. It just takes time, so if your feature is not here, make a issue under this project and we will take a look at it.

Setup and Run

  1. Clone this project git clone [email protected]:danielboye/exbitron-cli.git
  2. Follow the API guide to get access to your API keys.
  3. Run ./setup.shy
  4. Run python cli.py

Commands

More commands are comming. Everything can be implimented, it just takes time.

Wallet

  • oversikt - Main menu with overview over active orders and your wallet.
  • wallet - Returns the value of your wallet.
  • exit - Close the program.

Price

  • price <ticker> - Price of a trading pair.
  • ask <ticker> - Ask price from the orderbooks to a optional trading pair.
  • bid <ticker> - Bid price from the orderbooks to a optional trading pair.
  • spread <ticker> - Spread showes in % on a optional trading pair.

Example:

spread btc

Output

Spread on btc is: 2.44 %

Other

  • kontakt - Contact information to the author.

TODO

  • Get a better wallet overview
  • Execute trades
  • Stop, create and edit live orders
  • Better design for closing the script with ctrl c without printing out "KeyboardInterrupt"
  • More features from the API
  • Rewrite the project into English
  • Rewrite the program in C++
  • Convert the program into a bash command in linux with the help of a bash script. As "neofetch" only as "exbitron" that launches the client

Big changes that are cool but a little bit more difficult

  • Get trading data represented as a chart in the terminal
  • Have a more persistent program that rather asks you once for the keys, and remembers them after that

Contribute

Pull request

I appreciate all contributions whether they are small changes such as documentation of source code to major improvement of code. The easiest way is to create a fork and then make a pull request to our master branch.

More features will come eventually, and it's just a matter of creating new "issues" for any features you want, and I'll take a look at them

Contributors

The following contributors have either helped start this project, have contributed code, actively maintain it (including documentation), or in other ways be wonderful contributors to this project. We'd like to take a moment to recognize them.

danielboye mjovanc

License

The license is MIT

About

Command line interface that interacts with the Exbitron platform via their API

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published