ccxt 4.4.30 → 4.4.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (496) hide show
  1. package/README.md +3 -3
  2. package/dist/ccxt.browser.min.js +3 -3
  3. package/dist/cjs/ccxt.js +1 -1
  4. package/dist/cjs/src/ace.js +123 -123
  5. package/dist/cjs/src/alpaca.js +237 -237
  6. package/dist/cjs/src/ascendex.js +342 -341
  7. package/dist/cjs/src/bigone.js +242 -242
  8. package/dist/cjs/src/binance.js +1338 -1291
  9. package/dist/cjs/src/bingx.js +639 -639
  10. package/dist/cjs/src/bit2c.js +111 -111
  11. package/dist/cjs/src/bitbank.js +142 -142
  12. package/dist/cjs/src/bitbns.js +140 -140
  13. package/dist/cjs/src/bitfinex.js +231 -231
  14. package/dist/cjs/src/bitfinex2.js +403 -403
  15. package/dist/cjs/src/bitflyer.js +184 -184
  16. package/dist/cjs/src/bitget.js +848 -846
  17. package/dist/cjs/src/bithumb.js +125 -124
  18. package/dist/cjs/src/bitmart.js +525 -525
  19. package/dist/cjs/src/bitmex.js +317 -317
  20. package/dist/cjs/src/bitopro.js +221 -221
  21. package/dist/cjs/src/bitrue.js +315 -315
  22. package/dist/cjs/src/bitso.js +220 -220
  23. package/dist/cjs/src/bitstamp.js +251 -251
  24. package/dist/cjs/src/bitteam.js +183 -183
  25. package/dist/cjs/src/bitvavo.js +247 -247
  26. package/dist/cjs/src/bl3p.js +82 -82
  27. package/dist/cjs/src/blockchaincom.js +211 -211
  28. package/dist/cjs/src/blofin.js +332 -331
  29. package/dist/cjs/src/btcalpha.js +166 -166
  30. package/dist/cjs/src/btcbox.js +108 -108
  31. package/dist/cjs/src/btcmarkets.js +198 -198
  32. package/dist/cjs/src/btcturk.js +124 -124
  33. package/dist/cjs/src/bybit.js +906 -900
  34. package/dist/cjs/src/cex.js +227 -226
  35. package/dist/cjs/src/coinbase.js +481 -481
  36. package/dist/cjs/src/coinbaseexchange.js +274 -274
  37. package/dist/cjs/src/coinbaseinternational.js +304 -304
  38. package/dist/cjs/src/coincatch.js +648 -648
  39. package/dist/cjs/src/coincheck.js +113 -113
  40. package/dist/cjs/src/coinex.js +611 -601
  41. package/dist/cjs/src/coinlist.js +304 -303
  42. package/dist/cjs/src/coinmate.js +162 -161
  43. package/dist/cjs/src/coinmetro.js +187 -187
  44. package/dist/cjs/src/coinone.js +124 -123
  45. package/dist/cjs/src/coinsph.js +237 -237
  46. package/dist/cjs/src/coinspot.js +82 -82
  47. package/dist/cjs/src/cryptocom.js +342 -341
  48. package/dist/cjs/src/currencycom.js +225 -224
  49. package/dist/cjs/src/delta.js +320 -320
  50. package/dist/cjs/src/deribit.js +411 -408
  51. package/dist/cjs/src/digifinex.js +432 -431
  52. package/dist/cjs/src/exmo.js +328 -327
  53. package/dist/cjs/src/gate.js +812 -789
  54. package/dist/cjs/src/gemini.js +199 -198
  55. package/dist/cjs/src/hashkey.js +520 -517
  56. package/dist/cjs/src/hitbtc.js +465 -462
  57. package/dist/cjs/src/hollaex.js +253 -252
  58. package/dist/cjs/src/htx.js +791 -848
  59. package/dist/cjs/src/huobijp.js +219 -218
  60. package/dist/cjs/src/hyperliquid.js +421 -417
  61. package/dist/cjs/src/idex.js +238 -237
  62. package/dist/cjs/src/independentreserve.js +133 -132
  63. package/dist/cjs/src/indodax.js +176 -170
  64. package/dist/cjs/src/kraken.js +379 -377
  65. package/dist/cjs/src/krakenfutures.js +283 -279
  66. package/dist/cjs/src/kucoin.js +630 -622
  67. package/dist/cjs/src/kucoinfutures.js +439 -434
  68. package/dist/cjs/src/kuna.js +283 -282
  69. package/dist/cjs/src/latoken.js +211 -210
  70. package/dist/cjs/src/lbank.js +268 -267
  71. package/dist/cjs/src/luno.js +174 -173
  72. package/dist/cjs/src/lykke.js +172 -171
  73. package/dist/cjs/src/mercado.js +123 -122
  74. package/dist/cjs/src/mexc.js +650 -646
  75. package/dist/cjs/src/ndax.js +229 -228
  76. package/dist/cjs/src/novadax.js +230 -229
  77. package/dist/cjs/src/oceanex.js +187 -186
  78. package/dist/cjs/src/okcoin.js +286 -285
  79. package/dist/cjs/src/okx.js +909 -904
  80. package/dist/cjs/src/onetrading.js +218 -218
  81. package/dist/cjs/src/oxfun.js +335 -334
  82. package/dist/cjs/src/p2b.js +154 -154
  83. package/dist/cjs/src/paradex.js +249 -244
  84. package/dist/cjs/src/paymium.js +101 -101
  85. package/dist/cjs/src/phemex.js +369 -367
  86. package/dist/cjs/src/poloniex.js +270 -270
  87. package/dist/cjs/src/poloniexfutures.js +250 -250
  88. package/dist/cjs/src/pro/alpaca.js +64 -64
  89. package/dist/cjs/src/pro/ascendex.js +64 -64
  90. package/dist/cjs/src/pro/binance.js +546 -543
  91. package/dist/cjs/src/pro/bingx.js +116 -116
  92. package/dist/cjs/src/pro/bitfinex.js +42 -42
  93. package/dist/cjs/src/pro/bitfinex2.js +66 -66
  94. package/dist/cjs/src/pro/bitget.js +187 -180
  95. package/dist/cjs/src/pro/bithumb.js +40 -40
  96. package/dist/cjs/src/pro/bitmart.js +121 -119
  97. package/dist/cjs/src/pro/bitmex.js +135 -133
  98. package/dist/cjs/src/pro/bitopro.js +49 -49
  99. package/dist/cjs/src/pro/bitrue.js +19 -19
  100. package/dist/cjs/src/pro/bitstamp.js +29 -29
  101. package/dist/cjs/src/pro/bitvavo.js +253 -253
  102. package/dist/cjs/src/pro/blockchaincom.js +62 -62
  103. package/dist/cjs/src/pro/blofin.js +132 -130
  104. package/dist/cjs/src/pro/bybit.js +317 -313
  105. package/dist/cjs/src/pro/cex.js +168 -168
  106. package/dist/cjs/src/pro/coinbase.js +93 -91
  107. package/dist/cjs/src/pro/coinbaseexchange.js +95 -95
  108. package/dist/cjs/src/pro/coinbaseinternational.js +111 -111
  109. package/dist/cjs/src/pro/coincatch.js +150 -143
  110. package/dist/cjs/src/pro/coincheck.js +21 -21
  111. package/dist/cjs/src/pro/coinex.js +110 -110
  112. package/dist/cjs/src/pro/coinone.js +30 -30
  113. package/dist/cjs/src/pro/cryptocom.js +227 -227
  114. package/dist/cjs/src/pro/currencycom.js +45 -45
  115. package/dist/cjs/src/pro/deribit.js +127 -127
  116. package/dist/cjs/src/pro/exmo.js +66 -66
  117. package/dist/cjs/src/pro/gate.js +287 -283
  118. package/dist/cjs/src/pro/gemini.js +74 -74
  119. package/dist/cjs/src/pro/hashkey.js +87 -85
  120. package/dist/cjs/src/pro/hitbtc.js +190 -190
  121. package/dist/cjs/src/pro/hollaex.js +51 -51
  122. package/dist/cjs/src/pro/htx.js +96 -94
  123. package/dist/cjs/src/pro/huobijp.js +38 -38
  124. package/dist/cjs/src/pro/hyperliquid.js +151 -150
  125. package/dist/cjs/src/pro/idex.js +48 -48
  126. package/dist/cjs/src/pro/independentreserve.js +19 -19
  127. package/dist/cjs/src/pro/kraken.js +167 -167
  128. package/dist/cjs/src/pro/krakenfutures.js +137 -138
  129. package/dist/cjs/src/pro/kucoin.js +167 -168
  130. package/dist/cjs/src/pro/kucoinfutures.js +147 -147
  131. package/dist/cjs/src/pro/lbank.js +95 -95
  132. package/dist/cjs/src/pro/luno.js +21 -21
  133. package/dist/cjs/src/pro/mexc.js +101 -101
  134. package/dist/cjs/src/pro/ndax.js +42 -42
  135. package/dist/cjs/src/pro/okcoin.js +61 -61
  136. package/dist/cjs/src/pro/okx.js +332 -330
  137. package/dist/cjs/src/pro/onetrading.js +71 -71
  138. package/dist/cjs/src/pro/oxfun.js +193 -191
  139. package/dist/cjs/src/pro/p2b.js +77 -77
  140. package/dist/cjs/src/pro/paradex.js +39 -39
  141. package/dist/cjs/src/pro/phemex.js +94 -94
  142. package/dist/cjs/src/pro/poloniex.js +171 -171
  143. package/dist/cjs/src/pro/poloniexfutures.js +62 -62
  144. package/dist/cjs/src/pro/probit.js +63 -63
  145. package/dist/cjs/src/pro/upbit.js +80 -80
  146. package/dist/cjs/src/pro/vertex.js +65 -63
  147. package/dist/cjs/src/pro/wazirx.js +70 -70
  148. package/dist/cjs/src/pro/whitebit.js +83 -83
  149. package/dist/cjs/src/pro/woo.js +106 -104
  150. package/dist/cjs/src/pro/woofipro.js +105 -103
  151. package/dist/cjs/src/pro/xt.js +119 -119
  152. package/dist/cjs/src/probit.js +229 -229
  153. package/dist/cjs/src/timex.js +198 -197
  154. package/dist/cjs/src/tokocrypto.js +214 -213
  155. package/dist/cjs/src/tradeogre.js +92 -91
  156. package/dist/cjs/src/upbit.js +243 -242
  157. package/dist/cjs/src/vertex.js +258 -258
  158. package/dist/cjs/src/wavesexchange.js +175 -172
  159. package/dist/cjs/src/wazirx.js +168 -168
  160. package/dist/cjs/src/whitebit.js +361 -361
  161. package/dist/cjs/src/woo.js +571 -572
  162. package/dist/cjs/src/woofipro.js +392 -391
  163. package/dist/cjs/src/xt.js +436 -435
  164. package/dist/cjs/src/yobit.js +159 -158
  165. package/dist/cjs/src/zaif.js +103 -103
  166. package/dist/cjs/src/zonda.js +168 -168
  167. package/js/ccxt.d.ts +1 -1
  168. package/js/ccxt.js +1 -1
  169. package/js/src/ace.d.ts +123 -0
  170. package/js/src/ace.js +123 -123
  171. package/js/src/alpaca.d.ts +237 -0
  172. package/js/src/alpaca.js +237 -237
  173. package/js/src/ascendex.d.ts +339 -0
  174. package/js/src/ascendex.js +342 -341
  175. package/js/src/base/types.d.ts +1 -0
  176. package/js/src/bigone.d.ts +242 -0
  177. package/js/src/bigone.js +242 -242
  178. package/js/src/binance.d.ts +1305 -0
  179. package/js/src/binance.js +1338 -1291
  180. package/js/src/bingx.d.ts +639 -0
  181. package/js/src/bingx.js +639 -639
  182. package/js/src/bit2c.d.ts +111 -0
  183. package/js/src/bit2c.js +111 -111
  184. package/js/src/bitbank.d.ts +142 -0
  185. package/js/src/bitbank.js +142 -142
  186. package/js/src/bitbns.d.ts +140 -0
  187. package/js/src/bitbns.js +140 -140
  188. package/js/src/bitfinex.d.ts +231 -0
  189. package/js/src/bitfinex.js +231 -231
  190. package/js/src/bitfinex2.d.ts +403 -0
  191. package/js/src/bitfinex2.js +403 -403
  192. package/js/src/bitflyer.d.ts +184 -0
  193. package/js/src/bitflyer.js +184 -184
  194. package/js/src/bitget.d.ts +846 -0
  195. package/js/src/bitget.js +848 -846
  196. package/js/src/bithumb.d.ts +125 -0
  197. package/js/src/bithumb.js +125 -124
  198. package/js/src/bitmart.d.ts +525 -0
  199. package/js/src/bitmart.js +525 -525
  200. package/js/src/bitmex.d.ts +317 -0
  201. package/js/src/bitmex.js +317 -317
  202. package/js/src/bitopro.d.ts +221 -0
  203. package/js/src/bitopro.js +221 -221
  204. package/js/src/bitrue.d.ts +315 -0
  205. package/js/src/bitrue.js +315 -315
  206. package/js/src/bitso.d.ts +220 -0
  207. package/js/src/bitso.js +220 -220
  208. package/js/src/bitstamp.d.ts +251 -0
  209. package/js/src/bitstamp.js +251 -251
  210. package/js/src/bitteam.d.ts +183 -0
  211. package/js/src/bitteam.js +183 -183
  212. package/js/src/bitvavo.d.ts +247 -0
  213. package/js/src/bitvavo.js +247 -247
  214. package/js/src/bl3p.d.ts +82 -0
  215. package/js/src/bl3p.js +82 -82
  216. package/js/src/blockchaincom.d.ts +211 -0
  217. package/js/src/blockchaincom.js +211 -211
  218. package/js/src/blofin.d.ts +332 -0
  219. package/js/src/blofin.js +332 -331
  220. package/js/src/btcalpha.d.ts +166 -0
  221. package/js/src/btcalpha.js +166 -166
  222. package/js/src/btcbox.d.ts +108 -0
  223. package/js/src/btcbox.js +108 -108
  224. package/js/src/btcmarkets.d.ts +198 -0
  225. package/js/src/btcmarkets.js +198 -198
  226. package/js/src/btcturk.d.ts +124 -0
  227. package/js/src/btcturk.js +124 -124
  228. package/js/src/bybit.d.ts +906 -1
  229. package/js/src/bybit.js +906 -900
  230. package/js/src/cex.d.ts +227 -0
  231. package/js/src/cex.js +227 -226
  232. package/js/src/coinbase.d.ts +481 -0
  233. package/js/src/coinbase.js +481 -481
  234. package/js/src/coinbaseexchange.d.ts +274 -0
  235. package/js/src/coinbaseexchange.js +274 -274
  236. package/js/src/coinbaseinternational.d.ts +304 -0
  237. package/js/src/coinbaseinternational.js +304 -304
  238. package/js/src/coincatch.d.ts +646 -0
  239. package/js/src/coincatch.js +648 -648
  240. package/js/src/coincheck.d.ts +113 -0
  241. package/js/src/coincheck.js +113 -113
  242. package/js/src/coinex.d.ts +603 -0
  243. package/js/src/coinex.js +611 -601
  244. package/js/src/coinlist.d.ts +304 -0
  245. package/js/src/coinlist.js +304 -303
  246. package/js/src/coinmate.d.ts +162 -0
  247. package/js/src/coinmate.js +162 -161
  248. package/js/src/coinmetro.d.ts +187 -0
  249. package/js/src/coinmetro.js +187 -187
  250. package/js/src/coinone.d.ts +124 -0
  251. package/js/src/coinone.js +124 -123
  252. package/js/src/coinsph.d.ts +237 -0
  253. package/js/src/coinsph.js +237 -237
  254. package/js/src/coinspot.d.ts +82 -0
  255. package/js/src/coinspot.js +82 -82
  256. package/js/src/cryptocom.d.ts +342 -0
  257. package/js/src/cryptocom.js +342 -341
  258. package/js/src/currencycom.d.ts +225 -0
  259. package/js/src/currencycom.js +225 -224
  260. package/js/src/delta.d.ts +320 -0
  261. package/js/src/delta.js +320 -320
  262. package/js/src/deribit.d.ts +411 -0
  263. package/js/src/deribit.js +411 -408
  264. package/js/src/digifinex.d.ts +430 -0
  265. package/js/src/digifinex.js +432 -431
  266. package/js/src/exmo.d.ts +328 -0
  267. package/js/src/exmo.js +328 -327
  268. package/js/src/gate.d.ts +801 -1
  269. package/js/src/gate.js +812 -789
  270. package/js/src/gemini.d.ts +199 -0
  271. package/js/src/gemini.js +199 -198
  272. package/js/src/hashkey.d.ts +516 -0
  273. package/js/src/hashkey.js +520 -517
  274. package/js/src/hitbtc.d.ts +465 -0
  275. package/js/src/hitbtc.js +465 -462
  276. package/js/src/hollaex.d.ts +253 -0
  277. package/js/src/hollaex.js +253 -252
  278. package/js/src/htx.d.ts +765 -2
  279. package/js/src/htx.js +791 -848
  280. package/js/src/huobijp.d.ts +219 -0
  281. package/js/src/huobijp.js +219 -218
  282. package/js/src/hyperliquid.d.ts +419 -0
  283. package/js/src/hyperliquid.js +421 -417
  284. package/js/src/idex.d.ts +238 -0
  285. package/js/src/idex.js +238 -237
  286. package/js/src/independentreserve.d.ts +133 -0
  287. package/js/src/independentreserve.js +133 -132
  288. package/js/src/indodax.d.ts +171 -0
  289. package/js/src/indodax.js +176 -170
  290. package/js/src/kraken.d.ts +379 -0
  291. package/js/src/kraken.js +379 -377
  292. package/js/src/krakenfutures.d.ts +280 -0
  293. package/js/src/krakenfutures.js +283 -279
  294. package/js/src/kucoin.d.ts +613 -0
  295. package/js/src/kucoin.js +630 -622
  296. package/js/src/kucoinfutures.d.ts +437 -0
  297. package/js/src/kucoinfutures.js +439 -434
  298. package/js/src/kuna.d.ts +283 -0
  299. package/js/src/kuna.js +283 -282
  300. package/js/src/latoken.d.ts +211 -0
  301. package/js/src/latoken.js +211 -210
  302. package/js/src/lbank.d.ts +268 -0
  303. package/js/src/lbank.js +268 -267
  304. package/js/src/luno.d.ts +174 -0
  305. package/js/src/luno.js +174 -173
  306. package/js/src/lykke.d.ts +172 -0
  307. package/js/src/lykke.js +172 -171
  308. package/js/src/mercado.d.ts +123 -0
  309. package/js/src/mercado.js +123 -122
  310. package/js/src/mexc.d.ts +647 -0
  311. package/js/src/mexc.js +650 -646
  312. package/js/src/ndax.d.ts +229 -0
  313. package/js/src/ndax.js +229 -228
  314. package/js/src/novadax.d.ts +230 -0
  315. package/js/src/novadax.js +230 -229
  316. package/js/src/oceanex.d.ts +187 -0
  317. package/js/src/oceanex.js +187 -186
  318. package/js/src/okcoin.d.ts +286 -0
  319. package/js/src/okcoin.js +286 -285
  320. package/js/src/okx.d.ts +907 -0
  321. package/js/src/okx.js +909 -904
  322. package/js/src/onetrading.d.ts +218 -0
  323. package/js/src/onetrading.js +218 -218
  324. package/js/src/oxfun.d.ts +336 -3
  325. package/js/src/oxfun.js +335 -334
  326. package/js/src/p2b.d.ts +154 -0
  327. package/js/src/p2b.js +154 -154
  328. package/js/src/paradex.d.ts +241 -0
  329. package/js/src/paradex.js +249 -244
  330. package/js/src/paymium.d.ts +101 -0
  331. package/js/src/paymium.js +101 -101
  332. package/js/src/phemex.d.ts +366 -0
  333. package/js/src/phemex.js +369 -367
  334. package/js/src/poloniex.d.ts +270 -0
  335. package/js/src/poloniex.js +270 -270
  336. package/js/src/poloniexfutures.d.ts +250 -0
  337. package/js/src/poloniexfutures.js +250 -250
  338. package/js/src/pro/alpaca.d.ts +64 -0
  339. package/js/src/pro/alpaca.js +64 -64
  340. package/js/src/pro/ascendex.d.ts +64 -0
  341. package/js/src/pro/ascendex.js +64 -64
  342. package/js/src/pro/binance.d.ts +546 -0
  343. package/js/src/pro/binance.js +546 -543
  344. package/js/src/pro/bingx.d.ts +116 -0
  345. package/js/src/pro/bingx.js +116 -116
  346. package/js/src/pro/bitfinex.d.ts +42 -0
  347. package/js/src/pro/bitfinex.js +42 -42
  348. package/js/src/pro/bitfinex2.d.ts +66 -0
  349. package/js/src/pro/bitfinex2.js +66 -66
  350. package/js/src/pro/bitget.d.ts +187 -0
  351. package/js/src/pro/bitget.js +187 -180
  352. package/js/src/pro/bithumb.d.ts +40 -0
  353. package/js/src/pro/bithumb.js +40 -40
  354. package/js/src/pro/bitmart.d.ts +121 -0
  355. package/js/src/pro/bitmart.js +121 -119
  356. package/js/src/pro/bitmex.d.ts +135 -0
  357. package/js/src/pro/bitmex.js +135 -133
  358. package/js/src/pro/bitopro.d.ts +49 -0
  359. package/js/src/pro/bitopro.js +49 -49
  360. package/js/src/pro/bitrue.d.ts +19 -0
  361. package/js/src/pro/bitrue.js +19 -19
  362. package/js/src/pro/bitstamp.d.ts +29 -0
  363. package/js/src/pro/bitstamp.js +29 -29
  364. package/js/src/pro/bitvavo.d.ts +253 -0
  365. package/js/src/pro/bitvavo.js +253 -253
  366. package/js/src/pro/blockchaincom.d.ts +62 -0
  367. package/js/src/pro/blockchaincom.js +62 -62
  368. package/js/src/pro/blofin.d.ts +132 -0
  369. package/js/src/pro/blofin.js +132 -130
  370. package/js/src/pro/bybit.d.ts +317 -0
  371. package/js/src/pro/bybit.js +317 -313
  372. package/js/src/pro/cex.d.ts +168 -0
  373. package/js/src/pro/cex.js +168 -168
  374. package/js/src/pro/coinbase.d.ts +93 -0
  375. package/js/src/pro/coinbase.js +93 -91
  376. package/js/src/pro/coinbaseexchange.d.ts +95 -0
  377. package/js/src/pro/coinbaseexchange.js +95 -95
  378. package/js/src/pro/coinbaseinternational.d.ts +111 -0
  379. package/js/src/pro/coinbaseinternational.js +111 -111
  380. package/js/src/pro/coincatch.d.ts +150 -0
  381. package/js/src/pro/coincatch.js +150 -143
  382. package/js/src/pro/coincheck.d.ts +21 -0
  383. package/js/src/pro/coincheck.js +21 -21
  384. package/js/src/pro/coinex.d.ts +110 -0
  385. package/js/src/pro/coinex.js +110 -110
  386. package/js/src/pro/coinone.d.ts +30 -0
  387. package/js/src/pro/coinone.js +30 -30
  388. package/js/src/pro/cryptocom.d.ts +227 -0
  389. package/js/src/pro/cryptocom.js +227 -227
  390. package/js/src/pro/currencycom.d.ts +45 -0
  391. package/js/src/pro/currencycom.js +45 -45
  392. package/js/src/pro/deribit.d.ts +127 -0
  393. package/js/src/pro/deribit.js +127 -127
  394. package/js/src/pro/exmo.d.ts +66 -0
  395. package/js/src/pro/exmo.js +66 -66
  396. package/js/src/pro/gate.d.ts +287 -0
  397. package/js/src/pro/gate.js +287 -283
  398. package/js/src/pro/gemini.d.ts +74 -0
  399. package/js/src/pro/gemini.js +74 -74
  400. package/js/src/pro/hashkey.d.ts +87 -0
  401. package/js/src/pro/hashkey.js +87 -85
  402. package/js/src/pro/hitbtc.d.ts +190 -0
  403. package/js/src/pro/hitbtc.js +190 -190
  404. package/js/src/pro/hollaex.d.ts +51 -0
  405. package/js/src/pro/hollaex.js +51 -51
  406. package/js/src/pro/htx.d.ts +96 -0
  407. package/js/src/pro/htx.js +96 -94
  408. package/js/src/pro/huobijp.d.ts +38 -0
  409. package/js/src/pro/huobijp.js +38 -38
  410. package/js/src/pro/hyperliquid.d.ts +151 -0
  411. package/js/src/pro/hyperliquid.js +151 -150
  412. package/js/src/pro/idex.d.ts +48 -0
  413. package/js/src/pro/idex.js +48 -48
  414. package/js/src/pro/independentreserve.d.ts +19 -0
  415. package/js/src/pro/independentreserve.js +19 -19
  416. package/js/src/pro/kraken.d.ts +167 -0
  417. package/js/src/pro/kraken.js +167 -167
  418. package/js/src/pro/krakenfutures.d.ts +137 -0
  419. package/js/src/pro/krakenfutures.js +137 -138
  420. package/js/src/pro/kucoin.d.ts +167 -0
  421. package/js/src/pro/kucoin.js +167 -168
  422. package/js/src/pro/kucoinfutures.d.ts +147 -0
  423. package/js/src/pro/kucoinfutures.js +147 -147
  424. package/js/src/pro/lbank.d.ts +95 -0
  425. package/js/src/pro/lbank.js +95 -95
  426. package/js/src/pro/luno.d.ts +21 -0
  427. package/js/src/pro/luno.js +21 -21
  428. package/js/src/pro/mexc.d.ts +101 -0
  429. package/js/src/pro/mexc.js +101 -101
  430. package/js/src/pro/ndax.d.ts +42 -0
  431. package/js/src/pro/ndax.js +42 -42
  432. package/js/src/pro/okcoin.d.ts +61 -0
  433. package/js/src/pro/okcoin.js +61 -61
  434. package/js/src/pro/okx.d.ts +332 -0
  435. package/js/src/pro/okx.js +332 -330
  436. package/js/src/pro/onetrading.d.ts +71 -0
  437. package/js/src/pro/onetrading.js +71 -71
  438. package/js/src/pro/oxfun.d.ts +193 -0
  439. package/js/src/pro/oxfun.js +193 -191
  440. package/js/src/pro/p2b.d.ts +77 -0
  441. package/js/src/pro/p2b.js +77 -77
  442. package/js/src/pro/paradex.d.ts +39 -0
  443. package/js/src/pro/paradex.js +39 -39
  444. package/js/src/pro/phemex.d.ts +94 -0
  445. package/js/src/pro/phemex.js +94 -94
  446. package/js/src/pro/poloniex.d.ts +171 -0
  447. package/js/src/pro/poloniex.js +171 -171
  448. package/js/src/pro/poloniexfutures.d.ts +62 -0
  449. package/js/src/pro/poloniexfutures.js +62 -62
  450. package/js/src/pro/probit.d.ts +63 -0
  451. package/js/src/pro/probit.js +63 -63
  452. package/js/src/pro/upbit.d.ts +80 -0
  453. package/js/src/pro/upbit.js +80 -80
  454. package/js/src/pro/vertex.d.ts +65 -0
  455. package/js/src/pro/vertex.js +65 -63
  456. package/js/src/pro/wazirx.d.ts +70 -0
  457. package/js/src/pro/wazirx.js +70 -70
  458. package/js/src/pro/whitebit.d.ts +83 -0
  459. package/js/src/pro/whitebit.js +83 -83
  460. package/js/src/pro/woo.d.ts +106 -0
  461. package/js/src/pro/woo.js +106 -104
  462. package/js/src/pro/woofipro.d.ts +105 -0
  463. package/js/src/pro/woofipro.js +105 -103
  464. package/js/src/pro/xt.d.ts +119 -0
  465. package/js/src/pro/xt.js +119 -119
  466. package/js/src/probit.d.ts +229 -0
  467. package/js/src/probit.js +229 -229
  468. package/js/src/timex.d.ts +198 -0
  469. package/js/src/timex.js +198 -197
  470. package/js/src/tokocrypto.d.ts +214 -0
  471. package/js/src/tokocrypto.js +214 -213
  472. package/js/src/tradeogre.d.ts +92 -0
  473. package/js/src/tradeogre.js +92 -91
  474. package/js/src/upbit.d.ts +243 -0
  475. package/js/src/upbit.js +243 -242
  476. package/js/src/vertex.d.ts +258 -0
  477. package/js/src/vertex.js +258 -258
  478. package/js/src/wavesexchange.d.ts +175 -0
  479. package/js/src/wavesexchange.js +175 -172
  480. package/js/src/wazirx.d.ts +168 -0
  481. package/js/src/wazirx.js +168 -168
  482. package/js/src/whitebit.d.ts +361 -0
  483. package/js/src/whitebit.js +361 -361
  484. package/js/src/woo.d.ts +571 -0
  485. package/js/src/woo.js +571 -572
  486. package/js/src/woofipro.d.ts +392 -0
  487. package/js/src/woofipro.js +392 -391
  488. package/js/src/xt.d.ts +439 -4
  489. package/js/src/xt.js +436 -435
  490. package/js/src/yobit.d.ts +159 -0
  491. package/js/src/yobit.js +159 -158
  492. package/js/src/zaif.d.ts +103 -0
  493. package/js/src/zaif.js +103 -103
  494. package/js/src/zonda.d.ts +168 -0
  495. package/js/src/zonda.js +168 -168
  496. package/package.json +1 -1
@@ -740,15 +740,15 @@ class phemex extends phemex$1 {
740
740
  'info': market,
741
741
  });
742
742
  }
743
+ /**
744
+ * @method
745
+ * @name phemex#fetchMarkets
746
+ * @description retrieves data on all markets for phemex
747
+ * @see https://phemex-docs.github.io/#query-product-information-3
748
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
749
+ * @returns {object[]} an array of objects representing market data
750
+ */
743
751
  async fetchMarkets(params = {}) {
744
- /**
745
- * @method
746
- * @name phemex#fetchMarkets
747
- * @description retrieves data on all markets for phemex
748
- * @see https://phemex-docs.github.io/#query-product-information-3
749
- * @param {object} [params] extra parameters specific to the exchange API endpoint
750
- * @returns {object[]} an array of objects representing market data
751
- */
752
752
  const v2Products = await this.v2GetPublicProducts(params);
753
753
  //
754
754
  // {
@@ -970,14 +970,14 @@ class phemex extends phemex$1 {
970
970
  }
971
971
  return result;
972
972
  }
973
+ /**
974
+ * @method
975
+ * @name phemex#fetchCurrencies
976
+ * @description fetches all available currencies on an exchange
977
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
978
+ * @returns {object} an associative dictionary of currencies
979
+ */
973
980
  async fetchCurrencies(params = {}) {
974
- /**
975
- * @method
976
- * @name phemex#fetchCurrencies
977
- * @description fetches all available currencies on an exchange
978
- * @param {object} [params] extra parameters specific to the exchange API endpoint
979
- * @returns {object} an associative dictionary of currencies
980
- */
981
981
  const response = await this.v2GetPublicProducts(params);
982
982
  //
983
983
  // {
@@ -1075,17 +1075,17 @@ class phemex extends phemex$1 {
1075
1075
  result[asksKey] = this.sortBy(result[asksKey], 0);
1076
1076
  return result;
1077
1077
  }
1078
+ /**
1079
+ * @method
1080
+ * @name phemex#fetchOrderBook
1081
+ * @description fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
1082
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#queryorderbook
1083
+ * @param {string} symbol unified symbol of the market to fetch the order book for
1084
+ * @param {int} [limit] the maximum amount of order book entries to return
1085
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
1086
+ * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
1087
+ */
1078
1088
  async fetchOrderBook(symbol, limit = undefined, params = {}) {
1079
- /**
1080
- * @method
1081
- * @name phemex#fetchOrderBook
1082
- * @description fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
1083
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#queryorderbook
1084
- * @param {string} symbol unified symbol of the market to fetch the order book for
1085
- * @param {int} [limit] the maximum amount of order book entries to return
1086
- * @param {object} [params] extra parameters specific to the exchange API endpoint
1087
- * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
1088
- */
1089
1089
  await this.loadMarkets();
1090
1090
  const market = this.market(symbol);
1091
1091
  const request = {
@@ -1213,21 +1213,21 @@ class phemex extends phemex$1 {
1213
1213
  baseVolume,
1214
1214
  ];
1215
1215
  }
1216
+ /**
1217
+ * @method
1218
+ * @name phemex#fetchOHLCV
1219
+ * @description fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
1220
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#querykline
1221
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#query-kline
1222
+ * @param {string} symbol unified symbol of the market to fetch OHLCV data for
1223
+ * @param {string} timeframe the length of time each candle represents
1224
+ * @param {int} [since] *only used for USDT settled contracts, otherwise is emulated and not supported by the exchange* timestamp in ms of the earliest candle to fetch
1225
+ * @param {int} [limit] the maximum amount of candles to fetch
1226
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
1227
+ * @param {int} [params.until] *USDT settled/ linear swaps only* end time in ms
1228
+ * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
1229
+ */
1216
1230
  async fetchOHLCV(symbol, timeframe = '1m', since = undefined, limit = undefined, params = {}) {
1217
- /**
1218
- * @method
1219
- * @name phemex#fetchOHLCV
1220
- * @description fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
1221
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#querykline
1222
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#query-kline
1223
- * @param {string} symbol unified symbol of the market to fetch OHLCV data for
1224
- * @param {string} timeframe the length of time each candle represents
1225
- * @param {int} [since] *only used for USDT settled contracts, otherwise is emulated and not supported by the exchange* timestamp in ms of the earliest candle to fetch
1226
- * @param {int} [limit] the maximum amount of candles to fetch
1227
- * @param {object} [params] extra parameters specific to the exchange API endpoint
1228
- * @param {int} [params.until] *USDT settled/ linear swaps only* end time in ms
1229
- * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
1230
- */
1231
1231
  await this.loadMarkets();
1232
1232
  const market = this.market(symbol);
1233
1233
  const userLimit = limit;
@@ -1392,16 +1392,16 @@ class phemex extends phemex$1 {
1392
1392
  'info': ticker,
1393
1393
  }, market);
1394
1394
  }
1395
+ /**
1396
+ * @method
1397
+ * @name phemex#fetchTicker
1398
+ * @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
1399
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#query24hrsticker
1400
+ * @param {string} symbol unified symbol of the market to fetch the ticker for
1401
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
1402
+ * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
1403
+ */
1395
1404
  async fetchTicker(symbol, params = {}) {
1396
- /**
1397
- * @method
1398
- * @name phemex#fetchTicker
1399
- * @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
1400
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#query24hrsticker
1401
- * @param {string} symbol unified symbol of the market to fetch the ticker for
1402
- * @param {object} [params] extra parameters specific to the exchange API endpoint
1403
- * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
1404
- */
1405
1405
  await this.loadMarkets();
1406
1406
  const market = this.market(symbol);
1407
1407
  const request = {
@@ -1467,18 +1467,18 @@ class phemex extends phemex$1 {
1467
1467
  const result = this.safeDict(response, 'result', {});
1468
1468
  return this.parseTicker(result, market);
1469
1469
  }
1470
+ /**
1471
+ * @method
1472
+ * @name phemex#fetchTickers
1473
+ * @description fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
1474
+ * @see https://phemex-docs.github.io/#query-24-hours-ticker-for-all-symbols-2 // spot
1475
+ * @see https://phemex-docs.github.io/#query-24-ticker-for-all-symbols // linear
1476
+ * @see https://phemex-docs.github.io/#query-24-hours-ticker-for-all-symbols // inverse
1477
+ * @param {string[]|undefined} symbols unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
1478
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
1479
+ * @returns {object} a dictionary of [ticker structures]{@link https://docs.ccxt.com/#/?id=ticker-structure}
1480
+ */
1470
1481
  async fetchTickers(symbols = undefined, params = {}) {
1471
- /**
1472
- * @method
1473
- * @name phemex#fetchTickers
1474
- * @description fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
1475
- * @see https://phemex-docs.github.io/#query-24-hours-ticker-for-all-symbols-2 // spot
1476
- * @see https://phemex-docs.github.io/#query-24-ticker-for-all-symbols // linear
1477
- * @see https://phemex-docs.github.io/#query-24-hours-ticker-for-all-symbols // inverse
1478
- * @param {string[]|undefined} symbols unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
1479
- * @param {object} [params] extra parameters specific to the exchange API endpoint
1480
- * @returns {object} a dictionary of [ticker structures]{@link https://docs.ccxt.com/#/?id=ticker-structure}
1481
- */
1482
1482
  await this.loadMarkets();
1483
1483
  let market = undefined;
1484
1484
  if (symbols !== undefined) {
@@ -1503,18 +1503,18 @@ class phemex extends phemex$1 {
1503
1503
  const result = this.safeList(response, 'result', []);
1504
1504
  return this.parseTickers(result, symbols);
1505
1505
  }
1506
+ /**
1507
+ * @method
1508
+ * @name phemex#fetchTrades
1509
+ * @description get the list of most recent trades for a particular symbol
1510
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#querytrades
1511
+ * @param {string} symbol unified symbol of the market to fetch trades for
1512
+ * @param {int} [since] timestamp in ms of the earliest trade to fetch
1513
+ * @param {int} [limit] the maximum amount of trades to fetch
1514
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
1515
+ * @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
1516
+ */
1506
1517
  async fetchTrades(symbol, since = undefined, limit = undefined, params = {}) {
1507
- /**
1508
- * @method
1509
- * @name phemex#fetchTrades
1510
- * @description get the list of most recent trades for a particular symbol
1511
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#querytrades
1512
- * @param {string} symbol unified symbol of the market to fetch trades for
1513
- * @param {int} [since] timestamp in ms of the earliest trade to fetch
1514
- * @param {int} [limit] the maximum amount of trades to fetch
1515
- * @param {object} [params] extra parameters specific to the exchange API endpoint
1516
- * @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
1517
- */
1518
1518
  await this.loadMarkets();
1519
1519
  const market = this.market(symbol);
1520
1520
  const request = {
@@ -1952,19 +1952,19 @@ class phemex extends phemex$1 {
1952
1952
  result[code] = account;
1953
1953
  return this.safeBalance(result);
1954
1954
  }
1955
+ /**
1956
+ * @method
1957
+ * @name phemex#fetchBalance
1958
+ * @description query for balance and get the amount of funds available for trading or funds locked in orders
1959
+ * @see https://phemex-docs.github.io/#query-wallets
1960
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#query-account-positions
1961
+ * @see https://phemex-docs.github.io/#query-trading-account-and-positions
1962
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
1963
+ * @param {string} [params.type] spot or swap
1964
+ * @param {string} [params.code] *swap only* currency code of the balance to query (USD, USDT, etc), default is USDT
1965
+ * @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
1966
+ */
1955
1967
  async fetchBalance(params = {}) {
1956
- /**
1957
- * @method
1958
- * @name phemex#fetchBalance
1959
- * @description query for balance and get the amount of funds available for trading or funds locked in orders
1960
- * @see https://phemex-docs.github.io/#query-wallets
1961
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#query-account-positions
1962
- * @see https://phemex-docs.github.io/#query-trading-account-and-positions
1963
- * @param {object} [params] extra parameters specific to the exchange API endpoint
1964
- * @param {string} [params.type] spot or swap
1965
- * @param {string} [params.code] *swap only* currency code of the balance to query (USD, USDT, etc), default is USDT
1966
- * @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
1967
- */
1968
1968
  await this.loadMarkets();
1969
1969
  let type = undefined;
1970
1970
  [type, params] = this.handleMarketTypeAndParams('fetchBalance', undefined, params);
@@ -2482,28 +2482,28 @@ class phemex extends phemex$1 {
2482
2482
  }
2483
2483
  return this.parseSpotOrder(order, market);
2484
2484
  }
2485
+ /**
2486
+ * @method
2487
+ * @name phemex#createOrder
2488
+ * @description create a trade order
2489
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#place-order
2490
+ * @see https://phemex-docs.github.io/#place-order-http-put-prefered-3
2491
+ * @param {string} symbol unified symbol of the market to create an order in
2492
+ * @param {string} type 'market' or 'limit'
2493
+ * @param {string} side 'buy' or 'sell'
2494
+ * @param {float} amount how much of currency you want to trade in units of base currency
2495
+ * @param {float} [price] the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
2496
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
2497
+ * @param {float} [params.trigger] trigger price for conditional orders
2498
+ * @param {object} [params.takeProfit] *swap only* *takeProfit object in params* containing the triggerPrice at which the attached take profit order will be triggered (perpetual swap markets only)
2499
+ * @param {float} [params.takeProfit.triggerPrice] take profit trigger price
2500
+ * @param {object} [params.stopLoss] *swap only* *stopLoss object in params* containing the triggerPrice at which the attached stop loss order will be triggered (perpetual swap markets only)
2501
+ * @param {float} [params.stopLoss.triggerPrice] stop loss trigger price
2502
+ * @param {string} [params.posSide] *swap only* "Merged" for one way mode, "Long" for buy side of hedged mode, "Short" for sell side of hedged mode
2503
+ * @param {bool} [params.hedged] *swap only* true for hedged mode, false for one way mode, default is false
2504
+ * @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
2505
+ */
2485
2506
  async createOrder(symbol, type, side, amount, price = undefined, params = {}) {
2486
- /**
2487
- * @method
2488
- * @name phemex#createOrder
2489
- * @description create a trade order
2490
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#place-order
2491
- * @see https://phemex-docs.github.io/#place-order-http-put-prefered-3
2492
- * @param {string} symbol unified symbol of the market to create an order in
2493
- * @param {string} type 'market' or 'limit'
2494
- * @param {string} side 'buy' or 'sell'
2495
- * @param {float} amount how much of currency you want to trade in units of base currency
2496
- * @param {float} [price] the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
2497
- * @param {object} [params] extra parameters specific to the exchange API endpoint
2498
- * @param {float} [params.trigger] trigger price for conditional orders
2499
- * @param {object} [params.takeProfit] *swap only* *takeProfit object in params* containing the triggerPrice at which the attached take profit order will be triggered (perpetual swap markets only)
2500
- * @param {float} [params.takeProfit.triggerPrice] take profit trigger price
2501
- * @param {object} [params.stopLoss] *swap only* *stopLoss object in params* containing the triggerPrice at which the attached stop loss order will be triggered (perpetual swap markets only)
2502
- * @param {float} [params.stopLoss.triggerPrice] stop loss trigger price
2503
- * @param {string} [params.posSide] *swap only* "Merged" for one way mode, "Long" for buy side of hedged mode, "Short" for sell side of hedged mode
2504
- * @param {bool} [params.hedged] *swap only* true for hedged mode, false for one way mode, default is false
2505
- * @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
2506
- */
2507
2507
  await this.loadMarkets();
2508
2508
  const market = this.market(symbol);
2509
2509
  const requestSide = this.capitalize(side);
@@ -2803,22 +2803,22 @@ class phemex extends phemex$1 {
2803
2803
  const data = this.safeDict(response, 'data', {});
2804
2804
  return this.parseOrder(data, market);
2805
2805
  }
2806
+ /**
2807
+ * @method
2808
+ * @name phemex#editOrder
2809
+ * @description edit a trade order
2810
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#amend-order-by-orderid
2811
+ * @param {string} id cancel order id
2812
+ * @param {string} symbol unified symbol of the market to create an order in
2813
+ * @param {string} type 'market' or 'limit'
2814
+ * @param {string} side 'buy' or 'sell'
2815
+ * @param {float} amount how much of currency you want to trade in units of base currency
2816
+ * @param {float} [price] the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
2817
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
2818
+ * @param {string} [params.posSide] either 'Merged' or 'Long' or 'Short'
2819
+ * @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
2820
+ */
2806
2821
  async editOrder(id, symbol, type = undefined, side = undefined, amount = undefined, price = undefined, params = {}) {
2807
- /**
2808
- * @method
2809
- * @name phemex#editOrder
2810
- * @description edit a trade order
2811
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#amend-order-by-orderid
2812
- * @param {string} id cancel order id
2813
- * @param {string} symbol unified symbol of the market to create an order in
2814
- * @param {string} type 'market' or 'limit'
2815
- * @param {string} side 'buy' or 'sell'
2816
- * @param {float} amount how much of currency you want to trade in units of base currency
2817
- * @param {float} [price] the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
2818
- * @param {object} [params] extra parameters specific to the exchange API endpoint
2819
- * @param {string} [params.posSide] either 'Merged' or 'Long' or 'Short'
2820
- * @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
2821
- */
2822
2822
  await this.loadMarkets();
2823
2823
  const market = this.market(symbol);
2824
2824
  const request = {
@@ -2882,18 +2882,18 @@ class phemex extends phemex$1 {
2882
2882
  const data = this.safeDict(response, 'data', {});
2883
2883
  return this.parseOrder(data, market);
2884
2884
  }
2885
+ /**
2886
+ * @method
2887
+ * @name phemex#cancelOrder
2888
+ * @description cancels an open order
2889
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#cancel-single-order-by-orderid
2890
+ * @param {string} id order id
2891
+ * @param {string} symbol unified symbol of the market the order was made in
2892
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
2893
+ * @param {string} [params.posSide] either 'Merged' or 'Long' or 'Short'
2894
+ * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
2895
+ */
2885
2896
  async cancelOrder(id, symbol = undefined, params = {}) {
2886
- /**
2887
- * @method
2888
- * @name phemex#cancelOrder
2889
- * @description cancels an open order
2890
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#cancel-single-order-by-orderid
2891
- * @param {string} id order id
2892
- * @param {string} symbol unified symbol of the market the order was made in
2893
- * @param {object} [params] extra parameters specific to the exchange API endpoint
2894
- * @param {string} [params.posSide] either 'Merged' or 'Long' or 'Short'
2895
- * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
2896
- */
2897
2897
  if (symbol === undefined) {
2898
2898
  throw new errors.ArgumentsRequired(this.id + ' cancelOrder() requires a symbol argument');
2899
2899
  }
@@ -2927,16 +2927,16 @@ class phemex extends phemex$1 {
2927
2927
  const data = this.safeDict(response, 'data', {});
2928
2928
  return this.parseOrder(data, market);
2929
2929
  }
2930
+ /**
2931
+ * @method
2932
+ * @name phemex#cancelAllOrders
2933
+ * @description cancel all open orders in a market
2934
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#cancelall
2935
+ * @param {string} symbol unified market symbol of the market to cancel orders in
2936
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
2937
+ * @returns {object[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
2938
+ */
2930
2939
  async cancelAllOrders(symbol = undefined, params = {}) {
2931
- /**
2932
- * @method
2933
- * @name phemex#cancelAllOrders
2934
- * @description cancel all open orders in a market
2935
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#cancelall
2936
- * @param {string} symbol unified market symbol of the market to cancel orders in
2937
- * @param {object} [params] extra parameters specific to the exchange API endpoint
2938
- * @returns {object[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
2939
- */
2940
2940
  if (symbol === undefined) {
2941
2941
  throw new errors.ArgumentsRequired(this.id + ' cancelAllOrders() requires a symbol argument');
2942
2942
  }
@@ -2991,17 +2991,17 @@ class phemex extends phemex$1 {
2991
2991
  }),
2992
2992
  ];
2993
2993
  }
2994
+ /**
2995
+ * @method
2996
+ * @name phemex#fetchOrder
2997
+ * @see https://phemex-docs.github.io/#query-orders-by-ids
2998
+ * @description fetches information on an order made by the user
2999
+ * @param {string} id the order id
3000
+ * @param {string} symbol unified symbol of the market the order was made in
3001
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
3002
+ * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
3003
+ */
2994
3004
  async fetchOrder(id, symbol = undefined, params = {}) {
2995
- /**
2996
- * @method
2997
- * @name phemex#fetchOrder
2998
- * @see https://phemex-docs.github.io/#query-orders-by-ids
2999
- * @description fetches information on an order made by the user
3000
- * @param {string} id the order id
3001
- * @param {string} symbol unified symbol of the market the order was made in
3002
- * @param {object} [params] extra parameters specific to the exchange API endpoint
3003
- * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
3004
- */
3005
3005
  if (symbol === undefined) {
3006
3006
  throw new errors.ArgumentsRequired(this.id + ' fetchOrder() requires a symbol argument');
3007
3007
  }
@@ -3048,18 +3048,18 @@ class phemex extends phemex$1 {
3048
3048
  }
3049
3049
  return this.parseOrder(order, market);
3050
3050
  }
3051
+ /**
3052
+ * @method
3053
+ * @name phemex#fetchOrders
3054
+ * @description fetches information on multiple orders made by the user
3055
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#queryorder
3056
+ * @param {string} symbol unified market symbol of the market orders were made in
3057
+ * @param {int} [since] the earliest time in ms to fetch orders for
3058
+ * @param {int} [limit] the maximum number of order structures to retrieve
3059
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
3060
+ * @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
3061
+ */
3051
3062
  async fetchOrders(symbol = undefined, since = undefined, limit = undefined, params = {}) {
3052
- /**
3053
- * @method
3054
- * @name phemex#fetchOrders
3055
- * @description fetches information on multiple orders made by the user
3056
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#queryorder
3057
- * @param {string} symbol unified market symbol of the market orders were made in
3058
- * @param {int} [since] the earliest time in ms to fetch orders for
3059
- * @param {int} [limit] the maximum number of order structures to retrieve
3060
- * @param {object} [params] extra parameters specific to the exchange API endpoint
3061
- * @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
3062
- */
3063
3063
  if (symbol === undefined) {
3064
3064
  throw new errors.ArgumentsRequired(this.id + ' fetchOrders() requires a symbol argument');
3065
3065
  }
@@ -3089,20 +3089,20 @@ class phemex extends phemex$1 {
3089
3089
  const rows = this.safeList(data, 'rows', data);
3090
3090
  return this.parseOrders(rows, market, since, limit);
3091
3091
  }
3092
+ /**
3093
+ * @method
3094
+ * @name phemex#fetchOpenOrders
3095
+ * @description fetch all unfilled currently open orders
3096
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#queryopenorder
3097
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md
3098
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Spot-API-en.md#spotListAllOpenOrder
3099
+ * @param {string} symbol unified market symbol
3100
+ * @param {int} [since] the earliest time in ms to fetch open orders for
3101
+ * @param {int} [limit] the maximum number of open order structures to retrieve
3102
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
3103
+ * @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
3104
+ */
3092
3105
  async fetchOpenOrders(symbol = undefined, since = undefined, limit = undefined, params = {}) {
3093
- /**
3094
- * @method
3095
- * @name phemex#fetchOpenOrders
3096
- * @description fetch all unfilled currently open orders
3097
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#queryopenorder
3098
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md
3099
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Spot-API-en.md#spotListAllOpenOrder
3100
- * @param {string} symbol unified market symbol
3101
- * @param {int} [since] the earliest time in ms to fetch open orders for
3102
- * @param {int} [limit] the maximum number of open order structures to retrieve
3103
- * @param {object} [params] extra parameters specific to the exchange API endpoint
3104
- * @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
3105
- */
3106
3106
  await this.loadMarkets();
3107
3107
  if (symbol === undefined) {
3108
3108
  throw new errors.ArgumentsRequired(this.id + ' fetchOpenOrders() requires a symbol argument');
@@ -3139,22 +3139,22 @@ class phemex extends phemex$1 {
3139
3139
  return this.parseOrders(rows, market, since, limit);
3140
3140
  }
3141
3141
  }
3142
+ /**
3143
+ * @method
3144
+ * @name phemex#fetchClosedOrders
3145
+ * @description fetches information on multiple closed orders made by the user
3146
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#queryorder
3147
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#queryorder
3148
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedgedd-Perpetual-API.md#query-closed-orders-by-symbol
3149
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Spot-API-en.md#spotDataOrdersByIds
3150
+ * @param {string} symbol unified market symbol of the market orders were made in
3151
+ * @param {int} [since] the earliest time in ms to fetch orders for
3152
+ * @param {int} [limit] the maximum number of order structures to retrieve
3153
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
3154
+ * @param {string} [params.settle] the settlement currency to fetch orders for
3155
+ * @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
3156
+ */
3142
3157
  async fetchClosedOrders(symbol = undefined, since = undefined, limit = undefined, params = {}) {
3143
- /**
3144
- * @method
3145
- * @name phemex#fetchClosedOrders
3146
- * @description fetches information on multiple closed orders made by the user
3147
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#queryorder
3148
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#queryorder
3149
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedgedd-Perpetual-API.md#query-closed-orders-by-symbol
3150
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Spot-API-en.md#spotDataOrdersByIds
3151
- * @param {string} symbol unified market symbol of the market orders were made in
3152
- * @param {int} [since] the earliest time in ms to fetch orders for
3153
- * @param {int} [limit] the maximum number of order structures to retrieve
3154
- * @param {object} [params] extra parameters specific to the exchange API endpoint
3155
- * @param {string} [params.settle] the settlement currency to fetch orders for
3156
- * @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
3157
- */
3158
3158
  await this.loadMarkets();
3159
3159
  let market = undefined;
3160
3160
  if (symbol !== undefined) {
@@ -3226,20 +3226,20 @@ class phemex extends phemex$1 {
3226
3226
  return this.parseOrders(rows, market, since, limit);
3227
3227
  }
3228
3228
  }
3229
+ /**
3230
+ * @method
3231
+ * @name phemex#fetchMyTrades
3232
+ * @description fetch all trades made by the user
3233
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#query-user-trade
3234
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#query-user-trade
3235
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Spot-API-en.md#spotDataTradesHist
3236
+ * @param {string} symbol unified market symbol
3237
+ * @param {int} [since] the earliest time in ms to fetch trades for
3238
+ * @param {int} [limit] the maximum number of trades structures to retrieve
3239
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
3240
+ * @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
3241
+ */
3229
3242
  async fetchMyTrades(symbol = undefined, since = undefined, limit = undefined, params = {}) {
3230
- /**
3231
- * @method
3232
- * @name phemex#fetchMyTrades
3233
- * @description fetch all trades made by the user
3234
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#query-user-trade
3235
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#query-user-trade
3236
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Spot-API-en.md#spotDataTradesHist
3237
- * @param {string} symbol unified market symbol
3238
- * @param {int} [since] the earliest time in ms to fetch trades for
3239
- * @param {int} [limit] the maximum number of trades structures to retrieve
3240
- * @param {object} [params] extra parameters specific to the exchange API endpoint
3241
- * @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
3242
- */
3243
3243
  await this.loadMarkets();
3244
3244
  let market = undefined;
3245
3245
  if (symbol !== undefined) {
@@ -3388,15 +3388,15 @@ class phemex extends phemex$1 {
3388
3388
  }
3389
3389
  return this.parseTrades(data, market, since, limit);
3390
3390
  }
3391
+ /**
3392
+ * @method
3393
+ * @name phemex#fetchDepositAddress
3394
+ * @description fetch the deposit address for a currency associated with this account
3395
+ * @param {string} code unified currency code
3396
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
3397
+ * @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
3398
+ */
3391
3399
  async fetchDepositAddress(code, params = {}) {
3392
- /**
3393
- * @method
3394
- * @name phemex#fetchDepositAddress
3395
- * @description fetch the deposit address for a currency associated with this account
3396
- * @param {string} code unified currency code
3397
- * @param {object} [params] extra parameters specific to the exchange API endpoint
3398
- * @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
3399
- */
3400
3400
  await this.loadMarkets();
3401
3401
  const currency = this.currency(code);
3402
3402
  const request = {
@@ -3436,17 +3436,17 @@ class phemex extends phemex$1 {
3436
3436
  'tag': tag,
3437
3437
  };
3438
3438
  }
3439
+ /**
3440
+ * @method
3441
+ * @name phemex#fetchDeposits
3442
+ * @description fetch all deposits made to an account
3443
+ * @param {string} code unified currency code
3444
+ * @param {int} [since] the earliest time in ms to fetch deposits for
3445
+ * @param {int} [limit] the maximum number of deposits structures to retrieve
3446
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
3447
+ * @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
3448
+ */
3439
3449
  async fetchDeposits(code = undefined, since = undefined, limit = undefined, params = {}) {
3440
- /**
3441
- * @method
3442
- * @name phemex#fetchDeposits
3443
- * @description fetch all deposits made to an account
3444
- * @param {string} code unified currency code
3445
- * @param {int} [since] the earliest time in ms to fetch deposits for
3446
- * @param {int} [limit] the maximum number of deposits structures to retrieve
3447
- * @param {object} [params] extra parameters specific to the exchange API endpoint
3448
- * @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
3449
- */
3450
3450
  await this.loadMarkets();
3451
3451
  let currency = undefined;
3452
3452
  if (code !== undefined) {
@@ -3476,17 +3476,17 @@ class phemex extends phemex$1 {
3476
3476
  const data = this.safeList(response, 'data', []);
3477
3477
  return this.parseTransactions(data, currency, since, limit);
3478
3478
  }
3479
+ /**
3480
+ * @method
3481
+ * @name phemex#fetchWithdrawals
3482
+ * @description fetch all withdrawals made from an account
3483
+ * @param {string} code unified currency code
3484
+ * @param {int} [since] the earliest time in ms to fetch withdrawals for
3485
+ * @param {int} [limit] the maximum number of withdrawals structures to retrieve
3486
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
3487
+ * @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
3488
+ */
3479
3489
  async fetchWithdrawals(code = undefined, since = undefined, limit = undefined, params = {}) {
3480
- /**
3481
- * @method
3482
- * @name phemex#fetchWithdrawals
3483
- * @description fetch all withdrawals made from an account
3484
- * @param {string} code unified currency code
3485
- * @param {int} [since] the earliest time in ms to fetch withdrawals for
3486
- * @param {int} [limit] the maximum number of withdrawals structures to retrieve
3487
- * @param {object} [params] extra parameters specific to the exchange API endpoint
3488
- * @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
3489
- */
3490
3490
  await this.loadMarkets();
3491
3491
  let currency = undefined;
3492
3492
  if (code !== undefined) {
@@ -3654,19 +3654,19 @@ class phemex extends phemex$1 {
3654
3654
  'fee': fee,
3655
3655
  };
3656
3656
  }
3657
+ /**
3658
+ * @method
3659
+ * @name phemex#fetchPositions
3660
+ * @description fetch all open positions
3661
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#query-trading-account-and-positions
3662
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#query-account-positions
3663
+ * @see https://phemex-docs.github.io/#query-account-positions-with-unrealized-pnl
3664
+ * @param {string[]} [symbols] list of unified market symbols
3665
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
3666
+ * @param {string} [params.method] *USDT contracts only* 'privateGetGAccountsAccountPositions' or 'privateGetAccountsPositions' default is 'privateGetGAccountsAccountPositions'
3667
+ * @returns {object[]} a list of [position structure]{@link https://docs.ccxt.com/#/?id=position-structure}
3668
+ */
3657
3669
  async fetchPositions(symbols = undefined, params = {}) {
3658
- /**
3659
- * @method
3660
- * @name phemex#fetchPositions
3661
- * @description fetch all open positions
3662
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#query-trading-account-and-positions
3663
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#query-account-positions
3664
- * @see https://phemex-docs.github.io/#query-account-positions-with-unrealized-pnl
3665
- * @param {string[]} [symbols] list of unified market symbols
3666
- * @param {object} [params] extra parameters specific to the exchange API endpoint
3667
- * @param {string} [param.method] *USDT contracts only* 'privateGetGAccountsAccountPositions' or 'privateGetAccountsPositions' default is 'privateGetGAccountsAccountPositions'
3668
- * @returns {object[]} a list of [position structure]{@link https://docs.ccxt.com/#/?id=position-structure}
3669
- */
3670
3670
  await this.loadMarkets();
3671
3671
  symbols = this.marketSymbols(symbols);
3672
3672
  let subType = undefined;
@@ -3941,18 +3941,18 @@ class phemex extends phemex$1 {
3941
3941
  'takeProfitPrice': undefined,
3942
3942
  });
3943
3943
  }
3944
+ /**
3945
+ * @method
3946
+ * @name phemex#fetchFundingHistory
3947
+ * @description fetch the history of funding payments paid and received on this account
3948
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#futureDataFundingFeesHist
3949
+ * @param {string} symbol unified market symbol
3950
+ * @param {int} [since] the earliest time in ms to fetch funding history for
3951
+ * @param {int} [limit] the maximum number of funding history structures to retrieve
3952
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
3953
+ * @returns {object} a [funding history structure]{@link https://docs.ccxt.com/#/?id=funding-history-structure}
3954
+ */
3944
3955
  async fetchFundingHistory(symbol = undefined, since = undefined, limit = undefined, params = {}) {
3945
- /**
3946
- * @method
3947
- * @name phemex#fetchFundingHistory
3948
- * @description fetch the history of funding payments paid and received on this account
3949
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#futureDataFundingFeesHist
3950
- * @param {string} symbol unified market symbol
3951
- * @param {int} [since] the earliest time in ms to fetch funding history for
3952
- * @param {int} [limit] the maximum number of funding history structures to retrieve
3953
- * @param {object} [params] extra parameters specific to the exchange API endpoint
3954
- * @returns {object} a [funding history structure]{@link https://docs.ccxt.com/#/?id=funding-history-structure}
3955
- */
3956
3956
  if (symbol === undefined) {
3957
3957
  throw new errors.ArgumentsRequired(this.id + ' fetchFundingHistory() requires a symbol argument');
3958
3958
  }
@@ -4033,15 +4033,15 @@ class phemex extends phemex$1 {
4033
4033
  }
4034
4034
  return value;
4035
4035
  }
4036
+ /**
4037
+ * @method
4038
+ * @name phemex#fetchFundingRate
4039
+ * @description fetch the current funding rate
4040
+ * @param {string} symbol unified market symbol
4041
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
4042
+ * @returns {object} a [funding rate structure]{@link https://docs.ccxt.com/#/?id=funding-rate-structure}
4043
+ */
4036
4044
  async fetchFundingRate(symbol, params = {}) {
4037
- /**
4038
- * @method
4039
- * @name phemex#fetchFundingRate
4040
- * @description fetch the current funding rate
4041
- * @param {string} symbol unified market symbol
4042
- * @param {object} [params] extra parameters specific to the exchange API endpoint
4043
- * @returns {object} a [funding rate structure]{@link https://docs.ccxt.com/#/?id=funding-rate-structure}
4044
- */
4045
4045
  await this.loadMarkets();
4046
4046
  const market = this.market(symbol);
4047
4047
  if (!market['swap']) {
@@ -4145,17 +4145,17 @@ class phemex extends phemex$1 {
4145
4145
  'interval': undefined,
4146
4146
  };
4147
4147
  }
4148
+ /**
4149
+ * @method
4150
+ * @name phemex#setMargin
4151
+ * @description Either adds or reduces margin in an isolated position in order to set the margin to a specific value
4152
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#assign-position-balance-in-isolated-marign-mode
4153
+ * @param {string} symbol unified market symbol of the market to set margin in
4154
+ * @param {float} amount the amount to set the margin to
4155
+ * @param {object} [params] parameters specific to the exchange API endpoint
4156
+ * @returns {object} A [margin structure]{@link https://docs.ccxt.com/#/?id=add-margin-structure}
4157
+ */
4148
4158
  async setMargin(symbol, amount, params = {}) {
4149
- /**
4150
- * @method
4151
- * @name phemex#setMargin
4152
- * @description Either adds or reduces margin in an isolated position in order to set the margin to a specific value
4153
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#assign-position-balance-in-isolated-marign-mode
4154
- * @param {string} symbol unified market symbol of the market to set margin in
4155
- * @param {float} amount the amount to set the margin to
4156
- * @param {object} [params] parameters specific to the exchange API endpoint
4157
- * @returns {object} A [margin structure]{@link https://docs.ccxt.com/#/?id=add-margin-structure}
4158
- */
4159
4159
  await this.loadMarkets();
4160
4160
  const market = this.market(symbol);
4161
4161
  const request = {
@@ -4204,16 +4204,16 @@ class phemex extends phemex$1 {
4204
4204
  'datetime': undefined,
4205
4205
  };
4206
4206
  }
4207
+ /**
4208
+ * @method
4209
+ * @name phemex#setMarginMode
4210
+ * @description set margin mode to 'cross' or 'isolated'
4211
+ * @param {string} marginMode 'cross' or 'isolated'
4212
+ * @param {string} symbol unified market symbol
4213
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
4214
+ * @returns {object} response from the exchange
4215
+ */
4207
4216
  async setMarginMode(marginMode, symbol = undefined, params = {}) {
4208
- /**
4209
- * @method
4210
- * @name phemex#setMarginMode
4211
- * @description set margin mode to 'cross' or 'isolated'
4212
- * @param {string} marginMode 'cross' or 'isolated'
4213
- * @param {string} symbol unified market symbol
4214
- * @param {object} [params] extra parameters specific to the exchange API endpoint
4215
- * @returns {object} response from the exchange
4216
- */
4217
4217
  if (symbol === undefined) {
4218
4218
  throw new errors.ArgumentsRequired(this.id + ' setMarginMode() requires a symbol argument');
4219
4219
  }
@@ -4239,17 +4239,17 @@ class phemex extends phemex$1 {
4239
4239
  };
4240
4240
  return await this.privatePutPositionsLeverage(this.extend(request, params));
4241
4241
  }
4242
+ /**
4243
+ * @method
4244
+ * @name phemex#setPositionMode
4245
+ * @description set hedged to true or false for a market
4246
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#switch-position-mode-synchronously
4247
+ * @param {bool} hedged set to true to use dualSidePosition
4248
+ * @param {string} symbol not used by binance setPositionMode ()
4249
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
4250
+ * @returns {object} response from the exchange
4251
+ */
4242
4252
  async setPositionMode(hedged, symbol = undefined, params = {}) {
4243
- /**
4244
- * @method
4245
- * @name phemex#setPositionMode
4246
- * @description set hedged to true or false for a market
4247
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#switch-position-mode-synchronously
4248
- * @param {bool} hedged set to true to use dualSidePosition
4249
- * @param {string} symbol not used by binance setPositionMode ()
4250
- * @param {object} [params] extra parameters specific to the exchange API endpoint
4251
- * @returns {object} response from the exchange
4252
- */
4253
4253
  this.checkRequiredArgument('setPositionMode', symbol, 'symbol');
4254
4254
  await this.loadMarkets();
4255
4255
  const market = this.market(symbol);
@@ -4267,15 +4267,15 @@ class phemex extends phemex$1 {
4267
4267
  }
4268
4268
  return await this.privatePutGPositionsSwitchPosModeSync(this.extend(request, params));
4269
4269
  }
4270
+ /**
4271
+ * @method
4272
+ * @name phemex#fetchLeverageTiers
4273
+ * @description retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes
4274
+ * @param {string[]|undefined} symbols list of unified market symbols
4275
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
4276
+ * @returns {object} a dictionary of [leverage tiers structures]{@link https://docs.ccxt.com/#/?id=leverage-tiers-structure}, indexed by market symbols
4277
+ */
4270
4278
  async fetchLeverageTiers(symbols = undefined, params = {}) {
4271
- /**
4272
- * @method
4273
- * @name phemex#fetchLeverageTiers
4274
- * @description retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes
4275
- * @param {string[]|undefined} symbols list of unified market symbols
4276
- * @param {object} [params] extra parameters specific to the exchange API endpoint
4277
- * @returns {object} a dictionary of [leverage tiers structures]{@link https://docs.ccxt.com/#/?id=leverage-tiers-structure}, indexed by market symbols
4278
- */
4279
4279
  await this.loadMarkets();
4280
4280
  if (symbols !== undefined) {
4281
4281
  const first = this.safeValue(symbols, 0);
@@ -4383,7 +4383,8 @@ class phemex extends phemex$1 {
4383
4383
  // ]
4384
4384
  // },
4385
4385
  //
4386
- market = this.safeMarket(undefined, market);
4386
+ const marketId = this.safeString(info, 'symbol');
4387
+ market = this.safeMarket(marketId, market);
4387
4388
  const riskLimits = (market['info']['riskLimits']);
4388
4389
  const tiers = [];
4389
4390
  let minNotional = 0;
@@ -4392,6 +4393,7 @@ class phemex extends phemex$1 {
4392
4393
  const maxNotional = this.safeInteger(tier, 'limit');
4393
4394
  tiers.push({
4394
4395
  'tier': this.sum(i, 1),
4396
+ 'symbol': this.safeSymbol(marketId, market),
4395
4397
  'currency': market['settle'],
4396
4398
  'minNotional': minNotional,
4397
4399
  'maxNotional': maxNotional,
@@ -4443,20 +4445,20 @@ class phemex extends phemex$1 {
4443
4445
  url = this.implodeHostname(this.urls['api'][api]) + url;
4444
4446
  return { 'url': url, 'method': method, 'body': body, 'headers': headers };
4445
4447
  }
4448
+ /**
4449
+ * @method
4450
+ * @name phemex#setLeverage
4451
+ * @description set the level of leverage for a market
4452
+ * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#set-leverage
4453
+ * @param {float} leverage the rate of leverage, 100 > leverage > -100 excluding numbers between -1 to 1
4454
+ * @param {string} symbol unified market symbol
4455
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
4456
+ * @param {bool} [params.hedged] set to true if hedged position mode is enabled (by default long and short leverage are set to the same value)
4457
+ * @param {float} [params.longLeverageRr] *hedged mode only* set the leverage for long positions
4458
+ * @param {float} [params.shortLeverageRr] *hedged mode only* set the leverage for short positions
4459
+ * @returns {object} response from the exchange
4460
+ */
4446
4461
  async setLeverage(leverage, symbol = undefined, params = {}) {
4447
- /**
4448
- * @method
4449
- * @name phemex#setLeverage
4450
- * @description set the level of leverage for a market
4451
- * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#set-leverage
4452
- * @param {float} leverage the rate of leverage, 100 > leverage > -100 excluding numbers between -1 to 1
4453
- * @param {string} symbol unified market symbol
4454
- * @param {object} [params] extra parameters specific to the exchange API endpoint
4455
- * @param {bool} [params.hedged] set to true if hedged position mode is enabled (by default long and short leverage are set to the same value)
4456
- * @param {float} [params.longLeverageRr] *hedged mode only* set the leverage for long positions
4457
- * @param {float} [params.shortLeverageRr] *hedged mode only* set the leverage for short positions
4458
- * @returns {object} response from the exchange
4459
- */
4460
4462
  // WARNING: THIS WILL INCREASE LIQUIDATION PRICE FOR OPEN ISOLATED LONG POSITIONS
4461
4463
  // AND DECREASE LIQUIDATION PRICE FOR OPEN ISOLATED SHORT POSITIONS
4462
4464
  if (symbol === undefined) {
@@ -4492,19 +4494,19 @@ class phemex extends phemex$1 {
4492
4494
  }
4493
4495
  return response;
4494
4496
  }
4497
+ /**
4498
+ * @method
4499
+ * @name phemex#transfer
4500
+ * @description transfer currency internally between wallets on the same account
4501
+ * @param {string} code unified currency code
4502
+ * @param {float} amount amount to transfer
4503
+ * @param {string} fromAccount account to transfer from
4504
+ * @param {string} toAccount account to transfer to
4505
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
4506
+ * @param {string} [params.bizType] for transferring between main and sub-acounts either 'SPOT' or 'PERPETUAL' default is 'SPOT'
4507
+ * @returns {object} a [transfer structure]{@link https://docs.ccxt.com/#/?id=transfer-structure}
4508
+ */
4495
4509
  async transfer(code, amount, fromAccount, toAccount, params = {}) {
4496
- /**
4497
- * @method
4498
- * @name phemex#transfer
4499
- * @description transfer currency internally between wallets on the same account
4500
- * @param {string} code unified currency code
4501
- * @param {float} amount amount to transfer
4502
- * @param {string} fromAccount account to transfer from
4503
- * @param {string} toAccount account to transfer to
4504
- * @param {object} [params] extra parameters specific to the exchange API endpoint
4505
- * @param {string} [params.bizType] for transferring between main and sub-acounts either 'SPOT' or 'PERPETUAL' default is 'SPOT'
4506
- * @returns {object} a [transfer structure]{@link https://docs.ccxt.com/#/?id=transfer-structure}
4507
- */
4508
4510
  await this.loadMarkets();
4509
4511
  const currency = this.currency(code);
4510
4512
  const accountsByType = this.safeValue(this.options, 'accountsByType', {});
@@ -4579,17 +4581,17 @@ class phemex extends phemex$1 {
4579
4581
  }
4580
4582
  return transfer;
4581
4583
  }
4584
+ /**
4585
+ * @method
4586
+ * @name phemex#fetchTransfers
4587
+ * @description fetch a history of internal transfers made on an account
4588
+ * @param {string} code unified currency code of the currency transferred
4589
+ * @param {int} [since] the earliest time in ms to fetch transfers for
4590
+ * @param {int} [limit] the maximum number of transfers structures to retrieve
4591
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
4592
+ * @returns {object[]} a list of [transfer structures]{@link https://docs.ccxt.com/#/?id=transfer-structure}
4593
+ */
4582
4594
  async fetchTransfers(code = undefined, since = undefined, limit = undefined, params = {}) {
4583
- /**
4584
- * @method
4585
- * @name phemex#fetchTransfers
4586
- * @description fetch a history of internal transfers made on an account
4587
- * @param {string} code unified currency code of the currency transferred
4588
- * @param {int} [since] the earliest time in ms to fetch transfers for
4589
- * @param {int} [limit] the maximum number of transfers structures to retrieve
4590
- * @param {object} [params] extra parameters specific to the exchange API endpoint
4591
- * @returns {object[]} a list of [transfer structures]{@link https://docs.ccxt.com/#/?id=transfer-structure}
4592
- */
4593
4595
  await this.loadMarkets();
4594
4596
  if (code === undefined) {
4595
4597
  throw new errors.ArgumentsRequired(this.id + ' fetchTransfers() requires a code argument');
@@ -4694,20 +4696,20 @@ class phemex extends phemex$1 {
4694
4696
  };
4695
4697
  return this.safeString(statuses, status, status);
4696
4698
  }
4699
+ /**
4700
+ * @method
4701
+ * @name phemex#fetchFundingRateHistory
4702
+ * @description fetches historical funding rate prices
4703
+ * @see https://phemex-docs.github.io/#query-funding-rate-history-2
4704
+ * @param {string} symbol unified symbol of the market to fetch the funding rate history for
4705
+ * @param {int} [since] timestamp in ms of the earliest funding rate to fetch
4706
+ * @param {int} [limit] the maximum amount of [funding rate structures]{@link https://docs.ccxt.com/#/?id=funding-rate-history-structure} to fetch
4707
+ * @param {object} [params] extra parameters specific to the exchange API endpoint
4708
+ * @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
4709
+ * @param {int} [params.until] timestamp in ms of the latest funding rate
4710
+ * @returns {object[]} a list of [funding rate structures]{@link https://docs.ccxt.com/#/?id=funding-rate-history-structure}
4711
+ */
4697
4712
  async fetchFundingRateHistory(symbol = undefined, since = undefined, limit = undefined, params = {}) {
4698
- /**
4699
- * @method
4700
- * @name phemex#fetchFundingRateHistory
4701
- * @description fetches historical funding rate prices
4702
- * @see https://phemex-docs.github.io/#query-funding-rate-history-2
4703
- * @param {string} symbol unified symbol of the market to fetch the funding rate history for
4704
- * @param {int} [since] timestamp in ms of the earliest funding rate to fetch
4705
- * @param {int} [limit] the maximum amount of [funding rate structures]{@link https://docs.ccxt.com/#/?id=funding-rate-history-structure} to fetch
4706
- * @param {object} [params] extra parameters specific to the exchange API endpoint
4707
- * @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
4708
- * @param {int} [params.until] timestamp in ms of the latest funding rate
4709
- * @returns {object[]} a list of [funding rate structures]{@link https://docs.ccxt.com/#/?id=funding-rate-history-structure}
4710
- */
4711
4713
  if (symbol === undefined) {
4712
4714
  throw new errors.ArgumentsRequired(this.id + ' fetchFundingRateHistory() requires a symbol argument');
4713
4715
  }
@@ -4779,20 +4781,20 @@ class phemex extends phemex$1 {
4779
4781
  const sorted = this.sortBy(result, 'timestamp');
4780
4782
  return this.filterBySymbolSinceLimit(sorted, symbol, since, limit);
4781
4783
  }
4784
+ /**
4785
+ * @method
4786
+ * @name phemex#withdraw
4787
+ * @description make a withdrawal
4788
+ * @see https://phemex-docs.github.io/#create-withdraw-request
4789
+ * @param {string} code unified currency code
4790
+ * @param {float} amount the amount to withdraw
4791
+ * @param {string} address the address to withdraw to
4792
+ * @param {string} tag
4793
+ * @param {object} [params] extra parameters specific to the phemex api endpoint
4794
+ * @param {string} [params.network] unified network code
4795
+ * @returns {object} a [transaction structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#transaction-structure}
4796
+ */
4782
4797
  async withdraw(code, amount, address, tag = undefined, params = {}) {
4783
- /**
4784
- * @method
4785
- * @name phemex#withdraw
4786
- * @description make a withdrawal
4787
- * @see https://phemex-docs.github.io/#create-withdraw-request
4788
- * @param {string} code unified currency code
4789
- * @param {float} amount the amount to withdraw
4790
- * @param {string} address the address to withdraw to
4791
- * @param {string} tag
4792
- * @param {object} [params] extra parameters specific to the phemex api endpoint
4793
- * @param {string} [params.network] unified network code
4794
- * @returns {object} a [transaction structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#transaction-structure}
4795
- */
4796
4798
  [tag, params] = this.handleWithdrawTagAndParams(tag, params);
4797
4799
  await this.loadMarkets();
4798
4800
  this.checkAddress(address);
@@ -4852,16 +4854,16 @@ class phemex extends phemex$1 {
4852
4854
  const data = this.safeDict(response, 'data', {});
4853
4855
  return this.parseTransaction(data, currency);
4854
4856
  }
4857
+ /**
4858
+ * @method
4859
+ * @name phemex#fetchOpenInterest
4860
+ * @description retrieves the open interest of a trading pair
4861
+ * @see https://phemex-docs.github.io/#query-24-hours-ticker
4862
+ * @param {string} symbol unified CCXT market symbol
4863
+ * @param {object} [params] exchange specific parameters
4864
+ * @returns {object} an open interest structure{@link https://docs.ccxt.com/#/?id=open-interest-structure}
4865
+ */
4855
4866
  async fetchOpenInterest(symbol, params = {}) {
4856
- /**
4857
- * @method
4858
- * @name phemex#fetchOpenInterest
4859
- * @description retrieves the open interest of a trading pair
4860
- * @see https://phemex-docs.github.io/#query-24-hours-ticker
4861
- * @param {string} symbol unified CCXT market symbol
4862
- * @param {object} [params] exchange specific parameters
4863
- * @returns {object} an open interest structure{@link https://docs.ccxt.com/#/?id=open-interest-structure}
4864
- */
4865
4867
  await this.loadMarkets();
4866
4868
  const market = this.market(symbol);
4867
4869
  if (!market['contract']) {