Skip to main content

bingx crypto exchange api client

Project description

bingx-python

Python SDK (sync and async) for Bingx cryptocurrency exchange with Rest and WS capabilities.

Installation

pip install bingx

Usage

Sync

from bingx import BingxSync

def main():
    instance = BingxSync({})
    ob =  instance.fetch_order_book("BTC/USDC")
    print(ob)
    #
    # balance = instance.fetch_balance()
    # order = instance.create_order("BTC/USDC", "limit", "buy", 1, 100000)

main()

Async

import sys
import asyncio
from bingx import BingxAsync

### on Windows, uncomment below:
# if sys.platform == 'win32':
# 	asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())

async def main():
    instance = BingxAsync({})
    ob =  await instance.fetch_order_book("BTC/USDC")
    print(ob)
    #
    # balance = await instance.fetch_balance()
    # order = await instance.create_order("BTC/USDC", "limit", "buy", 1, 100000)

    # once you are done with the exchange
    await instance.close()

asyncio.run(main())

Websockets

import sys
from bingx import BingxWs

### on Windows, uncomment below:
# if sys.platform == 'win32':
# 	asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())

async def main():
    instance = BingxWs({})
    while True:
        ob = await instance.watch_order_book("BTC/USDC")
        print(ob)
        # orders = await instance.watch_orders("BTC/USDC")

    # once you are done with the exchange
    await instance.close()

asyncio.run(main())

Raw call

You can also construct custom requests to available "implicit" endpoints

        request = {
            'type': 'candleSnapshot',
            'req': {
                'coin': coin,
                'interval': tf,
                'startTime': since,
                'endTime': until,
            },
        }
        response = await instance.public_post_info(request)

Available methods

REST Unified

  • create_market_buy_order_with_cost(self, symbol: str, cost: float, params={})
  • create_market_order_with_cost(self, symbol: str, side: OrderSide, cost: float, params={})
  • create_market_sell_order_with_cost(self, symbol: str, cost: float, params={})
  • create_order_request(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, params={})
  • create_order(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, params={})
  • create_orders(self, orders: List[OrderRequest], params={})
  • fetch_balance(self, params={})
  • fetch_canceled_and_closed_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})
  • fetch_canceled_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})
  • fetch_closed_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})
  • fetch_currencies(self, params={})
  • fetch_deposit_address(self, code: str, params={})
  • fetch_deposit_addresses_by_network(self, code: str, params={})
  • fetch_deposit_withdraw_fees(self, codes: Strings = None, params={})
  • fetch_deposits(self, code: Str = None, since: Int = None, limit: Int = None, params={})
  • fetch_funding_history(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})
  • fetch_funding_rate_history(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})
  • fetch_funding_rate(self, symbol: str, params={})
  • fetch_funding_rates(self, symbols: Strings = None, params={})
  • fetch_inverse_swap_markets(self, params)
  • fetch_leverage(self, symbol: str, params={})
  • fetch_margin_mode(self, symbol: str, params={})
  • fetch_mark_price(self, symbol: str, params={})
  • fetch_mark_prices(self, symbols: Strings = None, params={})
  • fetch_market_leverage_tiers(self, symbol: str, params={})
  • fetch_markets(self, params={})
  • fetch_my_liquidations(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})
  • fetch_my_trades(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})
  • fetch_ohlcv(self, symbol: str, timeframe: str = '1m', since: Int = None, limit: Int = None, params={})
  • fetch_open_interest(self, symbol: str, params={})
  • fetch_open_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})
  • fetch_order_book(self, symbol: str, limit: Int = None, params={})
  • fetch_order(self, id: str, symbol: Str = None, params={})
  • fetch_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})
  • fetch_position_history(self, symbol: str, since: Int = None, limit: Int = None, params={})
  • fetch_position_mode(self, symbol: Str = None, params={})
  • fetch_position(self, symbol: str, params={})
  • fetch_positions(self, symbols: Strings = None, params={})
  • fetch_spot_markets(self, params)
  • fetch_swap_markets(self, params)
  • fetch_ticker(self, symbol: str, params={})
  • fetch_tickers(self, symbols: Strings = None, params={})
  • fetch_time(self, params={})
  • fetch_trades(self, symbol: str, since: Int = None, limit: Int = None, params={})
  • fetch_trading_fee(self, symbol: str, params={})
  • fetch_transfers(self, code: Str = None, since: Int = None, limit: Int = None, params={})
  • fetch_withdrawals(self, code: Str = None, since: Int = None, limit: Int = None, params={})
  • add_margin(self, symbol: str, amount: float, params={})
  • cancel_all_orders_after(self, timeout: Int, params={})
  • cancel_all_orders(self, symbol: Str = None, params={})
  • cancel_order(self, id: str, symbol: Str = None, params={})
  • cancel_orders(self, ids: List[str], symbol: Str = None, params={})
  • close_all_positions(self, params={})
  • close_position(self, symbol: str, side: OrderSide = None, params={})
  • custom_encode(self, params)
  • describe(self)
  • edit_order(self, id: str, symbol: str, type: OrderType, side: OrderSide, amount: Num = None, price: Num = None, params={})
  • nonce(self)
  • reduce_margin(self, symbol: str, amount: float, params={})
  • set_leverage(self, leverage: int, symbol: Str = None, params={})
  • set_margin_mode(self, marginMode: str, symbol: Str = None, params={})
  • set_margin(self, symbol: str, amount: float, params={})
  • set_position_mode(self, hedged: bool, symbol: Str = None, params={})
  • set_sandbox_mode(self, enable: bool)
  • transfer(self, code: str, amount: float, fromAccount: str, toAccount: str, params={})
  • withdraw(self, code: str, amount: float, address: str, tag: Str = None, params={})

