Skip to main content

woo crypto exchange api client

Project description

woo-python

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

Installation

pip install woo-api

Usage

Sync

from woo import WooSync

def main():
    instance = WooSync({})
    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 woo import WooAsync

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

async def main():
    instance = WooAsync({})
    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 woo import WooWs

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

async def main():
    instance = WooWs({})
    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_convert_trade(self, id: str, fromCode: str, toCode: str, amount: Num = None, params={})
  • create_market_buy_order_with_cost(self, symbol: str, cost: float, params={})
  • create_market_sell_order_with_cost(self, symbol: str, cost: float, params={})
  • create_order(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, params={})
  • create_trailing_amount_order(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, trailingAmount: Num = None, trailingTriggerPrice: Num = None, params={})
  • create_trailing_percent_order(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, trailingPercent: Num = None, trailingTriggerPrice: Num = None, params={})
  • fetch_accounts(self, params={})
  • fetch_balance(self, params={})
  • fetch_closed_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})
  • fetch_convert_currencies(self, params={})
  • fetch_convert_quote(self, fromCode: str, toCode: str, amount: Num = None, params={})
  • fetch_convert_trade_history(self, code: Str = None, since: Int = None, limit: Int = None, params={})
  • fetch_convert_trade(self, id: str, code: Str = None, params={})
  • fetch_currencies(self, params={})
  • fetch_deposit_address(self, code: str, params={})
  • fetch_deposits_withdrawals(self, code: Str = None, since: Int = None, limit: Int = 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_interval(self, symbol: str, 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_ledger(self, code: Str = None, since: Int = None, limit: Int = None, params={})
  • fetch_leverage(self, symbol: str, params={})
  • fetch_markets(self, 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_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})
  • fetch_order_book(self, symbol: str, limit: Int = None, params={})
  • fetch_order_trades(self, id: str, symbol: Str = None, since: Int = None, 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(self, symbol: Str, params={})
  • fetch_positions_adl_rank(self, symbols: Strings = None, params={})
  • fetch_positions(self, symbols: Strings = None, params={})
  • fetch_status(self, 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_trading_fees(self, 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={})
  • default_network_code_for_currency(self, code)
  • describe(self)
  • edit_order(self, id: str, symbol: str, type: OrderType, side: OrderSide, amount: Num = None, price: Num = None, params={})
  • encode_margin_mode(self, mode)
  • get_asset_history_rows(self, code: Str = None, since: Int = None, limit: Int = None, params={})
  • get_currency_from_chaincode(self, networkizedCode, currency)
  • get_dedicated_network_id(self, currency, params: dict)
  • modify_margin_helper(self, symbol: str, amount, type, params={})
  • nonce(self)
  • reduce_margin(self, symbol: str, amount: float, params={})
  • repay_margin(self, code: str, amount: float, symbol: Str = None, params={})
  • set_leverage(self, leverage: int, symbol: Str = None, 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

  • v1_pub_get_hist_kline(request)
  • v1_pub_get_hist_trades(request)
  • v1_public_get_info(request)
  • v1_public_get_info_symbol(request)
  • v1_public_get_system_info(request)
  • v1_public_get_market_trades(request)
  • v1_public_get_token(request)
  • v1_public_get_token_network(request)
  • v1_public_get_funding_rates(request)
  • v1_public_get_funding_rate_symbol(request)
  • v1_public_get_funding_rate_history(request)
  • v1_public_get_futures(request)
  • v1_public_get_futures_symbol(request)
  • v1_public_get_orderbook_symbol(request)
  • v1_public_get_kline(request)
  • v1_private_get_client_token(request)
  • v1_private_get_order_oid(request)
  • v1_private_get_client_order_client_order_id(request)
  • v1_private_get_orders(request)
  • v1_private_get_client_trade_tid(request)
  • v1_private_get_order_oid_trades(request)
  • v1_private_get_client_trades(request)
  • v1_private_get_client_hist_trades(request)
  • v1_private_get_staking_yield_history(request)
  • v1_private_get_client_holding(request)
  • v1_private_get_asset_deposit(request)
  • v1_private_get_asset_history(request)
  • v1_private_get_sub_account_all(request)
  • v1_private_get_sub_account_assets(request)
  • v1_private_get_sub_account_asset_detail(request)
  • v1_private_get_sub_account_ip_restriction(request)
  • v1_private_get_asset_main_sub_transfer_history(request)
  • v1_private_get_token_interest(request)
  • v1_private_get_token_interest_token(request)
  • v1_private_get_interest_history(request)
  • v1_private_get_interest_repay(request)
  • v1_private_get_funding_fee_history(request)
  • v1_private_get_positions(request)
  • v1_private_get_position_symbol(request)
  • v1_private_get_client_transaction_history(request)
  • v1_private_get_client_futures_leverage(request)
  • v1_private_post_order(request)
  • v1_private_post_order_cancel_all_after(request)
  • v1_private_post_asset_ltv(request)
  • v1_private_post_asset_internal_withdraw(request)
  • v1_private_post_interest_repay(request)
  • v1_private_post_client_account_mode(request)
  • v1_private_post_client_position_mode(request)
  • v1_private_post_client_leverage(request)
  • v1_private_post_client_futures_leverage(request)
  • v1_private_post_client_isolated_margin(request)
  • v1_private_delete_order(request)
  • v1_private_delete_client_order(request)
  • v1_private_delete_orders(request)
  • v1_private_delete_asset_withdraw(request)
  • v2_private_get_client_holding(request)
  • v3_public_get_systeminfo(request)
  • v3_public_get_instruments(request)
  • v3_public_get_token(request)
  • v3_public_get_tokennetwork(request)
  • v3_public_get_tokeninfo(request)
  • v3_public_get_markettrades(request)
  • v3_public_get_markettradeshistory(request)
  • v3_public_get_orderbook(request)
  • v3_public_get_kline(request)
  • v3_public_get_klinehistory(request)
  • v3_public_get_futures(request)
  • v3_public_get_fundingrate(request)
  • v3_public_get_fundingratehistory(request)
  • v3_public_get_insurancefund(request)
  • v3_private_get_trade_order(request)
  • v3_private_get_trade_orders(request)
  • v3_private_get_trade_algoorder(request)
  • v3_private_get_trade_algoorders(request)
  • v3_private_get_trade_transaction(request)
  • v3_private_get_trade_transactionhistory(request)
  • v3_private_get_trade_tradingfee(request)
  • v3_private_get_account_info(request)
  • v3_private_get_account_tokenconfig(request)
  • v3_private_get_account_symbolconfig(request)
  • v3_private_get_account_subaccounts_all(request)
  • v3_private_get_account_referral_summary(request)
  • v3_private_get_account_referral_rewardhistory(request)
  • v3_private_get_account_credentials(request)
  • v3_private_get_asset_balances(request)
  • v3_private_get_asset_token_history(request)
  • v3_private_get_asset_transfer_history(request)
  • v3_private_get_asset_wallet_history(request)
  • v3_private_get_asset_wallet_deposit(request)
  • v3_private_get_asset_staking_yieldhistory(request)
  • v3_private_get_futures_positions(request)
  • v3_private_get_futures_leverage(request)
  • v3_private_get_futures_defaultmarginmode(request)
  • v3_private_get_futures_fundingfee_history(request)
  • v3_private_get_spotmargin_interestrate(request)
  • v3_private_get_spotmargin_interesthistory(request)
  • v3_private_get_spotmargin_maxmargin(request)
  • v3_private_get_algo_order_oid(request)
  • v3_private_get_algo_orders(request)
  • v3_private_get_positions(request)
  • v3_private_get_buypower(request)
  • v3_private_get_convert_exchangeinfo(request)
  • v3_private_get_convert_assetinfo(request)
  • v3_private_get_convert_rfq(request)
  • v3_private_get_convert_trade(request)
  • v3_private_get_convert_trades(request)
  • v3_private_post_trade_order(request)
  • v3_private_post_trade_algoorder(request)
  • v3_private_post_trade_cancelallafter(request)
  • v3_private_post_account_tradingmode(request)
  • v3_private_post_account_listenkey(request)
  • v3_private_post_asset_transfer(request)
  • v3_private_post_asset_wallet_withdraw(request)
  • v3_private_post_spotmargin_leverage(request)
  • v3_private_post_spotmargin_interestrepay(request)
  • v3_private_post_algo_order(request)
  • v3_private_post_convert_rft(request)
  • v3_private_put_trade_order(request)
  • v3_private_put_trade_algoorder(request)
  • v3_private_put_futures_leverage(request)
  • v3_private_put_futures_positionmode(request)
  • v3_private_put_order_oid(request)
  • v3_private_put_order_client_client_order_id(request)
  • v3_private_put_algo_order_oid(request)
  • v3_private_put_algo_order_client_client_order_id(request)
  • v3_private_delete_trade_order(request)
  • v3_private_delete_trade_orders(request)
  • v3_private_delete_trade_algoorder(request)
  • v3_private_delete_trade_algoorders(request)
  • v3_private_delete_trade_allorders(request)
  • v3_private_delete_algo_order_order_id(request)
  • v3_private_delete_algo_orders_pending(request)
  • v3_private_delete_algo_orders_pending_symbol(request)
  • v3_private_delete_orders_pending(request)

WS Unified

  • describe(self)
  • watch_public(self, messageHash, message)
  • unwatch_public(self, subHash: str, symbol: str, topic: str, params={})
  • watch_order_book(self, symbol: str, limit: Int = None, params={})
  • un_watch_order_book(self, symbol: str, params={})
  • fetch_order_book_snapshot(self, client, message, subscription)
  • watch_ticker(self, symbol: str, params={})
  • un_watch_ticker(self, symbol: str, params={})
  • watch_tickers(self, symbols: Strings = None, params={})
  • un_watch_tickers(self, symbols: Strings = None, params={})
  • watch_bids_asks(self, symbols: Strings = None, params={})
  • un_watch_bids_asks(self, symbols: Strings = None, 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_trades(self, symbol: str, since: Int = None, limit: Int = None, params={})
  • un_watch_trades(self, symbol: str, params={})
  • check_required_uid(self, error=True)
  • authenticate(self, params={})
  • watch_private(self, messageHash, message, params={})
  • watch_private_multiple(self, messageHashes, message, 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_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)
  • watch_balance(self, params={})
  • watch_funding_rate(self, symbol: str, params={})

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

woo_api-0.0.124.tar.gz (740.1 kB view details)

Uploaded Source

Built Distribution

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

woo_api-0.0.124-py3-none-any.whl (1.0 MB view details)

Uploaded Python 3

File details

Details for the file woo_api-0.0.124.tar.gz.

File metadata

  • Download URL: woo_api-0.0.124.tar.gz
  • Upload date:
  • Size: 740.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for woo_api-0.0.124.tar.gz
Algorithm Hash digest
SHA256 9145a6dd60c8574fb9bcebd48da4b72617ffdfe8a2e11969b7597775fea1b1a4
MD5 6eceb9bd83a87a3c00d4639398418883
BLAKE2b-256 c8cf2afac8601b4aa5be40f3137972e0966c40ef902a1bf3191094d6321c32d7

See more details on using hashes here.

File details

Details for the file woo_api-0.0.124-py3-none-any.whl.

File metadata

  • Download URL: woo_api-0.0.124-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.3

File hashes

Hashes for woo_api-0.0.124-py3-none-any.whl
Algorithm Hash digest
SHA256 ae1eddff488348cb2a7e5a569c96077c7ba51da405124731671ba7a463199b2f
MD5 fd396f853f4301fc3a9541580d116223
BLAKE2b-256 84bd1f9283b014033d3b0d75033d6d66c7b790d5e683cb2ca1100738f928bb14

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