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
fundamentals_api = Intrinio::FundamentalsApi.new
identifier = "AAPL"
statement_code = "income_statement"
fiscal_year = 2017
fiscal_period = "FY"
result = fundamentals_api.lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
identifierStringA Company identifier (Ticker, CIK, LEI, Intrinio ID) 
statement_codeStringThe statement code 
fiscal_yearIntegerThe fiscal year 
fiscal_periodStringThe fiscal period 

Return Type

object
Intrinio::Fundamental

Properties

NameTypeDescription
idStringThe Intrinio ID of the Fundamental  
statement_codeStringThe code of the financial statement that the Fundamental represents  
fiscal_yearFloatThe fiscal year  
fiscal_periodStringThe fiscal period  
typeStringThe type of Fundamental  
start_dateDateThe period start date  
end_dateDateThe period start date  
filing_dateDateTimeThe date and time when the Fundamental was filed with the SEC  
is_latestBOOLEANIs this the latest fundamental available based on the company's most recent filings? Use the Lookup Fundamental endpoint to find the latest fundamental (reference)  
companyCompanySummaryThe Company that the Fundamental was belongs to  
object
Intrinio::CompanySummary

Properties

NameTypeDescription
idStringThe Intrinio ID of the company  
tickerStringThe stock market ticker symbol associated with the company's common stock securities  
nameStringThe company's common name  
leiStringThe Legal Entity Identifier (LEI) assigned to the company  
cikStringThe Central Index Key (CIK) assigned to the company  
View Documentation for Lookup Fundamental 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