Welcome to AntBot’s documentation!

Contents:

• autodocumentation_python
  • build_sphinx_docs()
  • clean_up_and_exit()
  • create_module_rst_files()
  • find_python_modules()
  • initialize_sphinx()
  • main()
  • rename_files_and_replace_top_level_package_names()
  • update_conf_py()
  • update_index_rst()
• firebase_tools.BaseClasses
  • ConStrBase
  • CoreModel
  • FirebaseAuthGoodResponse
  • FirestoreIDType
• firebase_tools.FirestoreClient
• firebase_tools.authenticate
  • authenticate_with_firebase()
  • check_str_token_validity()
  • check_token_validity()
• h2o_dashboard.dashboard
  • on_client_disconnect()
  • on_global_notification_bar_dismissed()
  • on_shutdown()
  • on_startup()
  • serve()
• h2o_dashboard.pages.documentation_page
  • documentation_page()
• h2o_dashboard.pages.okx_dashbaord_page.okx_account_widget
  • OKX_Account_StreamWidget
• h2o_dashboard.pages.okx_dashbaord_page.okx_antbot_okx_premium_indicator_handler
  • OKX_Premium_Indicator_Handler_Widget
  • generate_tv_payload()
  • okx_signal_validate_inputs()
  • on_instID_selection()
  • on_premium_indicator_signal_selection()
  • submit_okx_signal()
• h2o_dashboard.pages.okx_dashbaord_page.okx_dashboard_page
  • okx_dashboard_page()
• h2o_dashboard.pages.okx_dashbaord_page.okx_fill_report_widget
  • OKX_Fill_Report_StreamWidget
• h2o_dashboard.pages.okx_dashbaord_page.okx_orders_widget
  • OKX_Orders_StreamWidget
• h2o_dashboard.pages.okx_dashbaord_page.okx_positions_widget
  • OKX_Live_Positions_StreamWidget
• h2o_dashboard.pages.overview_page.overview_page
  • add_tradingview_advanced_chart()
  • overview_page()
• h2o_dashboard.pages.overview_page.overview_stream_widget
  • Overview_StreamWidget
• h2o_dashboard.util
  • add_card()
  • clear_cards()
  • convert_to_col_type()
  • load_env_file()
  • push_notification_bar()
  • remove_card()
  • stream_message()
• h2o_dashboard.wave_auth
  • add_application_sidebar()
  • init()
  • initialize_client()
  • render_hidden_content()
  • render_login_page()
  • serve_security()
• okx_polling_service_app
  • health_check()
  • shutdown_event()
  • startup_event()
• pyokx.Futures_Exchange_Client
  • OKX_Futures_Exchange_Client
• pyokx.InstrumentSearcher
  • InstrumentSearcher
• pyokx.OkxEnum
  • AccountConfigMode
  • CtType
  • InstState
  • InstType
  • ListEnumMeta
  • MgnMode
  • OptType
  • OrderCategory
  • OrderExecType
  • OrderOp
  • OrderSide
  • OrderState
  • OrderType
  • PosSide
  • TdMode
• pyokx.data_structures
  • AccountBalanceData
  • AccountBalanceDetails
  • AccountConfigData
  • AccountStatusReport
  • Algo_Order
  • Algo_Order_Placement_Return
  • Ask
  • Bid
  • Cancelled_Algo_Order
  • Cancelled_Order
  • Closed_Position
  • DCAInputParameters
  • DCAOrderParameters
  • FillEntry
  • FillHistoricalMetrics
  • FillHistoricalMetricsEntry
  • InstIdSignalRequestForm
  • Instrument
  • MaxAvailSizeData
  • MaxOrderSizeData
  • OKXBaseModel
  • OKXBaseModelModelMeta
  • OKXPremiumIndicatorSignalRequestForm
  • OKXSignalInput
  • Order
  • Order_Placement_Return
  • Orderbook_Snapshot
  • Position
  • PositionHistory
  • PremiumIndicatorSignals
  • Simplified_Balance_Details
  • Ticker
• pyokx.low_rest_api.Account
  • AccountAPI
• pyokx.low_rest_api.BlockTrading
  • BlockTradingAPI
• pyokx.low_rest_api.Convert
  • ConvertAPI
• pyokx.low_rest_api.CopyTrading
  • CopyTradingAPI
• pyokx.low_rest_api.Earning
  • EarningAPI
• pyokx.low_rest_api.FDBroker
  • FDBrokerAPI
• pyokx.low_rest_api.Funding
  • FundingAPI
