====================================================== Kucoin-Cli: Pandas-oriented REST and Websocket Wrapper
A data science focused Python API implementation
.. image:: https://img.shields.io/pypi/v/kucoin-cli.svg :target: https://pypi.org/project/kucoin-cli/
.. image:: https://img.shields.io/pypi/l/kucoin-cli.svg :target: https://pypi.org/project/kucoin-cli/
.. image:: https://img.shields.io/badge/Maintained-YES-green.svg :target: https://pypi.org/project/kucoin-cli/
Why use this library over python-kucoin <https://github.com/sammchardy/python-kucoin>_ or the official SDK <https://github.com/Kucoin/kucoin-python-sdk>_?
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
This package was written by a data analyst for data analysts. Specifically designed for fast, efficient data acquisition and high complexity trades such as HFT, market-making, and long-short strategies. Essentially all REST endpoints output to pandas Dataframes, key data acquisition functions include rich features for acquiring large amounts of historic data easily, and the trading side of the package specializes in the managment of margin where I found other packages to be lacking. Of special note, OHLCV acquisition from the KuCoin REST API is a bit of a bear to handle as you can only query a single ticker at a time to a max of 1500 bars. Thanks to the magic of pandas, this package has a one-liner capable of calling as many tickers or bars as desired. Perhaps best of all, the package comes with a fully-built one- line data pipeline able to create and update your very own SQL database with almost no effort.
- Automate the generation of a PSQL database with over 400M rows of OHLCV data
- Take complex trading algorithms live via websockets
- Quickly obtain, clean, and organize large amounts of data for use in RL/ML models
Disclaimer: This is an unofficial implementation of the KuCoin Rest and Websocket API v2. Use this package at your own risk.
Roadmap +++++++ | [ ] Finish writing documentation | [ ] Clean-up websocket implemention and improve ease of use | [ ] Add stop-loss order capabilities | [ ] Add schema configuration functionality to data pipeline | [ ] Add futures API access | [ ] Develop an asynchronous REST client
Features ++++++++
- One-line database pipeline. Open a high stability pipe from kucoin's OHLC(V) endpoint to a database of your creation
- Automatically creates database or adds to pre-existing db
- Can handle multi-day data acqusitions sessions through dynamic timeout mechanism
- Feature rich OHLC(V) acquisition
- Query multiple currencies simultaneously
- Obtain clean pandas DataFrame output of paganated data
- Access to 99%+ of REST and Websocket endpoints
- Fully implemented margin trading features
Quickstart ++++++++++
- Register for an account at
KuCoin <https://www.kucoin.com/>_ Generate an API <https://www.kucoin.com/account/api>_- Download kucoin-cli using pip
.. code-block:: bash
pip install kucoin-cli
- Try out some functions!
.. code-block:: python
import kucoincli.client as Client
Your own credentials here
api_key = 'api_key' api_secret = 'api_secret' api_passphrase = 'api_passphrase'
client = Client(api_key, api_secret, api_passphrase)
Get recent margin dataflow for Bitcoin
margin_df = client.get_margin_data("BTC")
Pull buy/sell orders for BTC-USDT
order_df = client.get_order_histories("BTC-USDT")
Query one month of minutely data for BTC-USDT and ETH-USDT
ohlvc_df = client.get_kline_history( tickers=["BTC-USDT", "ETH-USDT"], begin="2022-01-01", end="2022-02-01", interval="1min", )
Place a margin limit order to sell 1 BTC good for 10 minutes
order = client.margin_limit_order( symbol="BTC-USDT", side="sell", size=1.0000, tif="GTT", cancel_after=600, )
Buy 0.015 ETH-USDT at market price
order = client.market_order( symbol="ETH-USDT", side="buy", size="0.015", )
Why KuCoin <https://www.kucoin.com/>_?
++++++++++++++++++++++++++++++++++++++++
- For U.S. based customer this is one of the last remaining "chaotic" exchanges
- Industry low transactions fees
- High liquidity across coins and a wide offering of shitcoins
- Frequent additions of speculative coins
- Among the least regulated exchanges
Distributions & Info: +++++++++++++++++++++
KuCoin-Cli Documentation on readthedocs <https://kucoin-cli.readthedocs.io/en/latest/>_Kucoin-Cli on PyPI <https://pypi.org/project/kucoin-cli/>_Kucoin-Cli on Github <https://github.com/jaythequant/kucoin-cli>_Official Kucoin API Documenation <https://docs.kucoin.com/#general>_
Consider donating: ++++++++++++++++++
| Etherium Wallet: 0x109CcCCEc0449E80336039c983e969DD23B9CE3E | Bitcoin Wallet: 3L47AT1SoLGs65RFHYBdVmbCdtQNxZFry6
1 maintainer
Metadata
1 maintainer
Release files for kucoin-cli 1.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| kucoin-cli-1.2.1.tar.gz | 23.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| kucoin_cli-1.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 47.6 kB
Release files / kucoin-cli-1.2.1.tar.gz
| Download URL | kucoin-cli-1.2.1.tar.gz |
|---|---|
| Size | 23.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4fd7bffe2fa68bd82608a0d8749e349b87e4a97a887aa9af8113d1a4b0f6e517
|
|
BLAKE2b-256 checksum How to use checksums |
9d4b463338a538235cd5dd93c641e8db6cefb958cc99b888984241b0011402cc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.5
|
Release files / kucoin_cli-1.2.1-py3-none-any.whl
| Download URL | kucoin_cli-1.2.1-py3-none-any.whl |
|---|---|
| Size | 24.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
146ce9438337992a4bccd56c416f20ddf571f2ae6eb63dc53e97a1bab48b423d
|
|
BLAKE2b-256 checksum How to use checksums |
9f288b23540bde51e2c293ce087b51866f73296ffa38bc438969af1a51a5f52e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.5
|
