bitmex-python

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

You can check the SDK docs here: SDK
You can check Bitmex's docs here: Docs
Github repo: https://github.com/ccxt/bitmex-python
Pypi package: https://pypi.org/project/bitmex-api

Installation

pip install bitmex-api

Usage

Sync

from bitmex import BitmexSync

def main():
    instance = BitmexSync({})
    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 bitmex import BitmexAsync

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

async def main():
    instance = BitmexAsync({})
    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 bitmex import BitmexWs

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

async def main():
    instance = BitmexWs({})
    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_order(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, params: dict = {})
fetch_balance(self, params: dict = {})
fetch_closed_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params: dict = {})
fetch_currencies(self, params: dict = {})
fetch_deposit_address(self, code: str, params: dict = {})
fetch_deposit_withdraw_fees(self, codes: Strings = None, params: dict = {})
fetch_deposits_withdrawals(self, code: Str = None, since: Int = None, limit: Int = None, params: dict = {})
fetch_funding_rate_history(self, symbol: Str = None, since: Int = None, limit: Int = None, params: dict = {})
fetch_funding_rates(self, symbols: Strings = None, params: dict = {})
fetch_ledger(self, code: Str = None, since: Int = None, limit: Int = None, params: dict = {})
fetch_leverages(self, symbols: Strings = None, params: dict = {})
fetch_liquidations(self, symbol: str, since: Int = None, limit: Int = None, params: dict = {})
fetch_markets(self, params: dict = {})
fetch_my_trades(self, symbol: Str = None, since: Int = None, limit: Int = None, params: dict = {})
fetch_ohlcv(self, symbol: str, timeframe: str = '1m', since: Int = None, limit: Int = None, params: dict = {})
fetch_open_interests(self, symbols: Strings = None, params: dict = {})
fetch_open_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params: dict = {})
fetch_order_book(self, symbol: str, limit: Int = None, params: dict = {})
fetch_order(self, id: str, symbol: Str = None, params: dict = {})
fetch_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params: dict = {})
fetch_positions_adl_rank(self, symbols: Strings = None, params: dict = {})
fetch_positions(self, symbols: Strings = None, params: dict = {})
fetch_settlement_history(self, symbol: Str = None, since: Int = None, limit: Int = None, params: dict = {})
fetch_ticker(self, symbol: str, params: dict = {})
fetch_tickers(self, symbols: Strings = None, params: dict = {})
fetch_trades(self, symbol: str, since: Int = None, limit: Int = None, params: dict = {})
amount_to_precision(self, symbol: Str, amount: object)
calculate_rate_limiter_cost(self, api: object, method: object, path: object, params: object, config: object = {})
cancel_all_orders_after(self, timeout: Int, params: dict = {})
cancel_all_orders(self, symbol: Str = None, params: dict = {})
cancel_order(self, id: str, symbol: Str = None, params: dict = {})
cancel_orders(self, ids: list[str], symbol: Str = None, params: dict = {})
close_position(self, symbol: str, side: OrderSide = None, params: dict = {})
convert_from_raw_cost(self, symbol: Str, rawQuantity: Str)
convert_from_raw_quantity(self, symbol: Str, rawQuantity: Str, currencySide: Str = 'base')
convert_from_real_amount(self, code: Str, amount: Num)
convert_to_real_amount(self, code: Str, amount: Str)
describe(self)
edit_order(self, id: str, symbol: str, type: OrderType, side: OrderSide, amount: Num = None, price: Num = None, params: dict = {})
nonce(self)
set_leverage(self, leverage: int, symbol: Str = None, params: dict = {})
set_margin_mode(self, marginMode: str, symbol: Str = None, params: dict = {})
withdraw(self, code: str, amount: float, address: str, tag: Str = None, params: dict = {})

REST Raw

public_get_announcement(request)
public_get_announcement_urgent(request)
public_get_chat(request)
public_get_chat_channels(request)
public_get_chat_connected(request)
public_get_chat_pinned(request)
public_get_funding(request)
public_get_guild(request)
public_get_instrument(request)
public_get_instrument_active(request)
public_get_instrument_activeandindices(request)
public_get_instrument_activeintervals(request)
public_get_instrument_compositeindex(request)
public_get_instrument_indices(request)
public_get_instrument_usdvolume(request)
public_get_insurance(request)
public_get_leaderboard(request)
public_get_liquidation(request)
public_get_orderbook_l2(request)
public_get_porl_nonce(request)
public_get_quote(request)
public_get_quote_bucketed(request)
public_get_schema(request)
public_get_schema_websockethelp(request)
public_get_settlement(request)
public_get_stats(request)
public_get_stats_history(request)
public_get_stats_historyusd(request)
public_get_trade(request)
public_get_trade_bucketed(request)
public_get_wallet_assets(request)
public_get_wallet_currencies(request)
public_get_wallet_haircuts(request)
public_get_wallet_networks(request)
private_get_address(request)
private_get_addressconfig(request)
private_get_apikey(request)
private_get_apikey_self(request)
private_get_execution(request)
private_get_execution_tradehistory(request)
private_get_globalnotification(request)
private_get_leaderboard_name(request)
private_get_leagueoftrader_myrankings(request)
private_get_managedsubaccountbinding_investor(request)
private_get_managedsubaccountbinding_tradingteam(request)
private_get_order(request)
private_get_porl_snapshots(request)
private_get_position(request)
private_get_referralcode(request)
private_get_referralcode_check_code(request)
private_get_referralcode_code_code(request)
private_get_referralcode_id(request)
private_get_user(request)
private_get_user_affiliatestatus(request)
private_get_user_checkreferralcode(request)
private_get_user_commission(request)
private_get_user_csa(request)
private_get_user_depositaddress(request)
private_get_user_depositaddressinformation(request)
private_get_user_executionhistory(request)
private_get_user_getwallettransferaccounts(request)
private_get_user_margin(request)
private_get_user_marginingmode(request)
private_get_user_quotefillratio(request)
private_get_user_quotevalueratio(request)
private_get_user_staking(request)
private_get_user_staking_instruments(request)
private_get_user_staking_tiers(request)
private_get_user_tradingsettings(request)
private_get_user_tradingvolume(request)
private_get_user_unstakingrequests(request)
private_get_user_wallet(request)
private_get_user_wallethistory(request)
private_get_user_walletsummary(request)
private_get_useraffiliates(request)
private_get_userevent(request)
private_get_userpricealert(request)
private_get_userstats_volumerank(request)
private_post_address(request)
private_post_chat(request)
private_post_guild(request)
private_post_guild_archive(request)
private_post_guild_join(request)
private_post_guild_kick(request)
private_post_guild_leave(request)
private_post_guild_sharestrades(request)
private_post_managedsubaccountbinding_approve(request)
private_post_managedsubaccountbinding_cancel(request)
private_post_managedsubaccountbinding_createmsa(request)
private_post_managedsubaccountbinding_reject(request)
private_post_managedsubaccountbinding_toggletradehistory(request)
private_post_managedsubaccountbinding_unbind(request)
private_post_order(request)
private_post_order_cancelallafter(request)
private_post_order_closeposition(request)
private_post_position_crossleverage(request)
private_post_position_isolate(request)
private_post_position_leverage(request)
private_post_position_risklimit(request)
private_post_position_transfermargin(request)
private_post_referralcode(request)
private_post_user_addsubaccount(request)
private_post_user_cancelwithdrawal(request)
private_post_user_communicationtoken(request)
private_post_user_confirmemail(request)
private_post_user_confirmwithdrawal(request)
private_post_user_createindependentsubaccount(request)
private_post_user_logout(request)
private_post_user_marginingmode(request)
private_post_user_positionmode(request)
private_post_user_preferences(request)
private_post_user_requestwithdrawal(request)
private_post_user_unstakingrequests(request)
private_post_user_updatesubaccount(request)
private_post_user_wallettransfer(request)
private_post_userpricealert(request)
private_put_address(request)
private_put_guild(request)
private_put_order(request)
private_put_referralcode_id(request)
private_put_userpricealert_id(request)
private_delete_order(request)
private_delete_order_all(request)
private_delete_referralcode_id(request)
private_delete_user_unstakingrequests(request)
private_delete_user_withdrawal(request)
private_delete_userpricealert(request)
private_delete_userpricealert_id(request)

WS Unified

describe(self)
watch_ticker(self, symbol: str, params: dict = {})
watch_tickers(self, symbols: Strings = None, params: dict = {})
watch_liquidations(self, symbol: str, since: Int = None, limit: Int = None, params: dict = {})
watch_liquidations_for_symbols(self, symbols: list[str], since: Int = None, limit: Int = None, params: dict = {})
watch_balance(self, params: dict = {})
watch_trades(self, symbol: str, since: Int = None, limit: Int = None, params: dict = {})
authenticate(self, params: dict = {})
watch_positions(self, symbols: Strings = None, since: Int = None, limit: Int = None, params: dict = {})
watch_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params: dict = {})
watch_my_trades(self, symbol: Str = None, since: Int = None, limit: Int = None, params: dict = {})
watch_order_book(self, symbol: str, limit: Int = None, params: dict = {})
watch_order_book_for_symbols(self, symbols: list[str], limit: Int = None, params: dict = {})
watch_trades_for_symbols(self, symbols: list[str], since: Int = None, limit: Int = None, params: dict = {})
watch_ohlcv(self, symbol: str, timeframe: str = '1m', since: Int = None, limit: Int = None, params: dict = {})
watch_heartbeat(self, params: dict = {})

Contribution

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

Release files for bitmex-api 0.0.163

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bitmex-api 0.0.163
File	Size	Uploaded
bitmex_api-0.0.163.tar.gz	305.3 kB	Sep 23, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for bitmex-api 0.0.163
File	Interpreter	ABI	Platform	Reset
bitmex_api-0.0.163-py3-none-any.whl 346.7 kB Sep 23, 2026	Python 3	none	any	Details

Total release size: 652.0 kB

Release files / bitmex_api-0.0.163.tar.gz

Download URL	bitmex_api-0.0.163.tar.gz
Size	305.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`c108edff150d1e732d3d9248814b6719d084697d1fdac773cfd52e4de594e092`
BLAKE2b-256 checksum How to use checksums	`7f8d02a8c02864cd98f139a84158c1ce56501c13ef6e6b09240f03e05a758bee`
Upload date	Sep 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.14.7`

Release files / bitmex_api-0.0.163-py3-none-any.whl

Download URL	bitmex_api-0.0.163-py3-none-any.whl
Size	346.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`82e42df9c36a9b33e4decfe8f0fc8fd72e8ec72876a136106d3c60e8e787b6f1`
BLAKE2b-256 checksum How to use checksums	`3090b58d267c652581e4e2784558590f269d989eb993ee25ca86559de5e2e9e3`
Upload date	Sep 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.14.7`