Unofficial Python Wrapper for the Celcius Network API
Project description
pyCelsiusNetwork
Unofficial Python Wrapper for the Celcius Network API
See more on Github
What is this?
pyCelsiusNetwork is a Python API Wrapper for Celsius Network public API. This package also offers a short-and-sweet abstraction layer, with functions like depagination of API Results, reversing, and filtering, but the raw JSON response is always one paramether away.
Requirements
You will need:
- a Omnibus Treasury Partner Token, you can read on how to get one here.
- a Celsius Account API Key, you can read on how to generate one here
- a computer with
Python 3.5+
andpip
installed
Installation
$ pip install pycelsiusnetwork
Usage and Examples
Docs
Additional documentation is provided through the __doc__
attribute.
>> from pycelsiusnetwork import CelsiusNetwork
>> print(CelsiusNetwork.get_deposit_adress_for_coin.__doc__)
Initialization
from pycelsiusnetwork import CelsiusNetwork
api = CelsiusNetwork("PARTNER_TOKEN",
"USER_API_KEY")
### Filtering transactions
You don't neet to set all filtering options, only the ones you want.
> dt_from and dt_to also accepts datetime objects.
>
```python
filtered_transactions = api.get_transactions(dt_from="2020-01-01",
dt_to="2020-05-01",
state="confirmed",
nature="interest",
amount_lower_than=2,
amount_bigger_than=0.1)
Silence errors
By passing silent=True
to any function or the API object itself, you can mute package exceptions, A.K.A. AbstractionFailure
and CelsiusNetworkHTTPError
, by doing so, None
will be returned in the presence of an error instead of raising an Exception.
api = CelsiusNetwork("PARTNER_TOKEN",
"USER_API_KEY",
silent=True)
or
api.get_deposit_adress_for_coin('BTC', silent=True)
Also, if you pass silent=True
to the API initialization, you can override it for any function by passing silent=False
to it.
api = CelsiusNetwork("PARTNER_TOKEN",
"USER_API_KEY",
silent=True)
api.get_deposit_adress_for_coin('BTC', silent=False)
Getting the raw response
If you want to ignore the abstraction layer and get access to that juicy JSON directly, you can pass raw=True
to any function, doing so, will make the function return the full response JSON.
api.get_supported_coins(raw=True)
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
License
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
Built Distribution
Hashes for pycelsiusnetwork-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50d609779c298b55a363cbbf21c9c9496ab5fcc47c61d343f9e3352d617ab961 |
|
MD5 | 4f8de336bf7417fb77e282d7cf7e91f0 |
|
BLAKE2b-256 | 7274c2861ac67d5afff0e29c5fd6ce6afc92f8f220db1c368ba4a99b7bc62752 |