Skip to main content

btcbox-client is a python client (sync/async) library for btcbox api.

Project description

PyPI version License: MIT

btcbox-client is a python client (sync/async) library for btcbox api

Installation

$ pip install btcbox-client

Usage

#
# sync
#
from btcbox_client.sync import Client

client = Client(public_key='your public key', private_key='your private key')
response = client.ticker()
print(response.status_code, response.json())

#
# async
#
import grequests
from btcbox_client.async import Async

client = Async(public_key='your public key', private_key='your private key')
reqs = [client.ticker(), client.depth(), client.orders(), ...]
response = grequests.map(reqs)
for r in response:
    print(r.status_code, r.json())

#
# /api/v1/ticker
#
client.ticker()
# {"high":39700,"low":36300,"buy":1.879,"sell":0,"last":38800,"vol":283.954}

#
# /api/v1/depth
#
client.depth()
# {"asks":[[70000,5],[69000,0.48],[67000,0.9999],[64498,0.02],[61160,0.017],[60980,0.03],[60000,0.1924],[55900,1.4],[55100,2],[55044,0.019],[54500,0.7836],[54190,1],[52500,5.8645],[51500,5.6594],[51490,0.02],[47500,7],[45999,0.0244],[44585,0.024],[43000,10],[41700,10],[41300,6],[40900,10],[40500,6],[40125,10.0277],[40100,5],[40089,0.509],[39800,14.7132],[39799,0.0695],[39798,5],[39700,2.89],[39000,0.209]],"bids":[[38300,1.879],[38100,1.0078],[38000,1.24],[37700,4.706],[37600,3.8313],[37001,0.146],[36999,5.8],[36400,5],[36200,1.3314],[36002,2],[36000,1.568],[35501,0.282],[35500,9.9],[35200,5.6],[35010,10],[35001,0.03],[34600,7.6],[34500,5.505],[34200,9.3],[34000,6.4],[33800,4.434],[33333,3],[32830,0.0305],[31800,2],[31500,3.018],[30001,0.03],[30000,11.48],[28000,10],[25001,0.04],[22000,5.863],[20001,0.05],[460,10]]}

#
# /api/v1/orders
#
client.orders()
# [{"date":"0","price":3,"amount":0.1,"tid":"1","type":"buy"},{"date":"0","price":32323,"amount":2,"tid":"2","type":"sell"},{"date":"0","price":32,"amount":432,"tid":"3","type":"sell"},{"date":"0","price":323,"amount":2,"tid":"4","type":"sell"},{"date":"0","price":2100,"amount":0.3,"tid":"5","type":"buy"}]

#
# /api/v1/balance
#
client.balance()
# {"uid":8,"nameauth":0,"moflag":0,"btc_balance":4234234,"btc_lock":0,"ltc_balance":32429.6,"ltc_lock":2.4,"doge_balance":0,"doge_lock":0,"jpy_balance":2344581.519,"jpy_lock":868862.481}

#
# /api/v1/wallet
#
client.wallet()
# {"result":true, "address":"1xxxxxxxxxxxxxxxxxxxxxxxx"}

#
# /api/v1/trade_list
#
client.trade_list()
# [{"id":"11","datetime":"2014-10-21 10:47:20","type":"sell","price":42000,"amount_original":1.2,"amount_outstanding":1.2},{"id":"10","datetime":"2014-10-20 13:29:39","type":"sell","price":42000,"amount_original":1.2,"amount_outstanding":1.2},{"id":"9","datetime":"2014-10-20 13:29:29","type":"sell","price":42000,"amount_original":1.2,"amount_outstanding":1.2},{"id":"8","datetime":"2014-10-20 13:28:14","type":"buy","price":42800,"amount_original":0.34,"amount_outstanding":0.34},{"id":"7","datetime":"2014-10-20 13:27:38","type":"buy","price":42750,"amount_original":0.235,"amount_outstanding":0.235},{"id":"6","datetime":"2014-10-20 13:27:15","type":"buy","price":43299,"amount_original":4.789,"amount_outstanding":4.789},{"id":"5","datetime":"2014-10-20 13:26:52","type":"buy","price":42500,"amount_original":14,"amount_outstanding":14},{"id":"4","datetime":"2014-10-20 13:26:23","type":"buy","price":43200,"amount_original":0.4813,"amount_outstanding":0.4813},{"id":"3","datetime":"2014-10-20 13:25:57","type":"buy","price":43200,"amount_original":0.4813,"amount_outstanding":0.4813}]

#
# /api/v1/trade_view
#
client.trade_view(id=11)
# {"id":11,"datetime":"2014-10-21 10:47:20","type":"sell","price":42000,"amount_original":1.2,"amount_outstanding":1.2,"status":"closed","trades":[]}

#
# /api/v1/trade_cancel
#
client.trade_cancel(id=11)
# {"result":true, "id":"11"}

#
# /api/v1/trade_add
#
client.trade_add(amount=1, price=1, type='buy')
# {"result":true, "id":"11"}

Contributing

  1. Fork it

  2. Create your feature branch (git checkout -b my-new-feature)

  3. Commit your changes (git commit -am 'Add some feature')

  4. Push to the branch (git push origin my-new-feature)

  5. Create new Pull Request

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

btcbox-client-0.1.1.tar.gz (3.7 kB view details)

Uploaded Source

File details

Details for the file btcbox-client-0.1.1.tar.gz.

File metadata

  • Download URL: btcbox-client-0.1.1.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for btcbox-client-0.1.1.tar.gz
Algorithm Hash digest
SHA256 436b5f98006429ebaa339bc17792e3f7cea98c82d3f81e1443b65187c550727d
MD5 55d2c30ffd3f2b62e97f5bd3c8b4ad58
BLAKE2b-256 8f42e4b99a19bd59c1ef1a5a2d200d14e65f87ff570a029b70e5cfbf7d00f167

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page