ftx-api 0.2.4 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 798edaba47ec4e363488fe462aafc23a07600270944492e0df2de61bb3a0df39
-  data.tar.gz: 76bf0b23ced4ce5dd444d83dba36a8703481b859f16f05501c52750ec9928522
+  metadata.gz: 034ffdddca45eba8aefa59494ee718e329324b637f50585412eea9500a17011f
+  data.tar.gz: 6a19fc208851effb64df469a145d6ac76a94ea3ad6b2b4c338f07d99b7de57dd
 SHA512:
-  metadata.gz: f7ca004638de0447346204c8be75d8368c1d7208c70bcdaf02b35127e7d863c477abb03deb2a1b04c853ac28c7d229ba6a681a66afd9b978364134525379d254
-  data.tar.gz: 94fa7cc56036cd1911d2a7faa93043359749e46c6be75975128dbc3342fcce4225babebcf98d5ba3260361bd499f2dd51e9c17c780edfe850c35ae74e6f000dd
+  metadata.gz: e04b01cdc2240f3a69d8f3f7d2751d02f932fca080ee118918444a63b33b498cef423a090eaeeb5537244cb0513107a82e88ab9dc120f0e738df1c6465359d06
+  data.tar.gz: e8edc6cceb16276c0803185f1f025256e5b419d880dffc8487f53a1195e1b715b00cccc391be790229b8ba49d3c403fb1e2e03e1a54a6848654c39a9abb0190d

data/CHANGELOG.md

@@ -4,4 +4,28 @@
 - 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
+
+## [0.2.8] - 2021-10-18
+- Implement funding endpoints

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ftx-api (0.2.4)
+    ftx-api (0.2.8)
       httparty (~> 0.19)
       openssl (~> 2.2)
 
@@ -69,4 +69,4 @@ DEPENDENCIES
   simplecov (< 0.18)
 
 BUNDLED WITH
-   2.2.27
+   2.2.29

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
 
@@ -25,7 +23,7 @@ Or install it yourself as:
 
 ## Usage
 
-### Markets
+### Markets (public)
 
 Initialize a markets session:
 ```ruby
@@ -53,9 +51,9 @@ markets.historic('BTC/USD', resolution: 86400*30)
 ```
 *Check the [FTX API docs](https://docs.ftx.com/?python#get-historical-prices) for additional parameters such as start_time and end_time*
 
-Note: resolution is in seconds so 86,400 would be the number of seconds in a day. As a default, the API responds with 12 months of historical prices.
+> Note: resolution is in seconds so 86,400 would be the number of seconds in a day. As a default, the API responds with 12 months of historical prices.
 
-### Futures
+### Futures (public)
 
 Initialize a futures session:
 ```ruby
@@ -72,6 +70,18 @@ Fetch a single market price:
 futures.get('BTC-PERP')
 ```
 
+Fetch stats for a future:
+```ruby
+futures.stats('BTC-PERP')
+```
+
+Fetch all or one funding rates:
+```ruby
+futures.funding_rates(future: 'BTC-PERP')
+```
+
+> Note: future is optional, start_time and end_time are also accepted per the FTX API docs
+
 ### Account
 
 Initialize an account session:
@@ -128,9 +138,14 @@ Query for all historical orders:
 orders.history
 ```
 
-Fetch a specific order:
+Fetch a specific order by FTX `orderId`:
+```ruby
+orders.get(order_id)
+```
+
+Fetch a specific order by `clientId`:
 ```ruby
-orders.get
+orders.get_by_client_id(clientId)
 ```
 
 Create a new order:
@@ -150,10 +165,81 @@ args = {
 orders.create(args)
 ```
 
-Note: the create order method is not included as a test, because I have not been able to find FTX test keys and it seems a bit ridiculous to execute a live order for testing.
+> Note: the create order method is not included as a test, because I have not been able to find FTX test keys and it seems a bit ridiculous to execute a live order for testing.
 
 *Check the [FTX API docs](https://docs.ftx.com/#orders) for all parameters*
 
+### Fills
+
+Initialize a fills session:
+```ruby
+fills = FXT::API::Fills.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
+
+### Funding
+
+Initialize a funding session:
+```ruby
+funding = FXT::API::Funding.new(key: 'YOUR FTX KEY', secret: 'YOUR FTX SECRET')
+```
+
+Query for all or one funding payments:
+```ruby
+funding.payments(future: 'BTC-PERP')
+```
+
+Query for all or one funding rates:
+```ruby
+funding.rates(future: 'BTC-PERP')
+```
+
+> Note: future is optional, start_time and end_time are also accepted per the FTX API docs
+
+### 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.

data/lib/ftx/api/base.rb

@@ -4,15 +4,15 @@ 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)
-    @secret = args.dig(:secret)
+    @key = args.fetch(:key, ENV['FTX_KEY'])
+    @secret = args.fetch(:secret, ENV['FTX_SECRET'])
   end
 
   protected
@@ -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/funding.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'private'
+
+class FTX::API::Funding < FTX::API::Private
+
+  def payments(query = {})
+    send_request(:get, '/funding_payments', query)
+  end
+
+  def rates(query = {})
+    send_request(:get, '/funding_rates', query)
+  end
+  
+end

data/lib/ftx/api/futures.rb

@@ -11,5 +11,13 @@ class FTX::API::Futures < FTX::API::Public
   def get(futures_name)
     send_request(:get, "/futures/#{futures_name}", {})
   end
+
+  def stats(futures_name)
+    send_request(:get, "/futures/#{futures_name}/stats", {})
+  end
+
+  def funding_rates(query = {})
+    send_request(:get, '/funding_rates', 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
 
@@ -26,12 +28,12 @@ class FTX::API::Private < FTX::API::Base
     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.4"
+    VERSION = "0.2.8"
   end
 end

data/lib/ftx/api.rb

@@ -3,7 +3,10 @@ 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/funding"
+require_relative "api/convert"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ftx-api
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.8
 platform: ruby
 authors:
 - benrs44
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-05 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -63,6 +63,9 @@ 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/funding.rb
 - lib/ftx/api/futures.rb
 - lib/ftx/api/markets.rb
 - lib/ftx/api/orders.rb