emissions-api-sdk 1.0.3 → 1.0.5

package/sphinx-build/.secrets.baseline

@@ -0,0 +1,150 @@
+{
+  "exclude": {
+    "files": "^.secrets.baseline$",
+    "lines": null
+  },
+  "generated_at": "2026-02-16T08:57:50Z",
+  "plugins_used": [
+    {
+      "name": "AWSKeyDetector"
+    },
+    {
+      "name": "ArtifactoryDetector"
+    },
+    {
+      "name": "AzureStorageKeyDetector"
+    },
+    {
+      "base64_limit": 4.5,
+      "name": "Base64HighEntropyString"
+    },
+    {
+      "name": "BasicAuthDetector"
+    },
+    {
+      "name": "BoxDetector"
+    },
+    {
+      "name": "CloudantDetector"
+    },
+    {
+      "ghe_instance": "github.ibm.com",
+      "name": "GheDetector"
+    },
+    {
+      "name": "GitHubTokenDetector"
+    },
+    {
+      "hex_limit": 3,
+      "name": "HexHighEntropyString"
+    },
+    {
+      "name": "IbmCloudIamDetector"
+    },
+    {
+      "name": "IbmCosHmacDetector"
+    },
+    {
+      "name": "JwtTokenDetector"
+    },
+    {
+      "keyword_exclude": null,
+      "name": "KeywordDetector"
+    },
+    {
+      "name": "MailchimpDetector"
+    },
+    {
+      "name": "NpmDetector"
+    },
+    {
+      "name": "PrivateKeyDetector"
+    },
+    {
+      "name": "SlackDetector"
+    },
+    {
+      "name": "SoftlayerDetector"
+    },
+    {
+      "name": "SquareOAuthDetector"
+    },
+    {
+      "name": "StripeDetector"
+    },
+    {
+      "name": "TwilioKeyDetector"
+    }
+  ],
+  "results": {
+    "source/authentication.rst": [
+      {
+        "hashed_secret": "d92258e9826f7923e5fa45241420653a89db10b0",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 41,
+        "type": "Secret Keyword",
+        "verified_result": null
+      },
+      {
+        "hashed_secret": "9eddf3741c2ec20058940c3225b3e387cf6166dd",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 152,
+        "type": "Secret Keyword",
+        "verified_result": null
+      }
+    ],
+    "source/client.rst": [
+      {
+        "hashed_secret": "9eddf3741c2ec20058940c3225b3e387cf6166dd",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 108,
+        "type": "Secret Keyword",
+        "verified_result": null
+      }
+    ],
+    "source/getting_started.rst": [
+      {
+        "hashed_secret": "11fa7c37d697f30e6aee828b4426a10f83ab2380",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 122,
+        "type": "Secret Keyword",
+        "verified_result": null
+      }
+    ],
+    "source/troubleshooting.rst": [
+      {
+        "hashed_secret": "ade7ae7ec3dcbc8e6efab2ad366fd59b4be60bda",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 129,
+        "type": "Secret Keyword",
+        "verified_result": null
+      },
+      {
+        "hashed_secret": "24de2a83c833555a5931a357cb9a639830db7851",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 191,
+        "type": "Secret Keyword",
+        "verified_result": null
+      },
+      {
+        "hashed_secret": "11fa7c37d697f30e6aee828b4426a10f83ab2380",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 224,
+        "type": "Secret Keyword",
+        "verified_result": null
+      }
+    ]
+  },
+  "version": "0.13.1+ibm.64.dss",
+  "word_list": {
+    "file": null,
+    "hash": null
+  }
+}

package/sphinx-build/requirements.txt

@@ -1,5 +1,4 @@
 sphinx==8.1.3
 furo==2025.7.19
-nbsphinx==0.9.7
 sphinxcontrib-httpdomain==1.8.1
-pandoc
+sphinx-js

package/sphinx-build/source/index.rst

@@ -20,11 +20,13 @@ The **emissions-api-sdk** is a Node.js SDK for using Emissions API in your proje
 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  
-* **Generic** – custom emission calculations  
+* **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.

package/sphinx-build/source/reference.rst

@@ -27,6 +27,10 @@ API
 
 .. js:autofunction:: TransportationAndDistribution.calculate
 
