python-viabtc-api's Introduction

python-viabtc-api

API Wrapper for ViaBTC exchange server - open source cryptocurrency exchange engine. Also works with the original exchange server.

Installation

This API is very simple. The installation is just the downloading sources from github

git clone https://github.com/testnet-exchange/python-viabtc-api
cd python-viabtc-api
pip3 install -r requirements.txt

Usage

The basic usage:

from ViaBTCAPI.ViaBTCAPI import ViaBTCAPI

exchange_url = "http://localhost:8080/"  # choose to your exchange url
api = ViaBTCAPI(exchange_url)

resp = api.market_list()
market_names = [m["name"] for m in resp["result"]]
print("Exchange markets: ", market_names)

print()
print("Orderbooks:")
for market in market_names:
    ob = api.order_depth(market=market)
    print(market, ob["result"])

More usage code examples you can find in examples folder. Read the code first, it may contain some hardcoded constants that should be changed.

Working with the exchange server

Since I have had a lot of troubles with the original exchange server by ViaBTC, I've decided to write this tutorial for beginners. I hope that helps.

Install exchange

For me the easiest way to install the exchange was found in bitlum's fork of the original ViaBTC repository. You need docker and docker-compose (up-to-date) to launch this installation script.

git clone https://github.com/testnet-exchange/viabtc_exchange_server
cd viabtc_exchange_server/docker
sudo docker-compose up

That's it! It successfully run on Ubuntu and Debian servers, but failed on macOS (there were some disk path errors that I balieve can be easily fixed if you are familiar with docker or stackoverflow).

Connect to exchange local network

Docker-compose creates the local net for all dockers images. Take a look at docker-compose file: you may notice the local ip addresses near every docker container. We will use the address of accesshttp container to make API requests.

As all of that stuff is happening on the remote server's local network, we need to make some port forwarding from it to out development machine (in my case this is my macbook laptop):

ssh user@<your-server-id-address-> -L 8080:192.168.18.45:8080 -N -f

where 192.168.18.45 is the ip address of accesshttp container and 8080 is its port.

And now you can send API requests to exchange_url = "http://localhost:8080"

I spent a few hours to figure out how to run the exchange and make requests to it. If this tutorial helped you, smash the star button at the top of the page. And fell free to make Pull Requests with some additional functionallity.

Happy Coding!

python-viabtc-api's People

Contributors

Stargazers

Watchers