pybit.py 解析図

シンガポールの暗号通貨取引所 Bybit 公式ライブラリーがbybitからpybitに替わったらしい。

pybit

condapromptから

(base) C:\temp>pyreverse -o png C:\Anaconda3\Lib\site-packages\pybit

パッケージ相関図

クラス相関図

なるほどなるほど (汗)


dir(pybit)



‘FailedRequestError’,

 ‘HTTP’, 

‘InvalidRequestError’,

 ‘JSONDecodeError’,

 ‘ThreadPoolExecutor’,

 ‘VERSION’, 

‘WebSocket’,

 ‘__builtins__’, ‘__cached__’, ‘__doc__’, ‘__file__’, ‘__loader__’, ‘__name__’, ‘__package__’, ‘__path__’, ‘__spec__’,

 ‘dt’,

 ‘exceptions’,

 ‘hmac’,

 ‘json’,

 ‘logging’,

 ‘requests’,

 ‘threading’,

 ‘time’, 

‘websocket’
– –

help

 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 

Help on package pybit:

NAME
    pybit

DESCRIPTION
    pybit
    ------------------------
    
    pybit is a lightweight and high-performance API connector for the
    RESTful and WebSocket APIs of the Bybit exchange.
    
    Documentation can be found at
    https://github.com/verata-veritatis/pybit
    
    :copyright: (c) 2020-2021 verata-veritatis
    :license: MIT License

PACKAGE CONTENTS
    exceptions
    test