+.. js:autofunction:: RealEstate.calculate
+
+.. js:autofunction:: EconomicActivity.calculate
+
 Metadata APIs
 ===========
 
@@ -47,6 +51,10 @@ getTypes
 
 .. js:autofunction:: Fugitive.getTypes
 
+.. js:autofunction:: RealEstate.getTypes
+
+.. js:autofunction:: EconomicActivity.getTypes
+
 getArea
 -------
 
@@ -66,6 +74,10 @@ getArea
 
 .. js:autofunction:: Fugitive.getArea
 
+.. js:autofunction:: RealEstate.getArea
+
+.. js:autofunction:: EconomicActivity.getArea
+
 getUnits
 --------
 
@@ -83,6 +95,10 @@ getUnits
 
 .. js:autofunction:: Fugitive.getUnits
 
+.. js:autofunction:: RealEstate.getUnits
+
+.. js:autofunction:: EconomicActivity.getUnits
+
 
 Usage API
 ===========

package/src/Constants.ts

@@ -9,6 +9,8 @@ export const TRANSPORTATION_AND_DISTRIBUTION_API_PATH = "/v3/carbon/transportati
 export const FACTOR_API_PATH = "/v3/carbon/factor";
 export const FACTOR_SET_API_PATH = "/v3/carbon/factorset";
 export const SEARCH_API_PATH = "/v3/carbon/factor/search";
+export const ECONOMIC_ACTIVITY_API_PATH = "/v3/carbon/economic-activity";
+export const REAL_ESTATE_API_PATH = "/v3/carbon/real-estate";
 
 export const CALCULATION_TYPES = "/v3/carbon/calculation/types";
 export const LOCATION_TYPES = "/v3/carbon/location/types";
@@ -17,6 +19,8 @@ export const MOBILE_API_TYPES = "/v3/carbon/mobile/types";
 export const STATIONARY_API_TYPES = "/v3/carbon/stationary/types";
 export const FACTOR_API_TYPES = "/v3/carbon/factor/types";
 export const TRANSPORTATION_AND_DISTRIBUTION_API_TYPES = "/v3/carbon/transportation-and-distribution/types";
+export const REAL_ESTATE_API_TYPES = "/v3/carbon/real-estate/types";
+export const ECONOMIC_ACTIVITY_API_TYPES = "/v3/carbon/economic-activity/types";
 
 export const FUGITIVE_API_AREA = "/v3/carbon/fugitive/area";
 export const GENERAL_API_AREA = "/v3/carbon/calculation/area";
@@ -26,6 +30,8 @@ export const STATIONARY_API_AREA = "/v3/carbon/stationary/area";
 export const TRANSPORTATION_AND_DISTRIBUTION_API_AREA = "/v3/carbon/transportation-and-distribution/area";
 export const SEARCH_API_AREA = "/v3/carbon/factor/search/area";
 export const FACTOR_API_AREA = "/v3/carbon/factor/area";
+export const REAL_ESTATE_API_AREA = "/v3/carbon/real-estate/area";
+export const ECONOMIC_ACTIVITY_API_AREA = "/v3/carbon/economic-activity/area";
 
 export const FUGITIVE_API_UNITS = "/v3/carbon/fugitive/units";
 export const LOCATION_API_UNITS = "/v3/carbon/location/units";
@@ -34,6 +40,8 @@ export const STATIONARY_API_UNITS = "/v3/carbon/stationary/units";
 export const GENERAL_API_UNITS = "/v3/carbon/calculation/units";
 export const FACTOR_API_UNITS = "/v3/carbon/factor/units";
 export const TRANSPORTATION_AND_DISTRIBUTION_API_UNITS = "/v3/carbon/transportation-and-distribution/units";
+export const REAL_ESTATE_API_UNITS = "/v3/carbon/real-estate/units";
+export const ECONOMIC_ACTIVITY_API_UNITS = "/v3/carbon/economic-activity/units";
 
 export const USAGE_API = "/v3/carbon/usage";
 

package/src/api/EconomicActivity.ts

