E#i1SSKrSSKJrJrJrJr SSKrSSKJ r J r J r J r J r JrJrJrJrJrJrJrJrJrJrJrJrJr SSKJr SSKJr SSKJ r SSKJ!r! SSKJ"r" SS KJ#r# SS KJ$r$ SS KJ%r% "S S \RLRN5r'g)N) ArrayCacheArrayCacheBySymbolByIdArrayCacheBySymbolBySideArrayCacheByTimestamp)AnyBalancesBoolInt LiquidationNumOrder OrderBook OrderSide OrderTypePositionStrStringsTickerTickers FundingRate FundingRatesTrade)Client)List) ExchangeError)AuthenticationError)ArgumentsRequired) BadRequest) InvalidNonce) ChecksumErrorc^\rSrSrS\4U4SjjrS[S\4SjjrS04S\4Sjjr 04S jr SS04S \S \ S \ S\ \ 4S jjrSS04S\ \S \ S \ S\ \ 4Sjjr04S\ \S\4Sjjr04S \S\4SjjrS\4Sjr04S \S\4Sjjr04S\ \S\4SjjrS\4Sjr04S \S\4Sjjr04S \S\4SjjrS04S\S\4Sjjr04S \S\4SjjrS04S\S\4SjjrS04S\S\4Sjjr S\4Sjr!S04S\S\4Sjjr"S\4Sjr#S\Sjr$SS04S\ \S \ S \ S\ \%4S jjr&S\4S!jr'SS04S\ \S \ S \ S\ \%4S"jjr(S\4S#jr)S\S$jr*S\S%jr+S&SS04S \S'\S \ S \ S\ \,4 S(jjr-S&04S \S'\S\4S)jjr.SS04S*\ \ \S \ S \ 4S+jjr/04S*\ \ \S\4S,jjr0S\4S-jr1S04S \S \ S\24S.jjr3S04S\ \S \ S\24S/jjr404S\ \S\4S0jjr504S \S\4S1jjr6S2r7S3r8S\S\4S4jjr9S\4S5jr:04S6jr;04S\<4S7jjr=S\4S8jr>S\4S9jr?S\S:jr@SSS04S \AS \ S \ S\ \ 4S;jjrBSSS04S\S \ S \ S\ \C4S<jjrDS=rESSS04S \AS \ S \ S\ \F4S>jjrGS\S\4S?jjrHS\4S@jrISArJS04S \SB\KSC\LSD\MSE\NS\F4 SFjjrOS\4SGjrPSS04SH\S \SB\KSC\LSD\NSE\NS\F4SIjjrQS04SH\S \AS\F4SJjjrRS04SK\ \S \A4SLjjrSS04S \AS\ \F4SMjjrTS\4SNjrUS\4SOjrVS\4SPjrWS\4SQjrXS\4SRjrYS\S\Z4SSjr[S\4STjr\S\S \S\4SUjr]S\S \S\4SVjr^S\S \S\4SWjr_S\S \4SXjr`S\4SYjraSZrbU=rc$)]okxreturnc,>UR[[U]50SS_SS_SS_SS_SS_SS_SS_S S_S S_S S_S S_S S_SS_SS_SS_SS_SS_SSSSSSSSSSS. ESS0SS0S.SSS.SSS0SS0SS0SS0SS 0SS!00S". URS#S$.S%.5$)&NwsT watchTickerwatchMarkPricewatchMarkPrices watchTickers watchBidsAskswatchOrderBook watchTradeswatchTradesForSymbolswatchOrderBookForSymbols watchBalancewatchLiquidationsemulatedwatchLiquidationsForSymbolswatchMyLiquidationswatchMyLiquidationsForSymbols watchOHLCVwatchOHLCVForSymbols) watchOrders watchMyTradeswatchPositionswatchFundingRatewatchFundingRates createOrderWs editOrderWs cancelOrderWscancelOrdersWscancelAllOrdersWszwss://ws.okx.com:8443/ws/v5zwss://wspap.okx.com:8443/ws/v5)apitestbooks)checksumdepthspotchanneltickerstypeANYop batch-orders amend-order) r,r0r'r*r8r9r=r>r&iPF)ping keepAlive)hasurlsoptions streaming) deep_extendsuperr"describerO)self __class__s F/home/james-whalen/.local/lib/python3.13/site-packages/ccxt/pro/okx.pyrW okx.describesc4 9 ;dt!$"4      !$t(+D$Z.t&z0 d!"'#$ $!%"&$(%)!%#!%"&%)7>7: !%0%3#6!'y y!E E"."- _2l " s_> _ _ rHcURSnU(aSOSnUS:HnUS:HnURSSnU(dURS5S :dUS :XaUS -U-$U(aUS -U-$US -U-$)N sandboxModez?brokerId=9999businesspublicrBr&candle orders-algoz /businessz/publicz/private)rSrRfind)rXrHaccess isSandbox sandboxSuffix isBusinessisPublicurls rZget_url okx.get_urlxsLL/ ,5(2  * h&iit$ ',,x0257m;S$}4 4 ?]2 2Z-//r\Nsymbolsc# UR5IShvN Uc URnURU5nURX!5n/n/n[ S[ U55HTnUR X85n UU S.n URURX55 URUS-X8-5 MV SUS.n URXVX5IShvN $NN7f)NrrHinstId:: subscriberLargs) load_marketsrnmarket_symbolsrlrangelen market_idappendextendwatch_multiple) rXrfrHrnparamsrk messageHashesruimarketIdargrequests rZsubscribe_multipleokx.subscribe_multiples!!! ?llG%%g.ll7+ q#g,'A~~gj1H""C KK C0 1  4'*!< =( ((WTTT' "&Us"C CCC CC C c# UR5IShvN URX15nSU0nUb$URU5nUSUS-- nUSUS'SURXu5/S.n UR XbX5IShvN $NoN7f)NrH:idrqrsrt)rvrlmarketrUwatch) rXrf messageHashrHsymbolr~rk firstArgumentrrs rZrs okx.subscribes!!!ll7+ w   [[(F 3- -K&,TlM( #  7  ZZ'GGG "Hs"B BA*B BB B rsincelimitcF# URU/X#U5IShvN $N7f)aL https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-trades-channel https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-all-trades-channel get the list of most recent trades for a particular symbol :param str symbol: unified symbol of the market to fetch trades for :param int [since]: timestamp in ms of the earliest trade to fetch :param int [limit]: the maximum amount of trades to fetch :param dict [params]: extra parameters specific to the exchange API endpoint :returns dict[]: a list of `trade structures ` N)watch_trades_for_symbols)rXrrrr~s rZ watch_tradesokx.watch_tradess$22F8U6RRRRs !!c# [U5nUS:Xa[URS-5eUR5IShvN UR U5nSnUR USSS5upd/n/n[ S[U55HEn Xn URUS-U -5 URU 5n UU S.n URU 5 MG S US .n S nUS :XaS nURSU05IShvN URXn5nURXX5IShvN nUR(a6URUS5nURUS5nURUU5nUR!UX#SS5$GN@NNd7f)a https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-trades-channel https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-all-trades-channel get the list of most recent trades for a particular symbol :param str symbols: :param int [since]: timestamp in ms of the earliest trade to fetch :param int [limit]: the maximum amount of trades to fetch :param dict [params]: extra parameters specific to the exchange API endpoint :param str [params.channel]: the channel to subscribe to, trades by default. Can be 'trades' and 'trades-all' :returns dict[]: a list of `trade structures ` rz> watchTradesForSymbols() requires a non-empty array of symbolsNr-rHtradesrrprsrtra trades-allr`rfr timestampT)ryrrrvrwhandle_option_and_paramsrxr{rz authenticaterlr} newUpdates safe_value safe_stringgetLimitfilter_by_since_limit)rXrnrrr~ symbolsLengthrHtopicsrrrrtopicrrfrkrfirst tradeSymbols rZrokx.watch_trades_for_symbolssG A #DGG.n$no o!!!%%g.77 yZbc q#g,'AZF  3!7 8~~f-H""E MM% (  l "F##Xv$67 7 7ll7+**3wVV ??OOFA.E**5(;KOOK7E))&% TRR; ", 8Vs6=FE?B4F4F5*FF A FFFc # UR5IShvN URUSS5nSnURUSSS5up2/n/n[S[ U55HEnXnUR SU-U-5 UR U5nUUS.n UR U 5 MG S US .n S n US :XaS n URSU 05IShvN URX;5n URXX5IShvN $NN1N7f)aG unWatches from the stream channel :param str[] symbols: :param dict [params]: extra parameters specific to the exchange API endpoint :param str [params.channel]: the channel to subscribe to, trades by default. Can be trades, trades-all :returns dict[]: a list of `trade structures ` NFr-rHrr unsubscribe:rp unsubscribertrarr`rf) rvrwrrxryr{rzrrlr}) rXrnr~rHrrrrrrrrfrks rZun_watch_trades_for_symbolsokx.un_watch_trades_for_symbolss!!!%%gtU;77 yZbc q#g,'AZF  '!9F!B C~~f-H""E MM% (   l "F##Xv$67 7 7ll7+((WTTT1 ", 8Ts4DC=B6D C?*D8D9D?DDcD# URU/U5IShvN $N7f)a unWatches from the stream channel :param str symbol: unified symbol of the market to fetch trades for :param dict [params]: extra parameters specific to the exchange API endpoint :returns dict[]: a list of `trade structures ` N)rrXrr~s rZun_watch_tradesokx.un_watch_tradess"55vhGGGG   clientcURUS05nURUS5nURUS5nURU5nURUS/5nURURSS5n[ S[ U55Hxn URXy5n US-U-n URURU5n U c[U5n XRU'U RU 5 URX5 Mz g) NrrHrqdata tradesLimitrr) rr safe_symbol safe_integerrSrxry parse_traderrr{resolve) rXrmessagerrHrrrrrtraderstoreds rZ handle_tradesokx.handle_tradessBoogub1""3 2##C2!!(+w3'' mTJ q#d)$A$$TW-E!C-&0K__T[[&9F~#K0&, F# MM% NN6 /%r\cn# URU5nURU/U5IShvN nX1$N7f)aB watch the current funding rate https://www.okx.com/docs-v5/en/#public-data-websocket-funding-rate-channel :param str symbol: unified market symbol :param dict [params]: extra parameters specific to the exchange API endpoint :returns dict: a `funding rate structure ` N)rwatch_funding_rates)rXrr~frs rZwatch_funding_rateokx.watch_funding_rateHs9V$++VHf= =z>s (53 5c# UR5IShvN URU5nSn/n/n[S[U55HEnXnUR US-U-5 UR U5nUUS.n UR U 5 MG SUS.n UR US5n URXX5IShvN n UR(aURU S 5n0n XU'U $URURS U5$NNN7f) a watch the funding rate for multiple markets https://www.okx.com/docs-v5/en/#public-data-websocket-funding-rate-channel :param str[] symbols: list of unified market symbols :param dict [params]: extra parameters specific to the exchange API endpoint :returns dict: a dictionary of `funding rates structures `, indexe by market symbols N funding-raterrrprsrtrar) rvrwrxryr{rzrlr}rrfilter_by_array fundingRates)rXrnr~rHrrrrrrrrk fundingRateresults rZrokx.watch_funding_ratesVs!!!%%g.  q#g,'AZF  3!7 8~~f-H""E MM% ( ll7H- //G[[ ??%%k8` Nr'rHrIr)rr watch_tickersrrXrr~rHrtickers rZ watch_tickerokx.watch_tickersp77 yZcd#yV$!))6(F;;v..` N)un_watch_tickersrs rZun_watch_tickerokx.un_watch_tickers"**F8V<<<` NFr*rHrIrarrvrwrrrrrIrXrnr~rH newTickerss rZrokx.watch_tickerss!!!%%gtU;77PY[de228WvVV ?? ##DLL(GDD "W"BBABB5BBc# SnURUSSS5up2X2S'URU5nUSnURU/U5IShvN nXQ$N7f)a https://www.okx.com/docs-v5/en/#public-data-websocket-mark-price-channel watches a mark price :param str symbol: unified symbol of the market to fetch the ticker for :param dict [params]: extra parameters specific to the exchange API endpoint :param str [params.channel]: the channel to subscribe to, tickers by default. Can be tickers, sprd-tickers, index-tickers, block-tickers :returns dict: a `ticker structure ` Nr(rH mark-pricer)rrwatch_mark_pricesrs rZwatch_mark_priceokx.watch_mark_pricesl77@PR[]ij#yV$!--vh??~@sA A A Ac.# UR5IShvN URUSS5nSnURUSSS5up2URSX1U5IShvN nUR(aU$UR UR SU5$NzN67f)a https://www.okx.com/docs-v5/en/#public-data-websocket-mark-price-channel watches mark prices :param str[] [symbols]: unified symbol of the market to fetch the ticker for :param dict [params]: extra parameters specific to the exchange API endpoint :param str [params.channel]: the channel to subscribe to, tickers by default. Can be tickers, sprd-tickers, index-tickers, block-tickers :returns dict: a `ticker structure ` NFr)rHrrarrrs rZrokx.watch_mark_pricess!!!%%gtU;77@QS\^jk228WvVV ?? ##DLL(GDD "Wrc# UR5IShvN URUSS5nSnURUSSS5up2/n/n[S[ U55HBnXnUR SU-5 UR U5nUUS.n UR U 5 MD S US .n URUS 5n URXX5IShvN $NN7f) aY https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel unWatches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list :param str[] [symbols]: unified symbol of the market to fetch the ticker for :param dict [params]: extra parameters specific to the exchange API endpoint :param str [params.channel]: the channel to subscribe to, tickers by default. Can be tickers, sprd-tickers, index-tickers, block-tickers :returns dict: a `ticker structure ` NFr*rHrIrunsubscribe:ticker:rprrtra) rvrwrrxryr{rzrlr}) rXrnr~rHrrrrrrrrks rZrokx.un_watch_tickerss!!!%%gtU;77PY[de q#g,'AZF  !6!? @~~f-H""E MM% (  ll7H-((WTTT) "(Us"CCB:CCCCcURX5 URUS05nURUS5nURUSS5nUSnURUS5nURUS/5n0n [ S[ U55H(n UR X5n XRU'XU'M* US-U-n URX5 g) Nrrq-rrHrrrr) handle_bid_askrr safe_marketrxry parse_tickerrIr) rXrrrrrrrHrrrrrs rZ handle_tickerokx.handle_tickers4 F,oogub1##C2!!(D#6!""3 2w3 q#d)$A&&tw/F#)LL !'v %nv- z/r\cJ# UR5IShvN URUSS5nSnURUSSS5up2URUS5n/n/n[ S[ U55HQnUR X5nUUS.n URURX55 URS X-5 MS S US .n URXEX5IShvN n UR(a 0n XU S 'U $URURS U5$GNN@7f) ac https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel watches best bid & ask for symbols :param str[] symbols: unified symbol of the market to fetch the ticker for :param dict [params]: extra parameters specific to the exchange API endpoint :returns dict: a `ticker structure ` NFr+rHrIrarrpbidask::rsrtr) rvrwrrlrxryrzr{r|r}rrbidsasks) rXrnr~rHrkrrurrrrrrIs rZwatch_bids_asksokx.watch_bids_asks<s,!!!%%gtU;77QZ\efll7H- q#g,'A~~gj1H""C KK C0 1  gj!8 9(  ..s7ZZ ??G,6Jx( )N##DMM8WEE1 "&[s"D#DC D# D!!>D#!D#cURUS/5nURUS05nURU5nUSnXPRU'SU-nUR XW5 g)Nrrrr)r safe_dictparse_ws_bid_askrr)rXrrrr parsedTickerrrs rZrokx.handle_bid_ask`sd4~~gvr2a,,,V4 h' , f 6) |1r\c dURUS5nURX25nURUS5nURUS5nURUUUR U5URUS5URUS5URUS5URUS5US.U5$) NrqrtsaskPxaskSzbidPxbidSz)rrdatetimeask askVolumebid bidVolumeinfo)rrr safe_tickeriso8601)rXrrrrrs rZrokx.parse_ws_bid_asks##FH5!!(3!!&(3%%fd3 " Y/##FG4))&':##FG4))&': !    r\cl# UR5IShvN URUSSS5nSn/nUb8[S[U55HnXnUR US-U-5 M OUR U5 UR U5n Sn UR SX5upSn U S:XaS n OU S :XaS n U R5n S U U S ./S.n URU S5nURXX5IShvN nUR(aU$URURXUS5$GNN87f)a watch the public liquidations of a trading pair https://www.okx.com/docs-v5/en/#public-data-websocket-liquidation-orders-channel :param str symbols: :param int [since]: the earliest time in ms to fetch liquidations for :param int [limit]: the maximum number of liquidation structures to retrieve :param dict [params]: exchange specific parameters for the okx api endpoint :returns dict: an array of `liquidation structures ` NT liquidationsrrrwatchliquidationsForSymbolsliquidation-ordersrGSWAPfuturefuturesrsrHinstTypertra) rvrwrxryr{get_market_from_symbolshandle_market_type_and_paramsupperrlr}rfilter_by_symbols_since_limitr )rXrnrrr~rrrrrrJrH uppercaseTyperrknewLiquidationss rZwatch_liquidations_for_symbols"okx.watch_liquidations_for_symbolssR!!!%%gtT4@$   1c'l+ $$[4%7&%@A,   ---g699:WY_h & 6>D X D  ' - ll7H- $ 3 3C __ ??" "11$2C2CWUZ\`aaA ":`s"D4D/C"D49D2:6D42D4cURUS/5n[S[U55HnX4nURU5nUR US5nUR UR U5nUc(URURSS5n [U 5nURU5 XR U'URU/S5 URU/SU-5 M g)NrrrliquidationsLimitrr zliquidations::) rrxryparse_ws_liquidationrrr rrSrr{r) rXrrrawLiquidationsrrawLiquidation liquidationrr rs rZhandle_liquidationokx.handle_liquidations8..&"=q#o./A,/N33NCK%%k8` NstoptriggerFrfr`privateTmyLiquidationsrrrbalance_and_positionrsrHrt)rv safe_value_2omitrrwrxryr{rlr}rUrrr )rXrnrrr~ isTriggerrrrrrHrrkrs rZ!watch_my_liquidations_for_symbols%okx.watch_my_liquidations_for_symbolss^!!!%%ffiG 6FI#67: RSSS%%gtT4@&   1c'l+ $$[4%7&%@A,   -(w ll7I. $ 3 3CHXHXY`Hikx yy ??" "11$2C2CWUZ\`aa5 " T(zs5E EA E "E#B)E  E 6E E E cURUS/5n[S[U55HnX4nURUS5nUS:wa gUR U5nURUS5nUR UR U5n U c(URURSS5n [U 5n U RU5 XR U'URU/S5 URU/S U-5 M g) Nrr eventTyper rmyLiquidationsLimitrr'zmyLiquidations::) rrxryrparse_ws_my_liquidationrr rrSrr{r) rXrrrrrr/r rr rs rZhandle_my_liquidationokx.handle_my_liquidationsF..&"=q#o./A,/N((EIM)66~FK%%k8 ,,V^D%%k7;" Y/ &  r\cURUS/5nURUS05nURUS5nURXR5nUR US5nUR UUR XR5URUS5URUS5URUS5URUS5SSUURU5S . 5$) Ndetailsrrqrszr8bkPxside) rrr:r8r;rGr<r=rrr>)rXr rrDliquidationDetailsrrs rZrokx.parse_ws_liquidationts*..i<!^^GQ;##K:!!(3%%&8$? $$&&x8))*+>sMSZ\i+j%j" 7 ??$$VU3E--guQM'' 8DD3 "*&ks&AE2E-CE2E0AE20E2cF# [U5nUS:Xd[US[5(d[URS-5eUR 5IShvN /n/n[ S[U55HsnXnUSnUSn URU5n URURX5n SU -n U U S.n URU 5 URSU -S-U-5 Mu S US .nURSS 5nURXX5IShvN $NN7f) a unWatches historical candlestick data containing the open, high, low, and close price, and the volume of a market :param str[][] symbolsAndTimeframes: array of arrays containing unified symbols and timeframes to fetch OHLCV data for, example [['BTC/USDT', '1m'], ['LTC/USDT', '5m']] :param dict [params]: extra parameters specific to the exchange API endpoint :returns int[][]: A list of candles ordered, open, high, low, close, volume rrYNrZrbrpzunsubscribe:multi:rrrtra) ryr\r]rrrvrxrzrrMr{rlr})rXrWr~rrrrr_r`rarrNrHrrrks rZrTokx.un_watch_ohlcv_for_symbolssF01 A Z0DQ0G%N%N#DGG/f%fg g!!! q#234A!5!8 $Q'C#A&B~~c*H''@H)G""E MM%  !5!?#!E!K L5  ll8X.((WTTT+ "*Us%AD!DCD!DD!D!c URUS05nURUS5nURUS/5nURUS5nURU5nUSnURSS5n UR U 5n [ S[ U55Hn URX[U5n URURU05URU'URURUU 5n U c9URURS S 5n[U5n XRUU 'U RU 5 US -US -nURX5 S U-S -U-nURXU /U5 M g)NrrHrrqrrbr_r OHLCVLimitrrrr[)rrrreplacefind_timeframerxry parse_ohlcvohlcvsrrSrr{r)rXrrrrHrrrrrNrKrparsedrrrmessageHashForMultis rZ handle_ohlcvokx.handle_ohlcvst"oogub1""3 2w3##C2!!(+!??8R0''1 q#d)$A%%dgv6F"&//$++vr"JDKK __T[[%8)DF~))$,, dK.u517 F#I. MM& !!C-&,6K NN6 /#+W"4s":V"C  NNFv68K L%r\cD# URU/X#5IShvN $N7f)a https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data :param str symbol: unified symbol of the market to fetch the order book for :param int [limit]: the maximum amount of order book entries to return :param dict [params]: extra parameters specific to the exchange API endpoint :param str [params.depth]: okx order book depth, can be books, books5, books-l2-tbt, books50-l2-tbt, bbo-tbt :returns dict: A dictionary of `order book structures ` indexed by market symbols N)watch_order_book_for_symbols)rXrrr~s rZwatch_order_bookokx.watch_order_book,s#F66xOOOOrc# UR5IShvN URU5nSnURUSSS5upCUb)US:XaSnO US:a US::aSnOUS :XaS nOUS :XaSnUS :XdUS :XaIURS 5(d[ UR S-5eUR SS05IShvN /n/n[S[U55HEnXnURUS-U-5 URU5n UU S.n URU 5 MG SUS.n URUS5n URXX5IShvN n U R5$GNRNN7f)a https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data :param str[] symbols: unified array of symbols :param int [limit]: 1,5, 400, 50(l2-tbt, vip4+) or 40000(vip5+) the maximum amount of order book entries to return :param dict [params]: extra parameters specific to the exchange API endpoint :param str [params.depth]: okx order book depth, can be books, books5, books-l2-tbt, books50-l2-tbt, bbo-tbt :returns dict: A dictionary of `order book structures ` indexed by market symbols Nr,rFrDrZbbo-tbtbooks52books50-l2-tbt books-l2-tbtFz watchOrderBook/watchOrderBookForSymbols requires authentication for self depth. Add credentials or change the depth option to books or books5rfrarrrprsrt)rvrwrcheck_required_credentialsrrrrxryr{rzrlr}r)rXrnrr~rFrrrrrrrrk orderbooks rZrs okx.watch_order_book_for_symbolsQs!!!%%g.55f>NPWY`a   z!uz "(# ^ #2B)B22599)$''5E+EFF##Xx$89 9 9 q#g,'AZF  v!5 6~~f-H "E MM% ( ll5(+--c'YY   E " :"Zs5E/E(B)E/E+BE/E-E/+E/-E/ch# UR5IShvN URUSS5nSnURUSSS5up2URUS5nUb)US:XaSnO US:a US ::aS nOUS :XaS nOUS :XaSn/n/n/n[ S[ U55HYnXn UR US-U -5 UR SU -5 URU 5n UU S.n UR U 5 M[ SUS.n URUS5n URXX5IShvN $GNN7f)as https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel unWatches information on open orders with bid(buy) and ask(sell) prices, volumes and other data :param str[] symbols: unified array of symbols :param dict [params]: extra parameters specific to the exchange API endpoint :param int [params.limit]: the maximum amount of order book entries to return :param str [params.depth]: okx order book depth, can be books, books5, books-l2-tbt, books50-l2-tbt, bbo-tbt :returns dict: A dictionary of `order book structures ` indexed by market symbols NFr,rFrDrrZrwrxryrzr{r|rrunsubscribe:orderbook:rprrtra) rvrwrrrxryr{rzrlr})rXrnr~rFrrsubMessageHashesrrrrrrrks rZun_watch_order_book_for_symbols#okx.un_watch_order_book_for_symbolss_!!!%%gtU;55f>NPWY`a !!&'2  z!uz "(# q#g,'AZF  # #ECK&$8 9  !9F!B C~~f-H "E MM% (  ll5(+((WTTTA "@Us"D2D-DD2(D0)D20D2cD# URU/U5IShvN $N7f)ap https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-channel unWatches information on open orders with bid(buy) and ask(sell) prices, volumes and other data :param str symbol: unified array of symbols :param dict [params]: extra parameters specific to the exchange API endpoint :param int [params.limit]: the maximum amount of order book entries to return :param str [params.depth]: okx order book depth, can be books, books5, books-l2-tbt, books50-l2-tbt, bbo-tbt :returns dict: A dictionary of `order book structures ` indexed by market symbols N)rrs rZun_watch_order_bookokx.un_watch_order_books"996(FKKKKrcnURUS5nURUS5nURX45 g)NrrZ) safe_floatstore)rXbooksidedeltar;amounts rZ handle_deltaokx.handle_deltas0q)*u%r\cd[S[U55HnURXU5 M g)Nr)rxryr)rXrdeltasrs rZ handle_deltasokx.handle_deltass)q#f+&A   hq 2'r\cURUS/5nURUS/5nUSnUSn URX5 URX5 URUS5n URX5n UR SSS5n UR US5n U (GaUR US5nUS n[ U5n[ U 5n/n[S S 5HnUU:aLURURU US 55 URURU US 55 UU:dM]URURUUS 55 URURUUS 55 M S RU5nUR US5nURUS5nSnUS:waX:wa[URS-5nUU:wa*[URS-URU 5-5nUb/UR U U b UR"U UR%UU5 UR US5nXS 'UUS'UR'U5US'U$)Nasksbidsrqr,rETseqId prevSeqIdnoncerrZrrcz& watchOrderBook received invalid nonce rrr)rrrr handle_optionrryrxr{number_to_stringjoincrc32rrr orderbook_checksum_message subscriptions orderbooksrejectr)rXrrrrrrr storedAsks storedBidsrrrErrr asksLength bidsLength payloadArrayrpayloadresponseChecksum localChecksumerrorrs rZhandle_order_book_messageokx.handle_order_book_messagesq(w3w3v& v&  :, :,##GX6!!(3%%&6 DI!!'73 ))';?Ig&EZJZJL1b\z> ''(=(=jmA>N(OP ''(=(=jmA>N(OPz> ''(=(=jmA>N(OP ''(=(=jmA>N(OP "hh|,G#00*E  JJw5MEB5#5$TWW/W%WX=0%dggmd6U6UV\6]&]^ ((5%/ e[1%%gt4 "'!* + $ Y 7 *r\c DURUS05nURUS5nURUS5nURUS/5nURUS5nURU5nUSn SSS SS S .n UR X5n US -U -n US :Xai[ S[ U55HNn XmnUR0U 5nXRU 'XS'URXX5 URX5 MP U$US:XadXR;aSURU n[ S[ U55H+n XmnURXXU5 URX5 M- U$US:XdUS:XaXR;aUR0U 5URU 'URU n[ S[ U55HQn XmnUR US5nURXUSSSS5nURU5 URX5 MS U$)NrrHactionrrqrrZr|rxrz)rwrDryr}r{rsnapshotrupdateryrwrrr) rrrrrrxry order_bookrrrparse_order_bookreset)rXrrrrHrrrrrdepthsrrrrrrrs rZhandle_order_bookokx.handle_order_book s*lnnWeR0""3 2!!'84~~gvr2##C2!!(+!  !!&2mf, Z 1c$i( OOB6 *3'&,(#..vyVy6 )0#x ( OOF3 q#d),A!WF2269[abNN9:-!w)';oo-*.//"e*D'/I1c$i( --fd; 00FTZ\]_`a)y6 ) r\c# UR5 URUSS5nURUS/5nURSU5nSnUR U5nUR U5nUR URU5nUc[UR55nSn Sn X-U -n URURU 5URUR5[RS5n Sn U URUR UU S ./S .nSU;aUSUS'UR#X4X5 UIShvN $N7f) Nrfr&users authenticatedGETz/users/self/verifybase64login)apiKey passphrasersignrt)r~rr*rlrreusableFuturerrstrsecondshmacencodesecrethashlibsha256rpasswordr)rXr~rfrkrrrrrmethodpathauth signature operationrs rZrokx.authenticates< '')!!&(I>6H:.ll7F+% S!&&{3(<(||sEE EE c# UR5IShvN UR5IShvN URSSSSU5IShvN $N9N#N7f)z watch balance and get the amount of funds available for trading or funds locked in orders :param dict [params]: extra parameters specific to the exchange API endpoint :returns dict: a `balance structure ` Nr&account)rvrrs)rXr~s rZ watch_balanceokx.watch_balancesP !!!!!!^^Iy)T6RRR "!Rs1AAAAA A AAAc&URX5 gN)r2rXrrs rZhandle_balance_and_positionokx.handle_balance_and_positions ""63r\cJURUS05nURUS5nSnURU5nURURU05nUR Xv5nUR U5URU'UR URUU5 g)NrrHrG)rrparseTradingBalancebalancerU safe_balancer) rXrrrrHrJr oldBalance newBalances rZhandle_balanceokx.handle_balancesXoogub1""3 2**73__T\\4< %%j: !..z: Tt||D)73r\cPURUS05nURUS5nURUS5nURUSS5S:HnURUUUR U5URUS5URUS5URUS 5URUS 5U(aS OS URUS 5UR US5UR US5UR US5UR US5UR U5S.S. U5$)NrfillTime fillFeeCcyexecTyper_TrtradeIdrrJtakermakerrGfillPxfillSzcostfillFee)rcurrency) rrrrrorderrJ takerOrMakerrGr;rrfee)rrr safe_traderr@safe_currency_code)rXrrrr feeMarketIdisTakers rZorder_to_tradeokx.order_to_trades(ufb1%%dJ7 &&t\: ""4R8C?" Y/&&uh7""43%%eT2$$UF3(/Gg$$UF3%%dH5&&tX6$$UF3((y9 33K@ " # r\c # SnURUSSS5upTURUSSS5nURUSS/5nUR5IShvN UR SU(aS OS 05IShvN U(aS OS nUS -nSn Ub#UR U5n U SnU SnUS-U-nUS:XaSnUR 5n Sn URSU5upU S:XaU bSn SU 0n URS XSURX55IShvN n UR(aU RX5nURXX#S5$NNN=7f)a- watches information on multiple trades made by the user https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel :param str [symbol]: unified market symbol of the market trades were made in :param int [since]: the earliest time in ms to fetch trades for :param int [limit]: the maximum number of trade structures to retrieve :param dict [params]: extra parameters specific to the exchange API endpoint :param bool [params.trigger]: True if fetching trigger or conditional trades :param str [params.type]: 'spot', 'swap', 'future', 'option', 'ANY', 'SPOT', 'MARGIN', 'SWAP', 'FUTURES' or 'OPTION' :param str [params.marginMode]: 'cross' or 'isolated', for automatically setting the type to spot margin :returns dict[]: a list of `trade structures ` Nr9rJrKr%r$Frfr`r&rdorders ::myTradesrrrrrSPOTMARGINrT) r safe_bool_2r*rvrrrhandle_margin_mode_and_paramsrsr|rrfilter_by_symbol_since_limit)rXrrrr~rJr+rHrrr marginModerrs rZwatch_my_tradesokx.watch_my_tradessz 44V_fV[\ $$VYF 6Iv#67!!!: RSSS#,-( ,   [[(FH%F&>D%,v5K 8 D  !??QWX F "% (   ~~itT[[Y`Mijj ??OOF2E00tTT1 "S(ks7AEE#E:E;BEE:EEEc # UR5IShvN URU5IShvN URU5nSS0nSnSnUcISSS.nURX5/n SU S.n UR US5n UR XX5IShvN nO*UR SXaURXT55IShvN nUR(aU$URURXUS 5$NNNdN;7f) a https://www.okx.com/docs-v5/en/#trading-account-websocket-positions-channel watch all open positions :param str[]|None symbols: list of unified market symbols @param since @param limit :param dict params: extra parameters specific to the exchange API endpoint :returns dict[]: a list of `position structure ` NrrK positionsrrsrtr&T) rvrrwr|rlrrrrr) rXrnrrr~rrH newPositionsrrunonSymbolRequestrks rZwatch_positionsokx.watch_positions6s !!!'''%%g.   ?&!CKK,-D!& ,,w 2C!%C:J!TTL!%!8!8GVZVaVabiVr!ssL ?? 11$..'RWY]^^1 "'$UssDC<C4C<C6A#C<C8*C<>C:?6C<6C<8C<:C<cURUS05nURUS5nURUSS5nUSnURUSS5nURUS/5nURc[ 5UlURn /n [ S[ U55Hn Xn URU 5n U S S:Xa=S U S 'URU 5nS US 'U RU5 U RU5 U RU 5 U RU 5 M UnUbUS -U-nURX5 g)NrrqrrrHr_rrr:longrGshortrr) rrrrrrxryparse_positioncloner{r)rXrrrrrrrHrcacherr rawPositionposition shortPositionrs rZhandle_positionsokx.handle_positions\sEFoogub1##C2!!(D#6!""3 26w3 >> !57DN q#d)$A'K**;7H $)#) $ 8 4 (/ f% ]+##M2    ) LL "%  !D.61K|1r\c # SnURUSSS5upTURUSSS5nURUSS/5nUR5IShvN UR SU(aS OS 05IShvN SnUbUR U5nUS nUSnUS :XaS nUR 5nSn URSU5upUS:XaU bSnSU0n U(aSOSn URS XXRX55IShvN n UR(aU RX5nURXX#S5$NNN=7f)a1 watches information on multiple orders made by the user https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-order-channel :param str [symbol]: unified market symbol of the market the orders were made in :param int [since]: the earliest time in ms to fetch orders for :param int [limit]: the maximum number of order structures to retrieve :param dict [params]: extra parameters specific to the exchange API endpoint :param bool [params.trigger]: True if fetching trigger or conditional orders :param str [params.type]: 'spot', 'swap', 'future', 'option', 'ANY', 'SPOT', 'MARGIN', 'SWAP', 'FUTURES' or 'OPTION' :param str [params.marginMode]: 'cross' or 'isolated', for automatically setting the type to spot margin :returns dict[]: a list of `order structures ` Nr8rJrKr$r%Frfr`r&rrrrrrrdrT) rr)r*rvrrrrrsr|rrr) rXrrrr~rJr+rrrrrHrs rZ watch_ordersokx.watch_orderss^44V]FTYZ %%ffiG 6FI#67!!!: RSSS  [[(FH%F&>D 8 D  !?? vV F "% (   $--(~~i6;;W^Kghh ??OOF2E00tTT- "S$is7AE E#E :E;BE  E  :E E  E cURX5 URUS05nURUS5nURUS/5n[U5nUS:Ga UR UR SS5nUR c [U5Ul[U5UlUS:Xa URO UR n /n URU5n [S[U 55HBn Xn U RU 5 U SnURU5nU RUS 5 MD URX5 [S[U 55Hn US -X-nURU U5 M! gg) NrrHrr ordersLimitrrdrrr)handle_my_tradesrrryrrSrr triggerOrders parse_ordersrxr{rr)rXrr subscriptionrrHr ordersLengthrr marketIdsrnrrrrrs rZ handle_ordersokx.handle_orderssYn f.oogub1""3 2&"56{ ! %%dllM4HE{{"4U; %;E%B",3},DT''4;;FI&&v.F1c&k*  e$xV,  . + NN6 +1c)n-%mil: v{3. r\cURUS05nURUS5nURUS/5n/n[S[U55HMnXWnURUSS5n [U 5S:dM+UR U5n UR U 5 MO [U5n U S:XagUR c-URURSS5n [U 5UlUR n 0n[S[U55H3nXgnURU5nU R U5 US nS UU'M5 US -nURUR U5 [UR55n[S[U55H*nUS -UU-nURUR U5 M, g) NrrHrrrr_rrrTrrr)rrrxry parse_orderr{myTradesrrSrrrr]keys)rXrrrrH rawOrdersfilteredOrdersrrawOrderrr tradesLengthrr$rnrawTraderrr tradeSymbolssymbolMessageHashs rZrokx.handle_my_trades4snoogub1""3 2OOGVR8 q#i.)A |H&&xB?G7|a((2%%e, * >* 1   == %%dllM4HE259DM==q#n-.A%(H''1E OOE "8_F"GFO /  , t}}k2GLLN+ q#l+,A +d 2\!_ D  NN4==*; <-r\ct[UR55nURS5n[U5nX-$)N)r milliseconds rand_number)rXr randomNumber randomParts rZ request_idokx.request_ids7 ""$ %''* & r\rJrGrr;c6# UR5IShvN UR5IShvN URSS5nUR5nSn UR USSS5upUR XX4XV5n UR U S5n U S:XdU S:XdUS :XdUS :Xd US :XdUS :Xa[URS -5eU S:waU S:wa[URS-5eUU U /S.n URXxX5IShvN $NNN7f)a https://www.okx.com/docs-v5/en/#websocket-api-trade-place-order create a trade order :param str symbol: unified symbol of the market to create an order in :param str type: 'market' or 'limit' :param str side: 'buy' or 'sell' :param float amount: how much of currency you want to trade in units of base currency :param float|None [price]: the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders :param dict [params]: extra parameters specific to the exchange API endpoint :param boolean params['test']: test order, default False :returns dict: an `order structure ` Nr&r=rLrMordTyper% conditionalocomove_order_stopicebergtwapzw createOrderWs() does not support algo trading. self.options["createOrderWs"]["op"] must be either order or batch-orderrz createOrderWs() does not support algo trading. self.options["createOrderWs"]["op"] must be either order or privatePostTradeOrder or privatePostTradeOrderAlgorrLru) rvrrlr4rcreate_order_requestrrrr) rXrrJrGrr;r~rkrrLrur7rs rZcreate_order_wsokx.create_order_wssU!!!!!!ll9i0oo' 226?DR`a ((tUS""43 y g&>DEMW[_pWpvzHwHNRV\N\TWW(aab b 'Mn 4TWW(HHI IF  ZZ'GGG# "! Hs2DDDDCDDDDDc URUS5nURUS/5nURUSS5nURU5(aEURUS5nUR U5nUR SSUR U0Xb005 URUSSS5nURUS05nURX5 g) NrrsCode0rLrZr_r) rr filter_byis_emptyjson handle_errorsrkrrr) rXrrrrur stringMsgrrs rZhandle_place_ordersokx.handle_place_orderss&&&w5 w3~~dGS1 ==  %%gt4F '*I   q"fjj&"iRTVX Y""4tT:vq"-u*r\rc t# UR5IShvN UR5IShvN URSS5nUR5n Sn UR USSS5upUR XX4XVU5n U U U /S.n UR XURX5U 5IShvN $NNN7f)a edit a trade order https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-multiple-orders :param str id: order id :param str symbol: unified symbol of the market to create an order in :param str type: 'market' or 'limit' :param str side: 'buy' or 'sell' :param float amount: how much of the currency you want to trade in units of the base currency :param float|None [price]: the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders :param dict [params]: extra parameters specific to the exchange API endpoint :returns dict: an `order structure ` Nr&r>rLrNr=)rvrrlr4redit_order_requestrr|) rXrrrJrGrr;r~rkrrLrurs rZ edit_order_wsokx.edit_order_wss !!!!!!ll9i0oo' 226=$P]^ &&r4vfUF  ZZ$++g2NP[\\\ "!]s2B8B2B8B4A>B8-B6.B84B86B8c# Uc[URS-5eUR5IShvN UR5IShvN UR SS5nUR 5nUR USS5nURUSS/5nSURU50nUbXgS'OXS'USURXs5/S .nURXEX5IShvN $NNN7f) a https://okx-docs.github.io/apidocs/websocket_api/en/#cancel-order-trade cancel multiple orders :param str id: order id :param str symbol: unified market symbol, default is None :param dict [params]: extra parameters specific to the exchange API endpoint :param str [params.clOrdId]: client order id :returns dict: an list of `order structures ` Nz+ cancelOrderWs() requires a symbol argumentr&clOrdId clientOrderIdrqordId cancel-orderr=) rrrvrrlr4 safe_string_2r*rzr|r) rXrrr~rkrrQrrs rZcancel_order_wsokx.cancel_order_wss >TWW'TTU U!!!!!!ll9i0oo' **69oN 6OY#?@ dnnV,   $* NL [[-.  ZZ'GGG% "!"Hs4/C,C&C, C( BC,!C*"C,(C,*C,idsc# [U5nUS:a[URS-5eUc[URS-5eUR5IShvN UR 5IShvN UR SS5nUR 5n/n[SU5H*nURU5XS.n URU 5 M, USUS .n URXVURX5U5IShvN $NNN7f) af https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order cancel multiple orders :param str[] ids: order ids :param str symbol: unified market symbol, default is None :param dict [params]: extra parameters specific to the exchange API endpoint :returns dict: an list of `order structures ` r#z0 cancelOrdersWs() accepts up to 20 ids at a timeNz, cancelOrdersWs() requires a symbol argumentr&r)rqrRzbatch-cancel-ordersr=) ryrrrvrrlr4rxrzr{rrU) rXrWrr~ idsLengthrkrrurrrs rZcancel_orders_wsokx.cancel_orders_wss H r>TWW'YYZ Z >TWW'UUV V!!!!!!ll9i0oo' q)$A..0C KK  %'  ZZ$2B2B72SU`aaa! "!bs7AD DD 2D3B D D D D  D c# Uc[URS-5eUR5IShvN UR5IShvN UR U5nUSS:wa[URS-5eUR SS5nUR 5nUSURSUS S .U5/S .nURXEXe5IShvN $NNN7f) a https://docs.okx.com/websockets/#message-cancelAll cancel all open orders of a type. Only applicable to Option in Portfolio Margin mode, and MMP privilege is required. :param str symbol: unified market symbol, only orders in the market of self symbol are cancelled when symbol is not None :param dict [params]: extra parameters specific to the exchange API endpoint :returns dict[]: a list of `order structures ` Nz/ cancelAllOrdersWs() requires a symbol argumentrJoptionzh cancelAllOrdersWs is only applicable to Option in Portfolio Margin mode, and MMP privilege is required.r& mass-cancelOPTIONr)r instFamilyr=) rrrvrrrlr4r|r)rXrr~rrkrrs rZcancel_all_orders_wsokx.cancel_all_orders_ws5s >TWW'XXY Y!!!!!!V$ &>X %TWW(RRS Sll9i0oo' [[$$Tl" ZZ'GGG "!Hs4/CCC C B CCCCCcpURUS5nURUS/5nURXC5 g)Nrr)rrr)rXrrrrs rZhandle_cancel_all_ordersokx.handle_cancel_all_ordersRs4&&w5 w3t)r\cU$rrs rZhandle_subscription_statusokx.handle_subscription_statusds r\c^URURS5nURS5 g)NrT)rrr)rXrrrs rZhandle_authenticateokx.handle_authenticatels$Atr\cg)NrOrg)rXrs rZrOokx.pingssr\c0UR5UlU$r)r0lastPongrs rZ handle_pongokx.handle_pongxs++-r\cURUS5nU(Ga*US:wGa#URS-URU5-nUS:waURURSX45 UR US5nUb UR URSXT5 OURUS/5n[S [U55HqnXgnURUS 5nUbURURSX45 UR US 5nUcMRUR URSXT5 Ms [U5eg![an URUS 5n U c`URUS5n U bKU RS 5(a5U RSS5n URU 5n URU S 5n U bURX5 Sn A gURU 5 Sn A gSn A ff=f)NcoderCr1exactmsgbroadrrrBsMsgrzIllegal request: {zIllegal request: r_FT)rrrFthrow_exactly_matched_exception exceptionsrthrow_broadly_matched_exceptionrrxryr Exception startswithrj parse_jsonr)rXrr errorCodefeedback messageStringrrderrwstringifiedJson parsedJsons rZhandle_error_messageokx.handle_error_message|s $$Wf5 " Y#-77S=499W+==#889QS\g $ ?  ,889QS`k>>'62>D"1c$i0 G$($4$4Q$@ $0 @@QXAY[do(,(H (4 @@QXAY[hs1$H--"! !!'40Bz&&w6?s~~6J'K'K&)kk2Er&JO!%!AJ))*d;B~ a$ MM!  s%DE.E G:B G5G55G:c XURX5(dgUS:XaURX5 gURUSS5nUbURURUR UR UR UR UR UR URS. nURXC5nUb U"X5 ggURUS05nURUS5n0SUR_SUR_S UR_S UR_S UR_S UR_S UR_SUR_SUR_SUR_SUR_SUR_SUR_SUR_SUR_SUR _SUR _UR"UR$S.EnURXG5nUc(UR'S5S:XaUR)X5 ggU"X5 g)NpongeventrL) rrsrrrMrNzbatch-amend-ordersrSr^rrHrwrDryr{r}rIrrz index-tickersz sprd-tickersz block-tickersrrrrrrd)r r(rbr)rrqrTrkrhhandle_unsubscriptionrIrdrrrrrrrrr r!rrerp)rXrrrmethodsrrrHs rZhandle_messageokx.handle_messages((99 P f    V - ""7GT:  11!<<#9911 $ 8 8#77&*&>&> $ 8 8#<< G__W4F!v'"//'5"5C&&sI6G411//$00!$"8"8   6 6  4-- d00T22 !3!3 2 2 !3!3$,,d004.. 8 8"$,,#$t11%&'+&=&=(,(H(H)G,__W6F~<<)Q.%%f6/v'r\c|US-U-nSU-nURXU5 X R;aURU gg)Nrr)clean_unsubscriptionrrXrrrHsubMessageHashrs rZhandle_un_subscription_trades!okx.handle_un_subscription_trades sE 3/$~5  !!&+F [[  F# !r\c|US-U-nSU-nURXU5 X R;aURU gg)Nrr)rrrs rZ handle_unsubscription_order_book$okx.handle_unsubscription_order_book sE 3/.7  !!&+F __ $' %r\cURSS5nURU5nSU-S-U-nSU-nURXU5 XPRU;aURUU gg)Nrbr_r[rr)rjrkrrm)rXrrrHrarKrrs rZhandle_unsubscription_ohlcvokx.handle_unsubscription_ohlcv su __Xr *''+ !G+c1F:$~5  !!&+F  F+ + F#I. ,r\c|US-U-nSU-nURXU5 X R;aURU gg)Nrrr)rrIrs rZhandle_unsubscription_ticker okx.handle_unsubscription_ticker sE 4&0+f4  !!&+F \\ ! V$ "r\cURUS05nURUSS5nURUS5nURU5nUS:XdUS:XaURXU5 gUR S5(dUR S5(aUR XU5 gUR S 5S :aURXU5 gUR S 5(aURXU5 gg) NrrHr_rqrrbbobookrIrcrb) rrrrr~rrerr)rXrrrrHrrs rZrokx.handle_unsubscription' snnWeR0""3 26##C2!!(+ h '\"9  . .vw G    & &'*<* s + DF#Jc#J,#JJV&V868//F/&9; =C =s =6:"E7EE(:<S&:>bEwEWE(9=RUgUCUB'0F'0R8rsk AAzzzzz4*0.')*i$F$   i$Fr\