py-bingx

================ This is py-bingx

Updated 1st Oct 2023

.. image:: https://img.shields.io/pypi/v/py-bingx.svg :target: https://pypi.python.org/pypi/py-bingx

.. image:: https://img.shields.io/pypi/l/py-bingx.svg :target: https://pypi.python.org/pypi/py-bingx

py-bingx is an unofficial Python wrapper for the BingX Perpetual Swap API <https://bingx-api.github.io/docs/swap/introduce.html>_. I am not affiliated with BingX.

TODO

• Add Response exception handling.
• Implement the remaining less important endpoints.

Usage

Register an account on BingX <https://bingx.com/en-us/register>_.

Create an API <https://bingx.com/en-us/account/api>_ and make sure you copy you Secret Key before leaving the page.

.. code:: bash

pip install py-bingx

.. code:: python

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