Ruby SDK

  6.35.0

The Intrinio Ruby SDK wraps all API endpoints into an easy-to-use set of classes, methods, and response objects.

Ruby SDK Installation

To install the SDK use RubyGems:

gem install intrinio-sdk

Be sure to require the SDK in your code as follows:

require 'intrinio-sdk'
View Ruby SDK on GitHub

Stock Price Code Example

Use my API Key
# Load the gem
require 'intrinio-sdk'
require 'pp'
# Setup authorization
Intrinio.configure do |config|
config.api_key['api_key'] = 'YOUR_API_KEY'
config.allow_retries = true
end
zacks_api = Intrinio::ZacksApi.new
opts = {
start_date: nil,
end_date: nil,
sales_actual_greater: nil,
sales_actual_less: nil,
sales_mean_estimate_greater: nil,
sales_mean_estimate_less: nil,
sales_amount_diff_greater: nil,
sales_amount_diff_less: nil,
sales_percent_diff_greater: nil,
sales_percent_diff_less: nil,
sales_count_estimate_greater: nil,
sales_count_estimate_less: nil,
sales_std_dev_estimate_greater: nil,
sales_std_dev_estimate_less: nil,
page_size: 100,
next_page: nil
}
result = zacks_api.get_zacks_sales_surprises(opts)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
start_dateDateLimit sales surprises to those on or after this date[optional]  
end_dateDateLimit sales surprises to those on or before this date[optional]  
sales_actual_greaterFloatReturn only records with an actual sales higher than this value[optional]  
sales_actual_lessFloatReturn only records with an actual sales lower than this value[optional]  
sales_mean_estimate_greaterFloatReturn only records with a sales mean estimate greater than this value[optional]  
sales_mean_estimate_lessFloatReturn only records with a sales mean estimate lower than this value[optional]  
sales_amount_diff_greaterFloatReturn only records with a sales amount difference greater than this value[optional]  
sales_amount_diff_lessFloatReturn only records with a sales amount difference less than this value[optional]  
sales_percent_diff_greaterFloatReturn only records with a sales percent difference greater than this value[optional]  
sales_percent_diff_lessFloatReturn only records with a sales percent difference less than this value[optional]  
sales_count_estimate_greaterFloatReturn only records with a sales count estimate greater than this value[optional]  
sales_count_estimate_lessFloatReturn only records with a sales count estimate less than this value[optional]  
sales_std_dev_estimate_greaterFloatReturn only records with a sales standard deviation greater than this value[optional]  
sales_std_dev_estimate_lessFloatReturn only records with a sales standard deviation less than this value[optional]  
page_sizeIntegerThe number of results to return[optional] [default to 100]  
next_pageStringGets the next page of data from a previous API call[optional]  

Return Type

object
Intrinio::ApiResponseZacksSalesSurprises

Properties

NameTypeDescription
sales_surprisesArrayZacks Sales Surprise data for a Security in descending order by actual reported date  
next_pageStringThe token required to request the next page of the data. If null, no further results are available.  
object
Intrinio::ZacksSalesSurprise

Properties

NameTypeDescription
idStringThe Intrinio ID for the record  
fiscal_yearFloatThe company's fiscal year for the reported period  
fiscal_quarterStringThe company's fiscal quarter for the reported period  
calendar_yearFloatThe closest calendar year for the company's fiscal year  
calendar_quarterStringThe closest calendar quarter for the company's fiscal year  
actual_reported_dateDateThe actual report date for the earnings release  
actual_reported_timeStringThe actual report time for the earnings release  
actual_reported_codeStringThe code cooresponding to the earnings release BTO = BEFORE THE OPENDTM = DURING THE MARKETAMC = AFTER MARKET CLOSE  
actual_reported_descStringThe description for the type of earnings release  
last_rev_dateDateThe last revision date for the analyst estimates  
sales_actualFloatThe actual Non-GAAP sales figure released by the company, interpreted by Zacks.  
sales_actual_zacks_adjFloatThe adjustments Zacks made to get to Non-GAAP sales to reconcile with GAAP sales.  
sales_actual_gaapFloatThe actual GAAP sales figured released by the company  
sales_mean_estimateFloatThe pre-earnings release mean sales estimate for the company sales_count_estimate; the pre-earnings release number of estimates by analysts  
sales_amount_diffFloatThe sales surprise amount difference  
sales_percent_diffFloatThe sales surprise percent difference  
sales_std_dev_estimateFloatThe pre-earnings release standard deviation of sales estimates  
View Documentation for Zacks Sales Surprises Example

Release History

6.35.0

Released 02/26/2025

No notes for this release.

ruby-sdk-source-code-6.35.0.zip

6.34.0

Released 11/27/2024

No release notes for this build.

ruby-sdk-source-code-6.34.0.zip

6.33.0

Released 11/21/2024

No release notes for this build

ruby-sdk-source-code-6.33.0.zip

6.32.0

Released 10/31/2024
ruby-sdk-source-code-6.32.0.zip

6.31.0

Released 09/19/2024

Added stock exchange quote endpoint

ruby-sdk-source-code-6.31.0.zip

6.30.0

Released 08/23/2024

Fix type on one endpoint.
Add quote type fields to equity intervals.

ruby-sdk-source-code-6.30.0.zip

6.29.1

Released 08/10/2024

No description for this build.

ruby-sdk-source-code-6.29.1.zip

6.29.0

Released 08/02/2024

Quote endpoint
Can specify multiple tickers on specific endpoints

ruby-sdk-source-code-6.29.0.zip

6.28.1

Released 07/22/2024
ruby-sdk-source-code-6.28.1.zip

6.28.0

Released 07/22/2024

No release notes for this build

ruby-sdk-source-code-6.28.0.zip

6.27.4

Released 06/25/2024

No release notes for this build.

ruby-sdk-source-code-6.27.4.zip

6.27.3

Released 06/05/2024

No release notes for this build

ruby-sdk-source-code-6.27.3.zip

6.27.2

Released 04/10/2024

Advanced company news endpoints

ruby-sdk-source-code-6.27.2.zip

6.27.1

Released 04/10/2024

Advanced Company News endpoints.

ruby-sdk-source-code-6.27.1.zip

6.27.0

Released 03/11/2024

No release notes for this build.

ruby-sdk-source-code-6.27.0.zip

6.26.8

Released 02/20/2024

Added Zacks Sales Estimate Endpoint

ruby-sdk-source-code-6.26.8.zip

6.26.7

Released 02/06/2024

No release notes for this release.

ruby-sdk-source-code-6.26.7.zip

6.26.6

Released 02/01/2024

No release notes for this build.

ruby-sdk-source-code-6.26.6.zip

6.26.5

Released 12/21/2023

Add extended price fields to options realtime calls
Add bid/ask time and size to options eod calls

ruby-sdk-source-code-6.26.5.zip

6.26.3

Released 12/05/2023

Documentation updates and fixes

ruby-sdk-source-code-6.26.3.zip

6.26.2

Released 11/08/2023

-Adjusting and releasing Company Public Float endpoint.

ruby-sdk-source-code-6.26.2.zip

6.26.1

Released 10/03/2023

Added missing preexisting parameters to the SDK methods.

ruby-sdk-source-code-6.26.1.zip

6.26.0

Released 09/08/2023

Add extra hint message to a Trade Alerts endpoint if user doesn’t have access
Fix enum on depreciated intraday endpoint docs
Add date filters to shares outstanding endpoint
Allow either datetime format for param on snapshot endpoints
Add missing next page param to docs for institutional ownership endpoint
Add documentation for market status endpoint

ruby-sdk-source-code-6.26.0.zip

6.25.0

Released 08/01/2023

Can specify greeks underlying price source in some options calls
Can specify greeks IV method of calculation in some options calls
Update intervals syntax so it can pull from more performant source

ruby-sdk-source-code-6.25.0.zip

6.24.1

Released 07/12/2023
ruby-sdk-source-code-6.24.1.zip

6.24.0

Released 06/14/2023

No release notes for this build

ruby-sdk-source-code-6.24.0.zip

6.23.1

Released 03/28/2023

-Fixed next_page parameter for an endpoint

ruby-sdk-source-code-6.23.1.zip

6.23.0

Released 03/17/2023

Added intervals endpoints and movers endpoints.

ruby-sdk-source-code-6.23.0.zip

6.22.3

Released 01/11/2023

Added options intervals and equitites delayed SIP endpoints
Added Intervals Movers endpoints

ruby-sdk-source-code-6.22.3.zip

6.22.2

Released 09/19/2022
ruby-sdk-source-code-6.22.2.zip