@@ -0,0 +1,115 @@
+import { Client } from "../Client";
+import { ECONOMIC_ACTIVITY_API_PATH, ECONOMIC_ACTIVITY_API_AREA, ECONOMIC_ACTIVITY_API_TYPES, ECONOMIC_ACTIVITY_API_UNITS, GET, POST } from "../Constants";
+import { CommonRequest } from "../interfaces/Api";
+import { AreaResponse } from "../interfaces/response/AreaResponse";
+import { EmissionResponse } from "../interfaces/response/EmissionResponse";
+import { EmissionResponseWithDetails } from "../interfaces/response/EmissionResponseWithDetails";
+import { TypeResponse } from "../interfaces/response/TypeResponse";
+import { UnitResponse } from "../interfaces/response/UnitResponse";
+import { makeApiRequest } from "../request";
+
+/**
+ * Performs scope 3 Spend based emission calculations by making a POST request to the economic activity API endpoint.
+ *
+ * @export
+ * @param {CommonRequest} payload - The request data to be sent to the API
+ * @return {Promise<EmissionResponse | EmissionResponseWithDetails>} A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const request = {
+    "time": {
+      "date": "2025-01-04"
+    },
+    "location": {
+      "country": "usa"
+    },
+    "activity": {
+      "type": "accomodation",
+      "value": 1500.12,
+      "unit": "usd"
+    },
+    "includeDetails": false
+  };
+ * const result = await calculate(request);
+ */
+
+export async function calculate(
+  payload: CommonRequest
+): Promise<EmissionResponse | EmissionResponseWithDetails> {
+  const client = Client.getInstance();
+  const url =  client.getDomain() + ECONOMIC_ACTIVITY_API_PATH;
+
+  return makeApiRequest<EmissionResponse | EmissionResponseWithDetails>({
+    method: POST,
+    url,
+    data: payload,
+  });
+}
+
+/**
+ * Retrieves available economic activity emission calculation types by making a GET request to the API endpoint.
+ *
+ * @export
+ * @return {Promise<TypeResponse>} A promise that resolves to a TypeResponse containing the available economic activity emission types
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const types = await getTypes();
+ */
+export async function getTypes(
+): Promise<TypeResponse> {
+  const client = Client.getInstance();
+  const url = client.getDomain() + ECONOMIC_ACTIVITY_API_TYPES;
+
+  return makeApiRequest<TypeResponse>({
+    method: GET,
+    url
+  });
+}
+
+/**
+ * Retrieves information about geographical areas supported by the economic activity emissions API.
+ *
+ * @export
+ * @return {Promise<AreaResponse>} A promise that resolves to an AreaResponse containing the supported geographical areas
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const areas = await getArea();
+ */
+export async function getArea(
+): Promise<AreaResponse> {
+  const client = Client.getInstance();
+  const url = client.getDomain() + ECONOMIC_ACTIVITY_API_AREA;
+
+  return makeApiRequest<AreaResponse>({
+    method: GET,
+    url
+  });
+}
+
+/**
+ * Retrieves available units for a specific economic activity emission type.
+ *
+ * @export
+ * @param {string} type - The economic activity emission type to get units for (e.g., "accomodation")
+ * @return {Promise<UnitResponse>} A promise that resolves to a UnitResponse containing the available units
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * // Get units for the "accomodation" emission economic activity type without subtype
+ * const units = await getUnits("accomodation");
+ */
+export async function getUnits(
+  type : string
+): Promise<UnitResponse> {
+  const client = Client.getInstance();
+  const url = client.getDomain() + ECONOMIC_ACTIVITY_API_UNITS;
+
+  return makeApiRequest<UnitResponse>({
+    method: GET,
+    url,
+    params : { type }
+  });
+}

package/src/api/RealEstate.ts

