{"id":28693432,"url":"https://github.com/ccxt/kucoinfutures-python","last_synced_at":"2025-07-04T07:04:52.898Z","repository":{"id":283541242,"uuid":"950877574","full_name":"ccxt/kucoinfutures-python","owner":"ccxt","description":null,"archived":false,"fork":false,"pushed_at":"2025-06-24T18:22:33.000Z","size":1038,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-30T11:13:20.518Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ccxt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-03-18T20:23:01.000Z","updated_at":"2025-06-24T18:22:37.000Z","dependencies_parsed_at":"2025-03-20T20:11:28.682Z","dependency_job_id":"bcd70415-e944-45b6-8b8b-967b8d3afc11","html_url":"https://github.com/ccxt/kucoinfutures-python","commit_stats":null,"previous_names":["ccxt/kucoinfutures-python"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ccxt/kucoinfutures-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccxt%2Fkucoinfutures-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccxt%2Fkucoinfutures-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccxt%2Fkucoinfutures-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccxt%2Fkucoinfutures-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ccxt","download_url":"https://codeload.github.com/ccxt/kucoinfutures-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccxt%2Fkucoinfutures-python/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263464184,"owners_count":23470473,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-14T08:30:28.120Z","updated_at":"2025-07-04T07:04:52.877Z","avatar_url":"https://github.com/ccxt.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# kucoinfutures-python\nPython SDK (sync and async) for Kucoinfutures cryptocurrency exchange with Rest and WS capabilities.\n\n- You can check the SDK docs here: [SDK](https://docs.ccxt.com/#/exchanges/kucoinfutures)\n- You can check Kucoinfutures's docs here: [Docs](https://www.google.com/search?q=google+kucoinfutures+cryptocurrency+exchange+api+docs)\n- Github repo: https://github.com/ccxt/kucoinfutures-python\n- Pypi package: https://pypi.org/project/kucoin-futures-api\n\n\n## Installation\n\n```\npip install kucoin-futures-api\n```\n\n## Usage\n\n### Sync\n\n```Python\nfrom kucoinfutures import KucoinfuturesSync\n\ndef main():\n    instance = KucoinfuturesSync({})\n    ob =  instance.fetch_order_book(\"BTC/USDC\")\n    print(ob)\n    #\n    # balance = instance.fetch_balance()\n    # order = instance.create_order(\"BTC/USDC\", \"limit\", \"buy\", 1, 100000)\n\nmain()\n```\n\n### Async\n\n```Python\nimport sys\nimport asyncio\nfrom kucoinfutures import KucoinfuturesAsync\n\n### on Windows, uncomment below:\n# if sys.platform == 'win32':\n# \tasyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())\n\nasync def main():\n    instance = KucoinfuturesAsync({})\n    ob =  await instance.fetch_order_book(\"BTC/USDC\")\n    print(ob)\n    #\n    # balance = await instance.fetch_balance()\n    # order = await instance.create_order(\"BTC/USDC\", \"limit\", \"buy\", 1, 100000)\n\n    # once you are done with the exchange\n    await instance.close()\n\nasyncio.run(main())\n```\n\n\n\n### Websockets\n\n```Python\nimport sys\nfrom kucoinfutures import KucoinfuturesWs\n\n### on Windows, uncomment below:\n# if sys.platform == 'win32':\n# \tasyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())\n\nasync def main():\n    instance = KucoinfuturesWs({})\n    while True:\n        ob = await instance.watch_order_book(\"BTC/USDC\")\n        print(ob)\n        # orders = await instance.watch_orders(\"BTC/USDC\")\n\n    # once you are done with the exchange\n    await instance.close()\n\nasyncio.run(main())\n```\n\n\n\n\n\n#### Raw call\n\nYou can also construct custom requests to available \"implicit\" endpoints\n\n```Python\n        request = {\n            'type': 'candleSnapshot',\n            'req': {\n                'coin': coin,\n                'interval': tf,\n                'startTime': since,\n                'endTime': until,\n            },\n        }\n        response = await instance.public_post_info(request)\n```\n\n\n## Available methods\n\n### REST Unified\n\n- `create_contract_order_request(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, params={})`\n- `create_order(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, params={})`\n- `create_orders(self, orders: List[OrderRequest], params={})`\n- `fetch_balance(self, params={})`\n- `fetch_bids_asks(self, symbols: Strings = None, params={})`\n- `fetch_closed_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})`\n- `fetch_deposit_address(self, code: str, params={})`\n- `fetch_deposits(self, code: Str = None, since: Int = None, limit: Int = None, params={})`\n- `fetch_funding_history(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})`\n- `fetch_funding_interval(self, symbol: str, params={})`\n- `fetch_funding_rate_history(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})`\n- `fetch_funding_rate(self, symbol: str, params={})`\n- `fetch_leverage(self, symbol: str, params={})`\n- `fetch_margin_mode(self, symbol: str, params={})`\n- `fetch_mark_price(self, symbol: str, params={})`\n- `fetch_market_leverage_tiers(self, symbol: str, params={})`\n- `fetch_markets(self, params={})`\n- `fetch_my_trades(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})`\n- `fetch_ohlcv(self, symbol: str, timeframe='1m', since: Int = None, limit: Int = None, params={})`\n- `fetch_open_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})`\n- `fetch_order_book(self, symbol: str, limit: Int = None, params={})`\n- `fetch_order(self, id: Str, symbol: Str = None, params={})`\n- `fetch_orders_by_status(self, status, symbol: Str = None, since: Int = None, limit: Int = None, params={})`\n- `fetch_position(self, symbol: str, params={})`\n- `fetch_positions_history(self, symbols: Strings = None, since: Int = None, limit: Int = None, params={})`\n- `fetch_positions(self, symbols: Strings = None, params={})`\n- `fetch_status(self, params={})`\n- `fetch_ticker(self, symbol: str, params={})`\n- `fetch_tickers(self, symbols: Strings = None, params={})`\n- `fetch_time(self, params={})`\n- `fetch_trades(self, symbol: str, since: Int = None, limit: Int = None, params={})`\n- `fetch_trading_fee(self, symbol: str, params={})`\n- `fetch_withdrawals(self, code: Str = None, since: Int = None, limit: Int = None, params={})`\n- `add_margin(self, symbol: str, amount: float, params={})`\n- `cancel_all_orders(self, symbol: Str = None, params={})`\n- `cancel_order(self, id: str, symbol: Str = None, params={})`\n- `cancel_orders(self, ids, symbol: Str = None, params={})`\n- `close_position(self, symbol: str, side: OrderSide = None, params={})`\n- `describe(self)`\n- `set_leverage(self, leverage: Int, symbol: Str = None, params={})`\n- `set_margin_mode(self, marginMode: str, symbol: Str = None, params={})`\n- `transfer(self, code: str, amount: float, fromAccount: str, toAccount: str, params={})`\n\n### REST Raw\n\n- `public_get_currencies(request)`\n- `public_get_currencies_currency(request)`\n- `public_get_symbols(request)`\n- `public_get_market_orderbook_level1(request)`\n- `public_get_market_alltickers(request)`\n- `public_get_market_stats(request)`\n- `public_get_markets(request)`\n- `public_get_market_orderbook_level_level_limit(request)`\n- `public_get_market_orderbook_level2_20(request)`\n- `public_get_market_orderbook_level2_100(request)`\n- `public_get_market_histories(request)`\n- `public_get_market_candles(request)`\n- `public_get_prices(request)`\n- `public_get_timestamp(request)`\n- `public_get_status(request)`\n- `public_get_mark_price_symbol_current(request)`\n- `public_get_mark_price_all_symbols(request)`\n- `public_get_margin_config(request)`\n- `public_get_announcements(request)`\n- `public_post_bullet_public(request)`\n- `private_get_user_info(request)`\n- `private_get_accounts(request)`\n- `private_get_accounts_accountid(request)`\n- `private_get_accounts_ledgers(request)`\n- `private_get_hf_accounts_ledgers(request)`\n- `private_get_hf_margin_account_ledgers(request)`\n- `private_get_transaction_history(request)`\n- `private_get_sub_user(request)`\n- `private_get_sub_accounts_subuserid(request)`\n- `private_get_sub_accounts(request)`\n- `private_get_sub_api_key(request)`\n- `private_get_margin_account(request)`\n- `private_get_margin_accounts(request)`\n- `private_get_isolated_accounts(request)`\n- `private_get_deposit_addresses(request)`\n- `private_get_deposits(request)`\n- `private_get_hist_deposits(request)`\n- `private_get_withdrawals(request)`\n- `private_get_hist_withdrawals(request)`\n- `private_get_withdrawals_quotas(request)`\n- `private_get_accounts_transferable(request)`\n- `private_get_transfer_list(request)`\n- `private_get_base_fee(request)`\n- `private_get_trade_fees(request)`\n- `private_get_market_orderbook_level_level(request)`\n- `private_get_market_orderbook_level2(request)`\n- `private_get_market_orderbook_level3(request)`\n- `private_get_hf_accounts_opened(request)`\n- `private_get_hf_orders_active(request)`\n- `private_get_hf_orders_active_symbols(request)`\n- `private_get_hf_margin_order_active_symbols(request)`\n- `private_get_hf_orders_done(request)`\n- `private_get_hf_orders_orderid(request)`\n- `private_get_hf_orders_client_order_clientoid(request)`\n- `private_get_hf_orders_dead_cancel_all_query(request)`\n- `private_get_hf_fills(request)`\n- `private_get_orders(request)`\n- `private_get_limit_orders(request)`\n- `private_get_orders_orderid(request)`\n- `private_get_order_client_order_clientoid(request)`\n- `private_get_fills(request)`\n- `private_get_limit_fills(request)`\n- `private_get_stop_order(request)`\n- `private_get_stop_order_orderid(request)`\n- `private_get_stop_order_queryorderbyclientoid(request)`\n- `private_get_oco_order_orderid(request)`\n- `private_get_oco_order_details_orderid(request)`\n- `private_get_oco_client_order_clientoid(request)`\n- `private_get_oco_orders(request)`\n- `private_get_hf_margin_orders_active(request)`\n- `private_get_hf_margin_orders_done(request)`\n- `private_get_hf_margin_orders_orderid(request)`\n- `private_get_hf_margin_orders_client_order_clientoid(request)`\n- `private_get_hf_margin_fills(request)`\n- `private_get_etf_info(request)`\n- `private_get_margin_currencies(request)`\n- `private_get_risk_limit_strategy(request)`\n- `private_get_isolated_symbols(request)`\n- `private_get_margin_symbols(request)`\n- `private_get_isolated_account_symbol(request)`\n- `private_get_margin_borrow(request)`\n- `private_get_margin_repay(request)`\n- `private_get_margin_interest(request)`\n- `private_get_project_list(request)`\n- `private_get_project_marketinterestrate(request)`\n- `private_get_redeem_orders(request)`\n- `private_get_purchase_orders(request)`\n- `private_get_broker_api_rebase_download(request)`\n- `private_get_migrate_user_account_status(request)`\n- `private_get_affiliate_inviter_statistics(request)`\n- `private_post_sub_user_created(request)`\n- `private_post_sub_api_key(request)`\n- `private_post_sub_api_key_update(request)`\n- `private_post_deposit_addresses(request)`\n- `private_post_withdrawals(request)`\n- `private_post_accounts_universal_transfer(request)`\n- `private_post_accounts_sub_transfer(request)`\n- `private_post_accounts_inner_transfer(request)`\n- `private_post_transfer_out(request)`\n- `private_post_transfer_in(request)`\n- `private_post_hf_orders(request)`\n- `private_post_hf_orders_test(request)`\n- `private_post_hf_orders_sync(request)`\n- `private_post_hf_orders_multi(request)`\n- `private_post_hf_orders_multi_sync(request)`\n- `private_post_hf_orders_alter(request)`\n- `private_post_hf_orders_dead_cancel_all(request)`\n- `private_post_orders(request)`\n- `private_post_orders_test(request)`\n- `private_post_orders_multi(request)`\n- `private_post_stop_order(request)`\n- `private_post_oco_order(request)`\n- `private_post_hf_margin_order(request)`\n- `private_post_hf_margin_order_test(request)`\n- `private_post_margin_order(request)`\n- `private_post_margin_order_test(request)`\n- `private_post_margin_borrow(request)`\n- `private_post_margin_repay(request)`\n- `private_post_purchase(request)`\n- `private_post_redeem(request)`\n- `private_post_lend_purchase_update(request)`\n- `private_post_bullet_private(request)`\n- `private_post_position_update_user_leverage(request)`\n- `private_post_deposit_address_create(request)`\n- `private_delete_sub_api_key(request)`\n- `private_delete_withdrawals_withdrawalid(request)`\n- `private_delete_hf_orders_orderid(request)`\n- `private_delete_hf_orders_sync_orderid(request)`\n- `private_delete_hf_orders_client_order_clientoid(request)`\n- `private_delete_hf_orders_sync_client_order_clientoid(request)`\n- `private_delete_hf_orders_cancel_orderid(request)`\n- `private_delete_hf_orders(request)`\n- `private_delete_hf_orders_cancelall(request)`\n- `private_delete_orders_orderid(request)`\n- `private_delete_order_client_order_clientoid(request)`\n- `private_delete_orders(request)`\n- `private_delete_stop_order_orderid(request)`\n- `private_delete_stop_order_cancelorderbyclientoid(request)`\n- `private_delete_stop_order_cancel(request)`\n- `private_delete_oco_order_orderid(request)`\n- `private_delete_oco_client_order_clientoid(request)`\n- `private_delete_oco_orders(request)`\n- `private_delete_hf_margin_orders_orderid(request)`\n- `private_delete_hf_margin_orders_client_order_clientoid(request)`\n- `private_delete_hf_margin_orders(request)`\n- `futurespublic_get_contracts_active(request)`\n- `futurespublic_get_contracts_symbol(request)`\n- `futurespublic_get_ticker(request)`\n- `futurespublic_get_level2_snapshot(request)`\n- `futurespublic_get_level2_depth20(request)`\n- `futurespublic_get_level2_depth100(request)`\n- `futurespublic_get_trade_history(request)`\n- `futurespublic_get_kline_query(request)`\n- `futurespublic_get_interest_query(request)`\n- `futurespublic_get_index_query(request)`\n- `futurespublic_get_mark_price_symbol_current(request)`\n- `futurespublic_get_premium_query(request)`\n- `futurespublic_get_trade_statistics(request)`\n- `futurespublic_get_funding_rate_symbol_current(request)`\n- `futurespublic_get_contract_funding_rates(request)`\n- `futurespublic_get_timestamp(request)`\n- `futurespublic_get_status(request)`\n- `futurespublic_get_level2_message_query(request)`\n- `futurespublic_get_contracts_risk_limit_symbol(request)`\n- `futurespublic_get_alltickers(request)`\n- `futurespublic_get_level2_depth_limit(request)`\n- `futurespublic_get_level3_message_query(request)`\n- `futurespublic_get_level3_snapshot(request)`\n- `futurespublic_post_bullet_public(request)`\n- `futuresprivate_get_transaction_history(request)`\n- `futuresprivate_get_account_overview(request)`\n- `futuresprivate_get_account_overview_all(request)`\n- `futuresprivate_get_transfer_list(request)`\n- `futuresprivate_get_orders(request)`\n- `futuresprivate_get_stoporders(request)`\n- `futuresprivate_get_recentdoneorders(request)`\n- `futuresprivate_get_orders_orderid(request)`\n- `futuresprivate_get_orders_byclientoid(request)`\n- `futuresprivate_get_fills(request)`\n- `futuresprivate_get_recentfills(request)`\n- `futuresprivate_get_openorderstatistics(request)`\n- `futuresprivate_get_position(request)`\n- `futuresprivate_get_positions(request)`\n- `futuresprivate_get_margin_maxwithdrawmargin(request)`\n- `futuresprivate_get_contracts_risk_limit_symbol(request)`\n- `futuresprivate_get_funding_history(request)`\n- `futuresprivate_get_deposit_address(request)`\n- `futuresprivate_get_deposit_list(request)`\n- `futuresprivate_get_withdrawals_quotas(request)`\n- `futuresprivate_get_withdrawal_list(request)`\n- `futuresprivate_get_sub_api_key(request)`\n- `futuresprivate_get_trade_statistics(request)`\n- `futuresprivate_get_trade_fees(request)`\n- `futuresprivate_get_history_positions(request)`\n- `futuresprivate_get_getmaxopensize(request)`\n- `futuresprivate_get_getcrossuserleverage(request)`\n- `futuresprivate_get_position_getmarginmode(request)`\n- `futuresprivate_post_transfer_out(request)`\n- `futuresprivate_post_transfer_in(request)`\n- `futuresprivate_post_orders(request)`\n- `futuresprivate_post_orders_test(request)`\n- `futuresprivate_post_orders_multi(request)`\n- `futuresprivate_post_position_margin_auto_deposit_status(request)`\n- `futuresprivate_post_margin_withdrawmargin(request)`\n- `futuresprivate_post_position_margin_deposit_margin(request)`\n- `futuresprivate_post_position_risk_limit_level_change(request)`\n- `futuresprivate_post_bullet_private(request)`\n- `futuresprivate_post_withdrawals(request)`\n- `futuresprivate_post_st_orders(request)`\n- `futuresprivate_post_sub_api_key(request)`\n- `futuresprivate_post_sub_api_key_update(request)`\n- `futuresprivate_post_changecrossuserleverage(request)`\n- `futuresprivate_post_position_changemarginmode(request)`\n- `futuresprivate_delete_orders_orderid(request)`\n- `futuresprivate_delete_orders_client_order_clientoid(request)`\n- `futuresprivate_delete_orders(request)`\n- `futuresprivate_delete_stoporders(request)`\n- `futuresprivate_delete_withdrawals_withdrawalid(request)`\n- `futuresprivate_delete_cancel_transfer_out(request)`\n- `futuresprivate_delete_sub_api_key(request)`\n- `futuresprivate_delete_orders_multi_cancel(request)`\n- `webexchange_get_currency_currency_chain_info(request)`\n- `webexchange_get_contract_symbol_funding_rates(request)`\n- `broker_get_broker_nd_info(request)`\n- `broker_get_broker_nd_account(request)`\n- `broker_get_broker_nd_account_apikey(request)`\n- `broker_get_broker_nd_rebase_download(request)`\n- `broker_get_asset_ndbroker_deposit_list(request)`\n- `broker_get_broker_nd_transfer_detail(request)`\n- `broker_get_broker_nd_deposit_detail(request)`\n- `broker_get_broker_nd_withdraw_detail(request)`\n- `broker_post_broker_nd_transfer(request)`\n- `broker_post_broker_nd_account(request)`\n- `broker_post_broker_nd_account_apikey(request)`\n- `broker_post_broker_nd_account_update_apikey(request)`\n- `broker_delete_broker_nd_account_apikey(request)`\n- `earn_get_otc_loan_loan(request)`\n- `earn_get_otc_loan_accounts(request)`\n- `earn_get_earn_redeem_preview(request)`\n- `earn_get_earn_saving_products(request)`\n- `earn_get_earn_hold_assets(request)`\n- `earn_get_earn_promotion_products(request)`\n- `earn_get_earn_kcs_staking_products(request)`\n- `earn_get_earn_staking_products(request)`\n- `earn_get_earn_eth_staking_products(request)`\n- `earn_post_earn_orders(request)`\n- `earn_delete_earn_orders(request)`\n\n### WS Unified\n\n- `describe(self)`\n- `negotiate(self, privateChannel, params={})`\n- `negotiate_helper(self, privateChannel, params={})`\n- `subscribe(self, url, messageHash, subscriptionHash, subscription, params={})`\n- `subscribe_multiple(self, url, messageHashes, topic, subscriptionHashes, subscriptionArgs, params={})`\n- `un_subscribe_multiple(self, url, messageHashes, topic, subscriptionHashes, params={}, subscription: dict = None)`\n- `watch_ticker(self, symbol: str, params={})`\n- `watch_tickers(self, symbols: Strings = None, params={})`\n- `watch_bids_asks(self, symbols: Strings = None, params={})`\n- `watch_multi_request(self, methodName, channelName: str, symbols: Strings = None, params={})`\n- `watch_position(self, symbol: Str = None, params={})`\n- `get_current_position(self, symbol)`\n- `set_position_cache(self, client: Client, symbol: str)`\n- `load_position_snapshot(self, client, messageHash, symbol)`\n- `watch_trades(self, symbol: str, since: Int = None, limit: Int = None, params={})`\n- `watch_trades_for_symbols(self, symbols: List[str], since: Int = None, limit: Int = None, params={})`\n- `un_watch_trades(self, symbol: str, params={})`\n- `un_watch_trades_for_symbols(self, symbols: List[str], params={})`\n- `watch_ohlcv(self, symbol: str, timeframe='1m', since: Int = None, limit: Int = None, params={})`\n- `watch_order_book(self, symbol: str, limit: Int = None, params={})`\n- `watch_order_book_for_symbols(self, symbols: List[str], limit: Int = None, params={})`\n- `un_watch_order_book(self, symbol: str, params={})`\n- `un_watch_order_book_for_symbols(self, symbols: List[str], params={})`\n- `get_cache_index(self, orderbook, cache)`\n- `watch_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})`\n- `watch_balance(self, params={})`\n- `fetch_balance_snapshot(self, client, message)`\n- `get_message_hash(self, elementName: str, symbol: Str = None)`\n\n## Contribution\n- Give us a star :star:\n- Fork and Clone! Awesome\n- Select existing issues or create a new issue.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fccxt%2Fkucoinfutures-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fccxt%2Fkucoinfutures-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fccxt%2Fkucoinfutures-python/lists"}