Skip to content

Latest commit

 

History

History
451 lines (265 loc) · 9.87 KB

ESGApi.md

File metadata and controls

451 lines (265 loc) · 9.87 KB

IntrinioSDK::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

# Setup client
client <- IntrinioSDK::ApiClient$new()

# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"

#Configure retries
client$configuration$allowRetries <- TRUE

# Setup API with client
ESGApi <- IntrinioSDK::ESGApi$new(client)

# Optional params
opts <- list(
  country = "Canada",
  industry = "Retail",
  ticker = "SHOP",
  page_size = 100,
  next_page = NULL
)

response <- ESGApi$get_esg_companies(opts)

print(response)
print(response$content)

Parameters

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

# Setup client
client <- IntrinioSDK::ApiClient$new()

# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"

#Configure retries
client$configuration$allowRetries <- TRUE

# Setup API with client
ESGApi <- IntrinioSDK::ESGApi$new(client)

# Required params
identifier <- "AAPL"

# Optional params
opts <- list(
  page_size = 100,
  next_page = NULL
)

response <- ESGApi$get_esg_company_comprehensive_ratings(identifier, opts)

print(response)
print(response$content)

Parameters

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

# Setup client
client <- IntrinioSDK::ApiClient$new()

# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"

#Configure retries
client$configuration$allowRetries <- TRUE

# Setup API with client
ESGApi <- IntrinioSDK::ESGApi$new(client)

# Required params
identifier <- "AAPL"

# Optional params
opts <- list(
  page_size = 100,
  next_page = NULL
)

response <- ESGApi$get_esg_company_ratings(identifier, opts)

print(response)
print(response$content)

Parameters

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

# Setup client
client <- IntrinioSDK::ApiClient$new()

# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"

#Configure retries
client$configuration$allowRetries <- TRUE

# Setup API with client
ESGApi <- IntrinioSDK::ESGApi$new(client)

# Optional params
opts <- list(
  country = "USA",
  page_size = 100,
  next_page = NULL
)

response <- ESGApi$get_esg_latest(opts)

print(response)
print(response$content)

Parameters

Name Type Description Notes
country Character [optional]  
page_size Integer The number of results to return [optional] [default to 100]  
next_page Character 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

# Setup client
client <- IntrinioSDK::ApiClient$new()

# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"

#Configure retries
client$configuration$allowRetries <- TRUE

# Setup API with client
ESGApi <- IntrinioSDK::ESGApi$new(client)

# Optional params
opts <- list(
  country = "USA",
  page_size = 100,
  next_page = NULL
)

response <- ESGApi$get_esg_latest_comprehensive(opts)

print(response)
print(response$content)

Parameters

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

Return type

ApiResponseESGLatestComprehensive