@@ -0,0 +1,116 @@
+import { Client } from "../Client";
+import { REAL_ESTATE_API_AREA, REAL_ESTATE_API_PATH, REAL_ESTATE_API_TYPES, REAL_ESTATE_API_UNITS, GET, POST } from "../Constants";
+import { CommonRequest } from "../interfaces/Api";
+import { AreaResponse } from "../interfaces/response/AreaResponse";
+import { EmissionResponse } from "../interfaces/response/EmissionResponse";
+import { EmissionResponseWithDetails } from "../interfaces/response/EmissionResponseWithDetails";
+import { TypeResponse } from "../interfaces/response/TypeResponse";
+import { UnitResponse } from "../interfaces/response/UnitResponse";
+import { makeApiRequest } from "../request";
+
+/**
+ * Performs scope 3 Real estate emission calculations by making a POST request to the real estate API endpoint.
+ *
+ * @export
+ * @param {CommonRequest} payload - The request data to be sent to the API
+ * @return {Promise<EmissionResponse | EmissionResponseWithDetails>} A promise that resolves to the emission calculation result. Returns EmissionResponseWithDetails if includeDetails is true, otherwise EmissionResponse
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const request = {
+    "time": {
+      "date": "2025-01-04"
+    },
+    "location": {
+      "country": "usa"
+    },
+    "activity": {
+      "type": "Commercial Real Estate:Industrial distribution warehouse",
+      "value": 17000.123,
+      "unit": "m2"
+    },
+    "includeDetails": false
+  };
+ * const result = await calculate(request);
+ */
+
+export async function calculate(
+  payload: CommonRequest
+): Promise<EmissionResponse | EmissionResponseWithDetails> {
+  const client = Client.getInstance();
+  const url =  client.getDomain() + REAL_ESTATE_API_PATH;
+
+  return makeApiRequest<EmissionResponse | EmissionResponseWithDetails>({
+    method: POST,
+    url,
+    data: payload,
+  });
+}
+
+/**
+ * Retrieves available Real estate emission calculation types by making a GET request to the API endpoint.
+ *
+ * @export
+ * @return {Promise<TypeResponse>} A promise that resolves to a TypeResponse containing the available Real estate emission types
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const types = await getTypes();
+ */
+export async function getTypes(
+): Promise<TypeResponse> {
+  const client = Client.getInstance();
+  const url = client.getDomain() + REAL_ESTATE_API_TYPES;
+
+  return makeApiRequest<TypeResponse>({
+    method: GET,
+    url
+  });
+}
+
+/**
+ * Retrieves information about geographical areas supported by the real estate emissions API.
+ *
+ * @export
+ * @return {Promise<AreaResponse>} A promise that resolves to an AreaResponse containing the supported geographical areas
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * const areas = await getArea();
+ */
+export async function getArea(
+): Promise<AreaResponse> {
+  const client = Client.getInstance();
+  const url = client.getDomain() + REAL_ESTATE_API_AREA;
+
+  return makeApiRequest<AreaResponse>({
+    method: GET,
+    url
+  });
+}
+
+/**
+ * Retrieves available units for a specific Real estate emission type.
+ *
+ * @export
+ * @param {string} type - The Real estate emission type to get units for (e.g., "R134A")
+ * @return {Promise<UnitResponse>} A promise that resolves to a UnitResponse containing the available units
+ * @throws {Error} May throw an error if the API request fails
+ *
+ * @example
+ * // Get units for the "Commercial Real Estate:Industrial distribution warehouse" emission real estate type with subtype
+ * const units = await getUnits("Commercial Real Estate:Industrial distribution warehouse");
+
+ */
+export async function getUnits(
+  type : string
+): Promise<UnitResponse> {
+  const client = Client.getInstance();
+  const url = client.getDomain() + REAL_ESTATE_API_UNITS;
+
+  return makeApiRequest<UnitResponse>({
+    method: GET,
+    url,
+    params : { type }
+  });
+}

package/src/index.ts

@@ -8,6 +8,8 @@ export * as TransportationAndDistribution from './api/TransportationAndDistribut
 export * as Usage from './api/Usage'
 export * as Factor from './api/Factor';
 export * as FactorSets from './api/FactorSets'
+export * as EconomicActivity from './api/EconomicActivity';
+export * as RealEstate from './api/RealEstate';
 export { ClientConfig } from './interfaces/Config';
 
 // Response interfaces

package/src/interfaces/response/EmissionResponseWithDetails.ts

@@ -78,6 +78,12 @@ export interface FactorDataTypeCode {
   
   /** Unique factor identifier */
   factorId: number;
+  
+  /** activity based or spend based */
+  methodology: string;
+
+  /** scopes data belongs to */
+	scope : string[];
 }
 
 /**

package/src/interfaces/response/FactorResponse.ts

@@ -62,17 +62,16 @@ export interface FactorResponse {
   
   /** Publication end date in ISO format (optional) */
   publishedTo?: string;
-
-  /** Effective start date in ISO format (optional) */
-  effectiveFrom?: string;
-
-  /** Effective end date in ISO format (optional) */
-  effectiveTo?: string;
-
   
   /** Geographic region (e.g., "Earth", "India") */
   region: string;
   
   /** Unique factor identifier */
   factorId: number;
