Skip to content

ESGApi.md

Latest commit

 

History

History
436 lines (253 loc) · 9.71 KB

ESGApi.md

File metadata and controls

436 lines (253 loc) · 9.71 KB

intrinioSDK.ESGApi

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

Method HTTP request Description
getEsgCompanies GET /esg/companies ESG Companies
getEsgCompanyComprehensiveRatings GET /esg/{identifier}/comprehensive ESG Company Comprehensive Ratings History
getEsgCompanyRatings GET /esg/{identifier} ESG Company Ratings History
getEsgLatest GET /esg ESG Latest
getEsgLatestComprehensive GET /esg/comprehensive ESG Latest Comprehensive

getEsgCompanies

View Intrinio API Documentation

ApiResponseESGCompanies getEsgCompanies(opts)

ESG Companies

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var eSG = new intrinioSDK.ESGApi();

var opts = { 
  'country': "Canada",
  'industry': "Retail",
  'ticker': "SHOP",
  'pageSize': 100,
  'nextPage': null
};

eSG.getEsgCompanies(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
country String [optional]  
industry String [optional]  
ticker String [optional]  
pageSize Number The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseESGCompanies

getEsgCompanyComprehensiveRatings

View Intrinio API Documentation

ApiResponseESGCompanyComprehensiveRatingHistory getEsgCompanyComprehensiveRatings(identifier, opts)

ESG Company Comprehensive Ratings History

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var eSG = new intrinioSDK.ESGApi();

var identifier = "AAPL";


var opts = { 
  'pageSize': 100,
  'nextPage': null
};

eSG.getEsgCompanyComprehensiveRatings(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String ISIN, Intrinio ID, or Ticker  
pageSize Number The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseESGCompanyComprehensiveRatingHistory

getEsgCompanyRatings

View Intrinio API Documentation

ApiResponseESGCompanyRatingHistory getEsgCompanyRatings(identifier, opts)

ESG Company Ratings History

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var eSG = new intrinioSDK.ESGApi();

var identifier = "AAPL";


var opts = { 
  'pageSize': 100,
  'nextPage': null
};

eSG.getEsgCompanyRatings(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String ISIN, Intrinio ID, or Ticker  
pageSize Number The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseESGCompanyRatingHistory

getEsgLatest

View Intrinio API Documentation

ApiResponseESGLatest getEsgLatest(opts)

ESG Latest

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var eSG = new intrinioSDK.ESGApi();

var opts = { 
  'country': "USA",
  'pageSize': 100,
  'nextPage': null
};

eSG.getEsgLatest(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
country String [optional]  
pageSize Number The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseESGLatest

getEsgLatestComprehensive

View Intrinio API Documentation

ApiResponseESGLatestComprehensive getEsgLatestComprehensive(opts)

ESG Latest Comprehensive

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var eSG = new intrinioSDK.ESGApi();

var opts = { 
  'country': "USA",
  'pageSize': 100,
  'nextPage': null
};

eSG.getEsgLatestComprehensive(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
country String [optional]  
pageSize Number The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseESGLatestComprehensive