🏎️Getting Started

Get up and running!

The ESG Pulse is our flagship metric that leverages our AI engine to look at daily news, media, and opinions for a given company, and then extract ESG signals on a per-company basis. We run sentiment analysis to give a score of -1 (negative) to +1 (positive) which can be broken down by what ESG topic.

The difference here compared to traditional ESG scoring, is that this is an unbiased system, every data point is available for review as an input into an overall score.

Typically a user is trying to do a few things:

  1. Get the company coverage

  2. See the scores for that company in different ways

  3. Investigate the material ESG issues for a given company

The base URL for the API is https://apis.esganalytics.io/{id}/

You can get the full URL for authentication by visiting https://dashboard.esganalytics.io and then clicking on your product and going to 'Authentication'

We cover 26 ESG Topics - which follows the SASB ESG framework. These can be used in certain endpoints, and for further filtering:'GHG Emissions', 'Air Quality', 'Energy Management', 'Water & Wastewater Management', 'Waste & Hazardous Materials Management', 'Ecological Impacts', 'Product Design & Lifecycle Management', 'Business Model Resilience', 'Supply Chain Management', 'Materials Sourcing & Efficiency', 'Physical Impacts of Climate Change', 'Labor Practices', 'Employee Health & Safety', 'Employee Engagement, Diversity & Inclusion', 'Human Rights & Community Relations', 'Customer Privacy', 'Data Security', 'Access & Affordability', 'Product Quality & Safety', 'Customer Welfare', 'Selling Practices & Product Labeling', 'Business Ethics', 'Competitive Behavior', 'Management of the Legal & Regulatory Environment', 'Critical Incident Risk Management', 'Systemic Risk Management'

Get the company coverage

You can get the company coverage by accessing the /company endpoint like this:

https://apis.esganalytics.io/7b2f6v3xevs7t3f2/company/

  [{
        "id": 190008,
        "company_name": "Fair Isaac Corporation",
        "sector": "Technology",
        "industry": "Software—Application",
        "gicSector": "Information Technology",
        "gicGroup": "Software & Services",
        "gicIndustry": "Software",
        "gicSubIndustry": "Application Software",
        "url": "http://www.fico.com",
        "company_pulse": 0.9068860139860148
    },
    {
        "id": 190011,
        "company_name": "Kimberly-Clark Corporation",
        "sector": "Consumer Defensive",
        "industry": "Household & Personal Products",
        "gicSector": "Consumer Staples",
        "gicGroup": "Household & Personal Products",
        "gicIndustry": "Household Products",
        "gicSubIndustry": "Household Products",
        "url": "http://www.kimberly-clark.com",
        "company_pulse": 0.9653215053763435
    }]

You can then use these IDs for future tasks. A full list of company coverage is also available here.

Let's use ID 190011 as our example going forwards for Kimberly Clark

See various company scores

Using our ID we can now investigate the company and its ESG performance using alternative data.

Company Details

This endpoint will give you the company summary, ESG Pulse and its involvement in certain activities such as Tobacco or deforestation

https://apis.esganalytics.io/7b2f6v3xevs7t3f2/company/details/?company_id=190011

