bullish-exchange / ccxt-bullish-python

ccxt exchange module for Bullish

CCXT exchange for Bullish (Python)

Overview

This python ccxt wrapper for the Bullish Trading API is work in progress. This only supports API calls on selected functionality, mainly on the read path. Please see the known gaps section for the features that are not yet available.

Pre-requisites

A valid API Key and Secret pair (HMAC) is required to access private API functionality.

Installation

This module can be installed using pip3 via source files in git. In particular:

pip3 install git+https://github.com/bullish-exchange/ccxt-bullish-python.git

or

pip3 install git+ssh://[email protected]/bullish-exchange/ccxt-bullish-python.git

Getting started

As this is not merged into ccxt yet, but available as a module - instantiate the bullish exchange object like the following:

from bullish_ccxt import bullish

my_logger = # Setup your logger...

exchange = bullish({
        'logger': my_logger,
        'apiKey': <API key>,
        'secret': <API secret>,
        'account_id': <Account ID>,
    })

fetch_balance_response = exchange.fetch_balance()
print(fetch_balance_response)

Running Integration tests

This is currently only necessary if you are trying to contribute. Update tests/exchange.py with your setup, such as environment and API keys. For example,

from bullish_ccxt import bullish

exchange = bullish({
        'apiKey': <API key>,
        'secret': <API secret>,
        'account_id': <Account ID>,
    })

exchange.set_sandbox_mode(True) # The tests are integration tests

At the parent folder of tests, trigger the tests with pytest

Available environments

• Prod
• Sandbox (set exchange.set_sandbox_mode(True) to activate sandbox)

Known gaps

• Only supports HMAC API Keys
• WebSocket support is not available
• Only read path functionality is available - such as fetch_markets and fetch_orders.
• Wallet/Custody functionality is not available yet

Feature requests

Please create issues via Github to request features or to report bugs.