Skip to main content

A Python library for interacting with the CoinEx API.

Project description

CoinexLib

Version: 1.1.0

CoinexLib is a Python library for interacting with the CoinEx API. This library simplifies the process of accessing CoinEx's cryptocurrency trading features, allowing developers to retrieve market data, manage balances, and place orders.


Features

  • Market Data Retrieval: Fetch market depth, recent trades, candlestick data, and futures market information.
  • Account Management: Access spot and futures account balances.
  • Order Management: Place, check the status of, and manage orders in spot and futures markets.
  • Futures Management: Adjust position leverage and retrieve current positions.
  • User Transaction Records: Retrieve transactions for specific user orders.
  • Order Placement: Place single and batch orders, including stop orders.

Installation

Install the library using pip:

pip install coinexlib

Usage

Initialize the API

To use CoinexLib, you need an API key and secret from CoinEx. Initialize the API client as follows:

from coinexlib import CoinexAPI

api = CoinexAPI("your_access_id", "your_secret_key")

Fetch Spot Market Depth

Retrieve the market depth for a specific spot market:

market_depth = api.get_market_depth("BTCUSDT", limit=10, interval="0")
print(market_depth)

Retrieve Account Balance

Get your account balance for spot trading:

balance = api.get_balance()
print(balance)

Place a Spot Order

Place a buy or sell order in the spot market:

order = api.place_order(
    market="BTCUSDT",
    market_type="SPOT",
    side="buy",
    order_type="limit",
    amount="0.1",
    price="25000"
)
print(order)

Place a Stop Order

Place a buy or sell stop order in the spot market:

order = api.place_stop_order(
    market="BTCUSDT",
    market_type="SPOT",
    side="buy",
    order_type="limit",
    amount="0.1",
    price="25000"
)
print(order)

Batch Place Orders

Place multiple orders in batch:

orders = [
    {"market": "BTCUSDT", "market_type": "SPOT", "side": "buy", "order_type": "limit", "amount": "0.1", "price": "25000"},
    {"market": "ETHUSDT", "market_type": "SPOT", "side": "sell", "order_type": "limit", "amount": "1", "price": "1800"}
]
batch_order = api.batch_place_orders(orders)
print(batch_order)

Query Order Status

Query the status of a specific order:

order_status = api.query_order_status(market="BTCUSDT", order_id=123456789)
print(order_status)

Retrieve Futures Positions

Get the current futures positions:

positions = api.get_current_position("BTCUSDT")
print(positions)

New Methods Added in Version 1.1.0

Market Data

  • get_market_status(market): Retrieve the market status for specified markets or all markets.
  • get_market_transactions(market, limit, last_id): Retrieve recent transaction records for a specific market.
  • get_market_index(market): Retrieve the market index information for specified markets or all markets.

User Transactions

  • get_user_transactions(market, market_type, side, start_time, end_time, page, limit): Retrieve user transaction records for a specific market.
  • get_user_order_transactions(market, market_type, order_id, page, limit): Retrieve transaction records for a specific user order.

Order Management

  • place_order(market, market_type, side, order_type, amount, price, ccy, client_id, is_hide, stp_mode): Place an order in the spot or margin market.
  • place_stop_order(market, market_type, side, order_type, amount, trigger_price, price, ccy, client_id, is_hide, stp_mode): Place a stop order in the spot or margin market.
  • batch_place_orders(orders): Place multiple orders in batch.
  • batch_place_stop_orders(orders): Place multiple stop orders in batch.
  • query_order_status(market, order_id): Query the status of a specific order.

Methods

Market Data

  • get_market_depth(market, limit, interval): Retrieve spot market depth.
  • get_market_depth_futures(market, limit, interval): Retrieve futures market depth.
  • get_market_deals(market, limit, last_id): Fetch recent spot market trades.
  • get_market_candlesticks_futures(market, limit, period, price_type): Retrieve futures market candlestick data.

Account Management

  • get_balance(): Get spot account balance.
  • get_balance_futures(): Get futures account balance.

Order Management

  • place_order_futures(market, market_type, side, order_type, amount, price, client_id, is_hide, stp_mode): Place a futures order.
  • order_status_futures(market, order_id): Check the status of a futures order.
  • adjust_position_leverage(market, market_type, margin_mode, leverage): Adjust leverage for a market position.

Requirements

  • Python 3.6+
  • requests library

Install requirements with:

pip install requests

License

This project is licensed under the MIT License.


Support

If you encounter issues or have questions, please open an issue on the GitHub repository.


Disclaimer

This library is a third-party implementation and is not affiliated with or endorsed by Coinex. Use at your own risk.

Project details


Download files

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

Source Distribution

coinexlib-1.1.0.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

coinexlib-1.1.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file coinexlib-1.1.0.tar.gz.

File metadata

  • Download URL: coinexlib-1.1.0.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.9

File hashes

Hashes for coinexlib-1.1.0.tar.gz
Algorithm Hash digest
SHA256 181e333d9a94346cc7e49e40a7853f4239801b29bb07b7171838e94bc2e9c4da
MD5 20c4364f5b721418e5b2caec6cede4e0
BLAKE2b-256 f4f4c403f91dd85865025179833ee58690770129b2024a90e7f0ab1d1a5da0a0

See more details on using hashes here.

File details

Details for the file coinexlib-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: coinexlib-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.9

File hashes

Hashes for coinexlib-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ac82e1bf1768f169db4da63ce90023225ad470924a9d354dbbb491d585714270
MD5 85f6e5b8b9eb9c0ea9e379ad907b3a12
BLAKE2b-256 8f041739caff82ca648dc211e6a9db43067407e71c1ec598e2d404e11587972b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page