max_exchange_api 1.3.0 → 2.0.0

data/README.md

@@ -1,4 +1,4 @@
-# MaxExchangeApi
+# MAX Exchange API Ruby SDK
 
 [![Gem Version](https://img.shields.io/gem/v/max_exchange_api.svg?style=flat)](http://rubygems.org/gems/max_exchange_api)
 [![Build Status](https://github.com/khiav223577/max_exchange_api/workflows/Ruby/badge.svg)](https://github.com/khiav223577/max_exchange_api/actions)
@@ -14,12 +14,141 @@ A ruby implementation of MAX exchange API
 ## Documentations
 
 * [REST API Introduction](https://max.maicoin.com/documents/api_v2)
-* [REST API End Points](https://max.maicoin.com/documents/api_list)
+* [MAX V3 RESTful API List](https://max-api.maicoin.com/doc/v3.html)
 * [WebSocket API Documentation](https://maicoin.github.io/max-websocket-docs/)
 
 
 ## Supports
-- Ruby 2.2 ~ 2.7, 3.0
+- Ruby 2.2 ~ 2.7, 3.0 ~ 3.3
+
+## Table of contents
+
+<!-- TOC -->
+* [MAX Exchange API Ruby SDK](#max-exchange-api-ruby-sdk)
+  * [Documentations](#documentations)
+  * [Supports](#supports)
+  * [Table of contents](#table-of-contents)
+  * [Installation](#installation)
+  * [Usage](#usage)
+  * [Configuration](#configuration)
+    * [Set timeout time](#set-timeout-time)
+    * [Logging](#logging)
+    * [Switch Sub-Account](#switch-sub-account)
+  * [Public V3 Api Examples](#public-v3-api-examples)
+      * [GET /api/v3/wallet/m/index_prices](#get-apiv3walletmindex_prices)
+      * [GET /api/v3/wallet/m/historical_index_prices](#get-apiv3walletmhistorical_index_prices)
+      * [GET /api/v3/wallet/m/limits](#get-apiv3walletmlimits)
+      * [GET /api/v3/wallet/m/interest_rates](#get-apiv3walletminterest_rates)
+      * [GET /api/v3/markets](#get-apiv3markets)
+      * [GET /api/v3/currencies](#get-apiv3currencies)
+      * [GET /api/v3/timestamp](#get-apiv3timestamp)
+      * [GET /api/v3/k](#get-apiv3k)
+      * [GET /api/v3/depth](#get-apiv3depth)
+      * [GET /api/v3/trades](#get-apiv3trades)
+      * [GET /api/v3/tickers](#get-apiv3tickers)
+      * [GET /api/v3/ticker](#get-apiv3ticker)
+  * [Private V3 Api Examples](#private-v3-api-examples)
+    * [User](#user)
+      * [GET /api/v3/info](#get-apiv3info)
+    * [Account](#account)
+      * [GET /api/v3/wallet/{wallet_type}/accounts](#get-apiv3walletwallet_typeaccounts)
+    * [M-Wallet](#m-wallet)
+      * [GET /api/v3/wallet/m/ad_ratio](#get-apiv3walletmad_ratio)
+      * [POST /api/v3/wallet/m/loan](#post-apiv3walletmloan)
+      * [POST /api/v3/wallet/m/repayment](#post-apiv3walletmrepayment)
+      * [GET /api/v3/wallet/m/loans](#get-apiv3walletmloans)
+      * [GET /api/v3/wallet/m/repayments](#get-apiv3walletmrepayments)
+      * [GET /api/v3/wallet/m/liquidations](#get-apiv3walletmliquidations)
+      * [GET /api/v3/wallet/m/liquidation](#get-apiv3walletmliquidation)
+      * [GET /api/v3/wallet/m/interests](#get-apiv3walletminterests)
+    * [Convert](#convert)
+      * [GET /api/v3/converts](#get-apiv3converts)
+      * [GET /api/v3/convert](#get-apiv3convert)
+      * [POST /api/v3/convert](#post-apiv3convert)
+    * [Order](#order)
+      * [GET /api/v3/wallet/{wallet_type}/orders/open](#get-apiv3walletwallet_typeordersopen)
+      * [GET /api/v3/wallet/{wallet_type}/orders/closed](#get-apiv3walletwallet_typeordersclosed)
+      * [GET /api/v3/wallet/{wallet_type}/orders/history](#get-apiv3walletwallet_typeordershistory)
+      * [POST /api/v3/wallet/{wallet_type}/order](#post-apiv3walletwallet_typeorder)
+      * [GET /api/v3/order](#get-apiv3order)
+      * [DELETE /api/v3/wallet/{wallet_type}/order](#delete-apiv3walletwallet_typeorder)
+      * [DELETE /api/v3/order](#delete-apiv3order)
+    * [Trade](#trade)
+      * [GET /api/v3/order/trades](#get-apiv3ordertrades)
+      * [GET /api/v3/wallet/{path_wallet_type}/trades](#get-apiv3walletpath_wallet_typetrades)
+    * [Deposit](#deposit)
+      * [GET /api/v3/deposit_address](#get-apiv3deposit_address)
+      * [GET /api/v3/deposits](#get-apiv3deposits)
+      * [GET /api/v3/deposit](#get-apiv3deposit)
+    * [Withdraw](#withdraw)
+      * [GET /api/v3/withdraw_addresses](#get-apiv3withdraw_addresses)
+      * [GET /api/v3/withdrawals](#get-apiv3withdrawals)
+      * [GET /api/v3/withdrawal](#get-apiv3withdrawal)
+      * [POST /api/v3/withdrawal](#post-apiv3withdrawal)
+      * [POST /api/v3/withdrawal/twd](#post-apiv3withdrawaltwd)
+    * [Internal Transfer](#internal-transfer)
+      * [GET /api/v3/internal_transfers](#get-apiv3internal_transfers)
+    * [Reward](#reward)
+      * [GET /api/v3/rewards](#get-apiv3rewards)
+  * [SubAccount](#subaccount)
+      * [GET /api/v3/sub_accounts](#get-apiv3sub_accounts)
+      * [GET /api/v3/sub_account](#get-apiv3sub_account)
+      * [POST /api/v3/sub_accounts](#post-apiv3sub_accounts)
+      * [PUT /api/v3/sub_account](#put-apiv3sub_account)
+      * [DELETE /api/v3/sub_account](#delete-apiv3sub_account)
+      * [POST /api/v3/sub_account/transfer](#post-apiv3sub_accounttransfer)
+  * [Public V2 Api Examples](#public-v2-api-examples)
+      * [GET /api/v2/vip_levels](#get-apiv2vip_levels)
+      * [GET /api/v2/vip_levels/{level}](#get-apiv2vip_levelslevel)
+      * [GET /api/v2/currencies](#get-apiv2currencies)
+      * [GET /api/v2/k](#get-apiv2k)
+      * [GET /api/v2/depth](#get-apiv2depth)
+      * [GET /api/v2/trades](#get-apiv2trades)
+      * [GET /api/v2/markets](#get-apiv2markets)
+      * [GET /api/v2/summary](#get-apiv2summary)
+      * [GET /api/v2/tickers/{path_market}](#get-apiv2tickerspath_market)
+      * [GET /api/v2/tickers](#get-apiv2tickers)
+      * [GET /api/v2/timestamp](#get-apiv2timestamp)
+  * [Private V2 Api Examples](#private-v2-api-examples)
+    * [User](#user-1)
+      * [GET /api/v2/members/profile](#get-apiv2membersprofile)
+      * [GET /api/v2/members/me](#get-apiv2membersme)
+      * [GET /api/v2/members/vip_level](#get-apiv2membersvip_level)
+    * [Account](#account-1)
+      * [GET /api/v2/members/accounts](#get-apiv2membersaccounts)
+      * [GET /api/v2/members/accounts/{path_currency}](#get-apiv2membersaccountspath_currency)
+    * [Order](#order-1)
+      * [GET /api/v2/orders](#get-apiv2orders)
+      * [GET /api/v2/order](#get-apiv2order)
+      * [POST /api/v2/orders/clear](#post-apiv2ordersclear)
+      * [POST /api/v2/order/delete](#post-apiv2orderdelete)
+      * [POST /api/v2/orders](#post-apiv2orders)
+      * [POST /api/v2/orders/multi/onebyone](#post-apiv2ordersmultionebyone)
+    * [Trade](#trade-1)
+      * [GET /api/v2/trades/my/of_order](#get-apiv2tradesmyof_order)
+      * [GET /api/v2/trades/my](#get-apiv2tradesmy)
+    * [Deposit](#deposit-1)
+      * [GET /api/v2/deposits](#get-apiv2deposits)
+      * [GET /api/v2/deposit](#get-apiv2deposit)
+      * [GET /api/v2/deposit_addresses](#get-apiv2deposit_addresses)
+      * [POST /api/v2/deposit_addresses](#post-apiv2deposit_addresses)
+    * [Withdrawal](#withdrawal)
+      * [GET /api/v2/withdrawals](#get-apiv2withdrawals)
+      * [GET /api/v2/withdrawal](#get-apiv2withdrawal)
+      * [POST /api/v2/withdrawal](#post-apiv2withdrawal)
+      * [GET /api/v2/withdraw_addresses](#get-apiv2withdraw_addresses)
+    * [Internal Transfer](#internal-transfer-1)
+      * [GET /api/v2/internal_transfers](#get-apiv2internal_transfers)
+      * [GET /api/v2/internal_transfer](#get-apiv2internal_transfer)
+    * [Reward](#reward-1)
+      * [GET /api/v2/rewards](#get-apiv2rewards)
+      * [GET /api/v2/rewards/{path_reward_type}](#get-apiv2rewardspath_reward_type)
+      * [GET /api/v2/max_rewards/yesterday](#get-apiv2max_rewardsyesterday)
+      * [GET /api/v2/yields](#get-apiv2yields)
+  * [Development](#development)
+  * [Contributing](#contributing)
+  * [License](#license)
+<!-- TOC -->
 
 ## Installation
 
@@ -35,6 +164,18 @@ Or install it yourself as:
 
     $ gem install max_exchange_api
 
+## Usage
+
+```rb
+@public_v3_api = MaxExchangeApi::PublicV3Api.new
+@public_v3_api.depth('usdttwd')
+
+access_key, secret_key = File.read('secret').split(',')
+@private_v3_api = MaxExchangeApi::PrivateV3Api.new(access_key, secret_key)
+@private_v3_api.create_order!('usdttwd', 'sell', 1000, price: 31.35)
+@private_v3_api.create_order!('usdttwd', 'buy', 1000, price: 31.15)
+```
+
 ## Configuration
 
 ### Set timeout time
@@ -44,8 +185,8 @@ Or install it yourself as:
 MaxExchangeApi.default_config.timeout = 3 # seconds
 
 # Create an api instance with custom timeout time
-api = MaxExchangeApi::PublicApi.new(config: { timeout: 12 })
-api = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { timeout: 12 })
+api = MaxExchangeApi::PublicV3Api.new(config: { timeout: 12 })
+api = MaxExchangeApi::PrivateV3Api.new(access_key, secret_key, config: { timeout: 12 })
 ```
 
 ### Logging
@@ -60,594 +201,854 @@ MaxExchangeApi.default_config.logger = Logger.new(STDOUT)
 MaxExchangeApi.default_config.logger = Logger.new('log/api.log')
 
 # Create an api instance with custom logger
-api = MaxExchangeApi::PublicApi.new(config: { logger: Logger.new(STDOUT) })
-api = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: Logger.new(STDOUT) })
+api = MaxExchangeApi::PublicV3Api.new(config: { logger: Logger.new(STDOUT) })
+api = MaxExchangeApi::PrivateV3Api.new(access_key, secret_key, config: { logger: Logger.new(STDOUT) })
 ```
 
-## Usage
+### Switch Sub-Account
+
+```rb
+@private_v3_api = MaxExchangeApi::PrivateV3Api.new(access_key, secret_key)
+
+# Switch to a specific sub-account (e.g., 's1-a7f20f')
+@private_v3_api.current_sub_account_sn = 's1-a7f20f'
+
+# Use the default sub-account (determined by the API token owner)
+@private_v3_api.current_sub_account_sn = nil
+
+# Switch to the main account
+@private_v3_api.current_sub_account_sn = 'main'
+```
 
-### Public Api Examples
+## Public V3 Api Examples
 
 ```rb
-@api = MaxExchangeApi::PublicApi.new
+@public_v3_api = MaxExchangeApi::PublicV3Api.new
 ```
 
-#### [GET /api/v2/vip_levels](https://max.maicoin.com/documents/api_list#!/public/getApiV2VipLevels)
+#### [GET /api/v3/wallet/m/index_prices](https://max-api.maicoin.com/doc/v3.html#tag/Public/operation/getApiV3WalletMIndexPrices)
 
-> Get all VIP level fees.
+> Get latest index prices of m-wallet
 
-<details>
-  <summary>Show code</summary>
-  
 ```rb
-@api.vip_levels
+@public_v3_api.index_prices
 ```
-</details>
 
-#### [GET /api/v2/vip_levels/{level}](https://max.maicoin.com/documents/api_list#!/public/getApiV2VipLevelsLevel)
+#### [GET /api/v3/wallet/m/historical_index_prices](https://max-api.maicoin.com/doc/v3.html#tag/Public/operation/getApiV3WalletMHistoricalIndexPrices)
 
-> Get VIP level fee by level.
+> Get latest historical index prices
 
-<details>
-  <summary>Show code</summary>
-  
 ```rb
-@api.vip_levels(2)
+@public_v3_api.index_prices_histories
 ```
-</details>
 
-#### [GET /api/v2/currencies](https://max.maicoin.com/documents/api_list#!/public/getApiV2Currencies)
+#### [GET /api/v3/wallet/m/limits](https://max-api.maicoin.com/doc/v3.html#tag/Public/operation/getApiV3WalletMLimits)
 
-> Get all available currencies.
+> Get total available loan amount
+
+```rb
+@public_v3_api.available_loan_amount
+```
+
+#### [GET /api/v3/wallet/m/interest_rates](https://max-api.maicoin.com/doc/v3.html#tag/Public/operation/getApiV3WalletMInterestRates)
+
+> Get latest interest rates of m-wallet
+
+```rb
+@public_v3_api.loan_interest_rates
+```
+
+#### [GET /api/v3/markets](https://max-api.maicoin.com/doc/v3.html#tag/Public/operation/getApiV3Markets)
+
+> Get all available markets.
+
+```rb
+@public_v3_api.markets
+```
+
+#### [GET /api/v3/currencies](https://max-api.maicoin.com/doc/v3.html#tag/Public/operation/getApiV3Currencies)
+
+> Get all available currencies
 
-<details>
-  <summary>Show code</summary>
-  
 ```rb
-@api.currencies
+@public_v3_api.currencies
 ```
-</details>
 
-#### [GET /api/v2/k](https://max.maicoin.com/documents/api_list#!/public/getApiV2K)
+#### [GET /api/v3/timestamp](https://max-api.maicoin.com/doc/v3.html#tag/Public/operation/getApiV3Timestamp)
+
+> Get server current time, in seconds since Unix epoch
+
+```rb
+@public_v3_api.timestamp
+```
+
+#### [GET /api/v3/k](https://max-api.maicoin.com/doc/v3.html#tag/Public/operation/getApiV3K)
 
 > Get OHLC(k line) of a specific market.
 
-<details>
-  <summary>Show code</summary>
-  
 ```rb
 # use default parameters
-@api.k('btctwd')
+@private_v3_api.k('btctwd')
 
 # provide all possible parameters
-@api.k('btctwd', limit: 30, period: 1, timestamp: 1624705402)
+@private_v3_api.k('btctwd', limit: 30, period: 1, timestamp: 1624705402)
 ```
-</details>
 
-#### [GET /api/v2/depth](https://max.maicoin.com/documents/api_list#!/public/getApiV2Depth)
+#### [GET /api/v3/depth](https://max-api.maicoin.com/doc/v3.html#tag/Public/operation/getApiV3Depth)
 
 > Get depth of a specified market.
 
-<details>
-  <summary>Show code</summary>
-  
 ```rb
 # use default parameters
-@api.depth('maxtwd')
+@private_v3_api.depth('maxtwd')
 
 # provide all possible parameters
-@api.depth('maxtwd', limit: 10, sort_by_price: true)
+@private_v3_api.depth('maxtwd', limit: 10, sort_by_price: true)
 ```
-</details>
 
-#### [GET /api/v2/trades](https://max.maicoin.com/documents/api_list#!/public/getApiV2Trades)
+#### [GET /api/v3/trades](https://max-api.maicoin.com/doc/v3.html#tag/Public/operation/getApiV3Trades)
 
 > Get recent trades on market, sorted in reverse creation order.
 
-<details>
-  <summary>Show code</summary>
-  
 ```rb
 # use default parameters
-@api.trades('btctwd')
+@private_v3_api.trades('btctwd')
 
 # provide all possible parameters
-@api.trades(
+@private_v3_api.trades(
   'maxtwd', 
   timestamp: 1624705402,
-  from: 68444,
-  to: 69444,
-  order_by: 'asc',
-  pagination: true,
-  page: 3,
   limit: 15,
-  offset: 5,
 )
 ```
-</details>
 
-#### [GET /api/v2/markets](https://max.maicoin.com/documents/api_list#!/public/getApiV2Markets)
+#### [GET /api/v3/tickers](https://max-api.maicoin.com/doc/v3.html#tag/Public/operation/getApiV3Tickers)
 
-> Get all available markets.
+> Get ticker of all markets.
 
-<details>
-  <summary>Show code</summary>
-  
 ```rb
-@api.markets
+@private_v3_api.tickers
 ```
-</details>
 
-#### [GET /api/v2/summary](https://max.maicoin.com/documents/api_list#!/public/getApiV2Summary)
+#### [GET /api/v3/ticker](https://max-api.maicoin.com/doc/v3.html#tag/Public/operation/getApiV3Ticker)
 
-> Overview of market data for all tickers.
+> Get ticker of specific market.
 
-<details>
-  <summary>Show code</summary>
-  
 ```rb
-@api.summary
+@private_v3_api.ticker('btctwd')
 ```
-</details>
 
-#### [GET /api/v2/tickers/{path_market}](https://max.maicoin.com/documents/api_list#!/public/getApiV2TickersPathMarket)
+---
 
-> Get ticker of specific market.
+## Private V3 Api Examples
 
-<details>
-  <summary>Show code</summary>
-  
 ```rb
-@api.tickers('btctwd')
+access_key = 'YOUR_ACCESS_KEY'
+secret_key = 'YOUR_SECRET_KEY'
+
+@private_v3_api = MaxExchangeApi::PrivateV3Api.new(access_key, secret_key)
 ```
-</details>
 
-#### [GET /api/v2/tickers](https://max.maicoin.com/documents/api_list#!/public/getApiV2Tickers)
+### User
+#### [GET /api/v3/info](https://max-api.maicoin.com/doc/v3.html#tag/User/operation/getApiV3Info)
 
-> Get ticker of all markets.
+> Get user information
 
-<details>
-  <summary>Show code</summary>
-  
 ```rb
-@api.tickers
+@private_v3_api.member_info
 ```
-</details>
 
-#### [GET /api/v2/timestamp](https://max.maicoin.com/documents/api_list#!/public/getApiV2Timestamp)
+### Account
+#### [GET /api/v3/wallet/{wallet_type}/accounts](https://max-api.maicoin.com/doc/v3.html#tag/Wallet/operation/getApiV3WalletPathWalletTypeAccounts)
 
-> Get server current time, in seconds since Unix epoch.
+> Get your account balance with all supported currencies by different wallet type
 
-<details>
-  <summary>Show code</summary>
-  
 ```rb
-@api.timestamp
+@private_v3_api.accounts
+
+# provide all possible parameters
+@private_v3_api.accounts(wallet_type: 'm', currency: 'usdt')
 ```
-</details>
 
-### Private Api Examples
+### M-Wallet
+#### [GET /api/v3/wallet/m/ad_ratio](https://max-api.maicoin.com/doc/v3.html#tag/Wallet/operation/getApiV3WalletMAdRatio)
 
-```rb
-access_key = 'YOUR_ACCESS_KEY'
-secret_key = 'YOUR_SECRET_KEY'
+> Get the latest AD ratio of your m-wallet
 
-@api = MaxExchangeApi::PrivateApi.new(access_key, secret_key)
+```rb
+@private_v3_api.m_wallet_ad_ratio
 ```
 
-### Trade
-#### [GET /api/v2/trades/my/of_order](https://max.maicoin.com/documents/api_list#!/private/getApiV2TradesMyOfOrder)
-
-> get your executed trades related to a order
+#### [POST /api/v3/wallet/m/loan](https://max-api.maicoin.com/doc/v3.html#tag/Wallet/operation/postApiV3WalletMLoan)
 
-<details>
-  <summary>Show code</summary>
+> Create a loan request for your m-wallet
 
 ```rb
-# use max unique order id
-@api.my_trades_of_order(123456)
-
-# use user specified order id
-@api.my_trades_of_order('MY_ORDER_123456', use_client_id: true)
+@private_v3_api.m_wallet_loan!('30000', 'usdt')
 ```
-</details>
 
-#### [GET /api/v2/trades/my](https://max.maicoin.com/documents/api_list#!/private/getApiV2TradesMy)
+#### [POST /api/v3/wallet/m/repayment](https://max-api.maicoin.com/doc/v3.html#tag/Wallet/operation/postApiV3WalletMRepayment)
 
-> get your executed trades, sorted in reverse creation order
+> Make a repayment for your loan
+
+```rb
+@private_v3_api.m_wallet_repay!('30000', 'usdt')
+```
 
-<details>
-  <summary>Show code</summary>
+#### [GET /api/v3/wallet/m/loans](https://max-api.maicoin.com/doc/v3.html#tag/Wallet/operation/getApiV3WalletMLoans)
+
+> Get loan history of your m-wallet
 
 ```rb
-# use default parameters
-@api.my_trades('btctwd')
+@private_v3_api.m_wallet_loans('usdt')
 
 # provide all possible parameters
-@api.my_trades(
-  'maxtwd',
+@private_v3_api.m_wallet_loans(
+  'usdt',
   timestamp: 1624705402,
-  from: 68444,
-  to: 69444,
   order_by: 'asc',
-  pagination: true,
-  page: 3,
   limit: 15,
-  offset: 5,
 )
 ```
-</details>
-
-### Withdrawal
-#### [GET /api/v2/withdrawals](https://max.maicoin.com/documents/api_list#!/private/getApiV2Withdrawals)
 
-> get your external withdrawals history
+#### [GET /api/v3/wallet/m/repayments](https://max-api.maicoin.com/doc/v3.html#tag/Wallet/operation/getApiV3WalletMRepayments)
 
-<details>
-  <summary>Show code</summary>
+> Get repayment history of your m-wallet
 
 ```rb
-# use default parameters
-@api.withdrawals('max')
+@private_v3_api.m_wallet_repayments('usdt')
 
 # provide all possible parameters
-@api.withdrawals(
-  'max',
-  'confirmed',
-  from: 68444,
-  to: 69444,
-  state: 'confirmed',
-  pagination: true,
-  page: 3,
+@private_v3_api.m_wallet_repayments(
+  'usdt',
+  timestamp: 1624705402,
+  order_by: 'asc',
   limit: 15,
-  offset: 5,
 )
 ```
-</details>
 
-#### [GET /api/v2/withdrawal](https://max.maicoin.com/documents/api_list#!/private/getApiV2Withdrawal)
+#### [GET /api/v3/wallet/m/liquidations](https://max-api.maicoin.com/doc/v3.html#tag/Wallet/operation/getApiV3WalletMLiquidations)
 
-> get details of a specific external withdraw
-
-<details>
-  <summary>Show code</summary>
+> Get liquidation history of your m-wallet
 
 ```rb
-@api.withdrawal('withdraw_id')
-```
-</details>
+@private_v3_api.m_wallet_liquidations
 
-#### [POST /api/v2/withdrawal](https://max.maicoin.com/documents/api_list#!/private/postApiV2Withdrawal)
+# provide all possible parameters
+@private_v3_api.m_wallet_liquidations(
+  timestamp: 1624705402,
+  order_by: 'asc',
+  limit: 15,
+)
+```
 
-> submit a withdrawal. IP whitelist for api token is required.
+#### [GET /api/v3/wallet/m/liquidation](https://max-api.maicoin.com/doc/v3.html#tag/Wallet/operation/getApiV3WalletMLiquidation)
 
-<details>
-  <summary>Show code</summary>
+> Get detail of one specific liquidation history of your m-wallet
 
 ```rb
-@api.create_withdrawal!('twd', 'withdraw_address_id', 100000)
+@private_v3_api.m_wallet_liquidation('210407080800050666')
 ```
-</details>
 
-### Profile
-#### [GET /api/v2/members/profile](https://max.maicoin.com/documents/api_list#!/private/getApiV2MembersProfile)
-
-> get personal profile information
+#### [GET /api/v3/wallet/m/interests](https://max-api.maicoin.com/doc/v3.html#tag/Wallet/operation/getApiV3WalletMInterests)
 
-<details>
-  <summary>Show code</summary>
+> Get interest history of your m-wallet
 
 ```rb
-@api.member_profile
-```
-</details>
+@private_v3_api.m_wallet_interests('usdt')
 
-#### [GET /api/v2/members/me](https://max.maicoin.com/documents/api_list#!/private/getApiV2MembersMe)
+# provide all possible parameters
+@private_v3_api.m_wallet_interests(
+  'usdt',
+  timestamp: 1624705402,
+  order_by: 'asc',
+  limit: 15,
+)
+```
 
-> get your profile and accounts information
+### Convert
+#### [GET /api/v3/converts](https://max-api.maicoin.com/doc/v3.html#tag/Convert/operation/getApiV3Converts)
 
-<details>
-  <summary>Show code</summary>
+> Get convert orders history
 
 ```rb
-@api.me
-```
-</details>
+@private_v3_api.convert_orders
 
-#### [GET /api/v2/members/vip_level](https://max.maicoin.com/documents/api_list#!/private/getApiV2MembersVipLevel)
+# provide all possible parameters
+@private_v3_api.convert_orders(
+  timestamp: 1624705402,
+  order_by: 'asc',
+  limit: 15,
+)
+```
 
-> get VIP level info
+#### [GET /api/v3/convert](https://max-api.maicoin.com/doc/v3.html#tag/Convert/operation/getApiV3Convert)
 
-<details>
-  <summary>Show code</summary>
+> Get details of a specific convert order
 
 ```rb
-@api.vip_level
+@private_v3_api.convert_order('6322d9bd-736b-4f19-b862-829e75cae1ce')
 ```
-</details>
 
-### Account
-#### [GET /api/v2/members/accounts](https://max.maicoin.com/documents/api_list#!/private/getApiV2MembersAccounts)
-
-> get personal accounts information
+#### [POST /api/v3/convert](https://max-api.maicoin.com/doc/v3.html#tag/Convert/operation/postApiV3Convert)
 
-<details>
-  <summary>Show code</summary>
+> Execute a convert (flash exchange) between two currencies
 
 ```rb
-@api.accounts
-```
-</details>
+# Specify from amount
+@private_v3_api.create_convert_order(
+  from: ['0.52', 'usdt'],
+  to: [nil, 'twd'],
+)
 
-#### [GET /api/v2/members/accounts/{path_currency}](https://max.maicoin.com/documents/api_list#!/private/getApiV2MembersAccountsPathCurrency)
+# Specify to amount
+@private_v3_api.create_convert_order(
+  from: [nil, 'usdt'],
+  to: ['16.58', 'twd'],
+)
+```
 
-> get personal accounts information of a currency
+### Order
+#### [GET /api/v3/wallet/{wallet_type}/orders/open](https://max-api.maicoin.com/doc/v3.html#tag/Order/operation/getApiV3WalletPathWalletTypeOrdersOpen)
 
-<details>
-  <summary>Show code</summary>
+> Get open orders.
 
 ```rb
-@api.account(currnecy)
-```
-</details>
+# use default parameters
+@private_v3_api.open_orders('maxtwd')
 
-### Deposit
-#### [GET /api/v2/deposits](https://max.maicoin.com/documents/api_list#!/private/getApiV2Deposits)
+# provide all possible parameters
+@private_v3_api.open_orders(
+  'maxtwd',
+  wallet_type: 'm', # 'spot' or 'm'
+  timestamp: 1773734452000,
+  order_by: 'desc',
+  limit: 15,
+)
+```
 
-> get your deposits history
+#### [GET /api/v3/wallet/{wallet_type}/orders/closed](https://max-api.maicoin.com/doc/v3.html#tag/Order/operation/getApiV3WalletPathWalletTypeOrdersClosed)
 
-<details>
-  <summary>Show code</summary>
+> Get closed orders.
 
 ```rb
 # use default parameters
-@api.deposits('max')
+@private_v3_api.closed_orders('maxtwd')
 
 # provide all possible parameters
-@api.deposits(
-  'max',
-  'confirmed',
-  from: 68444,
-  to: 69444,
-  state: 'accepted',
-  pagination: true,
-  page: 3,
+@private_v3_api.closed_orders(
+  'maxtwd',
+  wallet_type: 'm', # 'spot' or 'm'
+  timestamp: 1773734452000,
+  order_by: 'desc',
   limit: 15,
-  offset: 5,
 )
 ```
-</details>
-
-#### [GET /api/v2/deposit](https://max.maicoin.com/documents/api_list#!/private/getApiV2Deposit)
 
-> get details of a specific deposit
+#### [GET /api/v3/wallet/{wallet_type}/orders/history](https://max-api.maicoin.com/doc/v3.html#tag/Order/operation/getApiV3WalletPathWalletTypeOrdersHistory)
 
-<details>
-  <summary>Show code</summary>
+> Get order history in ascending order from a specific from_id.
 
 ```rb
-@api.deposit('transaction_id')
-```
-</details>
+# use default parameters
+@private_v3_api.order_history('maxtwd')
 
-### Address
-#### [GET /api/v2/deposit_addresses](https://max.maicoin.com/documents/api_list#!/private/getApiV2DepositAddresses)
+# provide all possible parameters
+@private_v3_api.orders_history(
+  'maxtwd',
+  wallet_type: 'm', # 'spot' or 'm'
+  from_id: 123456,
+  limit: 15,
+)
+```
 
-> The addresses could be empty before generated, please call POST /deposit_addresses in that case
+#### [POST /api/v3/wallet/{wallet_type}/order](https://max-api.maicoin.com/doc/v3.html#tag/Order/operation/postApiV3WalletPathWalletTypeOrder)
 
-<details>
-  <summary>Show code</summary>
+> Create sell/buy order
 
 ```rb
 # use default parameters
-@api.deposit_addresses
+@private_v3_api.create_order!('maxtwd', 'buy', 1000, price: 7.5)
 
 # provide all possible parameters
-@api.deposit_addresses(currency: 'twd', pagination: true, page: 3, limit: 15, offset: 5)
+@private_v3_api.create_order!(
+  'maxtwd',
+  'buy',
+  1000,
+  wallet_type: 'm', # 'spot' or 'm'
+  price: 7.5,
+  client_oid: 'MY_ORDER_ID_12345',
+  stop_price: 8,
+  ord_type: 'limit',
+  group_id: 12345678,
+)
 ```
-</details>
 
-#### [POST /api/v2/deposit_addresses](https://max.maicoin.com/documents/api_list#!/private/postApiV2DepositAddresses)
+#### [GET /api/v3/order](https://max-api.maicoin.com/doc/v3.html#tag/Order/operation/getApiV3Order)
 
-> Address creation is asynchronous, please call GET /deposit_addresses later to get generated addresses
-
-<details>
-  <summary>Show code</summary>
+> Get order detail
 
 ```rb
-@api.create_deposit_addresses!('twd')
-```
-</details>
+# use default parameters
+# use max unique order id
+@private_v3_api.order(123456)
 
-#### [GET /api/v2/withdraw_addresses](https://max.maicoin.com/documents/api_list#!/private/getApiV2WithdrawAddresses)
+# use user specified order id
+@private_v3_api.order(client_oid: 'MY_ORDER_123456')
+```
 
-> get withdraw addresses
+#### [DELETE /api/v3/wallet/{wallet_type}/order](https://max-api.maicoin.com/doc/v3.html#tag/Order/operation/deleteApiV3WalletPathWalletTypeOrders)
 
-<details>
-  <summary>Show code</summary>
+> Cancel all orders
 
 ```rb
 # use default parameters
-@api.withdraw_addresses('twd')
+@private_v3_api.cancel_orders!
 
 # provide all possible parameters
-@api.withdraw_addresses('usdt', pagination: true, page: 3, limit: 15, offset: 5)
+@private_v3_api.cancel_orders!(
+  wallet_type: 'm', # 'spot' or 'm'
+  market: 'maxtwd', 
+  side: 'sell',
+  group_id: '123456',
+)
 ```
-</details>
-
-### Internal Transfer
-#### [GET /api/v2/internal_transfers](https://max.maicoin.com/documents/api_list#!/private/getApiV2InternalTransfers)
 
-> get internal transfers history
+#### [DELETE /api/v3/order](https://max-api.maicoin.com/doc/v3.html#tag/Order/operation/deleteApiV3Order)
 
-<details>
-  <summary>Show code</summary>
+> Cancel an order
 
 ```rb
-# use default parameters
-@api.internal_transfers
+# use max unique order id
+@private_v3_api.cancel_order!(123456)
 
-# provide all possible parameters
-@api.internal_transfers(
-  currency: 'btc',
-  side: 'in',
-  from: 68444,
-  to: 69444,
-  pagination: true, 
-  page: 3, 
-  limit: 15, 
-  offset: 5,
-)
+# use user specified order id
+@private_v3_api.cancel_order!(client_oid: 'MY_ORDER_123456')
 ```
-</details>
-
-#### [GET /api/v2/internal_transfer](https://max.maicoin.com/documents/api_list#!/private/getApiV2InternalTransfer)
 
-> get details of a specific internal transfer
+### Trade
+#### [GET /api/v3/order/trades](https://max-api.maicoin.com/doc/v3.html#tag/Trade/operation/getApiV3OrderTrades)
 
-<details>
-  <summary>Show code</summary>
+> Get trade detail by your order info
 
 ```rb
-@api.internal_transfer('internal_transfer_id')
-```
-</details>
+# use max unique order id
+@private_v3_api.my_trades_of_order(123456)
 
-### Reward
-#### [GET /api/v2/rewards](https://max.maicoin.com/documents/api_list#!/private/getApiV2Rewards)
+# use user specified order id
+@private_v3_api.my_trades_of_order(client_oid: 'MY_ORDER_123456')
+```
 
-> get rewards history
+#### [GET /api/v3/wallet/{path_wallet_type}/trades](https://max-api.maicoin.com/doc/v3.html#tag/Trade/operation/getApiV3WalletPathWalletTypeTrades)
 
-<details>
-  <summary>Show code</summary>
+> Get executed trades
 
 ```rb
 # use default parameters
-@api.rewards
+@private_v3_api.my_trades
 
 # provide all possible parameters
-@api.rewards(
-  currency: 'btc',
-  from: 68444,
-  to: 69444,
-  pagination: true,
-  page: 3,
+@private_v3_api.my_trades(
+  wallet_type: 'm', # 'spot' or 'm'
+  market: 'maxtwd',
+  timestamp: 1624705402,
+  from_id: 68444,
+  order_by: 'asc',
   limit: 15,
-  offset: 5,
 )
 ```
-</details>
 
-#### [GET /api/v2/rewards/{path_reward_type}](https://max.maicoin.com/documents/api_list#!/private/getApiV2RewardsPathRewardType)
+### Deposit
+#### [GET /api/v3/deposit_address](https://max-api.maicoin.com/doc/v3.html#tag/Wallet/operation/getApiV3DepositAddress)
 
-> get specific rewards history
+> Get user deposit address by currency version
+
+```rb
+@private_v3_api.deposit_address('bscusdt')
+```
+
+#### [GET /api/v3/deposits](https://max-api.maicoin.com/doc/v3.html#tag/Transaction/operation/getApiV3Deposits)
 
-<details>
-  <summary>Show code</summary>
+> get your deposits history
 
 ```rb
 # use default parameters
-@api.rewards(reward_type: 'airdrop_rewards')
+@private_v3_api.deposits
 
 # provide all possible parameters
-@api.rewards(
-  reward_type: 'airdrop_rewards',
-  currency: 'btc',
-  from: 68444,
-  to: 69444,
-  pagination: true,
-  page: 3,
+@private_v3_api.deposits(
+  currency: 'max',
+  timestamp: 1624705402,
+  order_by: 'asc',
   limit: 15,
-  offset: 5,
 )
 ```
-</details>
 
-#### [GET /api/v2/max_rewards/yesterday](https://max.maicoin.com/documents/api_list#!/private/getApiV2MaxRewardsYesterday)
-
-> get max rewards yesterday
+#### [GET /api/v3/deposit](https://max-api.maicoin.com/doc/v3.html#tag/Transaction/operation/getApiV3Deposit)
 
-<details>
-  <summary>Show code</summary>
+> Get details of a specific deposit
 
 ```rb
-@api.max_rewards_yesterday
-```
-</details>
+# Query by uuid
+@private_v3_api.deposit(uuid: '18022603540001')
 
-#### [GET /api/v2/yields](https://max.maicoin.com/documents/api_list#!/private/getApiV2Yields)
+# Query by txid
+@private_v3_api.deposit(txid: '0x8daa98e07886985bd6a142cd81b83582d6085f7eb931dc4984c18c84f2a845e0')
+```
 
-> get yields history
+### Withdraw
+#### [GET /api/v3/withdraw_addresses](https://max-api.maicoin.com/doc/v3.html#tag/Wallet/operation/getApiV3WithdrawAddresses)
 
-<details>
-  <summary>Show code</summary>
+> Get withdraw addresses of spot wallet
 
 ```rb
-# use default parameters
-@api.yields
+@private_v3_api.withdraw_addresses('usdt')
 
 # provide all possible parameters
-@api.yields(
-  currency: 'usdt',
-  from: 68444,
-  to: 69444,
-  pagination: true,
-  page: 3,
-  limit: 15,
-  offset: 5,
-)
+@private_v3_api.withdraw_addresses('usdt', limit: 10, offset: 5)
 ```
-</details>
 
-### Order
-#### [GET /api/v2/orders](https://max.maicoin.com/documents/api_list#!/private/getApiV2Orders)
-
-> get your orders, results is paginated.
+#### [GET /api/v3/withdrawals](https://max-api.maicoin.com/doc/v3.html#tag/Transaction/operation/getApiV3Withdrawals)
 
-<details>
-  <summary>Show code</summary>
+> Get external withdrawals history
 
 ```rb
 # use default parameters
-@api.orders('maxtwd')
+@private_v3_api.withdraws
 
 # provide all possible parameters
-@api.orders(
-  'maxtwd',
+@private_v3_api.withdraws(
+  currency: 'max',
   state: 'done',
-  order_by: 'desc',
-  group_id: 12345,
-  pagination: true,
-  page: 3,
+  timestamp: 1624705402,
+  order_by: 'asc',
   limit: 15,
-  offset: 5,
 )
 ```
-</details>
 
-#### [GET /api/v2/order](https://max.maicoin.com/documents/api_list#!/private/getApiV2Order)
+#### [GET /api/v3/withdrawal](https://max-api.maicoin.com/doc/v3.html#tag/Transaction/operation/getApiV3Withdrawal)
 
-> get a specific order.
-
-<details>
-  <summary>Show code</summary>
+> Get details of a specific external withdraw
 
 ```rb
-# use max unique order id
-@api.order(123456)
+# Query by uuid
+@private_v3_api.withdraw(uuid: '18022603540001')
+```
+
+#### [POST /api/v3/withdrawal](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/postApiV2Withdrawal)
+
+> Submit a crypto withdrawal. IP whitelist for api token is required.
+
+```rb
+@private_v3_api.create_withdraw!('withdraw_address_id', 100000)
+```
+
+#### [POST /api/v3/withdrawal/twd](https://max-api.maicoin.com/doc/v3.html#tag/Transaction/operation/postApiV3WithdrawalTwd)
+
+> Submit twd withdrawal to verified bank account. IP whitelist for api token is required.
+
+```rb
+@private_v3_api.create_twd_withdraw!(100000)
+```
+
+### Internal Transfer
+#### [GET /api/v3/internal_transfers](https://max-api.maicoin.com/doc/v3.html#tag/Transaction/operation/getApiV3InternalTransfers)
+
+> Get internal transfers history
+
+```rb
+# use default parameters
+@private_v3_api.internal_transfers
+
+# provide all possible parameters
+@private_v2_api.internal_transfers(
+  currency: 'btc',
+  side: 'in',
+  timestamp: 1624705402,
+  order_by: 'asc',
+  limit: 15,
+)
+```
+
+### Reward
+#### [GET /api/v3/rewards](https://max-api.maicoin.com/doc/v3.html#tag/Transaction/operation/getApiV3Rewards)
+
+> Get internal transfers history
+
+```rb
+# use default parameters
+@private_v3_api.rewards
+
+# provide all possible parameters
+@private_v2_api.rewards(
+  currency: 'btc',
+  reward_type: 'yield',
+  timestamp: 1624705402,
+  order_by: 'asc',
+  limit: 15,
+)
+```
+
+## SubAccount
+#### [GET /api/v3/sub_accounts](https://max-api.maicoin.com/doc/v3.html#tag/Transaction/operation/getApiV3SubAccounts)
+
+> Get sub_accounts
+
+```rb
+@private_v3_api.sub_accounts
+```
+
+#### [GET /api/v3/sub_account](https://max-api.maicoin.com/doc/v3.html#tag/Transaction/operation/getApiV3SubAccount)
+
+> Get sub_account
+
+```rb
+@private_v3_api.sub_account('s1-a7f20f')
+```
+
+#### [POST /api/v3/sub_accounts](https://max-api.maicoin.com/doc/v3.html#tag/Transaction/operation/postApiV3SubAccounts)
+
+> Create sub_account
+
+```rb
+@private_v3_api.create_sub_account!(name: 'My Test SubAccount')
+```
+
+#### [PUT /api/v3/sub_account](https://max-api.maicoin.com/doc/v3.html#tag/Transaction/operation/putApiV3SubAccount)
+
+> Update sub_account
+
+```rb
+@private_v3_api.update_sub_account!('s1-a7f20f', name: 'My Test SubAccount')
+```
+
+#### [DELETE /api/v3/sub_account](https://max-api.maicoin.com/doc/v3.html#tag/Transaction/operation/deleteApiV3SubAccount)
+
+> Delete sub_account
+
+```rb
+@private_v3_api.delete_sub_account!('s1-a7f20f')
+```
+
+#### [POST /api/v3/sub_account/transfer](https://max-api.maicoin.com/doc/v3.html#tag/Transaction/operation/postApiV3SubAccountTransfer)
+
+> Submit sub_account transfer
+
+```rb
+# Transfer from main to s1 sub-account
+@private_v3_api.current_sub_account_sn = 'main'
+@private_v3_api.create_sub_account_transfer!('s1-a7f20f', 3, 'eth')
+
+# Transfer from s1 sub-account to s2 sub-account
+@private_v3_api.current_sub_account_sn = 's1-a7f20f'
+@private_v3_api.create_sub_account_transfer!('s2-jsjwsa', 3, 'eth')
+```
+
+## Public V2 Api Examples
+
+```rb
+@public_v2_api = MaxExchangeApi::PublicV2Api.new
+```
+
+#### [GET /api/v2/vip_levels](https://max-api.maicoin.com/doc/v2.html#tag/public/operation/getApiV2VipLevels)
+
+> Get all VIP level fees.
+
+```rb
+@public_v2_api.vip_levels
+```
+
+#### [GET /api/v2/vip_levels/{level}](https://max-api.maicoin.com/doc/v2.html#tag/public/operation/getApiV2VipLevelsLevel)
+
+> Get VIP level fee by level.
+
+```rb
+@public_v2_api.vip_levels(2)
+```
+
+#### [GET /api/v2/currencies](https://max-api.maicoin.com/doc/v2.html#tag/public/operation/getApiV2Currencies)
+
+> Get all available currencies.
+
+```rb
+@public_v2_api.currencies
+```
+
+#### [GET /api/v2/k](https://max-api.maicoin.com/doc/v2.html#tag/public/operation/getApiV2K)
+
+> Get OHLC(k line) of a specific market.
+
+```rb
+# use default parameters
+@public_v2_api.k('btctwd')
+
+# provide all possible parameters
+@public_v2_api.k('btctwd', limit: 30, period: 1, timestamp: 1624705402)
+```
+
+#### [GET /api/v2/depth](https://max-api.maicoin.com/doc/v2.html#tag/public/operation/getApiV2Depth)
+
+> Get depth of a specified market.
+
+```rb
+# use default parameters
+@public_v2_api.depth('maxtwd')
+
+# provide all possible parameters
+@public_v2_api.depth('maxtwd', limit: 10, sort_by_price: true)
+```
+
+#### [GET /api/v2/trades](https://max-api.maicoin.com/doc/v2.html#tag/public/operation/getApiV2Trades)
+
+> Get recent trades on market, sorted in reverse creation order.
+
+```rb
+# use default parameters
+@public_v2_api.trades('btctwd')
+
+# provide all possible parameters
+@public_v2_api.trades(
+  'maxtwd', 
+  timestamp: 1624705402,
+  from: 68444,
+  to: 69444,
+  order_by: 'asc',
+  pagination: true,
+  page: 3,
+  limit: 15,
+  offset: 5,
+)
+```
+
+#### [GET /api/v2/markets](https://max-api.maicoin.com/doc/v2.html#tag/public/operation/getApiV2Markets)
+
+> Get all available markets.
+
+```rb
+@public_v2_api.markets
+```
+
+#### [GET /api/v2/summary](https://max-api.maicoin.com/doc/v2.html#tag/public/operation/getApiV2Summary)
+
+> Overview of market data for all tickers.
+
+```rb
+@public_v2_api.summary
+```
+
+#### [GET /api/v2/tickers/{path_market}](https://max-api.maicoin.com/doc/v2.html#tag/public/operation/getApiV2TickersPathMarket)
+
+> Get ticker of specific market.
+
+```rb
+@public_v2_api.tickers('btctwd')
+```
+
+#### [GET /api/v2/tickers](https://max-api.maicoin.com/doc/v2.html#tag/public/operation/getApiV2Tickers)
+
+> Get ticker of all markets.
+
+```rb
+@public_v2_api.tickers
+```
+
+#### [GET /api/v2/timestamp](https://max-api.maicoin.com/doc/v2.html#tag/public/operation/getApiV2Timestamp)
+
+> Get server current time, in seconds since Unix epoch.
+
+```rb
+@public_v2_api.timestamp
+```
+
+## Private V2 Api Examples
+
+```rb
+access_key = 'YOUR_ACCESS_KEY'
+secret_key = 'YOUR_SECRET_KEY'
+
+@private_v2_api = MaxExchangeApi::PrivateV2Api.new(access_key, secret_key)
+```
+
+### User
+#### [GET /api/v2/members/profile](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2MembersProfile)
+
+> get personal profile information
+
+```rb
+@private_v2_api.member_profile
+```
+
+#### [GET /api/v2/members/me](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2MembersMe)
+
+> get your profile and accounts information
+
+```rb
+@private_v2_api.me
+```
+
+#### [GET /api/v2/members/vip_level](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2MembersVipLevel)
+
+> get VIP level info
+
+```rb
+@private_v2_api.vip_level
+```
+
+### Account
+#### [GET /api/v2/members/accounts](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2MembersAccounts)
+
+> get personal accounts information
+
+```rb
+@private_v2_api.accounts
+```
+
+#### [GET /api/v2/members/accounts/{path_currency}](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2MembersAccountsPathCurrency)
+
+> get personal accounts information of a currency
+
+```rb
+@private_v2_api.account(currnecy)
+```
+
+### Order
+#### [GET /api/v2/orders](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2Orders)
+
+> get your orders, results is paginated.
+
+```rb
+# use default parameters
+@private_v2_api.orders('maxtwd')
+
+# provide all possible parameters
+@api.orders(
+  'maxtwd',
+  state: 'done',
+  order_by: 'desc',
+  group_id: 12345,
+  pagination: true,
+  page: 3,
+  limit: 15,
+  offset: 5,
+)
+```
+
+#### [GET /api/v2/order](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2Order)
+
+> get a specific order.
+
+```rb
+# use max unique order id
+@api.order(123456)
 
 # use user specified order id
 @api.order('MY_ORDER_123456', use_client_id: true)
 ```
-</details>
 
-#### [POST /api/v2/orders/clear](https://max.maicoin.com/documents/api_list#!/private/postApiV2OrdersClear)
+#### [POST /api/v2/orders/clear](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/postApiV2OrdersClear)
 
 > cancel all your orders with given market and side
 
-<details>
-  <summary>Show code</summary>
-
 ```rb
 # use default parameters
 @api.cancel_orders!
@@ -655,15 +1056,11 @@ secret_key = 'YOUR_SECRET_KEY'
 # provide all possible parameters
 @api.cancel_orders!(market: 'maxtwd', side: 'sell', group_id: '123456')
 ```
-</details>
 
-#### [POST /api/v2/order/delete](https://max.maicoin.com/documents/api_list#!/private/postApiV2OrderDelete)
+#### [POST /api/v2/order/delete](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/postApiV2OrderDelete)
 
 > cancel an order
 
-<details>
-  <summary>Show code</summary>
-
 ```rb
 # use max unique order id
 @api.cancel_order!(123456)
@@ -671,15 +1068,11 @@ secret_key = 'YOUR_SECRET_KEY'
 # use user specified order id
 @api.cancel_order!('MY_ORDER_123456', use_client_id: true)
 ```
-</details>
 
-#### [POST /api/v2/orders](https://max.maicoin.com/documents/api_list#!/private/postApiV2Orders)
+#### [POST /api/v2/orders](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/postApiV2Orders)
 
 > create a sell/buy order
 
-<details>
-  <summary>Show code</summary>
-
 ```rb
 # use default parameters
 @api.create_order!('maxtwd', 'buy', 1000, price: 7.5)
@@ -696,29 +1089,261 @@ secret_key = 'YOUR_SECRET_KEY'
   group_id: 12345678,
 )
 ```
-</details>
 
-#### [POST /api/v2/orders/multi/onebyone](https://max.maicoin.com/documents/api_list#!/private/postApiV2OrdersMultiOnebyone)
+#### [POST /api/v2/orders/multi/onebyone](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/postApiV2OrdersMultiOnebyone)
 
 > Create multiple sell/buy orders, orders may be partially accepted, please put your orders as an array in json body.
 
-<details>
-  <summary>Show code</summary>
-
 ```rb
 # use default parameters
 @api.create_orders!('maxtwd', [
-  { side: 'buy', volume: '1000', price: 7.5 },
-  { side: 'buy', volume: '1500', price: 7.2 },
+  { side: 'buy', volume: '1000', price: '7.5' },
+  { side: 'buy', volume: '1500', price: '7.2' },
 ])
 
 # provide all possible parameters
 @api.create_orders!('maxtwd', [
-  { side: 'buy', volume: '1000', price: 7.5, client_oid: 'MY_ORDER_ID_12345', stop_price: 8, ord_type: 'limit' },
-  { side: 'buy', volume: '1500', price: 7.2, client_oid: 'MY_ORDER_ID_12346', stop_price: 8, ord_type: 'limit' },
+  { side: 'buy', volume: '1000', price: '7.5', client_oid: 'MY_ORDER_ID_12345', stop_price: '8', ord_type: 'limit' },
+  { side: 'buy', volume: '1500', price: '7.2', client_oid: 'MY_ORDER_ID_12346', stop_price: '8', ord_type: 'limit' },
 ], group_id: 12345)
 ```
-</details>
+
+### Trade
+#### [GET /api/v2/trades/my/of_order](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2TradesMyOfOrder)
+
+> get your executed trades related to a order
+
+```rb
+# use max unique order id
+@private_v2_api.my_trades_of_order(123456)
+
+# use user specified order id
+@private_v2_api.my_trades_of_order('MY_ORDER_123456', use_client_id: true)
+```
+
+#### [GET /api/v2/trades/my](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2TradesMy)
+
+> get your executed trades, sorted in reverse creation order
+
+```rb
+# use default parameters
+@private_v2_api.my_trades('btctwd')
+
+# provide all possible parameters
+@private_v2_api.my_trades(
+  'maxtwd',
+  timestamp: 1624705402,
+  from: 68444,
+  to: 69444,
+  order_by: 'asc',
+  pagination: true,
+  page: 3,
+  limit: 15,
+  offset: 5,
+)
+```
+
+### Deposit
+#### [GET /api/v2/deposits](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2Deposits)
+
+> get your deposits history
+
+```rb
+# use default parameters
+@private_v2_api.deposits('max')
+
+# provide all possible parameters
+@private_v2_api.deposits(
+  'max',
+  'confirmed',
+  from: 68444,
+  to: 69444,
+  state: 'accepted',
+  pagination: true,
+  page: 3,
+  limit: 15,
+  offset: 5,
+)
+```
+
+#### [GET /api/v2/deposit](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2Deposit)
+
+> get details of a specific deposit
+
+```rb
+@private_v2_api.deposit('transaction_id')
+```
+
+#### [GET /api/v2/deposit_addresses](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2DepositAddresses)
+
+> The addresses could be empty before generated, please call POST /deposit_addresses in that case
+
+```rb
+# use default parameters
+@private_v2_api.deposit_addresses
+
+# provide all possible parameters
+@private_v2_api.deposit_addresses(currency: 'twd', pagination: true, page: 3, limit: 15, offset: 5)
+```
+
+#### [POST /api/v2/deposit_addresses](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/postApiV2DepositAddresses)
+
+> Address creation is asynchronous, please call GET /deposit_addresses later to get generated addresses
+
+```rb
+@private_v2_api.create_deposit_addresses!('twd')
+```
+
+### Withdrawal
+#### [GET /api/v2/withdrawals](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2Withdrawals)
+
+> get your external withdrawals history
+
+```rb
+# use default parameters
+@private_v2_api.withdrawals('max')
+
+# provide all possible parameters
+@private_v2_api.withdrawals(
+  'max',
+  'confirmed',
+  from: 68444,
+  to: 69444,
+  state: 'confirmed',
+  pagination: true,
+  page: 3,
+  limit: 15,
+  offset: 5,
+)
+```
+
+#### [GET /api/v2/withdrawal](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2Withdrawal)
+
+> get details of a specific external withdraw
+
+```rb
+@private_v2_api.withdrawal('withdraw_id')
+```
+
+#### [POST /api/v2/withdrawal](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/postApiV2Withdrawal)
+
+> submit a withdrawal. IP whitelist for api token is required.
+
+```rb
+@private_v2_api.create_withdrawal!('twd', 'withdraw_address_id', 100000)
+```
+
+#### [GET /api/v2/withdraw_addresses](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2WithdrawAddresses)
+
+> get withdraw addresses
+
+```rb
+# use default parameters
+@private_v2_api.withdraw_addresses('twd')
+
+# provide all possible parameters
+@private_v2_api.withdraw_addresses('usdt', pagination: true, page: 3, limit: 15, offset: 5)
+```
+
+### Internal Transfer
+#### [GET /api/v2/internal_transfers](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2InternalTransfers)
+
+> get internal transfers history
+
+```rb
+# use default parameters
+@private_v2_api.internal_transfers
+
+# provide all possible parameters
+@private_v2_api.internal_transfers(
+  currency: 'btc',
+  side: 'in',
+  from: 68444,
+  to: 69444,
+  pagination: true, 
+  page: 3, 
+  limit: 15, 
+  offset: 5,
+)
+```
+
+#### [GET /api/v2/internal_transfer](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2InternalTransfer)
+
+> get details of a specific internal transfer
+
+```rb
+@private_v2_api.internal_transfer('internal_transfer_id')
+```
+
+### Reward
+#### [GET /api/v2/rewards](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2Rewards)
+
+> get rewards history
+
+```rb
+# use default parameters
+@private_v2_api.rewards
+
+# provide all possible parameters
+@private_v2_api.rewards(
+  currency: 'btc',
+  from: 68444,
+  to: 69444,
+  pagination: true,
+  page: 3,
+  limit: 15,
+  offset: 5,
+)
+```
+
+#### [GET /api/v2/rewards/{path_reward_type}](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2RewardsPathRewardType)
+
+> get specific rewards history
+
+```rb
+# use default parameters
+@private_v2_api.rewards(reward_type: 'airdrop_rewards')
+
+# provide all possible parameters
+@private_v2_api.rewards(
+  reward_type: 'airdrop_rewards',
+  currency: 'btc',
+  from: 68444,
+  to: 69444,
+  pagination: true,
+  page: 3,
+  limit: 15,
+  offset: 5,
+)
+```
+
+#### [GET /api/v2/max_rewards/yesterday](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2MaxRewardsYesterday)
+
+> get max rewards yesterday
+
+```rb
+@private_v2_api.max_rewards_yesterday
+```
+
+#### [GET /api/v2/yields](https://max-api.maicoin.com/doc/v2.html#tag/private/operation/getApiV2Yields)
+
+> get yields history
+
+```rb
+# use default parameters
+@private_v2_api.yields
+
+# provide all possible parameters
+@private_v2_api.yields(
+  currency: 'usdt',
+  from: 68444,
+  to: 69444,
+  pagination: true,
+  page: 3,
+  limit: 15,
+  offset: 5,
+)
+```
 
 ## Development