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.0.0
  • Package version: 1.0.0

Installation

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 filter_companies GET /companies/filter Filter Companies
Intrinio::CompanyApi filter_company_fundamentals GET /companies/identifier/fundamentals/filter Filter Fundamentals for a Company
Intrinio::CompanyApi get_all_companies GET /companies Get All Companies
Intrinio::CompanyApi get_all_company_news GET /companies/news Get All Company News
Intrinio::CompanyApi get_company GET /companies/identifier Get a Company by ID
Intrinio::CompanyApi get_company_data_point_number GET /companies/identifier/data_point/tag/number Get Company Data Point (Number)
Intrinio::CompanyApi get_company_data_point_text GET /companies/identifier/data_point/tag/text Get Company Data Point (Text)
Intrinio::CompanyApi get_company_filings GET /companies/identifier/filings Get Filings for a Company
Intrinio::CompanyApi get_company_fundamentals GET /companies/identifier/fundamentals Get All Fundamentals for a Company
Intrinio::CompanyApi get_company_historical_data GET /companies/identifier/historical_data/tag Get Company Historical Data
Intrinio::CompanyApi get_company_news GET /companies/identifier/news Get News for a Company
Intrinio::CompanyApi get_company_securities GET /companies/identifier/securities Get Securities by Company
Intrinio::CompanyApi lookup_company_fundamental GET /companies/identifier/fundamentals/lookup/statement_code/fiscal_year/fiscal_period Lookup a Fundamental for a Company
Intrinio::CompanyApi search_companies GET /companies/search Search Companies
Intrinio::DataPointApi get_data_point_number GET /data_point/identifier/tag/number Get a Data Point (Number)
Intrinio::DataPointApi get_data_point_text GET /data_point/identifier/tag/text Get a Data Point (Text)
Intrinio::DataTagApi filter_data_tags GET /data_tags/filter Filter Data Tags
Intrinio::DataTagApi get_all_data_tags GET /data_tags Get All Data Tags
Intrinio::DataTagApi get_data_tag_by_id GET /data_tags/identifier Get a Data Tag by ID
Intrinio::DataTagApi search_data_tags GET /data_tags/search Search Data Tags
Intrinio::FilingApi filter_filings GET /filings/filter Filter Filings
Intrinio::FilingApi get_all_filings GET /filings Get All Filings
Intrinio::FilingApi get_filing_by_id GET /filings/id Get a Filing by ID
Intrinio::FundamentalsApi get_fundamental_by_id GET /fundamentals/id Get a Fundamental by ID
Intrinio::FundamentalsApi get_fundamental_reported_financials GET /fundamentals/id/reported_financials Get Reported Financials for a Fundamental
Intrinio::FundamentalsApi get_fundamental_standardized_financials GET /fundamentals/id/standardized_financials Get Standardized Financials for a Fundamental
Intrinio::FundamentalsApi lookup_fundamental GET /fundamentals/lookup/identifier/statement_code/fiscal_year/fiscal_period Lookup a Fundamental
Intrinio::HistoricalDataApi get_historical_data GET /historical_data/identifier/tag Get Historical Data
Intrinio::IndexApi get_all_economic_indices GET /indices/economic Get All Economic Indices
Intrinio::IndexApi get_all_sic_indices GET /indices/sic Get All SIC Indices
Intrinio::IndexApi get_all_stock_market_indices GET /indices/stock_market Get All Stock Market Indices
Intrinio::IndexApi get_economic_index_by_id GET /indices/economic/identifier Get an Economic Index by ID
Intrinio::IndexApi get_economic_index_data_point_number GET /indices/economic/identifier/data_point/tag/number Get Economic Index Data Point (Number)
Intrinio::IndexApi get_economic_index_data_point_text GET /indices/economic/identifier/data_point/tag/text Get Economic Index Data Point (Text)
Intrinio::IndexApi get_economic_index_historical_data GET /indices/economic/identifier/historical_data/tag Get Economic Index Historical Data
Intrinio::IndexApi get_sic_index_by_id GET /indices/sic/identifier Get an SIC Index by ID
Intrinio::IndexApi get_sic_index_data_point_number GET /indices/sic/identifier/data_point/tag/number Get SIC Index Data Point (Number)
Intrinio::IndexApi get_sic_index_data_point_text GET /indices/sic/identifier/data_point/tag/text Get SIC Index Data Point (Text)
Intrinio::IndexApi get_sic_index_historical_data GET /indices/sic/identifier/historical_data/tag Get SIC Index Historical Data
Intrinio::IndexApi get_stock_market_index_by_id GET /indices/stock_market/identifier Get a Stock Market Index by ID
Intrinio::IndexApi get_stock_market_index_data_point_number GET /indices/stock_market/identifier/data_point/tag/number Get Stock Market Index Data Point (Number)
Intrinio::IndexApi get_stock_market_index_data_point_text GET /indices/stock_market/identifier/data_point/tag/text Get Stock Market Index Data Point (Text)
Intrinio::IndexApi get_stock_market_index_historical_data GET /indices/stock_market/identifier/historical_data/tag Get Stock Market Index Historical Data
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::SecurityApi get_all_securities GET /securities Get All Securiites
Intrinio::SecurityApi get_security_by_id GET /securities/identifier Get a Security by ID
Intrinio::SecurityApi get_security_data_point_number GET /securities/identifier/data_point/tag/number Get Security Data Point (Number)
Intrinio::SecurityApi get_security_data_point_text GET /securities/identifier/data_point/tag/text Get Security Data Point (Text)
Intrinio::SecurityApi get_security_historical_data GET /securities/identifier/historical_data/tag Get Security Historical Data
Intrinio::SecurityApi get_security_stock_price_adjustments GET /securities/identifier/prices/adjustments Get Stock Price Adjustments for Security
Intrinio::SecurityApi get_security_stock_prices GET /securities/identifier/prices Get Stock Prices for Security
Intrinio::SecurityApi screen_securities POST /securities/screen Screen Securities
Intrinio::SecurityApi search_securities GET /securities/search Search Securities
Intrinio::StockExchangeApi filter_stock_exchanges GET /stock_exchanges/filter Filter Stock Exchanges
Intrinio::StockExchangeApi get_all_stock_exchanges GET /stock_exchanges Get All Stock Exchanges
Intrinio::StockExchangeApi get_stock_exchange_by_id GET /stock_exchanges/identifier Get Stock Exchange by ID
Intrinio::StockExchangeApi get_stock_exchange_price_adjustments GET /stock_exchanges/identifier/prices/adjustments Get Stock Price Adjustments by Exchange
Intrinio::StockExchangeApi get_stock_exchange_prices GET /stock_exchanges/identifier/prices Get Stock Prices by Exchange
Intrinio::StockExchangeApi get_stock_exchange_securities GET /stock_exchanges/identifier/securities Get Securities by Exchange

Models