+
+  /** activity based or spend based */
+  methodology: string;
+
+  /** scopes data belongs to */
+	scope : string[];
 }

package/test/apiTest.test.ts

@@ -5,6 +5,8 @@ import * as mobileApi from "../src/api/Mobile";
 import * as stationaryApi from "../src/api/Stationary";
 import * as GenericCalculation from "../src/api/Calculation";
 import * as TransportationDistributionApi from "../src/api/TransportationAndDistribution";
+import * as economicActivityApi from "../src/api/EconomicActivity";
+import * as realEstateApi from "../src/api/RealEstate";
 import * as UsageApi from "../src/api/Usage";
 import * as Factors from "../src/api/Factor";
 import * as FactorSets from "../src/api/FactorSets";
@@ -41,7 +43,15 @@ import {
   GENERAL_API_UNITS,
   FACTOR_API_UNITS,
   TRANSPORTATION_AND_DISTRIBUTION_API_UNITS,
-  USAGE_API
+  USAGE_API,
+  ECONOMIC_ACTIVITY_API_PATH,
+  ECONOMIC_ACTIVITY_API_TYPES,
+  REAL_ESTATE_API_PATH,
+  REAL_ESTATE_API_TYPES,
+  ECONOMIC_ACTIVITY_API_AREA,
+  REAL_ESTATE_API_AREA,
+  ECONOMIC_ACTIVITY_API_UNITS,
+  REAL_ESTATE_API_UNITS
 } from "../src/Constants";
 import locationPayload from "./mocks/LocationRequest";
 import commonpayload from "./mocks/CommonRequest";
@@ -112,6 +122,20 @@ const testCases: ApiTestCase[] = [
     payload: GenericCalculationPayload,
     method: "POST",
   },
+  {
+    name: "Economic activity API",
+    func: economicActivityApi.calculate,
+    path: ECONOMIC_ACTIVITY_API_PATH,
+    payload: commonpayload,
+    method: "POST",
+  },
+  {
+    name: "Real estate API",
+    func: realEstateApi.calculate,
+    path: REAL_ESTATE_API_PATH,
+    payload: commonpayload,
+    method: "POST",
+  },
   {
     name: "FactorSet API",
     func: FactorSets.get,
@@ -149,6 +173,18 @@ const testCases: ApiTestCase[] = [
     path: STATIONARY_API_TYPES,
     method: "GET",
   },
+  {
+    name: "Economic activity API - getTypes",
+    func: economicActivityApi.getTypes,
+    path: ECONOMIC_ACTIVITY_API_TYPES,
+    method: "GET",
+  },
+  {
+    name: "Real estate API - getTypes",
+    func: realEstateApi.getTypes,
+    path: REAL_ESTATE_API_TYPES,
+    method: "GET",
+  },
   {
     name: "GenericCalculation API - getTypes",
     func: GenericCalculation.getTypes,
@@ -191,6 +227,18 @@ const testCases: ApiTestCase[] = [
     path: STATIONARY_API_AREA,
     method: "GET",
   },
+  {
+    name: "Economic activity API - getArea",
+    func: economicActivityApi.getArea,
+    path: ECONOMIC_ACTIVITY_API_AREA,
+    method: "GET",
+  },
+  {
+    name: "Real estate API - getArea",
+    func: realEstateApi.getArea,
+    path: REAL_ESTATE_API_AREA,
+    method: "GET",
+  },
   {
     name: "GenericCalculation API - getArea",
     func: GenericCalculation.getArea,
@@ -243,6 +291,20 @@ const testCases: ApiTestCase[] = [
     queryParams: { type: "Jet Kerosene" },
     method: "GET",
   },
+  {
+    name: "Economic activity API - getUnits",
+    func: economicActivityApi.getUnits,
+    path: ECONOMIC_ACTIVITY_API_UNITS,
+    queryParams: { type: "accomodation" },
+    method: "GET",
+  },
+  {
+    name: "Real estate API - getUnits",
+    func: realEstateApi.getUnits,
+    path: REAL_ESTATE_API_UNITS,
+    queryParams: { type: "Commercial Real Estate:Hotel" },
+    method: "GET",
+  },
   {
     name: "GenericCalculation API - getUnits",
     func: GenericCalculation.getUnits,