Response example (we removed some objects to make it easier to read:

{
    "company_detail": [
        {
            "id": 190011,
            "company_name": "Kimberly-Clark Corporation",
            "description": "Kimberly-Clark Corporation, together with its subsidiaries, manufactures and markets personal care, consumer tissue, and professional products worldwide. It operates through three segments: Personal Care, Consumer Tissue, and K-C Professional. The Personal Care segment offers disposable diapers, training and youth pants, swimpants, baby wipes, feminine and incontinence care products, and other related products under the Huggies, Pull-Ups, Little Swimmers, GoodNites, DryNites, Kotex, U by Kotex, Intimus, Depend, Plenitud, Poise, and other brand names. The Consumer Tissue segment provides facial and bathroom tissues, paper towels, napkins, and related products under the Kleenex, Scott, Cottonelle, Viva, Andrex, Scottex, Neve, and other brand names. The K-C Professional segment offers wipers, tissues, towels, apparel, soaps, and sanitizers under the Kleenex, Scott, WypAll, Kimtech, and KleenGuard brands. The company sells household use products directly to supermarkets, mass merchandisers, drugstores, warehouse clubs, variety and department stores, and other retail outlets, as well as through other distributors and e-commerce; and away-from-home use products directly to manufacturing, lodging, office building, food service, and public facilities, as well as through distributors. Kimberly-Clark Corporation was founded in 1872 and is headquartered in Dallas, Texas.",
            "gicSector": "Consumer Staples",
            "gicSubIndustry": "Household Products",
            "company_pulse": 0.9653215053763435,
            "pos_neg_ratio": [
                {
                    "sentiment_rank": "negative",
                    "total": 3
                },
                {
                    "sentiment_rank": "positive",
                    "total": 183
                }
            ]
        }
    ],
    "securities": [
        {
            "exchange": "New York Stock Exchange",
            "exchange_id": 69,
            "code": "KMB",
            "securities_type": "Common Stock",
            "currency_code": "USD"
        },
        {
            "exchange": "Frankfurt Exchange",
            "exchange_id": 12,
            "code": "KMY",
            "securities_type": "Common Stock",
            "currency_code": "EUR"
        }
    ],
    "executives": [
        {
            "name": "Mr. Michael D. Hsu",
            "title": "Chairman & CEO",
            "dob": "1964-01-01",
            "salary": 0,
            "bonus": 0,
            "stock_awards": 0,
            "option_awards": 0,
            "non_equity_incentives": 0,
            "pension_and_deferred": 0,
            "other_comp": 0,
            "total_compensation": 0
        },
     
        {
          ...
        }
    ],
    "all_executives": [
        {
            "name": "Mr. Mark A. Clouse",
            "title": "Pres, CEO & Director",
            "dob": "1968-01-01",
            "salary": 515068,
            "bonus": 0,
            "stock_awards": 2910107,
            "option_awards": 1951621,
            "non_equity_incentives": 1120883,
            "pension_and_deferred": 0,
            "other_comp": 398095,
            "total_compensation": 6895774
        },
        {
            ...
        }
    ],
    "indicators": [
        {
            "Adult Activity": "No",
            "Alcohol": "No",
            "Animal Testing": "Yes",
            "Catholic Values": "No",
            "Controversial Weapons": "No",
            "Small Arms": "No",
            "Fur & Leather": "No",
            "Gambling": "No",
            "GMO": "No",
            "Military Contracts": "No",
            "Nuclear": "No",
            "Pesticides": "No",
            "Palm Oil": "No",
            "Coal": "No",
            "Tobacco": "No",
            "Gender Equality": "",
            "Renewable Energy": "Yes",
            "Clean Oceans": "",
            "Oil & Gas": "",
            "Deforestation Financing": "",
            "Deforestation": "",
            "Prison Industry": "",
            "Innovation": ""
        }
    ]
}

Company Score Time Series

To get a time series of the ESG Pulse by week

https://apis.esganalytics.io/7b2f6v3xevs7t3f2/company/sentiment/?company_id=190011&group_by=week

This will give you a time series of the ESG Pulse and the company's stock price for comparison.

{
    "sent_queryset": [
        {
            "date": "2018-01-29T00:00:00",
            "average_sentiment": 0.991,
            "sent_mov_avg": 0.991
        },
        {
            "date": "2018-02-05T00:00:00",
            "average_sentiment": 0.9718,
            "sent_mov_avg": 0.9814
        }
        ],
    "stock_queryset": [
        {
            "date": "1980-04-01T00:00:00",
            "price": 40.752
        },
        {
            "date": "1980-05-01T00:00:00",
            "price": 41.256
        }
        ]
}

You can also add a filtered view to this by ESG Topic by using the query parameter filter_option and including one or more filters like this:

https://apis.esganalytics.io/7b2f6v3xevs7t3f2/company/sentiment/?company_id=190011&group_by=week&filter_option=["GHG Emissions","Employee Health %26 Safety"]

Company Snapshot

This feed will provide you a snapshot vs industry for the company, which is useful for creating charts like this or assessing gaps to investigate

https://apis.esganalytics.io/7b2f6v3xevs7t3f2/company/nlp/?feed_type=flags&company_id=190011

Company External Scores

Sometimes it's useful to compare the outside in view (ESG Pulse) to the traditional scoring providers, we give you this data to make your job easier.

https://apis.esganalytics.io/7b2f6v3xevs7t3f2/company/external/?company_id=190011

This will provide the scores from MSCI, Sustainalytics, Refinitiv and S&P as well as their normalized scores (since they all use different rating scales) and also a correlation matrix, which you can compare and contrast with.

{
    "details": [
        {
            "update_date": "2022-03-07",
            "snp": 27.0,
            "snp_link": "https://www.spglobal.com/esg/scores/results?cid=4060881",
            "refinitiv": 73.0,
            "refinitiv_link": "https://www.refinitiv.com/en/sustainable-finance/esg-scores",
            "sustainalytics": 22.0,
            "sustainalytics_link": "https://www.sustainalytics.com/esg-rating/kimberly-clark-corp/1008162103",
            "msci": "AA",
            "msci_link": "https://www.msci.com/our-solutions/esg-investing/esg-ratings/esg-ratings-corporate-search-tool/issuer/kimberly-clark-corporation/IID000000002134808",
            "snp_norm": 27.0,
            "refinitiv_norm": 73.0,
            "sustainalytics_norm": 55.0,
            "msci_norm": 85.67999999999999
        }
    ],
    "correlation": [
        [
            1.0,
            -0.089,
            0.17,
            -0.757
        ],
        [
            -0.089,
            1.0,
            0.833,
            0.633
        ],
        [
            0.17,
            0.833,
            1.0,
            0.515
        ],
        [
            -0.757,
            0.633,
            0.515,
            1.0
        ]
    ]
}

Investigating Material Issues

To understand the actual issues that are underlying these scores, you can use the /nlp/ endpoint, which can be filtered based on sentiment scores and topics.

As an example, if you wanted to find all issues that are positive for Kimberly Clark (they are a particularly good company - and nice to show some positive impacts!) related to "Employee Engagement, Diversity and Inclusion" we would use

https://apis.esganalytics.io/7b2f6v3xevs7t3f2/company/nlp/?esg_topics=Employee Engagement, Diversity %26 Inclusion&sentiment_score=0.5&comparison=greater&company_id=190011&feed_type=mini

This would give us a consolidated set of the ESG events that contributed to this query. This is a paginated response, so please use the query param 'page' for future 

{
    "count": 31,
    "next": "https://api.esganalytics.io/api/company/nlp/?company_id=190011&comparison=greater&esg_topics=Employee+Engagement%2C+Diversity+%26+Inclusion&feed_type=mini&page=2&sentiment_score=0.5",
    "previous": null,
    "results": {
        "details": [
            {
                "id": 190011,
                "company_name": "Kimberly-Clark Corporation"
            }
        ],
        "analysis": [
            {
                "id": 59518763,
                "published_at": "2022-08-02T12:00:09Z",
                "title": "Kimberly-Clark Reports Progress Toward 2030 Sustainability Goals",
                "source": "Yahoo Entertainment",
                "source_fk": "",
                "sentiment_score": 0.9991,
                "sentiment_rank": "positive",
                "esg_topics": [
                    "Product Design & Lifecycle Management",
                    "Water & Wastewater Management",
                    "Employee Engagement, Diversity & Inclusion",
                    "GHG Emissions"
                ],
                "url": "https://finance.yahoo.com/news/kimberly-clark-reports-progress-toward-120009705.html"
            },
            {
                "id": 59518530,
                "published_at": "2022-08-01T12:30:08Z",
                "title": "Kimberly-Clark Recognized as One of the 2022 World's Most Ethical Companies by Ethisphere",
                "source": "Yahoo Entertainment",
                "source_fk": "",
                "sentiment_score": 0.9982,
                "sentiment_rank": "positive",
                "esg_topics": [
                    "Employee Engagement, Diversity & Inclusion",
                    "Business Ethics",
                    "Management of the Legal & Regulatory Environment"
                ],
                "url": "https://finance.yahoo.com/news/kimberly-clark-recognized-one-2022-123008217.html"
            },
            {
                "id": 59518377,
                "published_at": "2022-08-01T12:16:00Z",
                "title": "Kimberly-Clark Recognized as One of the 2022 World's Most Ethical Companies by Ethisphere",
                "source": "PRNewswire",
                "source_fk": "",
                "sentiment_score": 0.9992,
                "sentiment_rank": "positive",
                "esg_topics": [
                    "Employee Engagement, Diversity & Inclusion",
                    "Business Model Resilience",
                    "Business Ethics",
                    "Management of the Legal & Regulatory Environment"
                ],
                "url": "https://www.prnewswire.com/news-releases/kimberly-clark-recognized-as-one-of-the-2022-worlds-most-ethical-companies-by-ethisphere-301592717.html"
            },
            {
                "id": 59503950,
                "published_at": "2022-06-21T12:02:00Z",
                "title": "Kimberly-Clark Named One of the Top 75 Companies for Executive Women by Seramount for the Sixth Consecutive Year",
                "source": "PRNewswire",
                "source_fk": "",
                "sentiment_score": 0.9993,
                "sentiment_rank": "positive",
                "esg_topics": [
                    "Human Rights & Community Relations",
                    "Employee Engagement, Diversity & Inclusion"
                ],
                "url": "https://www.prnewswire.com/news-releases/kimberly-clark-named-one-of-the-top-75-companies-for-executive-women-by-seramount-for-the-sixth-consecutive-year-301571105.html"
            },
            {
                "id": 59484142,
                "published_at": "2022-05-17T20:59:10Z",
                "title": "Kimberly-Clark Corporation(KMB) Goldman Sachs Global Staples Forum Conference (Transcript)",
                "source": "Seeking Alpha",
                "source_fk": "",
                "sentiment_score": 1.0,
                "sentiment_rank": "positive",
                "esg_topics": [
                    "Product Quality & Safety",
                    "Management of the Legal & Regulatory Environment",
                    "Employee Engagement, Diversity & Inclusion"
                ],
                "url": "https://seekingalpha.com/article/4512674-kimberly-clark-corporation-kmb-goldman-sachs-global-staples-forum-conference-transcript"
            },
            {
                "id": 59365127,
                "published_at": "2022-01-27T15:15:08Z",
                "title": "Kimberly-Clark Earns Perfect Score on Human Rights Campaign Foundation's 2022 Corporate Equality Index",
                "source": "Yahoo Entertainment",
                "source_fk": "",
                "sentiment_score": 0.9977,
                "sentiment_rank": "positive",
                "esg_topics": [
                    "Employee Engagement, Diversity & Inclusion",
                    "Human Rights & Community Relations"
                ],
                "url": "https://finance.yahoo.com/news/kimberly-clark-earns-perfect-score-151508984.html"
            },
            {
                "id": 59353333,
                "published_at": "2022-01-18T15:00:00Z",
                "title": "KIMBERLY-CLARK NAMED ONE OF AMERICA'S MOST JUST COMPANIES BY JUST CAPITAL",
                "source": "PRNewswire",
                "source_fk": "",
                "sentiment_score": 0.9987,
                "sentiment_rank": "positive",
                "esg_topics": [
                    "Labor Practices",
                    "Employee Engagement, Diversity & Inclusion"
                ],
                "url": "https://www.prnewswire.com/news-releases/kimberly-clark-named-one-of-americas-most-just-companies-by-just-capital-301462282.html"
            }
        ]
    }
}

You can also get the full text and other data points using the /nlp/item/ endpoint.

PreviousAuthenticationNextAPI Reference

Last updated