Ruby SDK

  6.34.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
security_api = Intrinio::SecurityApi.new
identifier = "AAPL"
opts = {
date: nil
}
result = security_api.get_security_zacks_analyst_ratings_snapshot(identifier, opts)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
identifierStringA Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) 
dateStringLookup a historical snapshot on the given date[optional]  

Return Type

object
Intrinio::ApiResponseSecurityZacksAnalystRatingsSnapshot

Properties

NameTypeDescription
snapshotsArray 
securitySecuritySummaryThe Security resolved from the given identifier  
object
Intrinio::ZacksAnalystRatingSnapshot

Properties

NameTypeDescription
typeStringThe snapshot type, signifying the age of the ratings data from the snapshot date.  
snapshot_dateDateThe date of the snapshot, when data was recorded.  
rating_dateDateThe date of the latest rating for the snapshot timeframe. This is the effective date of the ratings data.  
meanFloatThe mean (average) weighing of analyst recommendations, from 1 (strong buy) to 5 (strong sell).  
percentileFloatThe percentile of the mean, derived by comparing to all securities rated by analysts as of the rating date, ranging 0.0 (strong buy) to 1.0 (strong sell).  
strong_buysIntegerThe number of analysts recommending Strong Buy.  
buysIntegerThe number of analysts recommending Buy.  
holdsIntegerThe number of analysts recommending Hold.  
sellsIntegerThe number of analysts recommending Sell.  
strong_sellsIntegerThe number of analysts recommending Strong Sell.  
totalIntegerThe total number of analysts recommendations.  
object
Intrinio::SecuritySummary

Properties

NameTypeDescription
idStringThe Intrinio ID for Security  
company_idStringThe Intrinio ID for the Company for which the Security is issued  
nameStringThe name of the Security  
codeStringA 2-3 digit code classifying the Security (reference)  
currencyStringThe currency in which the Security is traded on the exchange  
tickerStringThe common/local ticker of the Security  
composite_tickerStringThe country-composite ticker of the Security  
figiStringThe OpenFIGI identifier  
composite_figiStringThe country-composite OpenFIGI identifier  
share_class_figiStringThe global-composite OpenFIGI identifier  
primary_listingBOOLEANIf 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 Analyst Ratings Snapshot Example

Release History

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

6.21.2

Released 09/17/2022
ruby-sdk-source-code-6.21.2.zip