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

# 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 = {

start_date: Date.parse("2018-01-01"),

end_date: Date.parse("2019-01-01"),

frequency: "daily",

page_size: 100,

next_page: nil

}

result = security_api.get_security_stock_prices(identifier, opts)

pp result

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

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
start_date	Date	Return prices on or after the date	[optional]
end_date	Date	Return prices on or before the date	[optional]
frequency	String	Return stock prices in the given frequency	[optional] [default to daily]
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::ApiResponseSecurityStockPrices

Properties

Name	Type	Description
stock_prices	Array	The stock prices for the Security
security	SecuritySummary	The Security resolved from the given identifier
next_page	String	The token required to request the next page of the data. If null, no further results are available.

object

Intrinio::StockPriceSummary

Properties

Name	Type	Description
date	Date	The calendar date that the stock price represents. For non-daily stock prices, this represents the last day in the period (end of the week, month, quarter, year, etc)
intraperiod	BOOLEAN	If true, the stock price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period
frequency	String	The type of period that the stock price represents
open	Float	The price at the beginning of the period
high	Float	The highest price over the span of the period
low	Float	The lowest price over the span of the period
close	Float	The price at the end of the period
volume	Float	The number of shares exchanged during the period
adj_open	Float	The price at the beginning of the period, adjusted for splits and dividends
adj_high	Float	The highest price over the span of the period, adjusted for splits and dividends
adj_low	Float	The lowest price over the span of the period, adjusted for splits and dividends
adj_close	Float	The price at the end of the period, adjusted for splits and dividends
adj_volume	Float	The number of shares exchanged during the period, adjusted for splits and dividends
factor	Float	The factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.
split_ratio	Float	The ratio of the stock split, if a stock split occurred.
dividend	Float	The dividend amount, if a dividend was paid.
change	Float	The difference in price from the last price for this frequency
percent_change	Float	The percent difference in price from the last price for this frequency
fifty_two_week_high	Float	The 52 week high price (daily only)
fifty_two_week_low	Float	The 52 week low price (daily only)

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 Stock Prices by Security 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