CLASSES
    builtins.object
        HTTP
        WebSocket
    
    class HTTP(builtins.object)
     |  HTTP(endpoint=None, api_key=None, api_secret=None, logging_level=20, log_requests=False, request_timeout=10, recv_window=5000, force_retry=False, retry_codes=None, ignore_codes=None, max_retries=3, retry_delay=3, referral_id=None, spot=False)
     |  
     |  Connector for Bybit's HTTP API.
     |  
     |  :param endpoint: The endpoint URL of the HTTP API, e.g.
     |      'https://api-testnet.bybit.com'.
     |  :type endpoint: str
     |  
     |  :param api_key: Your API key. Required for authenticated endpoints. Defaults
     |      to None.
     |  :type api_key: str
     |  
     |  :param api_secret: Your API secret key. Required for authenticated
     |      endpoints. Defaults to None.
     |  :type api_secret: str
     |  
     |  :param logging_level: The logging level of the built-in logger. Defaults to
     |      logging.INFO. Options are CRITICAL (50), ERROR (40), WARNING (30),
     |      INFO (20), DEBUG (10), or NOTSET (0).
     |  :type logging_level: Union[int, logging.level]
     |  
     |  :param log_requests: Whether or not pybit should log each HTTP request.
     |  :type log_requests: bool
     |  
     |  :param request_timeout: The timeout of each API request in seconds. Defaults
     |      to 10 seconds.
     |  :type request_timeout: int
     |  
     |  :param recv_window: How long an HTTP request is valid in ms. Default is
     |      5000.
     |  :type recv_window: int
     |  
     |  :param force_retry: Whether or not pybit should retry a timed-out request.
     |  :type force_retry: bool
     |  
     |  :param retry_codes: A list of non-fatal status codes to retry on.
     |  :type retry_codes: set
     |  
     |  :param ignore_codes: A list of non-fatal status codes to ignore.
     |  :type ignore_codes: set
     |  
     |  :param max_retries: The number of times to re-attempt a request.
     |  :type max_retries: int
     |  
     |  :param retry_delay: Seconds between retries for returned error or timed-out
     |      requests. Default is 3 seconds.
     |  :type retry_delay: int
     |  
     |  :param referral_id: An optional referer ID can be added to each request for
     |      identification.
     |  :type referral_id: str
     |  
     |  :returns: pybit.HTTP session.
     |  
     |  Methods defined here:
     |  
     |  __init__(self, endpoint=None, api_key=None, api_secret=None, logging_level=20, log_requests=False, request_timeout=10, recv_window=5000, force_retry=False, retry_codes=None, ignore_codes=None, max_retries=3, retry_delay=3, referral_id=None, spot=False)
     |      Initializes the HTTP class.
     |  
     |  add_reduce_margin(self, **kwargs)
     |      For linear markets only. Add margin.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/linear/#t-addmargin.
     |      :returns: Request results as dictionary.
     |  
     |  announcement(self)
     |      Get Bybit OpenAPI announcements in the last 30 days by reverse order.
     |      
     |      :returns: Request results as dictionary.
     |  
     |  api_key_info(self)
     |      Get user's API key info.
     |      
     |      :returns: Request results as dictionary.
     |  
     |  asset_exchange_records(self, **kwargs)
     |      Get asset exchange records.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-assetexchangerecords.
     |      :returns: Request results as dictionary.
     |  
     |  batch_cancel_active_order(self, **kwargs)
     |      Batch cancels active orders.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/spot/#t-batchcancelactiveorder.
     |      :returns: Request results as dictionary.
     |  
     |  batch_cancel_active_order_by_ids(self, **kwargs)
     |      Batch cancels active order by ids.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/spot/#t-atchcancelactiveorderbyids.
     |      :returns: Request results as dictionary.
     |  
     |  batch_fast_cancel_active_order(self, **kwargs)
     |      Batch fast cancels active orders.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/spot/#t-batchfastcancelactiveorder.
     |      :returns: Request results as dictionary.
     |  
     |  best_bid_ask_price(self, **kwargs)
     |      Get the best bid/ask price.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/spot/#t-bestbidask.
     |      :returns: Request results as dictionary.
     |  
     |  cancel_active_order(self, **kwargs)
     |      Cancels an active order. For more information, see
     |      https://bybit-exchange.github.io/docs/inverse/#t-cancelactive.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-cancelactive.
     |      :returns: Request results as dictionary.
     |  
     |  cancel_active_order_bulk(self, orders: list, max_in_parallel=10)
     |      Cancels multiple active orders in bulk using multithreading. For more
     |      information on cancel_active_order, see
     |      https://bybit-exchange.github.io/docs/inverse/#t-activeorders.
     |      
     |      :param list orders: A list of orders and their parameters.
     |      :param max_in_parallel: The number of requests to be sent in parallel.
     |          Note that you are limited to 50 requests per second.
     |      :returns: Future request result dictionaries as a list.
     |  
     |  cancel_all_active_orders(self, **kwargs)
     |      Cancel all active orders that are unfilled or partially filled. Fully
     |      filled orders cannot be cancelled.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-cancelallactive.
     |      :returns: Request results as dictionary.
     |  
     |  cancel_all_conditional_orders(self, **kwargs)
     |      Cancel all conditional orders that are unfilled or partially filled.
     |      Fully filled orders cannot be cancelled.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-cancelallcond.
     |      :returns: Request results as dictionary.
     |  
     |  cancel_conditional_order(self, **kwargs)
     |      Cancels a conditional order. For more information, see
     |      https://bybit-exchange.github.io/docs/inverse/#t-cancelcond.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-cancelcond.
     |      :returns: Request results as dictionary.
     |  
     |  cancel_conditional_order_bulk(self, orders: list, max_in_parallel=10)
     |      Cancels multiple conditional orders in bulk using multithreading. For
     |      more information on cancel_active_order, see
     |      https://bybit-exchange.github.io/docs/inverse/#t-cancelcond.
     |      
     |      :param list orders: A list of orders and their parameters.
     |      :param max_in_parallel: The number of requests to be sent in parallel.
     |          Note that you are limited to 50 requests per second.
     |      :returns: Future request result dictionaries as a list.
     |  
     |  change_margin(self, **kwargs)
     |      Update margin.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-changemargin.
     |      :returns: Request results as dictionary.
     |  
     |  change_user_leverage(self, **kwargs)
     |      Change user leverage.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-changeleverage.
     |      :returns: Request results as dictionary.
     |  
     |  close_position(self, symbol)
     |      Closes your open position. Makes two requests (position, order).
     |      
     |      Parameters
     |      ------------------------
     |      symbol : str
     |          Required parameter. The symbol of the market as a string,
     |          e.g. 'BTCUSD'.
     |  
     |  closed_profit_and_loss(self, **kwargs)
     |      Get user's closed profit and loss records. The results are ordered in
     |      descending order (the first item is the latest).
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-closedprofitandloss.
     |      :returns: Request results as dictionary.
     |  
     |  create_internal_transfer(self, **kwargs)
     |      Create internal transfer.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/account_asset/#t-createinternaltransfer.
     |      :returns: Request results as dictionary.
     |  
     |  create_subaccount_transfer(self, **kwargs)
     |      Create internal transfer.
     |      
     |      :param kwargs: See
     |          https://bybit-xchange.github.io/docs/account_asset/#teatesubaccounttransfer.
     |      :returns: Request results as dictionary.
     |  
     |  cross_isolated_margin_switch(self, **kwargs)
     |      Switch Cross/Isolated; must be leverage value when switching from Cross
     |      to Isolated.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-marginswitch.
     |      :returns: Request results as dictionary.
     |  
     |  fast_cancel_active_order(self, **kwargs)
     |      Fast cancels an active order.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/spot/#t-fastcancelactiveorder.
     |      :returns: Request results as dictionary.
     |  
     |  full_partial_position_tp_sl_switch(self, **kwargs)
     |      Switch mode between Full or Partial
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-switchmode.
     |      :returns: Request results as dictionary.
     |  
     |  get_active_order(self, **kwargs)
     |      Gets an active order. For more information, see
     |      https://bybit-exchange.github.io/docs/inverse/#t-getactive.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-getactive.
     |      :returns: Request results as dictionary.
     |  
     |  get_conditional_order(self, **kwargs)
     |      Gets a conditional order. For more information, see
     |      https://bybit-exchange.github.io/docs/inverse/#t-getcond.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-getcond.
     |      :returns: Request results as dictionary.
     |  
     |  get_risk_limit(self, **kwargs)
     |      Get risk limit.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-getrisklimit.
     |      :returns: Request results as dictionary.
     |  
     |  get_the_last_funding_rate(self, **kwargs)
     |      The funding rate is generated every 8 hours at 00:00 UTC, 08:00 UTC and
     |      16:00 UTC. For example, if a request is sent at 12:00 UTC, the funding
     |      rate generated earlier that day at 08:00 UTC will be sent.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-fundingrate.
     |      :returns: Request results as dictionary.
     |  
     |  get_wallet_balance(self, **kwargs)
     |      Get wallet balance info.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-balance.
     |      :returns: Request results as dictionary.
     |  
     |  last_traded_price(self, **kwargs)
     |      Get the last traded price.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/spot/#t-lasttradedprice.
     |      :returns: Request results as dictionary.
     |  
     |  latest_big_deal(self, **kwargs)
     |      Obtain filled orders worth more than 500,000 USD within the last 24h.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-marketbigdeal.
     |      :returns: Request results as dictionary.
     |  
     |  latest_information_for_symbol(self, **kwargs)
     |      Get the latest information for symbol.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-latestsymbolinfo.
     |      :returns: Request results as dictionary.
     |  
     |  lcp_info(self, **kwargs)
     |      Get user's LCP (data refreshes once an hour). Only supports inverse
     |      perpetual at present. See
     |      https://bybit-exchange.github.io/docs/inverse/#t-liquidity to learn
     |      more.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-lcp.
     |      :returns: Request results as dictionary.
     |  
     |  liquidated_orders(self, **kwargs)
     |      Retrieve the liquidated orders. The query range is the last seven days
     |      of data.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-query_liqrecords.
     |      :returns: Request results as dictionary.
     |  
     |  long_short_ratio(self, **kwargs)
     |      Gets the Bybit long-short ratio.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-marketaccountratio.
     |      :returns: Request results as dictionary.
     |  
     |  merged_orderbook(self, **kwargs)
     |      Get the merged orderbook.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/spot/#t-mergedorderbook.
     |      :returns: Request results as dictionary.
     |  
     |  my_last_funding_fee(self, **kwargs)
     |      Funding settlement occurs every 8 hours at 00:00 UTC, 08:00 UTC and
     |      16:00 UTC. The current interval's fund fee settlement is based on the
     |      previous interval's fund rate. For example, at 16:00, the settlement is
     |      based on the fund rate generated at 8:00. The fund rate generated at
     |      16:00 will be used at 0:00 the next day.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-mylastfundingfee.
     |      :returns: Request results as dictionary.
     |  
     |  my_position(self, endpoint='', **kwargs)
     |      Get my position list.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-myposition.
     |      :param endpoint: The endpoint path, such as "/v2/private/position/list".
     |          This allows the user to bypass the "symbol" arg, and instead specify
     |          the desired market contract type (inverse perp, linear perp, etc)
     |          and receive multiple symbols in the response.
     |      :returns: Request results as dictionary.
     |  
     |  open_interest(self, **kwargs)
     |      Gets the total amount of unsettled contracts. In other words, the total
     |      number of contracts held in open positions.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-marketopeninterest.
     |      :returns: Request results as dictionary.
     |  
     |  orderbook(self, **kwargs)
     |      Get the orderbook.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-orderbook.
     |      :returns: Request results as dictionary.
     |  
     |  place_active_order(self, **kwargs)
     |      Places an active order. For more information, see
     |      https://bybit-exchange.github.io/docs/inverse/#t-activeorders.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-activeorders.
     |      :returns: Request results as dictionary.
     |  
     |  place_active_order_bulk(self, orders: list, max_in_parallel=10)
     |      Places multiple active orders in bulk using multithreading. For more
     |      information on place_active_order, see
     |      https://bybit-exchange.github.io/docs/inverse/#t-activeorders.
     |      
     |      :param list orders: A list of orders and their parameters.
     |      :param max_in_parallel: The number of requests to be sent in parallel.
     |          Note that you are limited to 50 requests per second.
     |      :returns: Future request result dictionaries as a list.
     |  
     |  place_conditional_order(self, **kwargs)
     |      Places a conditional order. For more information, see
     |      https://bybit-exchange.github.io/docs/inverse/#t-placecond.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-placecond.
     |      :returns: Request results as dictionary.
     |  
     |  place_conditional_order_bulk(self, orders: list, max_in_parallel=10)
     |      Places multiple conditional orders in bulk using multithreading. For
     |      more information on place_active_order, see
     |      https://bybit-exchange.github.io/docs/inverse/#t-placecond.
     |      
     |      :param orders: A list of orders and their parameters.
     |      :param max_in_parallel: The number of requests to be sent in parallel.
     |          Note that you are limited to 50 requests per second.
     |      :returns: Future request result dictionaries as a list.
     |  
     |  position_mode_switch(self, **kwargs)
     |      If you are in One-Way Mode, you can only open one position on Buy or
     |      Sell side;
     |      If you are in Hedge Mode, you can open both Buy and Sell side positions
     |      simultaneously.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse_futures/#t-switchpositionmode.
     |      :returns: Request results as dictionary.
     |  
     |  predicted_funding_rate(self, **kwargs)
     |      Get predicted funding rate and my funding fee.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-predictedfunding.
     |      :returns: Request results as dictionary.
     |  
     |  public_trading_records(self, **kwargs)
     |      Get recent trades. You can find a complete history of trades on Bybit
     |      at https://public.bybit.com/.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-publictradingrecords.
     |      :returns: Request results as dictionary.
     |  
     |  query_active_order(self, **kwargs)
     |      Query real-time active order information.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-queryactive.
     |      :returns: Request results as dictionary.
     |  
     |  query_conditional_order(self, **kwargs)
     |      Query real-time conditional order information.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-querycond.
     |      :returns: Request results as dictionary.
     |  
     |  query_index_price_kline(self, **kwargs)
     |      Query index price kline (like query_kline but for index price).
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-queryindexpricekline.
     |      :returns: Request results as dictionary.
     |  
     |  query_kline(self, **kwargs)
     |      Get kline.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-querykline.
     |      :returns: Request results as dictionary.
     |  
     |  query_mark_price_kline(self, **kwargs)
     |      Query mark price kline (like query_kline but for mark price).
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-markpricekline.
     |      :returns: Request results as dictionary.
     |  
     |  query_premium_index_kline(self, **kwargs)
     |      Query premium index kline (like query_kline but for the premium index
     |      discount).
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-querypremiumindexkline.
     |      :returns: Request results as dictionary.
     |  
     |  query_subaccount_list(self)
     |      Create internal transfer.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/account_asset/#t-querysubaccountlist.
     |      :returns: Request results as dictionary.
     |  
     |  query_subaccount_transfer_list(self, **kwargs)
     |      Create internal transfer.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/account_asset/#t-querysubaccounttransferlist.
     |      :returns: Request results as dictionary.
     |  
     |  query_symbol(self, **kwargs)
     |      Get symbol info.
     |      
     |      :returns: Request results as dictionary.
     |  
     |  query_transfer_list(self, **kwargs)
     |      Create internal transfer.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/account_asset/#t-querytransferlist.
     |      :returns: Request results as dictionary.
     |  
     |  replace_active_order(self, **kwargs)
     |      Replace order can modify/amend your active orders.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-replaceactive.
     |      :returns: Request results as dictionary.
     |  
     |  replace_active_order_bulk(self, orders: list, max_in_parallel=10)
     |      Replaces multiple active orders in bulk using multithreading. For more
     |      information on replace_active_order, see
     |      https://bybit-exchange.github.io/docs/inverse/#t-replaceactive.
     |      
     |      :param list orders: A list of orders and their parameters.
     |      :param max_in_parallel: The number of requests to be sent in parallel.
     |          Note that you are limited to 50 requests per second.
     |      :returns: Future request result dictionaries as a list.
     |  
     |  replace_conditional_order(self, **kwargs)
     |      Replace conditional order can modify/amend your conditional orders.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-replacecond.
     |      :returns: Request results as dictionary.
     |  
     |  replace_conditional_order_bulk(self, orders: list, max_in_parallel=10)
     |      Replaces multiple conditional orders in bulk using multithreading. For
     |      more information on replace_active_order, see
     |      https://bybit-exchange.github.io/docs/inverse/#t-replacecond.
     |      
     |      :param list orders: A list of orders and their parameters.
     |      :param max_in_parallel: The number of requests to be sent in parallel.
     |          Note that you are limited to 50 requests per second.
     |      :returns: Future request result dictionaries as a list.
     |  
     |  server_time(self, **kwargs)
     |      Get Bybit server time.
     |      
     |      :returns: Request results as dictionary.
     |  
     |  set_auto_add_margin(self, **kwargs)
     |      For linear markets only. Set auto add margin, or Auto-Margin
     |      Replenishment.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/linear/#t-setautoaddmargin.
     |      :returns: Request results as dictionary.
     |  
     |  set_leverage(self, **kwargs)
     |      Change user leverage.
     |      If you want to switch between cross margin and isolated margin, please
     |      see cross_isolated_margin_switch.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/linear/#t-setleverage.
     |      :returns: Request results as dictionary.
     |  
     |  set_risk_limit(self, **kwargs)
     |      Set risk limit.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-setrisklimit.
     |      :returns: Request results as dictionary.
     |  
     |  set_trading_stop(self, **kwargs)
     |      Set take profit, stop loss, and trailing stop for your open position.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-tradingstop.
     |      :returns: Request results as dictionary.
     |  
     |  user_leverage(self, **kwargs)
     |      ABANDONED! Please use my_position instead. Fetches user leverage by
     |      fetching user position.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-getleverage.
     |      :returns: Request results as dictionary.
     |  
     |  user_trade_records(self, **kwargs)
     |      Get user's trading records. The results are ordered in ascending order
     |      (the first item is the oldest).
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-usertraderecords.
     |      :returns: Request results as dictionary.
     |  
     |  wallet_fund_records(self, **kwargs)
     |      Get wallet fund records. This endpoint also shows exchanges from the
     |      Asset Exchange, where the types for the exchange are
     |      ExchangeOrderWithdraw and ExchangeOrderDeposit.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-walletrecords.
     |      :returns: Request results as dictionary.
     |  
     |  withdraw_records(self, **kwargs)
     |      Get withdrawal records.
     |      
     |      :param kwargs: See
     |          https://bybit-exchange.github.io/docs/inverse/#t-withdrawrecords.
     |      :returns: Request results as dictionary.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
    
    class WebSocket(builtins.object)
     |  WebSocket(endpoint, api_key=None, api_secret=None, subscriptions=None, logging_level=20, max_data_length=200, ping_interval=30, ping_timeout=10, restart_on_error=True, purge_on_fetch=True, trim_data=True)
     |  
     |  Connector for Bybit's WebSocket API.
     |  
     |  Methods defined here:
     |  
     |  __init__(self, endpoint, api_key=None, api_secret=None, subscriptions=None, logging_level=20, max_data_length=200, ping_interval=30, ping_timeout=10, restart_on_error=True, purge_on_fetch=True, trim_data=True)
     |      Initializes the websocket session.
     |      
     |      :param endpoint: Required parameter. The endpoint of the remote
     |          websocket.
     |      :param api_key: Your API key. Required for authenticated endpoints.
     |          Defaults to None.
     |      :param api_secret: Your API secret key. Required for authenticated
     |          endpoints. Defaults to None.
     |      :param subscriptions: A list of desired topics to subscribe to. See API
     |          documentation for more information. Defaults to an empty list, which
     |          will raise an error.
     |      :param logging_level: The logging level of the built-in logger. Defaults
     |          to logging.INFO. Options are CRITICAL (50), ERROR (40),
     |          WARNING (30), INFO (20), DEBUG (10), or NOTSET (0).
     |      :param max_data_length: The maximum number of rows for the stored
     |          dataset. A smaller number will prevent performance or memory issues.
     |      :param ping_interval: The number of seconds between each automated ping.
     |      :param ping_timeout: The number of seconds to wait for 'pong' before an
     |          Exception is raised.
     |      :param restart_on_error: Whether or not the connection should restart on
     |          error.
     |      :param purge_on_fetch: Whether or not stored data should be purged each
     |          fetch. For example, if the user subscribes to the 'trade' topic, and
     |          fetches, should the data show all trade history up to the maximum
     |          length or only get the data since the last fetch?
     |      :param trim_data: Decide whether the returning data should be
     |          trimmed to only provide the data value.
     |      
     |      :returns: WebSocket session.
     |  
     |  exit(self)
     |      Closes the websocket connection.
     |  
     |  fetch(self, topic)
     |      Fetches data from the subscribed topic.
     |      
     |      :param topic: Required parameter. The subscribed topic to poll.
     |      :returns: Filtered data as dict.
     |  
     |  ping(self)
     |      Pings the remote server to test the connection. The status of the
     |      connection can be monitored using ws.ping().
     |  
     |  ----------------------------------------------------------------------
     |  Static methods defined here:
     |  
     |  conform_topic(topic)
     |      For spot API. Due to the fact that the JSON received in update
     |      messages does not include a simple "topic" key, and parameters all
     |      have their own separate keys, we need to compare the entire JSON.
     |      Therefore, we need to strip the JSON of any unnecessary keys,
     |      cast some values, and dump the JSON with sort_keys.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)

DATA
    VERSION = '1.3.2'

FILE
    c:\anaconda3\envs\python397\lib\site-packages\pybit\__init__.py


None
>>> 

公式githubより

https://github.com/verata-veritatis/pybit/blob/master/examples/http_example.py
https://github.com/verata-veritatis/pybit/blob/master/examples/websocket_example.py

コメント

タイトルとURLをコピーしました