====================================================== 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 with an eye towards data science and quantitative trading strategies. Specifically designed for fast, efficient data acquisition and high complexity trades such as HFT, market-making, and long-short strategies. Wherever possible, endpoints have been neatly wrapped to pandas DataFrames with key data acquisition enpoints thoughtfully constructed with rich configurability reducing time needed to clean and filter data. Trading functions are explicitly geared towards simplicity with seamless margin trade integration. Of special note, OHLCV acquisition from the KuCoin REST API has been overhauled to enable the user to query multiple assets over extended time periods despite the standard enpoint's limitations of a single asset with a max 1500 bars of historic data. For large scale ML projects, leverage the kucoincli.pipe module for a one-line function capable of piping large amounts of OHLCV data directly into the user's SQL database solution.

  • Automate the generation of a enormous SQL databases with kucoincli.pipe
  • Take complex trading algorithms live via websockets using kucoincli.socket [work in progress]
  • Quickly obtain, clean, and organize large amounts of data for use in RL/ML models with kucoincli.client

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 the KuCoin OHLC(V) endpoint to your SQL database

    • Automatically creates database or adds to pre-existing db
    • Capable of handling multi-day data acqusitions sessions through dynamic timeout mechanism
    • Take a look at a pre-built example in the examples folder available at my github <https://github.com/jaythequant/kucoin-cli>_

  • Highly configurable data acquisition endpoints

    • Spend less time cleaning and managing data
    • Checkout .ohlcv, .orderbook, .symbols, and .all_tickers

  • Access to 99%+ of KuCoin REST and Websocket endpoints

  • Seamless order management between Spot and Margin markets

Quickstart ++++++++++

  1. Register for an account at KuCoin <https://www.kucoin.com/>_
  2. Generate an API <https://www.kucoin.com/account/api>_
  3. Download kucoin-cli using pip

.. code-block:: bash

pip install kucoin-cli
  1. Try out some functions!

.. code-block:: python

from kucoincli.client import 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)

Pull details for all marginable currencies quoted in BTC terms

marginable_btc_curr = client.symbols(quote="BTC", marginable=True)

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

ohlcv_df = client.ohlcv( tickers=["BTC-USDT", "ETH-USDT"], begin="2022-01-01", end="2022-02-01", interval="1min", )

Buy 500 USDT of ETH on the spot market

order = client.order( symbol="ETH-USDT", side="buy", price=500, )

Place a 10 minute Good-to-Time margin limit sell order for 1 BTC @ 24,000 USDT

order = client.order( symbol="BTC-USDT", side="sell", price=24_000, size=1.0000, tif="GTT", cancel_after=600, margin=True, type="limit", )

Obtain the full orderbook depth for XRP-USDT as a namedtuple containing numpy arrays

orderbook = client.orderbook("XRP-USDT", depth="full", format="numpy")

Specify format="pd" to obtain an identical result wrapped in a pandas dataframe

orderbook = client.orderbook("XRP-USDT", depth="full", format="pd")

Why KuCoin <https://www.kucoin.com/>_? ++++++++++++++++++++++++++++++++++++++++

  • For U.S. based customers, KuCoin is one of the few non-KYC exchanges
  • Industry low transactions fees
  • High liquidity across coins and a wide offering of alts
  • Frequent new coin listings

Consider donating: ++++++++++++++++++

| Etherium Wallet: 0x109CcCCEc0449E80336039c983e969DD23B9CE3E | Bitcoin Wallet: 3L47AT1SoLGs65RFHYBdVmbCdtQNxZFry6

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>_

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.4.6)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for jvanlandingham from gravatar.com jvanlandingham

Credits

Author: James VanLandingham

License

MIT License

Requires

Python >=3.8

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kucoin-cli-1.3.8.tar.gz (29.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kucoin_cli-1.3.8-py3-none-any.whl (30.6 kB view details)

Uploaded Python 3

File details

Details for the file kucoin-cli-1.3.8.tar.gz.

File metadata

  • Download URL: kucoin-cli-1.3.8.tar.gz
  • Upload date:
  • Size: 29.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for kucoin-cli-1.3.8.tar.gz
Algorithm Hash digest
SHA256 a60f790d51af73ca77d4a73a84085d027e8039c76148c1c49a5b9e826439fcda
MD5 73f24d3533d81852e5e768113da1cc5e
BLAKE2b-256 f264efed7aa1a0bd739b81f3226ba56c7675d4166687c3eeff8ac78ba2549f9c

See more details on using hashes here.

File details

Details for the file kucoin_cli-1.3.8-py3-none-any.whl.

File metadata

  • Download URL: kucoin_cli-1.3.8-py3-none-any.whl
  • Upload date:
  • Size: 30.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for kucoin_cli-1.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 c4756a758b8daa211f7bdb4fb3852fec9bb0afc85e9dd5cfd562ddce06aa7996
MD5 9ca7676f496ef9f8a343359982143499
BLAKE2b-256 773f430aa5c8457dee594ef5103126f310ce850eddd88a1d348f6eb7852a0360

See more details on using hashes here.

Release history Release notifications | RSS feed

1.4.6

2 files

1.4.5

2 files

1.4.4

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.9

2 files

This release

1.3.8 This release

2 files

1.3.7

2 files

1.3.6

2 files

1.3.5

2 files

1.3.4

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.10

2 files

1.2.9

2 files

1.2.8

2 files

1.2.7

2 files

1.2.6

2 files

1.2.5

2 files

1.2.4

2 files

1.2.3

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.9

2 files

1.1.8

2 files

1.1.7

2 files

1.1.6

2 files

1.1.5

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.9

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.1.0

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page