Skip to main content

bitcom-python-api is a lightweight Python library for bit.com API, supporting Rest requests and event streaming using Websocket.

Project description

bitcom-python-api

Quick Start

Prerequisite

  • Python3

Install package

pip3 install bitcom

Host

You can get the latest hosts here, including REST API and WebSocket.

https://www.bit.com/docs/en-us/#api-hosts-production

Rest client example

from bitcom.client.market_client import MarketClient
from bitcom.utils import *
from bitcom.constant import *

# And add your personal access key and secret key
market_client = MarketClient(url=USER1_HOST, access_key=USER1_ACCESS_KEY, secret_key=USER1_SECRET_KEY)


param_map = {
    'instrument_id': 'BTC-PERPETUAL',
}
funding_rate_response = market_client.get_funding_rate(param_map)
LogInfo.output("Get funding rate: ", funding_rate_response)

Websocket subscribe example

from bitcom.client.ws_auth_client import WsAuthClient
from bitcom.client.subscribe_client import SubscribeClient
from bitcom.utils import *
from bitcom.constant import *
import json
import time


ws_client = WsAuthClient(url=USER1_HOST, access_key=USER1_ACCESS_KEY, secret_key=USER1_SECRET_KEY)

token_response = ws_client.get_ws_auth_token()
LogInfo.output("Get websocket token: ", token_response)

def on_wss_open(ws):
    cmd = """{"type": "subscribe", "instruments": ["BTC-PERPETUAL"],
     "channels": ["depth1"], "interval": "raw", "token": {your_token}}"""

    # check json
    obj = json.loads(cmd)

    print('send subscribe cmd: ' + cmd)
    ws.send(cmd)


def on_wss_msg(ws, data):
    print(data)


# Please choose an Websocket host:
# Testnet: wss://betaws.bitexch.dev
# Main: wss://ws.bitexch.dev
channel = SubscribeClient(WS_HOST, on_wss_open, on_wss_msg)
channel.start()

time.sleep(3)

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

bitcom-0.0.2.tar.gz (13.6 kB view hashes)

Uploaded Source

Built Distribution

bitcom-0.0.2-py3-none-any.whl (34.5 kB view hashes)

Uploaded Python 3

Supported by

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