ZacksApi.md

Intrinio::ZacksApi

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

Method	HTTP request	Description
get_zacks_analyst_ratings	GET /zacks/analyst_ratings	Zacks Analyst Ratings
get_zacks_ebitda_consensus	GET /zacks/ebitda_consensus	Zacks EBITDA Consensus
get_zacks_eps_estimates	GET /zacks/eps_estimates	Zacks EPS Estimates
get_zacks_eps_growth_rates	GET /zacks/eps_growth_rates	Zacks EPS Growth Rates
get_zacks_eps_surprises	GET /zacks/eps_surprises	Zacks EPS Surprises
get_zacks_etf_holdings	GET /zacks/etf_holdings	Zacks ETF Holdings
get_zacks_forward_pe	GET /zacks/forward_pe	Zacks Forward PE Estimates
get_zacks_forward_pe_by_identifier	GET /zacks/forward_pe/{identifier}	Zacks Forward PE by identifer
get_zacks_institutional_holding_companies	GET /zacks/institutional_holdings/companies	Zacks Institutional Holding Companies
get_zacks_institutional_holding_owners	GET /zacks/institutional_holdings/owners	Zacks Institutional Holding Owners
get_zacks_institutional_holdings	GET /zacks/institutional_holdings	Zacks Institutional Holdings
get_zacks_long_term_growth_rates	GET /zacks/long_term_growth_rates	Zacks Long Term Growth Rates
get_zacks_sales_estimates	GET /zacks/sales_estimates	Zacks Sales Estimates
get_zacks_sales_surprises	GET /zacks/sales_surprises	Zacks Sales Surprises
get_zacks_target_price_consensuses	GET /zacks/target_price_consensuses	Zacks Target Price Consensuses

get_zacks_analyst_ratings

View Intrinio API Documentation

ApiResponseZacksAnalystRatings get_zacks_analyst_ratings(opts)

Zacks Analyst Ratings

This database offers consensus analyst recommendations for over 5,000 US and Canadian listed companies.

Example

# 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

zacks_api = Intrinio::ZacksApi.new

opts = {
  identifier: "AAPL",
  start_date: nil,
  end_date: nil,
  mean_greater: nil,
  mean_less: nil,
  strong_buys_greater: nil,
  strong_buys_less: nil,
  buys_greater: nil,
  buys_less: nil,
  holds_greater: nil,
  holds_less: nil,
  sells_greater: nil,
  sells_less: nil,
  strong_sells_greater: nil,
  strong_sells_less: nil,
  total_greater: nil,
  total_less: nil,
  page_size: 100,
  next_page: nil
}

result = zacks_api.get_zacks_analyst_ratings(opts)
pp result

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)	[optional]
start_date	Date	Limit ratings to those on or after this date	[optional]
end_date	Date	Limit ratings to those on or before this date	[optional]
mean_greater	Float	Return only records with a mean (average) higher than this value	[optional]
mean_less	Float	Return only records with a mean (average) lower than this value	[optional]
strong_buys_greater	Integer	Return only records with more than this many Strong Buy recommendations	[optional]
strong_buys_less	Integer	Return only records with fewer than this many Strong Buy recommendations	[optional]
buys_greater	Integer	Return only records with more than this many Buy recommendations	[optional]
buys_less	Integer	Return only records with fewer than this many Buy recommendations	[optional]
holds_greater	Integer	Return only records with more than this many Hold recommendations	[optional]
holds_less	Integer	Return only records with fewer than this many Hold recommendations	[optional]
sells_greater	Integer	Return only records with more than this many Sell recommendations	[optional]
sells_less	Integer	Return only records with fewer than this many Sell recommendations	[optional]
strong_sells_greater	Integer	Return only records with more than this many Strong Sell recommendations	[optional]
strong_sells_less	Integer	Return only records with fewer than this many Strong Sell recommendations	[optional]
total_greater	Integer	Return only records with more than this many recommendations, regardless of type	[optional]
total_less	Integer	Return only records with fewer than this many recommendations, regardless of type	[optional]
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

ApiResponseZacksAnalystRatings

get_zacks_ebitda_consensus

View Intrinio API Documentation

ApiResponseZacksEBITDAConsensus get_zacks_ebitda_consensus(opts)

Zacks EBITDA Consensus

This database offers consensus EBITDA-related estimates for over 4,000 US and Canadian listed companies.

Example

# 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

zacks_api = Intrinio::ZacksApi.new

opts = {
  identifier: "AAPL",
  type: nil,
  next_page: nil
}

result = zacks_api.get_zacks_ebitda_consensus(opts)
pp result

Parameters

Name	Type	Description	Notes
identifier	String	A Company identifier (Ticker, CIK, LEI, Intrinio ID)	[optional]
type	String	Limit EBITDA estimates to this type	[optional]
next_page	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseZacksEBITDAConsensus

get_zacks_eps_estimates

View Intrinio API Documentation

ApiResponseZacksEPSEstimates get_zacks_eps_estimates(opts)

Zacks EPS Estimates

This database offers consensus earnings estimates for over 5,000 US and Canadian listed companies.

Example

# 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

zacks_api = Intrinio::ZacksApi.new

opts = {
  identifier: "AAPL",
  start_date: nil,
  end_date: nil,
  fiscal_year: nil,
  fiscal_period: nil,
  calendar_year: nil,
  calendar_period: nil,
  page_size: 100,
  next_page: nil
}

result = zacks_api.get_zacks_eps_estimates(opts)
pp result

Parameters

Name	Type	Description	Notes
identifier	String	A Company identifier (Ticker, CIK, LEI, Intrinio ID)	[optional]
start_date	Date	Limit EPS estimates to those on or after this date	[optional]
end_date	Date	Limit EPS estimates to those on or before this date	[optional]
fiscal_year	Integer	Only for the given fiscal year	[optional]
fiscal_period	String	The fiscal period	[optional]
calendar_year	Integer	Only for the given calendar year	[optional]
calendar_period	String	The calendar period	[optional]
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

ApiResponseZacksEPSEstimates

get_zacks_eps_growth_rates

View Intrinio API Documentation

ApiResponseZacksEPSGrowthRates get_zacks_eps_growth_rates(opts)

Zacks EPS Growth Rates

This database offers consensus EPS growth rate estimates, comparing company estimates to historical company estimates, industry estimates, and S&P 500 index estimates.

Example

# 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

zacks_api = Intrinio::ZacksApi.new

opts = {
  company: "AAPL",
  industry_group_name: nil,
  industry_group_number: nil,
  page_size: 100,
  next_page: nil
}

result = zacks_api.get_zacks_eps_growth_rates(opts)
pp result

Parameters

Name	Type	Description	Notes
company	String	Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID)	[optional]
industry_group_name	String	Return only growth rates for companies in the given Zacks industry group name	[optional]
industry_group_number	String	Return only growth rates for companies in the given Zacks industry group number	[optional]
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

ApiResponseZacksEPSGrowthRates

get_zacks_eps_surprises

View Intrinio API Documentation

ApiResponseZacksEPSSurprises get_zacks_eps_surprises(opts)

Zacks EPS Surprises

This database returns historical estimated and actual earnings, guidance, and announcement dates for 17,000+ US and Canadian listed companies.

Example

# 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

zacks_api = Intrinio::ZacksApi.new

opts = {
  start_date: nil,
  end_date: nil,
  eps_actual_greater: nil,
  eps_actual_less: nil,
  eps_mean_estimate_greater: nil,
  eps_mean_estimate_less: nil,
  eps_amount_diff_greater: nil,
  eps_amount_diff_less: nil,
  eps_percent_diff_greater: nil,
  eps_percent_diff_less: nil,
  eps_count_estimate_greater: nil,
  eps_count_estimate_less: nil,
  eps_std_dev_estimate_greater: nil,
  eps_std_dev_estimate_less: nil,
  page_size: 100,
  next_page: nil
}

result = zacks_api.get_zacks_eps_surprises(opts)
pp result

Parameters

Name	Type	Description	Notes
start_date	Date	Limit EPS surprises to those on or after this date	[optional]
end_date	Date	Limit EPS surprises to those on or before this date	[optional]
eps_actual_greater	Float	Return only records with an actual EPS higher than this value	[optional]
eps_actual_less	Float	Return only records with an actual EPS lower than this value	[optional]
eps_mean_estimate_greater	Float	Return only records with an EPS mean estimate greater than this value	[optional]
eps_mean_estimate_less	Float	Return only records with an EPS mean estimate lower than this value	[optional]
eps_amount_diff_greater	Float	Return only records with an EPS amount difference greater than this value	[optional]
eps_amount_diff_less	Float	Return only records with an EPS amount difference less than this value	[optional]
eps_percent_diff_greater	Float	Return only records with an EPS percent difference greater than this value	[optional]
eps_percent_diff_less	Float	Return only records with an EPS percent difference less than this value	[optional]
eps_count_estimate_greater	Float	Return only records with an EPS count estimate greater than this value	[optional]
eps_count_estimate_less	Float	Return only records with an EPS count estimate less than this value	[optional]
eps_std_dev_estimate_greater	Float	Return only records with an EPS standard deviation greater than this value	[optional]
eps_std_dev_estimate_less	Float	Return only records with an EPS standard deviation less than this value	[optional]
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

