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
options_api = Intrinio::OptionsApi.new
identifier = "AAPL__261218C00230000"
opts = {
source: nil,
stock_price_source: nil,
model: nil,
show_extended_price: nil
}
result = options_api.get_options_prices_realtime(identifier, opts)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
identifierStringThe Intrinio ID or code of the options contract to request prices for. 
sourceStringRealtime or 15-minute delayed contracts.[optional]  
stock_price_sourceStringSource for underlying price for calculating Greeks.[optional]  
modelStringModel for calculating Greek values. Default is black_scholes.[optional]  
show_extended_priceBOOLEANWhether to include open close high low type fields.[optional]  

Return Type

object
Intrinio::ApiResponseOptionsPriceRealtime

Properties

NameTypeDescription
priceOptionPriceRealtime 
statsOptionStatsRealtime 
optionOptionRealtime 
extended_priceOptionPriceRealtimeExtended 
object
Intrinio::OptionPriceRealtime

Properties

NameTypeDescription
lastFloatThe price of the last trade  
last_sizeIntegerThe size of the last trade  
last_timestampDateTimeThe time of the last trade  
volumeIntegerThe cumulative volume of this options contract that traded that day.  
askFloatThe price of the top ask order  
ask_sizeIntegerThe size of the top ask order  
ask_timestampDateTimeThe timestamp of the top ask order  
bidFloatThe price of the top bid order  
bid_sizeIntegerThe size of the top bid order  
bid_timestampDateTimeThe time of the top bid order  
open_interestIntegerThe total number of this options contract that are still open.  
exercise_styleStringThe exercise style of the option. ("A" = "American", "E" = "European")  
object
Intrinio::OptionStatsRealtime

Properties

NameTypeDescription
implied_volatilityFloatThe implied volatility of the contract calculated using the Black-Scholes Model.  
deltaFloatDelta represents the rate of change between the option's price and a $1 change in the underlying asset's price.  
gammaFloatGamma represents the rate of change between an option's delta and the underlying asset's price.  
thetaFloatTheta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay.  
vegaFloatVega represents the rate of change between an option's value and the underlying asset's implied volatility.  
underlying_priceFloatThe most recent trade price of the underlying asset.  
object
Intrinio::OptionRealtime

Properties

NameTypeDescription
codeStringThe Intrinio Code for the Option.  
tickerStringThe ticker symbol of the Security for the Option.  
expirationDateThe date on which the Option expires. The Option becomes invalid after this date and cannot be exercised.  
strikeFloatThe strike price is the fixed price at which a derivative can be exercised, and refers to the price of the derivative's underlying asset. In a call option, the strike price is the price at which the option holder can purchase the underlying security. For a put option, the strike price is the price at which the option holder can sell the underlying security.  
typeStringThe type of Option (put or call).  
object
Intrinio::OptionPriceRealtimeExtended

Properties

NameTypeDescription
bid_openFloatThe price of the bid at open  
bid_highFloatThe high bid so far today  
bid_lowFloatThe low bid so far today  
ask_openFloatThe price of the ask at open  
ask_highFloatThe high ask so far today  
ask_lowFloatThe low ask so far today  
trade_openFloatThe price of the trade at open  
trade_highFloatThe high trade so far today  
trade_lowFloatThe low trade so far today  
ask_closeFloatThe price of ask at close today  
bid_closeFloatThe price of bid at close today  
trade_closeFloatThe price of the last trade of the day  
markFloatThe mark price  
View Documentation for Option Prices Realtime 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