IBM Envizi - Emissions API Node.js SDK

Contents:

• Getting Started
  • Prerequisites
  • Installation
  • Authentication
  • First API Call
  • Example Response
  • Example Response with Details
  • Currency Conversion Support
• SDK
  • Client
  • Authentication
• Authentication
  • Overview
  • Authentication Methods
  • Authentication Flow
  • Authentication Headers
  • Architecture Diagram
  • Security Best Practices
• Client
  • Overview
  • Client Initialization
  • Configuration Options
  • Client Responsibilities
  • Error Handling
  • Best Practices
  • Authentication Integration
• Reference
  • Client
  • request.makeApiRequest()
  • utils.findExpiryTime()
  • API
  • Type Recommender API
  • Audit Log API
  • Global Metadata API
  • Usage API
  • Interfaces
• Troubleshooting Guide
  • Overview
  • SDK Initialization Errors
  • Client Instance Errors
  • Token Management
  • Error Summary Table
  • Required Configuration Parameters
  • Initialization Checklist
  • Common Scenarios
  • Troubleshooting Steps
  • Support

Introduction

IBM Envizi - Emissions API (Emissions API) is a managed factor database and calculation engine for embedding greenhouse gas (GHG) emissions calculations into operational decision making.

The emissions-api-sdk is a Node.js SDK for using Emissions API in your projects.

Supported Emission Types

• Location – emissions from region-specific factors

• Fugitive – emissions from leaks or fugitive sources

• Mobile – emissions from vehicles and mobile equipment

• Stationary – emissions from fixed fuel consumption

• Transportation & distribution – logistics and supply chain activities

• Real Estate – emissions from commercial and residential properties

• Economic Activity – spend-based emissions from business activities

• Generic – custom emission calculations

The SDK is designed for embedding emission calculations in applications, building sustainability dashboards, automating large-scale datasets, and tracking carbon footprints.

Additional capabilities

• Metadata API – query supported types, areas, and units across endpoints

• Type Recommender API – semantic search to identify likely activity types, with optional reranker control and scope in results

• Factor Search API – search for emission factors with unit and scope filtering, with optional reranker control

• Usage API – retrieve organization billing-period or historical usage

• Audit Log API – manage whether API requests and responses are stored for auditing