ApiResponseZacksEPSSurprises

get_zacks_etf_holdings

View Intrinio API Documentation

ApiResponseZacksETFHoldings get_zacks_etf_holdings(opts)

Zacks ETF Holdings

Returns Zacks ETF holdings data

Example

# 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

zacks_api = Intrinio::ZacksApi.new

opts = {
  etf_ticker: "SPY",
  holding_symbol: "AAPL",
  weight_greater: nil,
  weight_less: nil,
  page_size: 100,
  next_page: nil
}

result = zacks_api.get_zacks_etf_holdings(opts)
pp result

Parameters

Name	Type	Description	Notes
etf_ticker	String	Return holdings of the ETF with the given ticker	[optional]
holding_symbol	String	Return holdings where the instrument being held has the given trading symbol	[optional]
weight_greater	Float	Return on the holdings with a weight greater than	[optional]
weight_less	Float	Return on the holdings with a weight less than	[optional]
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

ApiResponseZacksETFHoldings

get_zacks_forward_pe

View Intrinio API Documentation

ApiResponseZacksForwardPEs get_zacks_forward_pe(opts)

Zacks Forward PE Estimates

This database offers price-to-earning ratio estimates for over 4,000 US and Canadian listed companies.

Example

# 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

zacks_api = Intrinio::ZacksApi.new

opts = {
  next_page: nil
}

result = zacks_api.get_zacks_forward_pe(opts)
pp result

Parameters

Name	Type	Description	Notes
next_page	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseZacksForwardPEs

get_zacks_forward_pe_by_identifier

View Intrinio API Documentation

ZacksForwardPE get_zacks_forward_pe_by_identifier(identifier)

Zacks Forward PE by identifer

Returns the forward PE estimates for the identifier

Example

# 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

zacks_api = Intrinio::ZacksApi.new
identifier = "MSFT"

result = zacks_api.get_zacks_forward_pe_by_identifier(identifier)
pp result

Parameters

Name	Type	Description	Notes
identifier	String	An Intrinio ID or ticker for a Security

Return type

ZacksForwardPE

get_zacks_institutional_holding_companies

View Intrinio API Documentation

ApiResponseZacksInstitutionalHoldingCompanies get_zacks_institutional_holding_companies(opts)

Zacks Institutional Holding Companies

Returns Zacks institutional holding companies data

Example

# 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

zacks_api = Intrinio::ZacksApi.new

opts = {
  ticker: nil,
  page_size: 100,
  next_page: nil
}

result = zacks_api.get_zacks_institutional_holding_companies(opts)
pp result

Parameters

Name	Type	Description	Notes
ticker	String	Return companies with the given ticker	[optional]
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

ApiResponseZacksInstitutionalHoldingCompanies

get_zacks_institutional_holding_owners

View Intrinio API Documentation

ApiResponseZacksInstitutionalHoldingOwners get_zacks_institutional_holding_owners(opts)

Zacks Institutional Holding Owners

Returns Zacks institutional holding owners data

Example

# 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

zacks_api = Intrinio::ZacksApi.new

opts = {
  cik: nil,
  page_size: 100,
  next_page: nil
}

result = zacks_api.get_zacks_institutional_holding_owners(opts)
pp result

Parameters

Name	Type	Description	Notes
cik	String	Return owners with the given Central Index Key (CIK)	[optional]
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

ApiResponseZacksInstitutionalHoldingOwners

get_zacks_institutional_holdings

View Intrinio API Documentation

ApiResponseZacksInstitutionalHoldings get_zacks_institutional_holdings(opts)

Zacks Institutional Holdings

Returns Zacks institutional holdings data

Example

# 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

zacks_api = Intrinio::ZacksApi.new

opts = {
  ticker: nil,
  owner_cik: nil,
  page_size: 100,
  next_page: nil
}

result = zacks_api.get_zacks_institutional_holdings(opts)
pp result

Parameters

Name	Type	Description	Notes
ticker	String	Return holdings where the company being held has the given ticker	[optional]
owner_cik	String	Return holdings where the owner/holder has the given Central Index Key (CIK)	[optional]
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

ApiResponseZacksInstitutionalHoldings

get_zacks_long_term_growth_rates

View Intrinio API Documentation

ApiResponseZacksLongTermGrowthRates get_zacks_long_term_growth_rates(opts)

Zacks Long Term Growth Rates

This database offers consensus long term growth rate estimates, including insight into changes in estimates and revisions over time.

Example

# 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

zacks_api = Intrinio::ZacksApi.new

opts = {
  identifier: "AAPL",
  page_size: 100,
  next_page: nil
}

