market_data 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '082a3b709ed32b745807906d0324a3b839a90c95e55bc199b564db75518d1fbc'
-  data.tar.gz: dab55b3c50200dbf92e071dc0bd3eab5b8d712928f82d045c92a80a5f09b0979
+  metadata.gz: b63212c9e8ada21f198021bc3537392d9a6a34933682ebe789923883c2f38131
+  data.tar.gz: 9afa24ef746a81f115628f65aff4bccfdbfbf3086887444d62409545be76b7fb
 SHA512:
-  metadata.gz: 64fca38c4e459cb4244f845ad4137939249c353b2e91922cc0bb416a2b1129871916c80bf0d44e3a71e8c48b797de2a27f378192a790286aed9d2f985345c556
-  data.tar.gz: 97b5508677cbff6418254771f78e68eb48c0ee66c067274663a40ad2c6cd00af3355dac9b93bd812e90290f2fb1c10af2d0b6ba3aa447bcc760f43024ccc8dc9
+  metadata.gz: e21e172593fcee9340de7ca5ac37373db2d07479e2c912c01d7bf05399e012edcf405caf12c2cbf3ad0545b4ae8a166d6c98f40f67367e60040f818356866666
+  data.tar.gz: a3fcd6d6368c073621e9f400be5412b82e88ada5cce2b00a26b4e6697b97b6beb568564f64032c6c8eb777db93fe7afa3f324c616465e2913b838fd02ffa3eed

data/CHANGELOG.md

@@ -19,4 +19,9 @@
 - Internal rework of code. New modules for models, mappers, constants and errors
 - Introduced unit tests for almost all modules.
 - Introduced coverage. Currently at 85%
