Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bradleykirton/ice3x
Python port of the Ice3x crypto currency exchange API
https://github.com/bradleykirton/ice3x
Last synced: 22 days ago
JSON representation
Python port of the Ice3x crypto currency exchange API
- Host: GitHub
- URL: https://github.com/bradleykirton/ice3x
- Owner: BradleyKirton
- License: mit
- Created: 2018-01-20T17:15:05.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-02T06:37:06.000Z (over 4 years ago)
- Last Synced: 2024-08-09T23:04:01.921Z (5 months ago)
- Language: Python
- Homepage:
- Size: 47.9 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ICE3X Python Library
This ice3x library is a Python package compliant with the ICE3X APi version 2.
This package is essentially a port of the official [PHP client](https://github.com/ICE3X/v2-PHP).
# Quickstart
The ICE3X API has two broad categories of resources, protected and unprotected resources.
In order to access protected resources one needs to create a private and public key under the [account management](https://ice3x.com/account/api) section of their platform.
## Sync client
```python
from ice3x.clients.sync import IceCubedSyncClient
api_key = 'public key'
secret = 'private key'
client = IceCubedSyncClient(api_key=api_key, secret=secret)
client.get_public_trade_list()
```
## Async client
```python
from __future__ import annotations
from twisted.internet import reactor
from ice3x.clients.asynchronous import IceCubedAsyncClient
api_key = 'public key'
secret = 'private key'
client = IceCubedAsyncClient(api_key=api_key, secret=secret)
def print_data(data: dict) -> None:
"""prints the json response from an API call"""
print(data)
d = client.get_public_trade_list()
d.addBoth(print_data)
reactor.run()
```
# Installation
The library can be installed from PyPi as follows.
```bash
pip install ice3x
```
The async client is an optional extra and may be installed as follows.
```bash
pip install ice3x[async]
```
To install the version on this repository follow the steps below.
```bash
git clone https://github.com/BradleyKirton/ice3x
cd ice3x
python -m venv env # virtualenv env
source env/bin/activate
pip install . #pip install .[async] for the async client
```
# Developement
Clone the repo and install the package with it's development requirements.
```bash
git clone https://github.com/BradleyKirton/ice3x
cd ice3x
pipenv install -e .[dev]
make test
```
# TODO
Note this library is still in beta.
- Write documentation