Intrinio::ESGApi

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

Method	HTTP request	Description
get_esg_companies	GET /esg/companies	ESG Companies
get_esg_company_comprehensive_ratings	GET /esg/identifier/comprehensive	ESG Company Comprehensive Ratings History
get_esg_company_ratings	GET /esg/identifier	ESG Company Ratings History
get_esg_latest	GET /esg	ESG Latest
get_esg_latest_comprehensive	GET /esg/comprehensive	ESG Latest Comprehensive

get_esg_companies

View Intrinio API Documentation

ApiResponseESGCompanies get_esg_companies(opts)

ESG 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

eSG_api = Intrinio::ESGApi.new

opts = {
  country: "Canada",
  industry: "Retail",
  ticker: "SHOP",
  page_size: 100,
  next_page: nil
}

result = eSG_api.get_esg_companies(opts)
pp result

Parameters

Name	Type	Description	Notes
country	String		[optional]
industry	String		[optional]
ticker	String		[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

ApiResponseESGCompanies

get_esg_company_comprehensive_ratings

View Intrinio API Documentation

ApiResponseESGCompanyComprehensiveRatingHistory get_esg_company_comprehensive_ratings(identifier, opts)

ESG Company Comprehensive Ratings History

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

eSG_api = Intrinio::ESGApi.new
identifier = "AAPL"

opts = {
  page_size: 100,
  next_page: nil
}

result = eSG_api.get_esg_company_comprehensive_ratings(identifier, opts)
pp result

Parameters

Name	Type	Description	Notes
identifier	String	ISIN, Intrinio ID, or Ticker
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

ApiResponseESGCompanyComprehensiveRatingHistory

get_esg_company_ratings

View Intrinio API Documentation

ApiResponseESGCompanyRatingHistory get_esg_company_ratings(identifier, opts)

ESG Company Ratings History

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

eSG_api = Intrinio::ESGApi.new
identifier = "AAPL"

opts = {
  page_size: 100,
  next_page: nil
}

result = eSG_api.get_esg_company_ratings(identifier, opts)
pp result

Parameters

Name	Type	Description	Notes
identifier	String	ISIN, Intrinio ID, or Ticker
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

ApiResponseESGCompanyRatingHistory

get_esg_latest

View Intrinio API Documentation

ApiResponseESGLatest get_esg_latest(opts)

ESG Latest

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

eSG_api = Intrinio::ESGApi.new

opts = {
  country: "USA",
  page_size: 100,
  next_page: nil
}

result = eSG_api.get_esg_latest(opts)
pp result

Parameters

Name	Type	Description	Notes
country	String		[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

ApiResponseESGLatest

get_esg_latest_comprehensive

View Intrinio API Documentation

ApiResponseESGLatestComprehensive get_esg_latest_comprehensive(opts)

ESG Latest Comprehensive

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

eSG_api = Intrinio::ESGApi.new

opts = {
  country: "USA",
  page_size: 100,
  next_page: nil
}

result = eSG_api.get_esg_latest_comprehensive(opts)
pp result

Parameters

Name	Type	Description	Notes
country	String		[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

ApiResponseESGLatestComprehensive