Kucoin-Cli: Pandas-oriented REST and Websocket API (alpha release)

A data science focused Python API implementation

Why use this library over python-kucoin or the official 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, OHLC(V) 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.

I have used this package to:

  • Automate the generation of a PSQL database with over 400M rows of OHLC(V) data
  • Take a complex statistical arbitrage trading algorithm live via websockets
  • Feed and train ML/RL algorithms for future deployment into live trading sessions

Disclaimer: This is an unofficial implementation of the KuCoin Rest and Websocket API v2. Use this package at your own risk.

Roadmap

  • Clean-up websocket implemention and improve ease of use
  • Improve logging across the package
  • Write better docstrings and update features for lesser used functions
  • 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

  1. Register for an account at KuCoin

  2. Generate an API

  3. Download kucoin-cli using pip

    pip install kucoin-cli

  4. Try out some functions!

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?

  • 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:
Consider donating:
  • Etherium Wallet: 0x109CcCCEc0449E80336039c983e969DD23B9CE3E
  • Bitcoin Wallet: 3L47AT1SoLGs65RFHYBdVmbCdtQNxZFry6

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.9

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.0.2.tar.gz (16.8 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.0.2-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kucoin-cli-1.0.2.tar.gz
  • Upload date:
  • Size: 16.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.1

File hashes

Hashes for kucoin-cli-1.0.2.tar.gz
Algorithm Hash digest
SHA256 4c6920ed1a71931462cebc6bc6e8f3eccdf22b95226dfd9bd85e27df018c342d
MD5 98d118497dcad1bed30d6f7c5bfd64a3
BLAKE2b-256 cc98eaa168fb7e0b20b2e642e1a5e5afc51b38d7f1a68cf0985563d9d4626340

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kucoin_cli-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 18.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.1

File hashes

Hashes for kucoin_cli-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 58ffbb5c24ca356216646b2ecf61c4dd363e574aa49c6ec0ee5b8b473de07917
MD5 dbc92f732cf0dce423cb5f2eca9ee867
BLAKE2b-256 8b886c726cab71bdd8fcdffe545ca750605a7275a3eff705f3c3d39672099564

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

1.3.8

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

This release

1.0.2 This release

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