ftx-api 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be471f1211cee30497ce74db4b05da88d05345bc8ada1966d26495db15f18890
-  data.tar.gz: e7ee23d92d2cf4782b2fcdbdf2c09232460ccafaeb0de6b09bf686bdb3cf4e55
+  metadata.gz: 034ffdddca45eba8aefa59494ee718e329324b637f50585412eea9500a17011f
+  data.tar.gz: 6a19fc208851effb64df469a145d6ac76a94ea3ad6b2b4c338f07d99b7de57dd
 SHA512:
-  metadata.gz: 552a6ed552f1b7ac7fa6063feb2698dd06d6693f38b20cee6fb07cf9bd6eb9b45ac8b3a7db2b1c5210c9dbc5eda695e638508785dce980045f8eadd57d337f68
-  data.tar.gz: 4c4f43ce73556ef89af1139f665ba24cb39d83837db32e4461054d8fef9aba8bfa2c6a0801827e92c3dba303814d5aab359443dd37e22df18acccf20b8adb8c4
+  metadata.gz: e04b01cdc2240f3a69d8f3f7d2751d02f932fca080ee118918444a63b33b498cef423a090eaeeb5537244cb0513107a82e88ab9dc120f0e738df1c6465359d06
+  data.tar.gz: e8edc6cceb16276c0803185f1f025256e5b419d880dffc8487f53a1195e1b715b00cccc391be790229b8ba49d3c403fb1e2e03e1a54a6848654c39a9abb0190d

data/CHANGELOG.md

@@ -25,4 +25,7 @@
 - Implement Fills endpoint including tests
 
 ## [0.2.7] - 2021-10-06
-- Implement orders get_by_client_id endpoint
+- 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.7)
+    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

@@ -23,7 +23,7 @@ Or install it yourself as:
 
 ## Usage
 
-### Markets
+### Markets (public)
 
 Initialize a markets session:
 ```ruby
@@ -51,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
@@ -70,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:
@@ -153,15 +165,15 @@ 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 an fills session:
+Initialize a fills session:
 ```ruby
-fills = FXT::API::Orders.new(key: 'YOUR FTX KEY', secret: 'YOUR FTX SECRET')
+fills = FXT::API::Fills.new(key: 'YOUR FTX KEY', secret: 'YOUR FTX SECRET')
 ```
 
 Query for all fills:
@@ -174,7 +186,26 @@ or
 fills.list(market: 'BTC/USD')
 ```
 
-Note: market is optional
+> 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
 

data/lib/ftx/api/base.rb

@@ -11,8 +11,8 @@ class FTX::API::Base
 
   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

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/version.rb

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

data/lib/ftx/api.rb

@@ -8,4 +8,5 @@ require_relative "api/account"
 require_relative "api/wallet"
 require_relative "api/orders"
 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.7
+  version: 0.2.8
 platform: ruby
 authors:
 - benrs44
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -65,6 +65,7 @@ files:
 - 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