-- Add functionality for [Candles](https://www.marketdata.app/docs/api/stocks/candles) and [Bulk Candles](https://www.marketdata.app/docs/api/stocks/bulkcandles) endpoints
+- Add functionality for [Candles](https://www.marketdata.app/docs/api/stocks/candles) and [Bulk Candles](https://www.marketdata.app/docs/api/stocks/bulkcandles) endpoints
+
+## [0.2.1] - 2024-10-09
+
+- Fix broken tests
+- Add support for new optional parameters for `quotes` and `bulk_quotes` endpoint

data/README.md

@@ -2,17 +2,107 @@
 
 A Ruby wrapper for the [MarketData API](https://www.marketdata.app/docs/api).
 
+![coverage](https://img.shields.io/badge/coverage%3A-84.71%25-yellow.svg)
+
 ## Installation
 
-    $ gem install market-data
+    $ gem install market_data
     $ bundle install
 
 ## Usage
 
-    $ client = MarketData.Client.new "YOUR_API_TOKEN"
+You must instantiate a `MarketData::Client` before running any method. You'll need your MarketData API token first.
+
+    $ client = MarketData::Client.new "YOUR_API_TOKEN"
+    
     $ client.quote("AAPL")
     $ => <struct MarketData::Models::Quote symbol="AAPL", ask=231.42, askSize=2, bid=231.4, .....
 
+### Quotes
+For getting a single quote, run the `quote` method just as the example above.
+
+#### Optional parameters
+
+* `w52`
+
+For getting fields with 52-week low and high information, pass true as the `w52` parameter. 
+    
+    $ q = client.quote("AAPL", w52=true)
+    $ => q.high52 = 252.11
+    $ => q.low52 = 222.35    
+**It is `false` by default.**
+
+* `extended`
+
+For getting a quote when market is on extended hours, you have to supply the `extended` parameter as true. 
+
+**It is false by default**, so if you fetch a quote during extended hours without the parameter, you'll always get the quote at closing time.
+
+### Bulk quotes
+
+For getting multiple quotes in a single request, use the `bulk_candle` method.
+
+    $ quotes = client.bulk_quotes(["AAPL", "AMD", "NOTAQUOTE])
+    
+    $ quotes["AMD"] => <struct MarketData::Models::Quote symbol="AMD", ask=150.42, askSize=2, bid=146.4, .....
+    
+    $ quotes["NOTAQUOTE"] = nil
+
+If a quote is not found, the hashmap will return a nil value for that ticker's key.
+
+#### Optional parameters
+
+* `snapshot`
+
+If snapshot is true, any supplied array of symbols will be ignored and a complete snapshot of the market ticker's will be returned.
+    
+    $ quotes = client.bulk_quotes([], snapshot = true)
+
+    $ quotes["A"] => <struct MarketData::Models::Quote symbol="A", ask=56.32, askSize=45, bid=67, .....
+    ....
+    $ quotes["Z"] => <struct MarketData::Models::Quote symbol="Z", ask=25, askSize=3, bid=14.5, .....
+
+**This could use all you API credits. Use with caution.**
+
+* `extended`
+
+For getting a quote when market is on extended hours, you have to supply the `extended` parameter as true. 
+
+**It is false by default**, so if you fetch a quote during extended hours without the parameter, you'll get the quote at closing time.
+
+### Candles
+For getting ticker candles, you'll need to specify:
+* a ticker symbol
+* a resolution (`M`, `D`, `W`, etc. See [docs](https://www.marketdata.app/docs/api/stocks/candles#request-parameters) for a complete list)
+* a strategy to specfy a date range. You can use `from` and `to` OR `to` and `countback`.
+
+
+As an example, for getting candles for last week, for the first strategy:
+        
+        $ quotes = client.candles("AAPL", "D", (Time.current - 1.week).iso8601, Time.current.iso8601, nil)
+
+and for the second
+
+        $ quotes = client.candles("AAPL", "D", nil, Time.current.iso8601, 7)
+
+`to` and `from` can receive an ISO 8601 compliant utc format or a unix timestamp.
+
+### Bulk candles
+
+For the `bulk_candles` method you pass a array of ticker symbols. Resolution is daily by default, although any daily variation will work as well (like `2D`, `3D`, etc.)
+
+It returns a hashmap with the ticker symbol as a key.
+
+        $ candles = cl.bulk_candles(["AAPL", "AMD", "NOTAQUOTE"])
+
+        $ candles["AMD"]
+        $ => #<struct MarketData::Models::Candle symbol="AMD", open=174.05, high=174.05, low=169.55, close=171.02, volume=33391035, time=1728446400>
+        $ candles["AAPL"]
+        $ => #<struct MarketData::Models::Candle symbol="AAPL", open=225.23, high=229.75, low=224.83, close=229.54, volume=31398884, time=1728446400>
+        $ candles["NOTAQUOTE"] => nil
+
+If a quote is not found, the hashmap will return a nil value for that ticker's key.
+
 ## ROADMAP
 
 The following is an ordered list of next expected developments, based on the endpoints present in the [docs](https://www.marketdata.app/docs/api)
@@ -22,19 +112,19 @@ From Stocks endpoints:
 - [X] Bulk Stocks
 - [X] Candles
 - [X] Bulk Candles
-- [X] Support for optional parameters for Bulk Candles
-- [] Earnings
+- [X] Support for new optional parameters for Quotes and Bulk Quotes
+- [ ] Earnings
 
 From Markets endpoints:
-- [] Status
+- [ ] Status
 
 From Indices endpoints:
-- [] Quotes
-- [] Candles
+- [ ] Quotes
+- [ ] Candles
 
 From Stocks endpoints:
-- [] Support for optional parameters for Candles
-- [] Support for optional parameters for Bulk Candles
+- [ ] Support for optional parameters for Candles
+- [ ] Support for optional parameters for Bulk Candles
 
 
 ## Tests

data/lib/market_data/quotes.rb

@@ -13,28 +13,40 @@ module MarketData
     @@candles = "/v1/stocks/candles/"
     @@bulk_candles = "/v1/stocks/bulkcandles/"
 
-    def quote(symbol, w52 = false)
+    def quote(symbol, w52 = false, extended = false)
       path_hash = { host: MarketData.base_host, path: @@single + symbol }
+      query_hash = {}
       if w52
-        path_hash[:query] = URI.encode_www_form({"52week" => true })
+        query_hash["52week"] = true
+      end
+      # MarketData API considers extended as true by default
+      if !extended
+        query_hash[:extended] = false
+      end
+      if !query_hash.empty?
+        path_hash[:query] = URI.encode_www_form(query_hash)
       end
       res = do_connect(get_uri path_hash)
       map_quote(res)
     end
 
-    def bulk_quotes(symbols, snapshot = false)
+    def bulk_quotes(symbols, snapshot = false, extended = false)
       path_hash = { host: MarketData.base_host, path: @@bulk  }
       query_hash = {}
       
+      # MarketData API considers extended as true by default
+      if !extended
+        query_hash[:extended] = false
+      end
+
       if snapshot
         query_hash[:snapshot] = true
       else
         if !symbols.is_a?(Array) || symbols.size < 1
           raise BadParameterError.new("symbols must be a non-empty list")
         end
-        query_hash = { symbols: symbols.join(",") }
+        query_hash[:symbols] = symbols.join(",")
       end
-      
       path_hash[:query] = URI.encode_www_form(query_hash)
 
       res = do_connect(get_uri path_hash)

data/lib/market_data/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MarketData
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: market_data
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Sebastián González
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-30 00:00:00.000000000 Z
+date: 2024-10-09 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby client for the MarketData API.
 email: