Intrinio Ruby SDK

intrinio-sdk - the Ruby gem for the Intrinio API

To get an API key, sign up here.

Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the Intrinio API documentation. If you need additional help in using the API, please visit the Intrinio website and click on the chat icon in the lower right corner.

This SDK is automatically generated by the Swagger Codegen project:

• API version: 2.1.1
• Package version: 2.0.0

Installation

gem install intrinio-sdk

Installation From Github

Add the following to your Gemfile:

gem 'intrinio-sdk', :git => 'https://github.com/intrinio/ruby-sdk.git'

SDK Code Examples

Code examples for Intrinio SDKs are available at https://github.com/intrinio/sdk-code-samples

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'intrinio-sdk'

# Setup authorization
Intrinio.configure do |config|
  config.api_key['api_key'] = 'YOUR API KEY'
end

company_api = Intrinio::CompanyApi.new

begin
  result = company_api.filter_companies()
  p result
rescue Intrinio::ApiError => e
  puts "Exception when calling CompanyApi->filter_companies: #{e}"
end

API Endpoints

All URIs are relative to https://api-v2.intrinio.com

Class	Method	HTTP request	Description
Intrinio::CompanyApi	get_all_companies	GET /companies	All Companies
Intrinio::CompanyApi	get_all_company_news	GET /companies/news	All News
Intrinio::CompanyApi	get_company	GET /companies/identifier	Lookup Company
Intrinio::CompanyApi	get_company_data_point_number	GET /companies/identifier/data_point/tag/number	Data Point (Number) for Company
Intrinio::CompanyApi	get_company_data_point_text	GET /companies/identifier/data_point/tag/text	Data Point (Text) for Company
Intrinio::CompanyApi	get_company_filings	GET /companies/identifier/filings	All Filings by Company
Intrinio::CompanyApi	get_company_fundamentals	GET /companies/identifier/fundamentals	All Fundamentals by Company
Intrinio::CompanyApi	get_company_historical_data	GET /companies/identifier/historical_data/tag	Historical Data for Company
Intrinio::CompanyApi	get_company_news	GET /companies/identifier/news	All News by Company
Intrinio::CompanyApi	get_company_securities	GET /companies/identifier/securities	All Securities by Company
Intrinio::CompanyApi	lookup_company_fundamental	GET /companies/identifier/fundamentals/lookup/statement_code/fiscal_year/fiscal_period	Lookup Fundamental by Company
Intrinio::CompanyApi	search_companies	GET /companies/search	Search Companies
Intrinio::DataPointApi	get_data_point_number	GET /data_point/identifier/tag/number	Data Point (Number)
Intrinio::DataPointApi	get_data_point_text	GET /data_point/identifier/tag/text	Data Point (Text)
Intrinio::DataTagApi	get_all_data_tags	GET /data_tags	All Data Tags
Intrinio::DataTagApi	get_data_tag_by_id	GET /data_tags/identifier	Lookup Data Tag
Intrinio::DataTagApi	search_data_tags	GET /data_tags/search	Search Data Tags
Intrinio::FilingApi	get_all_filings	GET /filings	All Filings
Intrinio::FilingApi	get_all_notes	GET /filings/notes	All Filing Notes
Intrinio::FilingApi	get_filing_by_id	GET /filings/id	Lookup Filing
Intrinio::FilingApi	get_note	GET /filings/notes/identifier	Filing Note by ID
Intrinio::FilingApi	get_note_html	GET /filings/notes/identifier/html	Filing Note HTML
Intrinio::FilingApi	get_note_text	GET /filings/notes/identifier/text	Filing Note Text
Intrinio::FilingApi	search_notes	GET /filings/notes/search	Search Filing Notes
Intrinio::FundamentalsApi	get_fundamental_by_id	GET /fundamentals/id	Fundamental by ID
Intrinio::FundamentalsApi	get_fundamental_reported_financials	GET /fundamentals/id/reported_financials	Reported Financials
Intrinio::FundamentalsApi	get_fundamental_standardized_financials	GET /fundamentals/id/standardized_financials	Standardized Financials
Intrinio::FundamentalsApi	lookup_fundamental	GET /fundamentals/lookup/identifier/statement_code/fiscal_year/fiscal_period	Lookup Fundamental
Intrinio::HistoricalDataApi	get_historical_data	GET /historical_data/identifier/tag	Historical Data
Intrinio::IndexApi	get_all_economic_indices	GET /indices/economic	All Economic Indices
Intrinio::IndexApi	get_all_sic_indices	GET /indices/sic	All SIC Indices
Intrinio::IndexApi	get_all_stock_market_indices	GET /indices/stock_market	All Stock Market Indices
Intrinio::IndexApi	get_economic_index_by_id	GET /indices/economic/identifier	Lookup Economic Index
Intrinio::IndexApi	get_economic_index_data_point_number	GET /indices/economic/identifier/data_point/tag/number	Data Point (Number) for an Economic Index
Intrinio::IndexApi	get_economic_index_data_point_text	GET /indices/economic/identifier/data_point/tag/text	Data Point (Text) for an Economic Index
Intrinio::IndexApi	get_economic_index_historical_data	GET /indices/economic/identifier/historical_data/tag	Historical Data for an Economic Index
Intrinio::IndexApi	get_sic_index_by_id	GET /indices/sic/identifier	Lookup SIC Index
Intrinio::IndexApi	get_sic_index_data_point_number	GET /indices/sic/identifier/data_point/tag/number	Data Point (Number) for an SIC Index
Intrinio::IndexApi	get_sic_index_data_point_text	GET /indices/sic/identifier/data_point/tag/text	Data Point (Text) for an SIC Index
Intrinio::IndexApi	get_sic_index_historical_data	GET /indices/sic/identifier/historical_data/tag	Historical Data for an SIC Index
Intrinio::IndexApi	get_stock_market_index_by_id	GET /indices/stock_market/identifier	Lookup Stock Market Index
Intrinio::IndexApi	get_stock_market_index_data_point_number	GET /indices/stock_market/identifier/data_point/tag/number	Data Point (Number) for Stock Market Index
Intrinio::IndexApi	get_stock_market_index_data_point_text	GET /indices/stock_market/identifier/data_point/tag/text	Data Point (Text) for Stock Market Index
Intrinio::IndexApi	get_stock_market_index_historical_data	GET /indices/stock_market/identifier/historical_data/tag	Historical Data for Stock Market Index
Intrinio::IndexApi	search_economic_indices	GET /indices/economic/search	Search Economic Indices
Intrinio::IndexApi	search_sic_indices	GET /indices/sic/search	Search SIC Indices
Intrinio::IndexApi	search_stock_markets_indices	GET /indices/stock_market/search	Search Stock Market Indices
Intrinio::MunicipalityApi	get_all_municipalities	GET /municipalities	All Municipalities
Intrinio::MunicipalityApi	get_municipality_by_id	GET /municipalities/id	Municipality by ID
Intrinio::MunicipalityApi	get_municipality_financials	GET /municipalities/id/financials	Financials for a Municipality
Intrinio::SecurityApi	get_all_securities	GET /securities	All Securities
Intrinio::SecurityApi	get_security_by_id	GET /securities/identifier	Lookup Security
Intrinio::SecurityApi	get_security_data_point_number	GET /securities/identifier/data_point/tag/number	Data Point (Number) for Security
Intrinio::SecurityApi	get_security_data_point_text	GET /securities/identifier/data_point/tag/text	Data Point (Text) for Security
Intrinio::SecurityApi	get_security_historical_data	GET /securities/identifier/historical_data/tag	Historical Data for Security
Intrinio::SecurityApi	get_security_intraday_prices	GET /securities/identifier/prices/intraday	Intraday Stock Prices for Security
Intrinio::SecurityApi	get_security_latest_dividend_record	GET /securities/identifier/dividends/latest	Lastest Dividend Record for Security
Intrinio::SecurityApi	get_security_latest_earnings_record	GET /securities/identifier/earnings/latest	Lastest Earnings Record for Security
Intrinio::SecurityApi	get_security_realtime_price	GET /securities/identifier/prices/realtime	Realtime Stock Price for Security
Intrinio::SecurityApi	get_security_stock_price_adjustments	GET /securities/identifier/prices/adjustments	Stock Price Adjustments by Security
Intrinio::SecurityApi	get_security_stock_prices	GET /securities/identifier/prices	Stock Prices by Security
Intrinio::SecurityApi	screen_securities	POST /securities/screen	Screen Securities
Intrinio::SecurityApi	search_securities	GET /securities/search	Search Securities
Intrinio::StockExchangeApi	get_all_stock_exchanges	GET /stock_exchanges	All Stock Exchanges
Intrinio::StockExchangeApi	get_stock_exchange_by_id	GET /stock_exchanges/identifier	Lookup Stock Exchange
Intrinio::StockExchangeApi	get_stock_exchange_price_adjustments	GET /stock_exchanges/identifier/prices/adjustments	Stock Price Adjustments by Exchange
Intrinio::StockExchangeApi	get_stock_exchange_prices	GET /stock_exchanges/identifier/prices	Stock Prices by Exchange
Intrinio::StockExchangeApi	get_stock_exchange_realtime_prices	GET /stock_exchanges/identifier/prices/realtime	Realtime Stock Prices by Exchange
Intrinio::StockExchangeApi	get_stock_exchange_securities	GET /stock_exchanges/identifier/securities	Securities by Exchange

Models

• Intrinio::ApiResponseCompanies
• Intrinio::ApiResponseCompaniesSearch
• Intrinio::ApiResponseCompanyFilings
• Intrinio::ApiResponseCompanyFundamentals
• Intrinio::ApiResponseCompanyHistoricalData
• Intrinio::ApiResponseCompanyNews
• Intrinio::ApiResponseCompanySecurities
• Intrinio::ApiResponseDataTags
• Intrinio::ApiResponseDataTagsSearch
• Intrinio::ApiResponseEconomicIndexHistoricalData
• Intrinio::ApiResponseEconomicIndices
• Intrinio::ApiResponseEconomicIndicesSearch
• Intrinio::ApiResponseFilingNotes
• Intrinio::ApiResponseFilingNotesSearch
• Intrinio::ApiResponseFilings
• Intrinio::ApiResponseHistoricalData
• Intrinio::ApiResponseMunicipalities
• Intrinio::ApiResponseMunicipalitiyFinancials
• Intrinio::ApiResponseNews
• Intrinio::ApiResponseReportedFinancials
• Intrinio::ApiResponseSICIndexHistoricalData
• Intrinio::ApiResponseSICIndices
• Intrinio::ApiResponseSICIndicesSearch
• Intrinio::ApiResponseSecurities
• Intrinio::ApiResponseSecuritiesSearch
• Intrinio::ApiResponseSecurityHistoricalData
• Intrinio::ApiResponseSecurityIntradayPrices
• Intrinio::ApiResponseSecurityStockPriceAdjustments
• Intrinio::ApiResponseSecurityStockPrices
• Intrinio::ApiResponseStandardizedFinancials
• Intrinio::ApiResponseStockExchangeRealtimeStockPrices
• Intrinio::ApiResponseStockExchangeSecurities
• Intrinio::ApiResponseStockExchangeStockPriceAdjustments
• Intrinio::ApiResponseStockExchangeStockPrices
• Intrinio::ApiResponseStockExchanges
• Intrinio::ApiResponseStockMarketIndexHistoricalData
• Intrinio::ApiResponseStockMarketIndices
• Intrinio::ApiResponseStockMarketIndicesSearch
• Intrinio::Company
• Intrinio::CompanyFiling
• Intrinio::CompanyNews
• Intrinio::CompanyNewsSummary
• Intrinio::CompanySummary
• Intrinio::DataTag
• Intrinio::DataTagSummary
• Intrinio::DividendRecord
• Intrinio::EarningsRecord
• Intrinio::EconomicIndex
• Intrinio::EconomicIndexSummary
• Intrinio::Filing
• Intrinio::FilingNote
• Intrinio::FilingNoteFiling
• Intrinio::FilingNoteSummary
• Intrinio::FilingSummary
• Intrinio::Fundamental
• Intrinio::FundamentalSummary
• Intrinio::HistoricalData
• Intrinio::IntradayStockPrice
• Intrinio::Municipality
• Intrinio::MunicipalityFinancial
• Intrinio::RealtimeStockPrice
• Intrinio::RealtimeStockPriceSecurity
• Intrinio::ReportedFinancial
• Intrinio::ReportedTag
• Intrinio::SICIndex
• Intrinio::Security
• Intrinio::SecurityScreenClause
• Intrinio::SecurityScreenGroup
• Intrinio::SecurityScreenResult
• Intrinio::SecurityScreenResultData
• Intrinio::SecuritySummary
• Intrinio::StandardizedFinancial
• Intrinio::StockExchange
• Intrinio::StockMarketIndex
• Intrinio::StockMarketIndexSummary
• Intrinio::StockPrice
• Intrinio::StockPriceAdjustment
• Intrinio::StockPriceAdjustmentSummary
• Intrinio::StockPriceSummary