API Overview
TextReveal® API gives you programmatic access to SESAMm data: the ESG and SDG controversies behind Event Monitoring, global datasets and time series indicators built from our data lake, and on-demand AI Reports.
New to TextReveal®? Getting Started presents the platform and its key concepts.
Get started with the API
1. Authenticate
Every API request must include a JWT access token. Follow Authentication to get your API keys and exchange them for a token.
2. Make your first calls
- Find the companies you monitor with
GET /entities, and your portfolios withGET /universes. - Read the ESG controversies of a company with
GET /entities/{entity_id}/esg/cases, or of a whole portfolio withGET /universes/{universe_id}/esg/cases. - Download the notebooks for ready-to-run examples.
3. Connect an AI assistant (optional)
The MCP Server lets Claude, ChatGPT or your coding agent call the API for you.
Follow the latest API updates in the Changelog.
What the API covers
The API reference is organized in three sections, available from the navigation bar.
ESG & SDG data
The data behind Event Monitoring: entities and universes (portfolios in the platform), ESG cases and events with their intensity scores, the Controversy Exposure Score (CES), UNGC screening and SDG positive impact documents.
Global data & indicators
Direct access to our data lake, beyond ESG: extract datasets of documents for any set of entities or keywords, and build time series indicators such as sentiment or volume over several years.
Tasks
Long-running jobs: generate AI Reports on any company, or request a coverage extension to add companies to SESAMm's coverage.
Methodology
SESAMm employs a multi-layered approach to analyze ESG data:
- Natural Language Processing (NLP): initial analysis using language models and deep learning techniques.
- Entity Recognition and Clustering: identifies relevant companies and groups related articles into events and cases.
- Sentiment Analysis and Event Classification: determines the sentiment and classifies events based on predefined ESG categories.
- Human Quality Control: analysts review the results to refine and improve their accuracy.
The full methodology is available at sesamm.com/methodology.
Notebook
To facilitate the use of our API, two notebooks are available to help you access the data efficiently.
The TextReveal® api case monitoring notebook provides access to SESAMm's ESG and SDG data,
while the TextReveal® api use case notebook enables access to global data and indicators.
Please note that using these notebooks requires credentials, which are provided by your SESAMm point of contact.
These notebooks include reusable authentication examples that can be directly integrated into your internal systems, as well as route usage examples demonstrating how to chain endpoints and apply relevant parameters.
If you do not have the necessary credentials or access to specific routes used in the notebooks, please contact the SESAMm team for assistance.