result = zacks_api.get_zacks_long_term_growth_rates(opts)
pp result

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)	[optional]
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

ApiResponseZacksLongTermGrowthRates

get_zacks_sales_estimates

View Intrinio API Documentation

ApiResponseZacksSalesEstimates get_zacks_sales_estimates(opts)

Zacks Sales Estimates

This database offers consensus sales estimates for over 5,000 US and Canadian listed companies.

Example

# 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

zacks_api = Intrinio::ZacksApi.new

opts = {
  identifier: "AAPL",
  start_date: nil,
  end_date: nil,
  fiscal_year: nil,
  fiscal_period: nil,
  calendar_year: nil,
  calendar_period: nil,
  next_page: nil,
  page_size: 100,
  next_page2: nil
}

result = zacks_api.get_zacks_sales_estimates(opts)
pp result

Parameters

Name	Type	Description	Notes
identifier	String	A Company identifier (Ticker, CIK, LEI, Intrinio ID)	[optional]
start_date	Date	Limit Sales estimates to those on or after this date	[optional]
end_date	Date	Limit Sales estimates to those on or before this date	[optional]
fiscal_year	Integer	Only for the given fiscal year	[optional]
fiscal_period	String	The fiscal period	[optional]
calendar_year	Integer	Only for the given calendar year	[optional]
calendar_period	String	The calendar period	[optional]
next_page	String	Gets the next page of data from a previous API call	[optional]
page_size	Integer	The number of results to return	[optional] [default to 100]
next_page2	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseZacksSalesEstimates

get_zacks_sales_surprises

View Intrinio API Documentation

ApiResponseZacksSalesSurprises get_zacks_sales_surprises(opts)

Zacks Sales Surprises

This database returns historical estimated and actual sales, guidance, and announcement dates for 17,000+ US and Canadian listed companies.

Example

# 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

zacks_api = Intrinio::ZacksApi.new

opts = {
  start_date: nil,
  end_date: nil,
  sales_actual_greater: nil,
  sales_actual_less: nil,
  sales_mean_estimate_greater: nil,
  sales_mean_estimate_less: nil,
  sales_amount_diff_greater: nil,
  sales_amount_diff_less: nil,
  sales_percent_diff_greater: nil,
  sales_percent_diff_less: nil,
  sales_count_estimate_greater: nil,
  sales_count_estimate_less: nil,
  sales_std_dev_estimate_greater: nil,
  sales_std_dev_estimate_less: nil,
  page_size: 100,
  next_page: nil
}

result = zacks_api.get_zacks_sales_surprises(opts)
pp result

Parameters

Name	Type	Description	Notes
start_date	Date	Limit sales surprises to those on or after this date	[optional]
end_date	Date	Limit sales surprises to those on or before this date	[optional]
sales_actual_greater	Float	Return only records with an actual sales higher than this value	[optional]
sales_actual_less	Float	Return only records with an actual sales lower than this value	[optional]
sales_mean_estimate_greater	Float	Return only records with a sales mean estimate greater than this value	[optional]
sales_mean_estimate_less	Float	Return only records with a sales mean estimate lower than this value	[optional]
sales_amount_diff_greater	Float	Return only records with a sales amount difference greater than this value	[optional]
sales_amount_diff_less	Float	Return only records with a sales amount difference less than this value	[optional]
sales_percent_diff_greater	Float	Return only records with a sales percent difference greater than this value	[optional]
sales_percent_diff_less	Float	Return only records with a sales percent difference less than this value	[optional]
sales_count_estimate_greater	Float	Return only records with a sales count estimate greater than this value	[optional]
sales_count_estimate_less	Float	Return only records with a sales count estimate less than this value	[optional]
sales_std_dev_estimate_greater	Float	Return only records with a sales standard deviation greater than this value	[optional]
sales_std_dev_estimate_less	Float	Return only records with a sales standard deviation less than this value	[optional]
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

ApiResponseZacksSalesSurprises

get_zacks_target_price_consensuses

View Intrinio API Documentation

ApiResponseZacksTargetPriceConsensuses get_zacks_target_price_consensuses(opts)

Zacks Target Price Consensuses

Returns the latest Zacks target price consensus data

Example

# 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

zacks_api = Intrinio::ZacksApi.new

opts = {
  identifier: "AAPL",
  industry_group_number: nil,
  page_size: 100,
  next_page: nil
}

result = zacks_api.get_zacks_target_price_consensuses(opts)
pp result

Parameters

Name	Type	Description	Notes
identifier	String	Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID)	[optional]
industry_group_number	String	Return only growth rates for companies in the given Zacks industry group number	[optional]
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

ApiResponseZacksTargetPriceConsensuses