Metadata-Version: 2.1
Name: crix
Version: 1.8.1
Summary: CRIX.IO official client
Home-page: https://github.com/blockwise/crix-client-py
Author: Baryshnikov Aleksandr (reddec)
Author-email: ab@crix.io
License: UNKNOWN
Description: # CRIX.io official client
        ![PyPI - License](https://img.shields.io/pypi/l/crix.svg)
        [![PyPI](https://img.shields.io/pypi/v/crix.svg)](https://pypi.org/project/crix/)
        ![PyPI - Wheel](https://img.shields.io/pypi/wheel/crix.svg)
        [![Documentation Status](https://readthedocs.org/projects/crix/badge/?version=latest)](https://crix.readthedocs.io/en/latest/?badge=latest)
        
        This official client of CRIX.io crypto exchange. Supports both synchronous and asynchronous approach
        
        Environment requirements:
        
        * python 3.6+
        * requests 2.* 
        
        For several operations like create/cancel orders you should
        also be registered in the exchange and got BOT API token and secret.
        
        To access historical data you should get explicit permission by exchange support.
        
        ## Installation
        
        * over pip: `pip install crix`
        * manually (dev): `pip install git+https://github.com/blockwise/crix-client-py.git#egg=crix`
        
        ## Sample usage
        
        
        ### Unauthorized (public) access
        
        
        ```python
        import crix
        
        client = crix.Client(env='prod')
        
        # get all symbols
        for symbol in client.fetch_markets():
            print(symbol)
        
        # get some order book
        depth = client.fetch_order_book('BTC_BCH')
        print(depth)
        ```
        
        
        ### Authorized (clients-only) access
        
        **BOT API token and secret are required**
        
        
        
        ```python
        import crix
        from crix.models import NewOrder
        
        client = crix.AuthorizedClient(
            env='prod',
            token='xxyyzz',
            secret='aabbcc'
        ) # replace token and secret value for your personal API credentials
        
        
        # list all open orders
        for order in client.fetch_open_orders('BTC_BCH'):
            print(order)
            
        # prepare order
        new_order = NewOrder.market('BTC_BCH', is_buy=True, quantity=0.1) # or use NewOrder constructor
        # place order
        order = client.create_order(new_order)
        print(order)
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Office/Business :: Financial
Description-Content-Type: text/markdown
