ftx-api 0.2.3 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 720fabc9ebb722b1831297bd96d66576c65e6b5b8dcd94214e23ba24017e4d02
-  data.tar.gz: 8fe4038ce8e62028216d0b594e5a45e26684642a33682bec42358589ad31b706
+  metadata.gz: be471f1211cee30497ce74db4b05da88d05345bc8ada1966d26495db15f18890
+  data.tar.gz: e7ee23d92d2cf4782b2fcdbdf2c09232460ccafaeb0de6b09bf686bdb3cf4e55
 SHA512:
-  metadata.gz: a538f6f23ca72be51f7a0c833ba757f939c66d32089badcc69f4c9e2fbd03f4725e799a7e07b0419c1af13c2c1d7d296024f349b59d2ea78647463dfe199c406
-  data.tar.gz: 9ad931c775665f6084ed7f37fc2377fe49d38edd17f5872142d1b2a95b8e7a7b3f57212c78866c5563e496260814c3a0fc039674d6eb51b6b04c7ab30b55b3ad
+  metadata.gz: 552a6ed552f1b7ac7fa6063feb2698dd06d6693f38b20cee6fb07cf9bd6eb9b45ac8b3a7db2b1c5210c9dbc5eda695e638508785dce980045f8eadd57d337f68
+  data.tar.gz: 4c4f43ce73556ef89af1139f665ba24cb39d83837db32e4461054d8fef9aba8bfa2c6a0801827e92c3dba303814d5aab359443dd37e22df18acccf20b8adb8c4

data/CHANGELOG.md

@@ -4,4 +4,25 @@
 - Initial release
 
 ## [0.2.0] - 2021-09-23
-- Implement public API covering Markets and Futures only
+- Implement public API covering Markets and Futures only
+
+## [0.2.1] - 2021-09-23
+- Empty
+
+## [0.2.2] - 2021-10-05
+- Include private API endpoints with tests
+
+## [0.2.3] - 2021-10-05
+- Include private API endpoints with tests - further updates
+
+## [0.2.4] - 2021-10-05
+- Fix error compact_blank creates for rails db:migrate
+
+## [0.2.5] - 2021-10-06
+- Fix issues with post methods and add Convert endpoint
+
+## [0.2.6] - 2021-10-06
+- Implement Fills endpoint including tests
+
+## [0.2.7] - 2021-10-06
+- Implement orders get_by_client_id endpoint

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ftx-api (0.2.3)
+    ftx-api (0.2.7)
       httparty (~> 0.19)
       openssl (~> 2.2)
 

data/README.md