• pyokx.low_rest_api.Grid
  • GridAPI
• pyokx.low_rest_api.MarketData
  • MarketAPI
• pyokx.low_rest_api.NDBroker
  • NDBrokerAPI
• pyokx.low_rest_api.PublicData
  • PublicAPI
• pyokx.low_rest_api.SpreadTrading
  • SpreadTradingAPI
• pyokx.low_rest_api.Status
  • StatusAPI
• pyokx.low_rest_api.SubAccount
  • SubAccountAPI
• pyokx.low_rest_api.Trade
  • TradeAPI
• pyokx.low_rest_api.TradingData
  • TradingDataAPI
• pyokx.low_rest_api.client
  • Client
• pyokx.low_rest_api.consts
• pyokx.low_rest_api.exceptions
  • OkxAPIException
  • OkxParamsException
  • OkxRequestException
• pyokx.low_rest_api.utils
  • get_header()
  • get_header_no_sign()
  • get_timestamp()
  • parse_params_to_str()
  • pre_hash()
  • sign()
  • signature()
• pyokx.redis_structured_streams
  • get_instruments_searcher_from_redis()
  • get_okx_fills_history()
  • get_stream_okx_account_messages()
  • get_stream_okx_all_messages()
  • get_stream_okx_fill_metrics_report()
  • get_stream_okx_incomplete_algo_orders()
  • get_stream_okx_incomplete_orders()
  • get_stream_okx_order_messages()
  • get_stream_okx_position_messages()
• pyokx.rest_handling
  • REDIS_STREAM_MAX_LEN
  • assert_okx_account_level()
  • cancel_all_algo_orders_with_params()
  • cancel_all_orders()
  • close_positions()
  • fetch_fill_history()
  • fetch_incomplete_algo_orders()
  • fetch_incomplete_orders()
  • fetch_initial_data()
  • fetch_status_report_for_instrument()
  • generate_random_string()
  • get_account_balance()
  • get_account_config()
  • get_algo_orders()
  • get_leverage()
  • get_max_avail_size()
  • get_max_order_size()
  • get_order_book()
  • get_orders()
  • get_positions()
  • get_request_data()
  • get_ticker()
  • get_ticker_with_higher_volume()
  • is_valid_alphanumeric()
  • okx_premium_indicator_handler()
  • okx_signal_handler()
  • place_algo_order()
  • place_algo_trailing_stop_loss()
  • place_order()
  • prepare_dca()
  • prepare_limit_price()
  • validate_okx_signal_params()
• pyokx.rest_messages_service
  • analyze_transaction_history()
  • loop_fetch_incomplete_algo_orders()
  • loop_fetch_incomplete_orders()
  • okx_rest_messages_services()
  • slow_polling_service()
  • update_instruments()
• pyokx.strategy_handling
  • listen_account_stream()
  • listen_fills_stream()
  • listen_orders_stream()
  • listen_position_stream()
• pyokx.test.AccountTest
  • AccountTest
• pyokx.test.BlockTradingTest
  • BlockTradingTest
• pyokx.test.BrokerTest
  • BrokerTest
• pyokx.test.ConvertTest
  • ConvertTest
• pyokx.test.CopyTradingTest
  • CopyTradingTest
• pyokx.test.EarningTest
  • EarningTest
• pyokx.test.FundingTest
  • FundingTest
• pyokx.test.GridTest
  • GridTest
• pyokx.test.MarketTest
  • MarketAPITest
• pyokx.test.PublicDataTest
  • publicDataTest
• pyokx.test.SpreadTest
  • TradeTest
• pyokx.test.StackingTest
  • StackingTest
• pyokx.test.SubAccountTest
  • SubAccountTest
• pyokx.test.TradeTest
  • TradeTest
• pyokx.test.TradingDataTest
  • TradingDataTest
• pyokx.test.WsPrivateAsyncTest
• pyokx.test.WsPublicAsyncTest
  • main()
  • publicCallback()
• pyokx.websocket_handling
  • get_btc_usdt_usd_index_channel_inputs_to_listen_to()
  • get_instrument_specific_channel_inputs_to_listen_to()
  • handle_reports()
  • okx_websockets_main_run()
  • test_restart()
  • ws_callback()
• pyokx.ws_clients.WebSocketFactory
  • WebSocketFactory
• pyokx.ws_clients.WsPprivateAsync
  • WsPrivateAsync
• pyokx.ws_clients.WsPublicAsync
  • WsPublicAsync
• pyokx.ws_clients.WsUtils
  • checkSocketParams()
  • getLocalTime()
  • getParamKey()
  • getServerTime()
  • initLoginParams()
  • initSubscribeSet()
  • isNotBlankStr()
• pyokx.ws_data_structures
  • AccountChannel
  • AccountChannelInputArgs
  • AccountChannelReturnArgs
  • AlgoOrdersChannel
  • AlgoOrdersChannelInputArgs
  • AlgoOrdersChannelReturnArgs
  • BalanceAndPositionData
  • BalanceAndPositionsChannel
  • BalanceAndPositionsChannelInputArgs
  • BalanceAndPositionsChannelReturnArgs
  • CandleStick
  • IndexCandleSticksChannel
  • IndexCandleSticksChannelInputArgs
  • IndexTickers
  • IndexTickersChannel
  • IndexTickersChannelInputArgs
  • InstrumentStatusReport
  • InstrumentsChannel
  • InstrumentsChannelInputArgs
  • MarkPrice
  • MarkPriceCandleSticksChannel
  • MarkPriceCandleSticksChannelInputArgs
  • MarkPriceChannel
  • MarkPriceChannelInputArgs
  • OrderBookChannel
  • OrderBookData
  • OrderBookInputArgs
  • OrderBookReturnArgs
  • OrdersChannel
  • OrdersChannelInputArgs
  • OrdersChannelReturnArgs
  • PositionsChannel
  • PositionsChannelInputArgs
  • PositionsChannelReturnArgs
  • PriceLimit
  • PriceLimitChannel
  • PriceLimitChannelInputArgs
  • TickersChannel
  • TickersChannelInputArgs
  • TickersChannelReturnArgs
  • WSAlgoOrder
  • WSOrder
  • WSPosition
  • WebSocketConnectionConfig
  • ws_balData_element
  • ws_posData_element
  • ws_trades_element
• redis_tools.config
  • RedisConfig
• redis_tools.consumers
  • add_listener_task()
  • consumer()
  • get_all_listener_tasks()
  • get_listener_task()
  • on_stream_data()
  • remove_listener_task()
  • start_listening()
• redis_tools.utils
  • connect_to_aioredis()
  • deserialize_from_redis()
  • get_async_redis()
  • serialize_for_redis()
  • stop_async_redis()
• rest_app
  • app
  • health_check()
  • shutdown_event()
  • start_listening_endpoint()
  • startup_event()
  • stop_listening_endpoint()
• routers.api_keys
  • create_access_token()
• routers.login
  • login()
• routers.okx
  • okx_antbot_webhook()
  • okx_highest_volume_ticker()
  • okx_instID_status()
  • okx_premium_indicator_webhook()
• routers.okx_authentication
  • InstIdAPIKeyCreationRequestForm
  • check_token_against_instrument()
  • create_instrument_api_key()
• routers.signup
• shared.command_execution
  • execute_command()
• shared.config
• shared.configuration_parser
  • parse_configuration_file()
  • write_example_configuration_file()
• shared.data_processing_utils
  • extract_datasets_from_h5_to_csv()
  • flatten_ND_to_2D()
  • float_range()
  • get_dipole_values_as_array()
  • natural_sort()
• shared.file_directory_ops
  • change_directory()
  • change_directory_manager
  • copy_to()
  • delete_files_or_directories()
  • file_len()
  • file_lenth()
  • find()
  • get_all_files_in_directory()
  • get_folders_in_directory()
  • make_directory()
  • uniquify()
  • validate_directory_and_get_full_path()
• shared.logging
  • ColoredLogger
  • get_caller_logger()
  • remarks()
  • setup_logger()
  • unknown()
• shared.string_dict_utils
  • load_json_file()
  • parse_and_identify_type()
  • recursively_normalize_dict_keys()
  • remove_json_comments()
  • remove_spaces_and_set_case()
  • save_json_file()
  • validate_and_correct_dictionary()
• shared.tmp_shared
  • FunctionCall
  • calculate_sl_stop_prices()
  • calculate_sl_stop_prices_usd()
  • calculate_stop_prices()
  • calculate_tp_stop_prices()
  • calculate_tp_stop_prices_usd()
  • ccy_contracts_to_usd()
  • ccy_usd_to_contracts()
  • execute_function_calls()
  • get_timestamp_from_days_ago()
• tradingview_tools.tradingview_widgets
  • get_chart_widget()
  • get_fundamentals()
  • get_info_widget()
• websocket_app
  • health_check()
  • restart_instrument_websocket()
  • shutdown_event()
  • startup_event()

Indices and tables

• Index

• Module Index

• Search Page