max_exchange_api 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71535a1c969d383e36c7af1860aeab28c78f55fb62d0e2ef4cb05c9fe8d0df27
-  data.tar.gz: c132f2796b57303bfd288a64f0b14cf966d4117568dadb02b606270c316d08c7
+  metadata.gz: 29e67831c545b85f3e39db7cdab7dcbf293c8d2958a5fed7affa29b2617d4a79
+  data.tar.gz: '08ba7fe4b157b1abcd9611e47c170c406975dcea7497cc9be6490ec7bd3985f3'
 SHA512:
-  metadata.gz: f51b1539a5cbc487c325fec8b46e5ef38b6c12f4fd909631769fba2e2d82bdbe8dba39ae0130919ca6951aed220e677ec07f64e5d465907fdb0d4cae7224080d
-  data.tar.gz: 2afa7b1325fe0756f92416b33e762b9fd264abb6ff4615d6495c4e1d92e8c265b92f680ce8ede43c4e408503cacd15f8b0d9adf84ce31799ca2d25a4aa360e1c
+  metadata.gz: c10c08e3462a21a8ea9cb5be83327d06bdc8e406757895004ef31ed38df4606903337edbf7c07e0c5944ca88f8817c203abd7319369cbe763fed74785d3a788a
+  data.tar.gz: dd2bc0c74f8ae55bb1df54cfed702c6c908678ebca08f10c4181adc26162b23401ecaaddbbe9ff2698a9a96fb0662a041431044b2f6327d26285dba12b62c10a

data/CHANGELOG.md

@@ -1,4 +1,8 @@
 ## Change Log
 
