Welcome to ESG Enterprise API docs. #
ESG Enterprise is an ESG data platform designed for organizations with a need to integrate ESG data into their internal systems or websites. ESG Enterprise uses industry best practices to harvest, process, and normalize public and private data into comprehensive ESG ratings and metrics.
This guide is designed to provide you with everything you need to familiarize yourself with ESG Enterprise real-time ESG data, and if authorized, to access the data via API.
API Overview #
ESG Enterprise APIs provide real-time vehicle location information in JSON formats.
Organizations that purchase ESG Enterprise API License can provide real-time ESG data to 3rd parties for the purpose of developing applications, websites, and other interfaces to internal IT systems.
ESG Enterprise welcomes extending and create a broad ecosystem of applications using our ESG data. All ESG Enterprise API use must be compliance with API License Agreement.
Authorization #
All requests to the ESG Enterprise API must be authorized. Authorization is accomplished by including a security token generated from ESG Enterprise app.
REST API STRUCTURE #
The REST URL designed to be simple and as stateless protocol with specification GET operations.
API Primary Data Server:
https://tf689y3hbj.execute-api.us-east-1.amazonaws.com
- GET /prod/authorization/search
Fetches ESG scores or indicators of one or more companies by name or stock symbols. The scores returned are total score of E/S/G, and individual score of E/S/G with letter grade and level. The indicators are by SDG/SASB standard metrics and weights.
There are currently over 40,000 companies and ratings and indicators updated every day in batches.
Parameter: token (string)
Security token generated within ESG Enterprise app. To get new security token, please register and go to Analytics -> API menu item to generate token.
Parameter: q (string)
By company name(s) – For single name, specify name. For multiple company names, separate names by commas. Ex. Microsoft, Visa, Intel
By ESG Id – Retrieve company based on their ESG ID. This is helpful for quick and direct access to targeted company and their ID. If use case is to retrieve the same company scores, using ID is more reliable than company name in general. ESG ID are part of return JSON result from search by company name.
By stock symbol(s) – For single symbol, state the symbol. For multiple stock tickers, separate symbols by commas. Ex. MSFT, V, INTC
By stock symbols and exchanges – To be precise on company stock tickers, use exchange name with a colon and followed by stock symbol. Ex. NASDAQ:MSFT, NYSE:XOM
Exchange names:
ADX, AMEX, AMS, ASX, Bahrain Bourse, BCBA, BIT, BKK, BME, BMV, BVMF, CPH, CVE, DFM, EBR, ELI, ENXL, EPA, ETR, FALSE, HKG, IDX, IST, JSE, KLSE, KOSDAQ, LON, NASDAQ, NSE, NYSE, OTCBB, OTCMKTS, QSE, SGX, SHA, SHE, STO, SWX, Tadawul, TLV, TPE, TSE, TYO, XAMS, XBRU, XMSM, XPAR
Note: Recommends to use both stock symbol and exchange name for more precise querying.
Examples:
a. https://tf689y3hbj.execute-api.us-east-1.amazonaws.com/prod/authorization/search?q=Visa&token=<your security token>
Returns ESG rating for one company by name
b. https://tf689y3hbj.execute-api.us-east-1.amazonaws.com/prod/authorization/search?q=id:7573&token=<your security token>
Returns ESG rating for one company by id
c. https://tf689y3hbj.execute-api.us-east-1.amazonaws.com/prod/authorization/search?q=tse:aqn&token=<your security token>
Returns ESG rating for one company by exchange : stock symbol
d. https://tf689y3hbj.execute-api.us-east-1.amazonaws.com/prod/authorization/search?q=ge&token=<your security token>
Returns ESG rating for one company by stock symbol only
e. https://tf689y3hbj.execute-api.us-east-1.amazonaws.com/prod/authorization/search?q=v,nasdaq:msft,exxon&token=<your security token>
Returns ESG ratings for multiple companies by name, stock symbol and exchange : stock symbol
ESG Score JSON Result:
2.GET /prod/authorization/goals
Return companies’ ESG rating by SDG and SASB metrics and scores
Parameter: q (string)
By company name(s) – For single name, specify name. For multiple company names, separate names by commas. Ex. Microsoft, Visa, Intel
By stock symbol(s) – For single symbol, state the symbol. For multiple stock tickers, separate symbols by commas. Ex. MSFT, V, INTC
By stock symbols and exchanges – To be precise on company stock tickers, use exchange name with a colon and followed by stock symbol. Ex. NASDAQ:MSFT, NYSE:XOM
Exchange names:
ADX, AMEX, AMS, ASX, Bahrain Bourse, BCBA, BIT, BKK, BME, BMV, BVMF, CPH, CVE, DFM, EBR, ELI, ENXL, EPA, ETR, FALSE, HKG, IDX, IST, JSE, KLSE, KOSDAQ, LON, NASDAQ, NSE, NYSE, OTCBB, OTCMKTS, QSE, SGX, SHA, SHE, STO, SWX, Tadawul, TLV, TPE, TSE, TYO, XAMS, XBRU, XMSM, XPAR
Note: Recommends to use both stock symbol and exchange name for more precise querying.
Examples:
a. https://tf689y3hbj.execute-api.us-east-1.amazonaws.com/prod/authorization/goals?q=Visa&token=<your security token>
Returns ESG rating for one company by name
b. https://tf689y3hbj.execute-api.us-east-1.amazonaws.com/prod/authorization/goals?q=tse:aqn&token=<your security token>
Returns ESG rating for one company by exchange : stock symbol
c. https://tf689y3hbj.execute-api.us-east-1.amazonaws.com/prod/authorization/goals?q=ge&token=<your security token>
Returns ESG rating for one company by stock symbol only
d. https://tf689y3hbj.execute-api.us-east-1.amazonaws.com/prod/authorization/goals?q=v,nasdaq:msft,exxon&token=<your security token>
Returns ESG ratings for multiple companies by name, stock symbol and exchange : stock symbol
ESG Ratings by Indicators JSON Result:
