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

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

# 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,

eps_actual_greater: nil,

eps_actual_less: nil,

eps_mean_estimate_greater: nil,

eps_mean_estimate_less: nil,

eps_amount_diff_greater: nil,

eps_amount_diff_less: nil,

eps_percent_diff_greater: nil,

eps_percent_diff_less: nil,

eps_count_estimate_greater: nil,

eps_count_estimate_less: nil,

eps_std_dev_estimate_greater: nil,

eps_std_dev_estimate_less: nil,

page_size: 100,

next_page: nil

}

result = zacks_api.get_zacks_eps_surprises(opts)

pp result

הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

Name	Type	Description	Notes
start_date	Date	Limit EPS surprises to those on or after this date	[optional]
end_date	Date	Limit EPS surprises to those on or before this date	[optional]
eps_actual_greater	Float	Return only records with an actual EPS higher than this value	[optional]
eps_actual_less	Float	Return only records with an actual EPS lower than this value	[optional]
eps_mean_estimate_greater	Float	Return only records with an EPS mean estimate greater than this value	[optional]
eps_mean_estimate_less	Float	Return only records with an EPS mean estimate lower than this value	[optional]
eps_amount_diff_greater	Float	Return only records with an EPS amount difference greater than this value	[optional]
eps_amount_diff_less	Float	Return only records with an EPS amount difference less than this value	[optional]
eps_percent_diff_greater	Float	Return only records with an EPS percent difference greater than this value	[optional]
eps_percent_diff_less	Float	Return only records with an EPS percent difference less than this value	[optional]
eps_count_estimate_greater	Float	Return only records with an EPS count estimate greater than this value	[optional]
eps_count_estimate_less	Float	Return only records with an EPS count estimate less than this value	[optional]
eps_std_dev_estimate_greater	Float	Return only records with an EPS standard deviation greater than this value	[optional]
eps_std_dev_estimate_less	Float	Return only records with an EPS standard deviation less than this value	[optional]
page_size	Integer	The number of results to return	[optional] [default to 100]
next_page	String	Gets the next page of data from a previous API call	[optional]

Return Type

object

Intrinio::ApiResponseZacksEPSSurprises

Properties

Name	Type	Description
eps_surprises	Array	Zacks EPS Surprise data for a Security in descending order by actual reported date
next_page	String	The token required to request the next page of the data. If null, no further results are available.

object

Intrinio::ZacksEPSSurprise

Properties

Name	Type	Description
id	String	The Intrinio ID for the record
fiscal_year	Float	The company's fiscal year for the reported period
fiscal_quarter	String	The company's fiscal quarter for the reported period
calendar_year	Float	The closest calendar year for the company's fiscal year
calendar_quarter	String	The closest calendar quarter for the company's fiscal year
actual_reported_date	Date	The actual report date for the earnings release
actual_reported_time	String	The actual report time for the earnings release
actual_reported_code	String	The code cooresponding to the earnings release BTO = BEFORE THE OPEN	DTM = DURING THE MARKET	AMC = AFTER MARKET CLOSE
actual_reported_desc	String	The description for the type of earnings release
eps_actual	Float	The actual Non-GAAP EPS figure released by the company, interpreted by Zacks.
eps_actual_zacks_adj	Float	The adjustments Zacks made to get to Non-GAAP EPS to reconcile with GAAP EPS.
eps_mean_estimate	Float	The pre-earnings release mean EPS estimate for the company
eps_amount_diff	Float	The EPS surprise amount difference
eps_percent_diff	Float	The EPS surprise percent difference
eps_count_estimate	Float	The pre-earnings release number of estimates by analysts
eps_std_dev_estimate	Float	The pre-earnings release standard deviation of EPS estimates
security	SecuritySummary	The Security of the Zacks EPS Surprise

object

Intrinio::SecuritySummary

Properties

Name	Type	Description
id	String	The Intrinio ID for Security
company_id	String	The Intrinio ID for the Company for which the Security is issued
exchange	String	The exchange's MIC
exchange_mic	String	The security's exchange MIC
stock_exchange_id	String	The exchange's Intrinio ID
name	String	The name of the Security
code	String	A 2-3 digit code classifying the Security (reference)
currency	String	The currency in which the Security is traded on the exchange
ticker	String	The common/local ticker of the Security
composite_ticker	String	The country-composite ticker of the Security
figi	String	The OpenFIGI identifier
composite_figi	String	The country-composite OpenFIGI identifier
share_class_figi	String	The global-composite OpenFIGI identifier
primary_listing	BOOLEAN	If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange

View Documentation for Zacks EPS Surprises Example

Release History

6.35.0

Released 02/26/2025

ruby-sdk-source-code-6.35.0.zip

6.34.0

Released 11/27/2024

ruby-sdk-source-code-6.34.0.zip

6.33.0

Released 11/21/2024

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

ruby-sdk-source-code-6.31.0.zip

6.30.0

Released 08/23/2024

ruby-sdk-source-code-6.30.0.zip

6.29.1

Released 08/10/2024

ruby-sdk-source-code-6.29.1.zip

6.29.0

Released 08/02/2024

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

ruby-sdk-source-code-6.28.0.zip

6.27.4

Released 06/25/2024

ruby-sdk-source-code-6.27.4.zip

6.27.3

Released 06/05/2024

ruby-sdk-source-code-6.27.3.zip

6.27.2

Released 04/10/2024

ruby-sdk-source-code-6.27.2.zip

6.27.1

Released 04/10/2024

ruby-sdk-source-code-6.27.1.zip

6.27.0

Released 03/11/2024

ruby-sdk-source-code-6.27.0.zip

6.26.8

Released 02/20/2024

ruby-sdk-source-code-6.26.8.zip

6.26.7

Released 02/06/2024

ruby-sdk-source-code-6.26.7.zip

6.26.6

Released 02/01/2024

ruby-sdk-source-code-6.26.6.zip

6.26.5

Released 12/21/2023

ruby-sdk-source-code-6.26.5.zip

6.26.3

Released 12/05/2023

ruby-sdk-source-code-6.26.3.zip

6.26.2

Released 11/08/2023

ruby-sdk-source-code-6.26.2.zip

6.26.1

Released 10/03/2023

ruby-sdk-source-code-6.26.1.zip

6.26.0

Released 09/08/2023

ruby-sdk-source-code-6.26.0.zip

6.25.0

Released 08/01/2023

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

ruby-sdk-source-code-6.24.0.zip

6.23.1

Released 03/28/2023

ruby-sdk-source-code-6.23.1.zip

6.23.0

Released 03/17/2023

ruby-sdk-source-code-6.23.0.zip

6.22.3

Released 01/11/2023

ruby-sdk-source-code-6.22.3.zip

6.22.2

Released 09/19/2022

ruby-sdk-source-code-6.22.2.zip