+### [v0.1.0](https://github.com/khiav223577/max_exchange_api/compare/v0.0.1...v0.1.0) 2021/06/26
+- [#3](https://github.com/khiav223577/max_exchange_api/pull/3) Add default_timeout config (@khiav223577)
+- [#2](https://github.com/khiav223577/max_exchange_api/pull/2) Implement all v2 public APIs (@khiav223577)
+
 ### v0.0.1 2021/06/23
 - [#1](https://github.com/khiav223577/max_exchange_api/pull/1) Implement `/depth` API (@khiav223577)

data/README.md

@@ -35,12 +35,21 @@ Or install it yourself as:
 
     $ gem install max_exchange_api
 
-## Default config
+## Configuration
 
-Change default api timeout time (in seconds)
+### Api timeout time
 
 ```rb
-MaxExchangeApi.config.default_timeout = 3
+MaxExchangeApi.default_config.timeout = 3 # seconds
+```
+
+### Api logging
+
+```rb
+require 'logger'
+
+MaxExchangeApi.default_config.logger = Logger.new(STDOUT) # print log to stdand output
+MaxExchangeApi.default_config.logger = Logger.new('log/api.log')
 ```
 
 ## Usage
@@ -205,6 +214,476 @@ MaxExchangeApi.config.default_timeout = 3
 ```
 </details>
 
+### Private Api Examples
+
+```rb
+access_key = 'YOUR_ACCESS_KEY'
+secret_key = 'YOUR_SECRET_KEY'
+
+@api = MaxExchangeApi::PrivateApi.new(access_key, secret_key)
+```
+
+### 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
+
+<details>
+  <summary>Show code</summary>
+
+```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)
+```
+</details>
+
+#### [GET /api/v2/trades/my](https://max.maicoin.com/documents/api_list#!/private/getApiV2TradesMy)
+
+> get your executed trades, sorted in reverse creation order
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+# use default parameters
+@api.my_trades('btctwd')
+
+# provide all possible parameters
+@api.my_trades(
+  'maxtwd',
+  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
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+# use default parameters
+@api.withdrawals('max')
+
+# provide all possible parameters
+@api.withdrawals(
+  'max',
+  'confirmed',
+  from: 68444,
+  to: 69444,
+  state: 'confirmed',
+  pagination: true,
+  page: 3,
+  limit: 15,
+  offset: 5,
+)
+```
+</details>
+
+#### [GET /api/v2/withdrawal](https://max.maicoin.com/documents/api_list#!/private/getApiV2Withdrawal)
+
+> get details of a specific external withdraw
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+@api.withdrawal('withdraw_id')
+```
+</details>
+
+#### [POST /api/v2/withdrawal](https://max.maicoin.com/documents/api_list#!/private/postApiV2Withdrawal)
+
+> submit a withdrawal. IP whitelist for api token is required.
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+@api.create_withdrawal!('twd', 'withdraw_address_id', 100000)
+```
+</details>
+
+### Profile
+#### [GET /api/v2/members/profile](https://max.maicoin.com/documents/api_list#!/private/getApiV2MembersProfile)
+
+> get personal profile information
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+@api.member_profile
+```
+</details>
+
+#### [GET /api/v2/members/me](https://max.maicoin.com/documents/api_list#!/private/getApiV2MembersMe)
+
+> get your profile and accounts information
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+@api.me
+```
+</details>
+
+#### [GET /api/v2/members/vip_level](https://max.maicoin.com/documents/api_list#!/private/getApiV2MembersVipLevel)
+
+> get VIP level info
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+@api.vip_level
+```
+</details>
+
+### Account
+#### [GET /api/v2/members/accounts](https://max.maicoin.com/documents/api_list#!/private/getApiV2MembersAccounts)
+
+> get personal accounts information
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+@api.accounts
+```
+</details>
+
+#### [GET /api/v2/members/accounts/{path_currency}](https://max.maicoin.com/documents/api_list#!/private/getApiV2MembersAccountsPathCurrency)
+
+> get personal accounts information of a currency
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+@api.account(currnecy)
+```
+</details>
+
+### Deposit
+#### [GET /api/v2/deposits](https://max.maicoin.com/documents/api_list#!/private/getApiV2Deposits)
+
+> get your deposits history
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+# use default parameters
+@api.deposits('max')
+
+# provide all possible parameters
+@api.deposits(
+  'max',
+  'confirmed',
+  from: 68444,
+  to: 69444,
+  state: 'accepted',
+  pagination: true,
+  page: 3,
+  limit: 15,
+  offset: 5,
+)
+```
+</details>
+
+#### [GET /api/v2/deposit](https://max.maicoin.com/documents/api_list#!/private/getApiV2Deposit)
+
+> get details of a specific deposit
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+@api.deposit('transaction_id')
+```
+</details>
+
+### Address
+#### [GET /api/v2/deposit_addresses](https://max.maicoin.com/documents/api_list#!/private/getApiV2DepositAddresses)
+
+> The addresses could be empty before generated, please call POST /deposit_addresses in that case
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+# use default parameters
+@api.deposit_addresses
+
+# provide all possible parameters
+@api.deposit_addresses(currency: 'twd', pagination: true, page: 3, limit: 15, offset: 5)
+```
+</details>
+
+#### [POST /api/v2/deposit_addresses](https://max.maicoin.com/documents/api_list#!/private/postApiV2DepositAddresses)
+
+> Address creation is asynchronous, please call GET /deposit_addresses later to get generated addresses
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+@api.create_deposit_addresses!('twd')
+```
+</details>
+
+#### [GET /api/v2/withdraw_addresses](https://max.maicoin.com/documents/api_list#!/private/getApiV2WithdrawAddresses)
+
+> get withdraw addresses
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+# use default parameters
+@api.withdraw_addresses('twd')
+
+# provide all possible parameters
+@api.withdraw_addresses('usdt', pagination: true, page: 3, limit: 15, offset: 5)
+```
+</details>
+
+### Internal Transfer
+#### [GET /api/v2/internal_transfers](https://max.maicoin.com/documents/api_list#!/private/getApiV2InternalTransfers)
+
+> get internal transfers history
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+# use default parameters
+@api.internal_transfers
+
+# provide all possible parameters
+@api.internal_transfers(
+  currency: 'btc',
+  side: 'in',
+  from: 68444,
+  to: 69444,
+  pagination: true, 
+  page: 3, 
+  limit: 15, 
+  offset: 5,
+)
+```
+</details>
+
+#### [GET /api/v2/internal_transfer](https://max.maicoin.com/documents/api_list#!/private/getApiV2InternalTransfer)
+
+> get details of a specific internal transfer
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+@api.internal_transfer('internal_transfer_id')
+```
+</details>
+
+### Reward
+#### [GET /api/v2/rewards](https://max.maicoin.com/documents/api_list#!/private/getApiV2Rewards)
+
+> get rewards history
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+# use default parameters
+@api.rewards
+
+# provide all possible parameters
+@api.rewards(
+  currency: 'btc',
+  from: 68444,
+  to: 69444,
+  pagination: true,
+  page: 3,
+  limit: 15,
+  offset: 5,
+)
+```
+</details>
+
+#### [GET /api/v2/rewards/{path_reward_type}](https://max.maicoin.com/documents/api_list#!/private/getApiV2RewardsPathRewardType)
+
+> get specific rewards history
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+# use default parameters
+@api.rewards(reward_type: 'airdrop_rewards')
+
+# provide all possible parameters
+@api.rewards(
+  reward_type: 'airdrop_rewards',
+  currency: 'btc',
+  from: 68444,
+  to: 69444,
+  pagination: true,
+  page: 3,
+  limit: 15,
+  offset: 5,
+)
+```
+</details>
+
+#### [GET /api/v2/max_rewards/yesterday](https://max.maicoin.com/documents/api_list#!/private/getApiV2MaxRewardsYesterday)
+
+> get max rewards yesterday
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+@api.max_rewards_yesterday
+```
+</details>
+
+### Order
+#### [GET /api/v2/orders](https://max.maicoin.com/documents/api_list#!/private/getApiV2Orders)
+
+> get your orders, results is paginated.
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+# use default parameters
+@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,
+)
+```
+</details>
+
+#### [GET /api/v2/order](https://max.maicoin.com/documents/api_list#!/private/getApiV2Order)
+
+> get a specific order.
+
+<details>
+  <summary>Show code</summary>
+
+```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)
+
+> cancel all your orders with given market and side
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+# use default parameters
+@api.cancel_orders!
+
+# 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)
+
+> cancel an order
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+# use max unique order id
+@api.cancel_order!(123456)
+
+# 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)
+
+> create a sell/buy order
+
+<details>
+  <summary>Show code</summary>
+
+```rb
+# use default parameters
+@api.create_order!('maxtwd', 'buy', 1000, price: 7.5)
+
+# provide all possible parameters
+@api.create_order!(
+  'maxtwd',
+  'buy',
+  1000,
+  price: 7.5,
+  client_oid: 'MY_ORDER_ID_12345',
+  stop_price: 8,
+  ord_type: 'limit',
+  group_id: 12345678,
+)
+```
+</details>
+
+#### [POST /api/v2/orders/multi/onebyone](https://max.maicoin.com/documents/api_list#!/private/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 },
+])
+
+# 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' },
+], group_id: 12345)
+```
+</details>
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/max_exchange_api.rb

@@ -1,3 +1,4 @@
 require 'max_exchange_api/version'
 require 'max_exchange_api/config'
 require 'max_exchange_api/public_api'
+require 'max_exchange_api/private_api'

data/lib/max_exchange_api/base_api.rb

@@ -19,7 +19,7 @@ module MaxExchangeApi
           path,
           headers: headers,
           query: query,
-          timeout: MaxExchangeApi.config.default_timeout,
+          timeout: MaxExchangeApi.default_config.timeout,
         ).parsed_response
 
         print_log(:info, "[API] #{uuid} response #{response}")
@@ -32,8 +32,9 @@ module MaxExchangeApi
 
     private
 
-    def print_log(_method, message)
-      puts message
+    def print_log(method, message)
+      logger = MaxExchangeApi.default_config.logger
+      logger.send(method, message) if logger
     end
   end
 end

data/lib/max_exchange_api/config.rb

@@ -2,16 +2,18 @@
 
 module MaxExchangeApi
   class Config
-    attr_accessor :default_timeout
+    attr_accessor :timeout
+    attr_accessor :logger
 
     def initialize
-      @default_timeout = 3
+      @timeout = 3
+      @logger = nil
     end
   end
 
-  @config = Config.new
+  @default_config = Config.new
 
   class << self
-    attr_reader :config
+    attr_reader :default_config
   end
 end

data/lib/max_exchange_api/helper.rb

@@ -2,5 +2,26 @@
 
 module MaxExchangeApi
   module Helper
+    class << self
+      def gen_headers(payload, access_key, secret_key)
+        encoded_payload = encode(payload)
+
+        return {
+          'X-MAX-ACCESSKEY' => access_key,
+          'X-MAX-PAYLOAD'   => encoded_payload,
+          'X-MAX-SIGNATURE' => encrypt(encoded_payload, secret_key),
+        }
+      end
+
+      private
+
+      def encode(data)
+        Base64.strict_encode64(data.to_json)
+      end
+
+      def encrypt(data, key)
+        OpenSSL::HMAC.digest('sha256', key, data).unpack('H*')[0]
+      end
+    end
   end
 end

data/lib/max_exchange_api/private_api.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+require 'max_exchange_api/base_api'
+
+module MaxExchangeApi
+  class PrivateApi < BaseApi
+    base_uri 'https://max-api.maicoin.com/api/v2'
+
+    def initialize(access_key, secret_key)
+      super()
+
+      @access_key = access_key
+      @secret_key = secret_key
+    end
+
+    def my_trades_of_order(order_id, use_client_id: false)
+      id_params_key = use_client_id ? :client_oid : :id
+      send_request(:get, '/trades/my/of_order', id_params_key => order_id)
+    end
+
+    def my_trades(market, timestamp: nil, from: nil, to: nil, order_by: 'desc', pagination: true, page: 1, limit: 50,
+                  offset: 0)
+      send_request(
+        :get,
+        '/trades/my',
+        market: market,
+        timestamp: timestamp,
+        from: from,
+        to: to,
+        order_by: order_by,
+        pagination: pagination,
+        page: page,
+        limit: limit,
+        offset: offset,
+      )
+    end
+
+    def member_profile
+      send_request(:get, '/members/profile', {})
+    end
+
+    def me
+      send_request(:get, '/members/me', {})
+    end
+
+    def vip_level
+      send_request(:get, '/members/vip_level', {})
+    end
+
+    def accounts
+      send_request(:get, '/members/accounts', {})
+    end
+
+    def account(currency)
+      send_request(:get, "/members/accounts/#{currency}", {})
+    end
+
+    def deposits(currency, from: nil, to: nil, state: nil, pagination: nil, page: 1, limit: 50,
+                 offset: 0)
+      send_request(
+        :get,
+        '/deposits',
+        currency: currency,
+        from: from,
+        to: to,
+        state: state,
+        pagination: pagination,
+        page: page,
+        limit: limit,
+        offset: offset,
+      )
+    end
+
+    def deposit(transaction_id)
+      send_request(:get, '/deposit', txid: transaction_id)
+    end
+
+    def deposit_addresses(currency: nil, pagination: nil, page: 1, limit: 50, offset: 0)
+      send_request(
+        :get,
+        '/deposit_addresses',
+        currency: currency,
+        pagination: pagination,
+        page: page,
+        limit: limit,
+        offset: offset,
+      )
+    end
+
+    def create_deposit_addresses!(currency)
+      send_request(:post, '/deposit_addresses', currency: currency)
+    end
+
+    def withdraw_addresses(currency, pagination: nil, page: 1, limit: 50, offset: 0)
+      send_request(
+        :get,
+        '/withdraw_addresses',
+        currency: currency,
+        pagination: pagination,
+        page: page,
+        limit: limit,
+        offset: offset,
+      )
+    end
+
+    def withdrawal(withdraw_id)
+      send_request(:get, '/withdrawal', uuid: withdraw_id)
+    end
+
+    def withdrawals(currency, from: nil, to: nil, state: nil, pagination: nil, page: 1, limit: 50,
+                    offset: 0)
+      send_request(
+        :get,
+        '/withdrawals',
+        currency: currency,
+        from: from,
+        to: to,
+        state: state,
+        pagination: pagination,
+        page: page,
+        limit: limit,
+        offset: offset,
+      )
+    end
+
+    def create_withdrawal!(currency, withdraw_address_id, amount)
+      send_request(:post, '/withdrawal', currency: currency, withdraw_address_uuid: withdraw_address_id, amount: amount)
+    end
+
+    def internal_transfers(currency: nil, side: 'in', from: nil, to: nil, pagination: nil, page: 1, limit: 50,
+                           offset: 0)
+      send_request(
+        :get,
+        '/internal_transfers',
+        currency: currency,
+        side: side,
+        from: from,
+        to: to,
+        pagination: pagination,
+        page: page,
+        limit: limit,
+        offset: offset,
+      )
+    end
+
+    def internal_transfer(internal_transfer_id)
+      send_request(:get, '/internal_transfer', uuid: internal_transfer_id)
+    end
+
+    def rewards(reward_type: nil, currency: nil, from: nil, to: nil, pagination: nil, page: 1, limit: 50, offset: 0)
+      path = reward_type ? '/rewards' : "/rewards/#{reward_type}"
+      send_request(
+        :get,
+        path,
+        currency: currency,
+        from: from,
+        to: to,
+        pagination: pagination,
+        page: page,
+        limit: limit,
+        offset: offset,
+      )
+    end
+
+    def max_rewards_yesterday
+      send_request(:get, '/max_rewards/yesterday', {})
+    end
+
+    def orders(market, state: nil, order_by: 'asc', group_id: nil, pagination: nil, page: 1, limit: 50, offset: 0)
+      send_request(
+        :get,
+        '/orders',
+        market: market,
+        state: state,
+        order_by: order_by,
+        group_id: group_id,
+        pagination: pagination,
+        page: page,
+        limit: limit,
+        offset: offset,
+      )
+    end
+
+    def order(order_id, use_client_id: false)
+      id_params_key = use_client_id ? :client_oid : :id
+      send_request(:get, '/order', id_params_key => order_id)
+    end
+
+    def cancel_orders!(market: nil, side: nil, group_id: nil)
+      send_request(:post, '/orders/clear', market: market, side: side, group_id: group_id)
+    end
+
+    def cancel_order!(order_id, use_client_id: false)
+      id_params_key = use_client_id ? :client_oid : :id
+      send_request(:post, '/order/delete', id_params_key => order_id)
+    end
+
+    def create_order!(market, side, volume, price: nil, client_oid: nil, stop_price: nil, ord_type: nil, group_id: nil)
+      send_request(
+        :post,
+        '/orders',
+        market: market,
+        side: side,
+        volume: volume,
+        price: price,
+        client_oid: client_oid,
+        stop_price: stop_price,
+        ord_type: ord_type,
+        group_id: group_id,
+      )
+    end
+
+    def create_orders!(market, orders, group_id: nil)
+      send_request(:post, '/orders/multi/onebyone', market: market, orders: orders, group_id: group_id)
+    end
+
+    protected
+
+    def send_request(method, path, query)
+      query = query.compact
+      query.merge!(path: "/api/v2#{path}", nonce: (Time.now.to_f * 1000).to_i)
+      return super(method, path, Helper.gen_headers(query, @access_key, @secret_key), query)
+    end
+  end
+end

data/lib/max_exchange_api/version.rb

@@ -1,3 +1,3 @@
 module MaxExchangeApi
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: max_exchange_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - khiav reoy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-26 00:00:00.000000000 Z
+date: 2021-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,7 @@ files:
 - lib/max_exchange_api/base_api.rb
 - lib/max_exchange_api/config.rb
 - lib/max_exchange_api/helper.rb
+- lib/max_exchange_api/private_api.rb
 - lib/max_exchange_api/public_api.rb
 - lib/max_exchange_api/version.rb
 - max_exchange_api.gemspec