apiverve_dividends 1.2.4 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ed40120c38329b9f819d644f52c01c25887f5ce594834dc9ccb0eb8f0fd111a
-  data.tar.gz: 130d33996de82298a0b0e27c2ef9a3b3c2e3d3a45c52eb2e8c49e69cf4ee5d2c
+  metadata.gz: 0df50f4b93cfab2521d4c956a7800ea742ffbc00f252e695a98dddee1f8eb3b6
+  data.tar.gz: a1712aefcce5a598fc9e472eb530ad779fb1a147241ba58532ec86a5faa13902
 SHA512:
-  metadata.gz: e548ea64b0adeafecab5faa28bf84e6457e467846a264909e4d630404265a1f9778d87e051689346e170a0903aaf55b355e9dea5278216222f1bb869b4c1b612
-  data.tar.gz: 32f19a2b6bbf04db996fe390d8d4efd47ba48dc23ba66f5302034181290646a1d6d080453bf9a08bc12570213c943d346d50c7e28e3a8c5e08a67ef5cc8f3409
+  metadata.gz: 0d2479f8d3d17c9ff38f61f6fab0e005d0780aefc43541e85ab9c950238139d80be74a5532dba2012f8acfeac71eb3f8f0d8c67269c3ee821bb523d76e7a6f2f
+  data.tar.gz: 63369d9ca77ceb0f06f295fb1c42493d559efae7b91940f2dd613d5555b18edaf9a56b554007471cc8645ae5785e6b3e6e9da2dcd7270beca51de403025f294d

data/README.md

@@ -1,6 +1,6 @@
 # Dividends API - Ruby Gem
 
-Dividends returns the dividend-per-share history for a US public company by ticker - the amount reported each quarter and year straight from official SEC filings - plus a derived dividend-growth summary with year-over-year growth, multi-year growth rates and a consecutive-years-of-growth streak calculated for you.
+Dividends returns the dividend-per-share history for a US public company by ticker - the amount reported each quarter and year straight from official SEC filings - plus a derived dividend-growth summary with year-over-year growth, multi-year growth rates and a consecutive-years-of-growth streak calculated for you. Paid plans can add dividend yield and the full-year payout ratio.
 
 ## Installation
 
@@ -38,7 +38,8 @@ client = APIVerve::Dividends::Client.new(api_key: "YOUR_API_KEY")
 response = client.execute({
   ticker: "AAPL",
   period: "annual",
-  limit: 10
+  limit: 10,
+  metrics: true
 })
 
 # Print the response
@@ -50,7 +51,7 @@ puts response
 
 ```ruby
 begin
-  response = client.execute({ ticker: "AAPL", period: "annual", limit: 10 })
+  response = client.execute({ ticker: "AAPL", period: "annual", limit: 10, metrics: true })
   puts response["data"]
 rescue APIVerve::Dividends::ValidationError => e
   puts "Validation error: #{e.errors.join(', ')}"
@@ -159,6 +160,14 @@ client = APIVerve::Dividends::Client.new(
           "perShare": 1.02
         }
       ]
+    },
+    "metrics": {
+      "trailingAnnualDividend": 1.02,
+      "trailingAnnualPeriod": "CY2025",
+      "dividendYield": 0.33,
+      "priceAsOf": "2026-08-17T19:27:12.559994467Z",
+      "payoutRatio": 13.67,
+      "payoutRatioFiscalYear": 2025
     }
   }
 }

data/lib/apiverve_dividends/client.rb

@@ -10,7 +10,7 @@ module APIVerve
     #
     # @example Basic usage
     #   client = APIVerve::Dividends::Client.new(api_key: "your_api_key")
-    #   response = client.execute({ ticker: "AAPL", period: "annual", limit: 10 })
+    #   response = client.execute({ ticker: "AAPL", period: "annual", limit: 10, metrics: true })
     #   puts response
     #
     # @see https://apiverve.com/marketplace/dividends?utm_source=ruby&utm_medium=referral&utm_content=readme
@@ -19,7 +19,7 @@ module APIVerve
       DEFAULT_TIMEOUT = 30
 
       # Validation rules for parameters
-      VALIDATION_RULES = { 'ticker' => { type: 'string', required: true, min_length: 1, max_length: 6 }, 'period' => { type: 'string', required: false }, 'limit' => { type: 'integer', required: false, min: 1, max: 25 } }
+      VALIDATION_RULES = { 'ticker' => { type: 'string', required: true, min_length: 1, max_length: 6 }, 'period' => { type: 'string', required: false }, 'limit' => { type: 'integer', required: false, min: 1, max: 25 }, 'metrics' => { type: 'boolean', required: false } }
 
       # Format validation patterns
       FORMAT_PATTERNS = {

data/lib/apiverve_dividends.rb

@@ -4,6 +4,6 @@ require_relative "apiverve_dividends/client"
 
 module APIVerve
   module Dividends
-    VERSION = "1.2.4"
+    VERSION = "1.2.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apiverve_dividends
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.5
 platform: ruby
 authors:
 - APIVerve
@@ -60,7 +60,8 @@ dependencies:
 description: Dividends returns the dividend-per-share history for a US public company
   by ticker - the amount reported each quarter and year straight from official SEC
   filings - plus a derived dividend-growth summary with year-over-year growth, multi-year
-  growth rates and a consecutive-years-of-growth streak calculated for you.
+  growth rates and a consecutive-years-of-growth streak calculated for you. Paid plans
+  can add dividend yield and the full-year payout ratio.
 email:
 - hello@apiverve.com
 executables: []