REST Raw

  • fund_v1_private_get_account_balance(request)
  • spot_v1_public_get_server_time(request)
  • spot_v1_public_get_common_symbols(request)
  • spot_v1_public_get_market_trades(request)
  • spot_v1_public_get_market_depth(request)
  • spot_v1_public_get_market_kline(request)
  • spot_v1_public_get_ticker_24hr(request)
  • spot_v1_public_get_ticker_price(request)
  • spot_v1_public_get_ticker_bookticker(request)
  • spot_v1_private_get_trade_query(request)
  • spot_v1_private_get_trade_openorders(request)
  • spot_v1_private_get_trade_historyorders(request)
  • spot_v1_private_get_trade_mytrades(request)
  • spot_v1_private_get_user_commissionrate(request)
  • spot_v1_private_get_account_balance(request)
  • spot_v1_private_get_oco_orderlist(request)
  • spot_v1_private_get_oco_openorderlist(request)
  • spot_v1_private_get_oco_historyorderlist(request)
  • spot_v1_private_post_trade_order(request)
  • spot_v1_private_post_trade_cancel(request)
  • spot_v1_private_post_trade_batchorders(request)
  • spot_v1_private_post_trade_order_cancelreplace(request)
  • spot_v1_private_post_trade_cancelorders(request)
  • spot_v1_private_post_trade_cancelopenorders(request)
  • spot_v1_private_post_trade_cancelallafter(request)
  • spot_v1_private_post_oco_order(request)
  • spot_v1_private_post_oco_cancel(request)
  • spot_v2_public_get_market_depth(request)
  • spot_v2_public_get_market_kline(request)
  • spot_v2_public_get_ticker_price(request)
  • spot_v3_private_get_get_asset_transfer(request)
  • spot_v3_private_get_asset_transfer(request)
  • spot_v3_private_get_capital_deposit_hisrec(request)
  • spot_v3_private_get_capital_withdraw_history(request)
  • spot_v3_private_post_post_asset_transfer(request)
  • swap_v1_public_get_ticker_price(request)
  • swap_v1_public_get_market_historicaltrades(request)
  • swap_v1_public_get_market_markpriceklines(request)
  • swap_v1_public_get_trade_multiassetsrules(request)
  • swap_v1_public_get_tradingrules(request)
  • swap_v1_private_get_positionside_dual(request)
  • swap_v1_private_get_trade_batchcancelreplace(request)
  • swap_v1_private_get_trade_fullorder(request)
  • swap_v1_private_get_maintmarginratio(request)
  • swap_v1_private_get_trade_positionhistory(request)
  • swap_v1_private_get_positionmargin_history(request)
  • swap_v1_private_get_twap_openorders(request)
  • swap_v1_private_get_twap_historyorders(request)
  • swap_v1_private_get_twap_orderdetail(request)
  • swap_v1_private_get_trade_assetmode(request)
  • swap_v1_private_get_user_marginassets(request)
  • swap_v1_private_post_trade_amend(request)
  • swap_v1_private_post_trade_cancelreplace(request)
  • swap_v1_private_post_positionside_dual(request)
  • swap_v1_private_post_trade_batchcancelreplace(request)
  • swap_v1_private_post_trade_closeposition(request)
  • swap_v1_private_post_trade_getvst(request)
  • swap_v1_private_post_twap_order(request)
  • swap_v1_private_post_twap_cancelorder(request)
  • swap_v1_private_post_trade_assetmode(request)
  • swap_v1_private_post_trade_reverse(request)
  • swap_v1_private_post_trade_autoaddmargin(request)
  • swap_v2_public_get_server_time(request)
  • swap_v2_public_get_quote_contracts(request)
  • swap_v2_public_get_quote_price(request)
  • swap_v2_public_get_quote_depth(request)
  • swap_v2_public_get_quote_trades(request)
  • swap_v2_public_get_quote_premiumindex(request)
  • swap_v2_public_get_quote_fundingrate(request)
  • swap_v2_public_get_quote_klines(request)
  • swap_v2_public_get_quote_openinterest(request)
  • swap_v2_public_get_quote_ticker(request)
  • swap_v2_public_get_quote_bookticker(request)
  • swap_v2_private_get_user_balance(request)
  • swap_v2_private_get_user_positions(request)
  • swap_v2_private_get_user_income(request)
  • swap_v2_private_get_trade_openorders(request)
  • swap_v2_private_get_trade_openorder(request)
  • swap_v2_private_get_trade_order(request)
  • swap_v2_private_get_trade_margintype(request)
  • swap_v2_private_get_trade_leverage(request)
  • swap_v2_private_get_trade_forceorders(request)
  • swap_v2_private_get_trade_allorders(request)
  • swap_v2_private_get_trade_allfillorders(request)
  • swap_v2_private_get_trade_fillhistory(request)
  • swap_v2_private_get_user_income_export(request)
  • swap_v2_private_get_user_commissionrate(request)
  • swap_v2_private_get_quote_bookticker(request)
  • swap_v2_private_post_trade_getvst(request)
  • swap_v2_private_post_trade_order(request)
  • swap_v2_private_post_trade_batchorders(request)
  • swap_v2_private_post_trade_closeallpositions(request)
  • swap_v2_private_post_trade_cancelallafter(request)
  • swap_v2_private_post_trade_margintype(request)
  • swap_v2_private_post_trade_leverage(request)
  • swap_v2_private_post_trade_positionmargin(request)
  • swap_v2_private_post_trade_order_test(request)
  • swap_v2_private_delete_trade_order(request)
  • swap_v2_private_delete_trade_batchorders(request)
  • swap_v2_private_delete_trade_allopenorders(request)
  • swap_v3_public_get_quote_klines(request)
  • swap_v3_private_get_user_balance(request)
  • cswap_v1_public_get_market_contracts(request)
  • cswap_v1_public_get_market_premiumindex(request)
  • cswap_v1_public_get_market_openinterest(request)
  • cswap_v1_public_get_market_klines(request)
  • cswap_v1_public_get_market_depth(request)
  • cswap_v1_public_get_market_ticker(request)
  • cswap_v1_private_get_trade_leverage(request)
  • cswap_v1_private_get_trade_forceorders(request)
  • cswap_v1_private_get_trade_allfillorders(request)
  • cswap_v1_private_get_trade_openorders(request)
  • cswap_v1_private_get_trade_orderdetail(request)
  • cswap_v1_private_get_trade_orderhistory(request)
  • cswap_v1_private_get_trade_margintype(request)
  • cswap_v1_private_get_user_commissionrate(request)
  • cswap_v1_private_get_user_positions(request)
  • cswap_v1_private_get_user_balance(request)
  • cswap_v1_private_post_trade_order(request)
  • cswap_v1_private_post_trade_leverage(request)
  • cswap_v1_private_post_trade_allopenorders(request)
  • cswap_v1_private_post_trade_closeallpositions(request)
  • cswap_v1_private_post_trade_margintype(request)
  • cswap_v1_private_post_trade_positionmargin(request)
  • cswap_v1_private_delete_trade_allopenorders(request)
  • cswap_v1_private_delete_trade_cancelorder(request)
  • contract_v1_private_get_allposition(request)
  • contract_v1_private_get_allorders(request)
  • contract_v1_private_get_balance(request)
  • wallets_v1_private_get_capital_config_getall(request)
  • wallets_v1_private_get_capital_deposit_address(request)
  • wallets_v1_private_get_capital_innertransfer_records(request)
  • wallets_v1_private_get_capital_subaccount_deposit_address(request)
  • wallets_v1_private_get_capital_deposit_subhisrec(request)
  • wallets_v1_private_get_capital_subaccount_innertransfer_records(request)
  • wallets_v1_private_get_capital_deposit_riskrecords(request)
  • wallets_v1_private_post_capital_withdraw_apply(request)
  • wallets_v1_private_post_capital_innertransfer_apply(request)
  • wallets_v1_private_post_capital_subaccountinnertransfer_apply(request)
  • wallets_v1_private_post_capital_deposit_createsubaddress(request)
  • subaccount_v1_private_get_list(request)
  • subaccount_v1_private_get_assets(request)
  • subaccount_v1_private_get_allaccountbalance(request)
  • subaccount_v1_private_post_create(request)
  • subaccount_v1_private_post_apikey_create(request)
  • subaccount_v1_private_post_apikey_edit(request)
  • subaccount_v1_private_post_apikey_del(request)
  • subaccount_v1_private_post_updatestatus(request)
  • account_v1_private_get_uid(request)
  • account_v1_private_get_apikey_query(request)
  • account_v1_private_get_account_apipermissions(request)
  • account_v1_private_get_allaccountbalance(request)
  • account_v1_private_post_innertransfer_authorizesubaccount(request)
  • account_transfer_v1_private_get_subaccount_asset_transferhistory(request)
  • account_transfer_v1_private_post_subaccount_transferasset_supportcoins(request)
  • account_transfer_v1_private_post_subaccount_transferasset(request)
  • user_auth_private_post_userdatastream(request)
  • user_auth_private_put_userdatastream(request)
  • user_auth_private_delete_userdatastream(request)
  • copytrading_v1_private_get_swap_trace_currenttrack(request)
  • copytrading_v1_private_get_pfutures_traderdetail(request)
  • copytrading_v1_private_get_pfutures_profithistorysummarys(request)
  • copytrading_v1_private_get_pfutures_profitdetail(request)
  • copytrading_v1_private_get_pfutures_tradingpairs(request)
  • copytrading_v1_private_get_spot_traderdetail(request)
  • copytrading_v1_private_get_spot_profithistorysummarys(request)
  • copytrading_v1_private_get_spot_profitdetail(request)
  • copytrading_v1_private_get_spot_historyorder(request)
  • copytrading_v1_private_post_swap_trace_closetrackorder(request)
  • copytrading_v1_private_post_swap_trace_settpsl(request)
  • copytrading_v1_private_post_pfutures_setcommission(request)
  • copytrading_v1_private_post_spot_trader_sellorder(request)
  • api_v3_private_get_asset_transfer(request)
  • api_v3_private_get_asset_transferrecord(request)
  • api_v3_private_get_capital_deposit_hisrec(request)
  • api_v3_private_get_capital_withdraw_history(request)
  • api_v3_private_post_post_asset_transfer(request)
  • api_asset_v1_private_post_transfer(request)
  • api_asset_v1_public_get_transfer_supportcoins(request)
  • agent_v1_private_get_account_inviteaccountlist(request)
  • agent_v1_private_get_reward_commissiondatalist(request)
  • agent_v1_private_get_account_inviterelationcheck(request)
  • agent_v1_private_get_asset_depositdetaillist(request)
  • agent_v1_private_get_reward_third_commissiondatalist(request)
  • agent_v1_private_get_asset_partnerdata(request)
  • agent_v1_private_get_commissiondatalist_referralcode(request)
  • agent_v1_private_get_account_superiorcheck(request)

WS Unified

  • describe(self)
  • un_watch(self, messageHash: str, subMessageHash: str, subscribeHash: str, dataType: str, topic: str, market: Market, methodName: str, params={})
  • watch_ticker(self, symbol: str, params={})
  • un_watch_ticker(self, symbol: str, params={})
  • get_order_book_limit_by_market_type(self, marketType: str, limit: Int = None)
  • get_message_hash(self, unifiedChannel: str, symbol: Str = None, extra: Str = None)
  • watch_trades(self, symbol: str, since: Int = None, limit: Int = None, params={})
  • un_watch_trades(self, symbol: str, params={})
  • watch_order_book(self, symbol: str, limit: Int = None, params={})
  • un_watch_order_book(self, symbol: str, params={})
  • watch_ohlcv(self, symbol: str, timeframe: str = '1m', since: Int = None, limit: Int = None, params={})
  • un_watch_ohlcv(self, symbol: str, timeframe: str = '1m', params={})
  • watch_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})
  • watch_my_trades(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})
  • watch_balance(self, params={})
  • set_balance_cache(self, client: Client, type, subType, subscriptionHash, params)
  • load_balance_snapshot(self, client, messageHash, type, subType)
  • watch_positions(self, symbols: Strings = None, since: Int = None, limit: Int = None, params={})
  • set_positions_cache(self, client: Client, type, symbols: Strings = None)
  • load_positions_snapshot(self, client, messageHash, type)
  • keep_alive_listen_key(self, params={})
  • authenticate(self, params={})
  • pong(self, client, message)

Contribution

  • Give us a star :star:
  • Fork and Clone! Awesome
  • Select existing issues or create a new issue.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

bingx-0.0.131.tar.gz (773.1 kB view details)

Uploaded Source

Built Distribution

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

bingx-0.0.131-py3-none-any.whl (1.0 MB view details)

Uploaded Python 3

File details

Details for the file bingx-0.0.131.tar.gz.

File metadata

  • Download URL: bingx-0.0.131.tar.gz
  • Upload date:
  • Size: 773.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for bingx-0.0.131.tar.gz
Algorithm Hash digest
SHA256 714125e039132d2b1980fb908af1680b138f48ea760c636983ecee5a6f2e6efb
MD5 711f301ff632344fede6d463dc488799
BLAKE2b-256 ecf2915fac89a8cf7c371ca442eb00058858943adb90cb901f58676ed3680563

See more details on using hashes here.

File details

Details for the file bingx-0.0.131-py3-none-any.whl.

File metadata

  • Download URL: bingx-0.0.131-py3-none-any.whl
  • Upload date:
  • Size: 1.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for bingx-0.0.131-py3-none-any.whl
Algorithm Hash digest
SHA256 a17995b74d3ef7ec1b3d9d90cdb24295fbaf7a0bd207ad8c91f57b89b0e131f7
MD5 3304393f7156ae5c4bd9225008302ea5
BLAKE2b-256 238f19c714d2564e964c5820457e3ffbed87aa84c9682b5c29f4a7747eee3d04

See more details on using hashes here.

Supported by

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