@@ -4,8 +4,6 @@ This gem is a ruby SDK for the FTX crypto exchange REST API.
 
 API docs can be found on the [FTX developer site](https://docs.ftx.com/)
 
-It is still under development and currently only covers the markets and futures endpoints.
-
 
 ## Installation
 
@@ -128,9 +126,14 @@ Query for all historical orders:
 orders.history
 ```
 
-Fetch a specific order:
+Fetch a specific order by FTX `orderId`:
 ```ruby
-orders.get
+orders.get(order_id)
+```
+
+Fetch a specific order by `clientId`:
+```ruby
+orders.get_by_client_id(clientId)
 ```
 
 Create a new order:
@@ -154,9 +157,65 @@ Note: the create order method is not included as a test, because I have not been
 
 *Check the [FTX API docs](https://docs.ftx.com/#orders) for all parameters*
 
+### Fills
+
+Initialize an fills session:
+```ruby
+fills = FXT::API::Orders.new(key: 'YOUR FTX KEY', secret: 'YOUR FTX SECRET')
+```
+
+Query for all fills:
+```ruby
+fills.list
+```
+or
+
+```ruby
+fills.list(market: 'BTC/USD')
+```
+
+Note: market is optional
+
+### Convert Coins
+
+Initialize an convert session:
+```ruby
+convert = FXT::API::Convert.new(key: 'YOUR FTX KEY', secret: 'YOUR FTX SECRET')
+```
+
+Create a new quote:
+```ruby
+args = {
+      size:         0.01,   # 0.01 is the smallest increment
+      fromCoin:     "USD",
+      toCoin:       "BTC",
+    }
+
+convert.new_quote(args)
+```
+
+Response:
+```ruby
+{:quoteId=>2*******3}
+```
+
+Fetch a quote:
+```ruby
+convert.get_quote('quoteId')
+```
+
+Accept a quote:
+```ruby
+convert.accept_quote('quoteId')
+```
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You'll need to add environment variables ENV['FTX_KEY'] and ENV['FTX_SECRET']. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+
+You'll then need to add environment variables `ENV['FTX_KEY']` and `ENV['FTX_SECRET']`. API keys can be created in your [FTX settings page](https://ftx.com/profile).
+
+Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/ext/array.rb

@@ -4,7 +4,7 @@ class Array
 		map(&:symbolize_keys)
 	end
 
-	def compact_blank
+	def compact_empty
 		delete_if {|i| i.respond_to?(:empty?) ? !!i.empty? : !i }
 	end
 	

data/lib/ftx/api/base.rb

@@ -4,11 +4,11 @@ require 'httparty'
 
 class FTX::API::Base
   
+  attr_reader :config, :key, :secret
+
   include HTTParty
   base_uri 'https://ftx.com/api'
 
-  attr_reader :config, :key, :secret
-
   def initialize(args = {})
     @config = FTX::API::Config.new(args.dig(:config))
     @key = args.dig(:key)
@@ -21,16 +21,21 @@ class FTX::API::Base
     uuid = SecureRandom.uuid
     print_log(:info, "[API] #{uuid} #{method.upcase} '#{path}' query = #{query}")
 
-    body_or_query = method == :get ? :query : :body
+    if method == :get
+      body_or_query = :query
+    else
+      body_or_query = :body
+      query = query.to_json
+    end
 
     begin
       response = self.class.send(
-        method,
-        path,
+        method, 
+        path, 
         headers: headers,
         timeout: @config.timeout,
-        body_or_query => query,
-      ).parsed_response
+        body_or_query.to_sym => query
+      )
 
       print_log(:info, "[API] #{uuid} response #{response}")
       return parse_response(response)
@@ -43,6 +48,7 @@ class FTX::API::Base
   private
 
   def parse_response(response)
+    response = response.parsed_response
     if response.dig("success")
       response.dig("result").symbolize_keys
     else
@@ -54,7 +60,6 @@ class FTX::API::Base
     logger = @config.logger
     if logger
       puts "#{method}: #{message}"
-      # logger[method] = message
     end
   end
   

data/lib/ftx/api/convert.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'private'
+
+class FTX::API::Convert < FTX::API::Private
+
+  def new_quote(query = {})
+    raise ArgumentError.new(
+      "Size, fromCoin, toCoin params required"
+      ) unless [:fromCoin, :toCoin, :size].all? { |i| query.include? i }
+    
+    send_request(:post, "/otc/quotes", query)
+  end
+
+  def get_quote(quote_id)
+    send_request(:get, "/otc/quotes/#{quote_id}", {})
+  end
+
+  def accept_quote(quote_id)   
+    send_request(:post, "/otc/quotes/#{quote_id}/accept", {})
+  end
+  
+end

data/lib/ftx/api/fills.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'private'
+
+class FTX::API::Fills < FTX::API::Private
+
+  def list(query = {})
+    send_request(:get, "/fills", query)
+  end
+  
+end

data/lib/ftx/api/orders.rb

@@ -16,6 +16,10 @@ class FTX::API::Orders < FTX::API::Private
     send_request(:get, "/orders/#{order_id}", {})
   end
 
+  def get_by_client_id(client_id)
+    send_request(:get, "/orders/by_client_id/#{client_id}", {})
+  end
+
   def create(query = {})
     raise ArgumentError.new(
       "Market, side, price (can be nil), tupe and size params required"

data/lib/ftx/api/private.rb

@@ -15,6 +15,8 @@ class FTX::API::Private < FTX::API::Base
       'FTX-KEY' => key,
       'FTX-SIGN' => signature(*args),
       'FTX-TS' => ts.to_s,
+      'Content-Type' => 'application/json',
+      'Accepts' => 'application/json',
     }
   end
 
@@ -23,15 +25,15 @@ class FTX::API::Private < FTX::API::Base
   end
 
   def signature_payload(method, path, query)
-    payload = [ts, method.to_s.upcase, "/api", path].compact_blank
+    payload = [ts, method.to_s.upcase, "/api", path].compact_empty
     
     if method==:post
-      payload.push(query.to_json)
+      payload << query.to_json
     elsif method==:get
-      payload.push("?" + URI.encode_www_form(query))
+      payload << ("?" + URI.encode_www_form(query))
     end unless query.empty?
 
-    "#{payload.join}".encode("UTF-8")
+    payload.join.encode("UTF-8")
   end
 
   def ts

data/lib/ftx/api/version.rb

@@ -2,6 +2,6 @@
 
 module FTX
   module API
-    VERSION = "0.2.3"
+    VERSION = "0.2.7"
   end
 end

data/lib/ftx/api.rb

@@ -3,7 +3,9 @@ require_relative "../ext/base"
 require_relative "api/version"
 require_relative "api/config"
 require_relative "api/markets"
+require_relative "api/futures"
 require_relative "api/account"
 require_relative "api/wallet"
 require_relative "api/orders"
-require_relative "api/futures"
+require_relative "api/fills"
+require_relative "api/convert"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ftx-api
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.7
 platform: ruby
 authors:
 - benrs44
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-05 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -63,6 +63,8 @@ files:
 - lib/ftx/api/account.rb
 - lib/ftx/api/base.rb
 - lib/ftx/api/config.rb
+- lib/ftx/api/convert.rb
+- lib/ftx/api/fills.rb
 - lib/ftx/api/futures.rb
 - lib/ftx/api/markets.rb
 - lib/ftx/api/orders.rb