Skip to content

Latest commit

 

History

History
407 lines (238 loc) · 10.1 KB

ESGApi.md

File metadata and controls

407 lines (238 loc) · 10.1 KB

intrinio_sdk.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(country=country, industry=industry, ticker=ticker, page_size=page_size, next_page=next_page)

ESG Companies

Example

from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

country = 'Canada'
industry = 'Retail'
ticker = 'SHOP'
page_size = 100
next_page = ''

response = intrinio.ESGApi().get_esg_companies(country=country, industry=industry, ticker=ticker, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)

Parameters

Name Type Description Notes
country str [optional]  
industry str [optional]  
ticker str [optional]  
page_size int The number of results to return [optional] [default to 100]  
next_page str 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, page_size=page_size, next_page=next_page)

ESG Company Comprehensive Ratings History

Example

from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'AAPL'
page_size = 100
next_page = ''

response = intrinio.ESGApi().get_esg_company_comprehensive_ratings(identifier, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)

Parameters

Name Type Description Notes
identifier str ISIN, Intrinio ID, or Ticker  
page_size int The number of results to return [optional] [default to 100]  
next_page str 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, page_size=page_size, next_page=next_page)

ESG Company Ratings History

Example

from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'AAPL'
page_size = 100
next_page = ''

response = intrinio.ESGApi().get_esg_company_ratings(identifier, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)

Parameters

Name Type Description Notes
identifier str ISIN, Intrinio ID, or Ticker  
page_size int The number of results to return [optional] [default to 100]  
next_page str 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(country=country, page_size=page_size, next_page=next_page)

ESG Latest

Example

from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

country = 'USA'
page_size = 100
next_page = ''

response = intrinio.ESGApi().get_esg_latest(country=country, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)

Parameters

Name Type Description Notes
country str [optional]  
page_size int The number of results to return [optional] [default to 100]  
next_page str 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(country=country, page_size=page_size, next_page=next_page)

ESG Latest Comprehensive

Example

from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

country = 'USA'
page_size = 100
next_page = ''

response = intrinio.ESGApi().get_esg_latest_comprehensive(country=country, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)

Parameters

Name Type Description Notes
country str [optional]  
page_size int The number of results to return [optional] [default to 100]  
next_page str Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseESGLatestComprehensive