Skip to main content

BingX REST API Python implementation

Project description

Updated 1st Oct 2023

https://img.shields.io/pypi/v/py-bingx.svg https://img.shields.io/pypi/l/py-bingx.svg

py-bingx is an unofficial Python wrapper for the BingX Perpetual Swap API. I am not affiliated with BingX.

TODO

  • Add Response exception handling.

  • Implement the remaining less important endpoints.

Usage

Register an account on BingX.

Create an API and make sure you copy you Secret Key before leaving the page.

pip install py-bingx
from bingx.api import BingxAPI

...

API_KEY = '<api_public_key>'
SECRET_KEY = '<api_secret_key>'

# It is faster and more efficient to use local timestamps. If you are getting an error try using "server" timestamp.
bingx = BingxAPI(API_KEY, SECRET_KEY, timestamp="local")
order_data = bingx.open_market_order('FLOKI-USDT', 'LONG', 121220, tp="0.00001800", sl="0.00001700")

Functions

py-bingx was written with the goal of being user-friendly. Feel free to ask your questions and state any bugs/issues with the code.

You can find the list of py-bingx functions below:

Market Data Functions

  • get_all_contracts() - Gets a list of all contracts/trading pairs available on Bingx

  • get_latest_price(pair) - Gets the latest price for a trading pair

  • get_market_depth(pair, limit) - Gets the order book depth data for a trading pair

  • get_latest_trade(pair) - Gets recent trades for a trading pair

  • get_latest_funding(pair) - Gets latest funding rate for a trading pair

  • get_index_price(pair) - Gets index price for a trading pair

  • get_market_price(pair) - Gets market price for a trading pair

  • get_funding_history(pair) - Gets historical funding rate data for a trading pair

  • get_kline_data(pair, interval, start_time, end_time, limit) - Gets candlestick/kline data for a trading pair

  • get_open_positions(pair) - Gets open interest data for a trading pair

  • get_tiker(pair) - Gets ticker data including 24hr prices and volumes

  • get_current_optimal_price(pair) - Gets best bid and offer prices for a trading pair

Account Data Functions

  • get_perpetual_balance() - Get user account balance info

  • get_my_perpetual_swap_positions(pair) - Get user open positions for a trading pair

  • get_fee_rate() - Get fee rate for trading

Trading Functions

  • open_market_order() - Opens a market order to buy/sell a trading pair

  • close_market_order() - Closes an open market order

  • place_trigger_market_order() - Places a stop-trigger market order

  • open_limit_order() - Opens a limit order for a trading pair

  • close_limit_order() - Closes an open limit order

  • place_trigger_limit_order() - Places a stop-trigger limit order

  • place_trailing_stop_order() - Places a trailing stop order

  • place_test_order() - Places a test order that does not execute

  • close_all_positions() - Closes all open positions for user

  • cancel_order() - Cancels a pending order

  • cancel_all_orders_of_symbol() - Cancels all pending orders for a trading pair

  • cancel_batch_orders() - Cancels multiple pending orders

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

py-bingx-0.4.tar.gz (12.7 kB view hashes)

Uploaded Source

Built Distribution

py_bingx-0.4-py3-none-any.whl (9.6 kB view hashes)

Uploaded Python 3

Supported by

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