Ice3x Crypto Currency Exchanage Python API
Project description
# 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 typing import Dict
from twisted.internet import reactor
from ice3x.clients.async 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
python -m venv env # virtualenv env
source env/bin/activate
pip install -e .[dev]
pytest
```
# TODO
Note this library is still in beta.
- Write documentation
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 typing import Dict
from twisted.internet import reactor
from ice3x.clients.async 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
python -m venv env # virtualenv env
source env/bin/activate
pip install -e .[dev]
pytest
```
# TODO
Note this library is still in beta.
- Write documentation
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ice3x-0.2.tar.gz
(5.7 kB
view details)
Built Distributions
ice3x-0.2.0-py3-none-any.whl
(8.6 kB
view details)
ice3x-0.2-py3-none-any.whl
(8.6 kB
view details)
File details
Details for the file ice3x-0.2.tar.gz
.
File metadata
- Download URL: ice3x-0.2.tar.gz
- Upload date:
- Size: 5.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67484db2c63f692804b6f02eca4d700e3ed2d7b09a2fa0ca43465026b0cd12ca |
|
MD5 | 002055d5bdec1291a52d9e69d1914e7b |
|
BLAKE2b-256 | 22b25e5aac7cfd4ad5b02a65ba85e199e9e8200587eadd258ad2d23768945a14 |
File details
Details for the file ice3x-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: ice3x-0.2.0-py3-none-any.whl
- Upload date:
- Size: 8.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bec3fd912bcad4dcd345030604eb7f9e9ee89a7451ab95ce623202702a023025 |
|
MD5 | 086e1c94f9d35c3fddbbf547705e9ff3 |
|
BLAKE2b-256 | d96b8d2dc0f5a62352e971b2833bc04a56cf87d54fa539443215d7e50a7d7b6f |
File details
Details for the file ice3x-0.2-py3-none-any.whl
.
File metadata
- Download URL: ice3x-0.2-py3-none-any.whl
- Upload date:
- Size: 8.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e31d902adbece04f45c6cb7497ec7cefa2e124689e99b56e8372a549a8649549 |
|
MD5 | 43f38f9c9f7fd8b173e73e24ef2722c2 |
|
BLAKE2b-256 | ca24bf96f5baf8f6ffe649430c787420cac8456ad850f53397b846444c662f3f |