emissions-api-sdk 1.0.12 → 1.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (120) hide show
  1. package/README.md +65 -2
  2. package/dist/Constants.js +7 -1
  3. package/dist/api/AuditExport.js +73 -0
  4. package/dist/api/AuditLog.js +99 -0
  5. package/dist/api/EconomicActivity.js +69 -0
  6. package/dist/api/Factor.js +16 -0
  7. package/dist/api/PhysicalActivity.js +87 -0
  8. package/dist/api/RealEstate.js +25 -1
  9. package/dist/api/TypeRecommender.js +19 -2
  10. package/dist/coverage/clover.xml +172 -89
  11. package/dist/coverage/coverage-final.json +15 -8
  12. package/dist/coverage/lcov-report/index.html +21 -21
  13. package/dist/coverage/lcov-report/src/Client.ts.html +32 -32
  14. package/dist/coverage/lcov-report/src/Constants.ts.html +45 -27
  15. package/dist/coverage/lcov-report/src/api/AuditExport.ts.html +355 -0
  16. package/dist/coverage/lcov-report/src/api/AuditLog.ts.html +388 -0
  17. package/dist/coverage/lcov-report/src/api/Calculation.ts.html +1 -1
  18. package/dist/coverage/lcov-report/src/api/EconomicActivity.ts.html +212 -5
  19. package/dist/coverage/lcov-report/src/api/Factor.ts.html +54 -3
  20. package/dist/coverage/lcov-report/src/api/FactorSets.ts.html +1 -1
  21. package/dist/coverage/lcov-report/src/api/Fugitive.ts.html +1 -1
  22. package/dist/coverage/lcov-report/src/api/Location.ts.html +1 -1
  23. package/dist/coverage/lcov-report/src/api/Metadata.ts.html +1 -1
  24. package/dist/coverage/lcov-report/src/api/Mobile.ts.html +1 -1
  25. package/dist/coverage/lcov-report/src/api/PhysicalActivity.ts.html +361 -0
  26. package/dist/coverage/lcov-report/src/api/RealEstate.ts.html +78 -6
  27. package/dist/coverage/lcov-report/src/api/Stationary.ts.html +1 -1
  28. package/dist/coverage/lcov-report/src/api/TransportationAndDistribution.ts.html +1 -1
  29. package/dist/coverage/lcov-report/src/api/TypeRecommender.ts.html +55 -4
  30. package/dist/coverage/lcov-report/src/api/Usage.ts.html +1 -1
  31. package/dist/coverage/lcov-report/src/api/index.html +51 -6
  32. package/dist/coverage/lcov-report/src/index.html +7 -7
  33. package/dist/coverage/lcov-report/src/request.ts.html +8 -5
  34. package/dist/coverage/lcov-report/src/utils.ts.html +6 -6
  35. package/dist/coverage/lcov-report/test/index.html +1 -1
  36. package/dist/coverage/lcov-report/test/mocks/AttributionRequest.ts.html +151 -0
  37. package/dist/coverage/lcov-report/test/mocks/CommonRequest.ts.html +1 -1
  38. package/dist/coverage/lcov-report/test/mocks/EconomicActivityAttributionRequest.ts.html +148 -0
  39. package/dist/coverage/lcov-report/test/mocks/FactorRequest.ts.html +1 -1
  40. package/dist/coverage/lcov-report/test/mocks/GenericCalculationRequest.ts.html +1 -1
  41. package/dist/coverage/lcov-report/test/mocks/LocationRequest.ts.html +1 -1
  42. package/dist/coverage/lcov-report/test/mocks/PhysicalActivityEVICRequest.ts.html +148 -0
  43. package/dist/coverage/lcov-report/test/mocks/PhysicalActivityRequest.ts.html +151 -0
  44. package/dist/coverage/lcov-report/test/mocks/SearchRequest.ts.html +1 -1
  45. package/dist/coverage/lcov-report/test/mocks/index.html +63 -3
  46. package/dist/coverage/lcov-report/test/testUtils.ts.html +1 -1
  47. package/dist/coverage/lcov.info +284 -124
  48. package/dist/index.js +4 -1
  49. package/dist/interfaces/response/AuditExportResponse.js +2 -0
  50. package/dist/interfaces/response/AuditLogResponse.js +2 -0
  51. package/dist/request.js +1 -0
  52. package/dist/types/Constants.d.ts +6 -0
  53. package/dist/types/api/AuditExport.d.ts +42 -0
  54. package/dist/types/api/AuditLog.d.ts +37 -0
  55. package/dist/types/api/EconomicActivity.d.ts +69 -0
  56. package/dist/types/api/Factor.d.ts +16 -0
  57. package/dist/types/api/PhysicalActivity.d.ts +76 -0
  58. package/dist/types/api/RealEstate.d.ts +25 -1
  59. package/dist/types/api/TypeRecommender.d.ts +19 -2
  60. package/dist/types/index.d.ts +6 -0
  61. package/dist/types/interfaces/Api.d.ts +17 -1
  62. package/dist/types/interfaces/Config.d.ts +5 -1
  63. package/dist/types/interfaces/common.d.ts +40 -0
  64. package/dist/types/interfaces/response/AuditExportResponse.d.ts +66 -0
  65. package/dist/types/interfaces/response/AuditLogResponse.d.ts +40 -0
  66. package/dist/types/interfaces/response/TypeRecommenderResponse.d.ts +2 -0
  67. package/docs/_sources/authentication.rst.txt +26 -4
  68. package/docs/_sources/getting_started.rst.txt +762 -74
  69. package/docs/_sources/index.rst.txt +13 -0
  70. package/docs/_sources/reference.rst.txt +48 -0
  71. package/docs/_sources/troubleshooting.rst.txt +77 -12
  72. package/docs/_static/basic.css +8 -0
  73. package/docs/_static/doctools.js +5 -6
  74. package/docs/_static/language_data.js +186 -7
  75. package/docs/_static/pygments.css +146 -164
  76. package/docs/_static/searchtools.js +60 -121
  77. package/docs/_static/sphinx_highlight.js +31 -36
  78. package/docs/_static/styles/furo.css +1 -1
  79. package/docs/_static/styles/furo.css.map +1 -1
  80. package/docs/authentication.html +61 -26
  81. package/docs/client.html +33 -22
  82. package/docs/genindex.html +77 -24
  83. package/docs/getting_started.html +969 -103
  84. package/docs/index.html +69 -21
  85. package/docs/reference.html +747 -66
  86. package/docs/sdk.html +32 -21
  87. package/docs/search.html +32 -21
  88. package/docs/searchindex.js +1 -1
  89. package/docs/troubleshooting.html +105 -38
  90. package/package.json +8 -3
  91. package/sphinx-build/source/authentication.rst +26 -4
  92. package/sphinx-build/source/getting_started.rst +762 -74
  93. package/sphinx-build/source/index.rst +13 -0
  94. package/sphinx-build/source/reference.rst +48 -0
  95. package/sphinx-build/source/troubleshooting.rst +77 -12
  96. package/src/Constants.ts +6 -0
  97. package/src/api/AuditExport.ts +90 -0
  98. package/src/api/AuditLog.ts +102 -0
  99. package/src/api/EconomicActivity.ts +69 -0
  100. package/src/api/Factor.ts +17 -1
  101. package/src/api/PhysicalActivity.ts +92 -0
  102. package/src/api/RealEstate.ts +25 -1
  103. package/src/api/TypeRecommender.ts +19 -2
  104. package/src/index.ts +15 -1
  105. package/src/interfaces/Api.ts +22 -6
  106. package/src/interfaces/Config.ts +6 -1
  107. package/src/interfaces/common.ts +46 -0
  108. package/src/interfaces/response/AuditExportResponse.ts +88 -0
  109. package/src/interfaces/response/AuditLogResponse.ts +47 -0
  110. package/src/interfaces/response/TypeRecommenderResponse.ts +3 -0
  111. package/src/request.ts +1 -0
  112. package/test/apiTest.test.ts +59 -3
  113. package/test/auditExport.test.ts +68 -0
  114. package/test/auditLog.test.ts +216 -0
  115. package/test/mocks/AttributionRequest.ts +23 -0
  116. package/test/mocks/EconomicActivityAttributionRequest.ts +22 -0
  117. package/test/mocks/PhysicalActivityEVICRequest.ts +22 -0
  118. package/test/mocks/PhysicalActivityRequest.ts +23 -0
  119. package/docs/_static/base-stemmer.js +0 -476
  120. package/docs/_static/english-stemmer.js +0 -1066
package/docs/getting_started.html CHANGED
@@ -1,14 +1,14 @@
1
1
  <!doctype html>
2
2
  <html class="no-js" lang="en" data-content_root="./">
3
- <head><meta charset="utf-8">
4
- <meta name="viewport" content="width=device-width,initial-scale=1">
3
+ <head><meta charset="utf-8"/>
4
+ <meta name="viewport" content="width=device-width,initial-scale=1"/>
5
5
  <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
6
- <link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="next" title="SDK" href="sdk.html"><link rel="prev" title="IBM Envizi - Emissions API Node.js SDK" href="index.html">
6
+ <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="SDK" href="sdk.html" /><link rel="prev" title="IBM Envizi - Emissions API Node.js SDK" href="index.html" />
7
7
 
8
- <!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
8
+ <!-- Generated with Sphinx 8.1.3 and Furo 2025.07.19 -->
9
9
  <title>Getting Started - IBM Envizi - Emissions API Node.js SDK documentation</title>
10
10
  <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
11
- <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=7bdb33bb" />
11
+ <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=25af2a20" />
12
12
  <link rel="stylesheet" type="text/css" href="_static/sphinx_js.css" />
13
13
  <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
14
14
  <link rel="stylesheet" type="text/css" href="_static/custom.css?v=8d04aa46" />
@@ -24,14 +24,14 @@
24
24
  }
25
25
  @media not print {
26
26
  body[data-theme="dark"] {
27
- --color-code-background: #202020;
28
- --color-code-foreground: #d0d0d0;
27
+ --color-code-background: #2b2b2b;
28
+ --color-code-foreground: #f8f8f2;
29
29
 
30
30
  }
31
31
  @media (prefers-color-scheme: dark) {
32
32
  body:not([data-theme="light"]) {
33
- --color-code-background: #202020;
34
- --color-code-foreground: #d0d0d0;
33
+ --color-code-background: #2b2b2b;
34
+ --color-code-foreground: #f8f8f2;
35
35
 
36
36
  }
37
37
  }
@@ -146,10 +146,14 @@
146
146
  </symbol>
147
147
  </svg>
148
148
 
149
- <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
150
- <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
151
- <label class="overlay sidebar-overlay" for="__navigation"></label>
152
- <label class="overlay toc-overlay" for="__toc"></label>
149
+ <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
150
+ <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
151
+ <label class="overlay sidebar-overlay" for="__navigation">
152
+ <div class="visually-hidden">Hide navigation sidebar</div>
153
+ </label>
154
+ <label class="overlay toc-overlay" for="__toc">
155
+ <div class="visually-hidden">Hide table of contents sidebar</div>
156
+ </label>
153
157
 
154
158
  <a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
155
159
 
@@ -159,7 +163,8 @@
159
163
  <header class="mobile-header">
160
164
  <div class="header-left">
161
165
  <label class="nav-overlay-icon" for="__navigation">
162
- <span class="icon"><svg><use href="#svg-menu"></use></svg></span>
166
+ <div class="visually-hidden">Toggle site navigation sidebar</div>
167
+ <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
163
168
  </label>
164
169
  </div>
165
170
  <div class="header-center">
@@ -167,7 +172,8 @@
167
172
  </div>
168
173
  <div class="header-right">
169
174
  <div class="theme-toggle-container theme-toggle-header">
170
- <button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
175
+ <button class="theme-toggle">
176
+ <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
171
177
  <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
172
178
  <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
173
179
  <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
@@ -175,7 +181,8 @@
175
181
  </button>
176
182
  </div>
177
183
  <label class="toc-overlay-icon toc-header-icon" for="__toc">
178
- <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
184
+ <div class="visually-hidden">Toggle table of contents sidebar</div>
185
+ <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
179
186
  </label>
180
187
  </div>
181
188
  </header>
@@ -195,11 +202,13 @@
195
202
  <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
196
203
  <ul class="current">
197
204
  <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Getting Started</a></li>
198
- <li class="toctree-l1 has-children"><a class="reference internal" href="sdk.html">SDK</a><input aria-label="Toggle navigation of SDK" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
205
+ <li class="toctree-l1 has-children"><a class="reference internal" href="sdk.html">SDK</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of SDK</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
199
206
  <li class="toctree-l2"><a class="reference internal" href="client.html">Client</a></li>
200
207
  <li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li>
201
208
  </ul>
202
209
  </li>
210
+ <li class="toctree-l1"><a class="reference internal" href="authentication.html">Authentication</a></li>
211
+ <li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
203
212
  <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
204
213
  <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting Guide</a></li>
205
214
  </ul>
@@ -228,7 +237,8 @@
228
237
  </a>
229
238
  </div>
230
239
  <div class="theme-toggle-container theme-toggle-content">
231
- <button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
240
+ <button class="theme-toggle">
241
+ <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
232
242
  <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
233
243
  <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
234
244
  <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
@@ -236,7 +246,8 @@
236
246
  </button>
237
247
  </div>
238
248
  <label class="toc-overlay-icon toc-content-icon" for="__toc">
239
- <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
249
+ <div class="visually-hidden">Toggle table of contents sidebar</div>
250
+ <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
240
251
  </label>
241
252
  </div>
242
253
  <article role="main" id="furo-main-content">
@@ -248,8 +259,9 @@
248
259
  <ul class="simple">
249
260
  <li><p><strong>Node.js</strong> installed</p></li>
250
261
  <li><p>Active internet connection</p></li>
251
- <li><p>Sign up for the preview waitlist <a class="reference external" href="https://www.ibm.com/account/reg/us-en/signup?formid=urx-53659">IBMid sign up</a> page.</p></li>
252
- <li><p>API credentials (<code class="docutils literal notranslate"><span class="pre">apiKey</span></code>, <code class="docutils literal notranslate"><span class="pre">tenantId</span></code>, <code class="docutils literal notranslate"><span class="pre">orgId</span></code>), are available on the Emissions API <a class="reference external" href="https://www-dev.supply-chain.ibm.com/envizi/emissions-api-home/overview?cuiURL=%2Femissions-api-home%2Foverview">Overview Page</a> after sign up</p></li>
262
+ <li><p>An IBMid account. Sign up at the <a class="reference external" href="https://www.ibm.com/account/reg/us-en/signup?formid=urx-54311">IBMid sign up</a> page.</p></li>
263
+ <li><p>Access to the Emissions API service and the required credentials</p></li>
264
+ <li><p>Read the <a class="reference external" href="https://developer.ibm.com/apis/catalog/ghgemissions--ibm-envizi-emissions-api/Introduction">Introduction</a> page for an overview of the Emissions API</p></li>
253
265
  </ul>
254
266
  </section>
255
267
  <section id="installation">
@@ -277,103 +289,72 @@
277
289
  </section>
278
290
  <section id="authentication">
279
291
  <h2>Authentication<a class="headerlink" href="#authentication" title="Link to this heading">¶</a></h2>
280
- <p>Initialize the client with your API credentials:</p>
281
- <p>The SDK provides two authentication methods:</p>
292
+ <p>The SDK supports three authentication methods:</p>
282
293
  <ul class="simple">
283
- <li><dl class="simple">
284
- <dt>Using an <strong>API key</strong> with following required Headers:</dt><dd><ul>
285
- <li><p><code class="docutils literal notranslate"><span class="pre">X-Api-Key</span></code>: Your API key</p></li>
286
- <li><p><code class="docutils literal notranslate"><span class="pre">X-IBM-Client-Id</span></code>: saascore-{your-client-id}</p></li>
287
- <li><p><code class="docutils literal notranslate"><span class="pre">accept</span></code>: application/json</p></li>
294
+ <li><p><strong>Personal Access Token (PAT)</strong>, recommended for most users</p></li>
295
+ <li><p><strong>API key</strong>, where the SDK retrieves and refreshes a bearer token</p></li>
296
+ <li><p><strong>Pre-generated JWT token</strong>, managed outside the SDK</p></li>
288
297
  </ul>
289
- </dd>
290
- </dl>
291
- </li>
292
- <li><dl class="simple">
293
- <dt>Using a <strong>Pre-generated token</strong></dt><dd><ul>
294
- <li><p>Token Generation Endpoint: <a class="reference external" href="https://api.ibm.com/saascore/run/authentication-retrieve/api-key">https://api.ibm.com/saascore/run/authentication-retrieve/api-key</a></p></li>
295
- </ul>
296
- </dd>
297
- </dl>
298
- </li>
299
- </ul>
300
- <section id="using-api-key-recommended">
301
- <h3>Using API Key (Recommended)<a class="headerlink" href="#using-api-key-recommended" title="Link to this heading">¶</a></h3>
298
+ <section id="using-personal-access-token-pat">
299
+ <h3>Using Personal Access Token (PAT)<a class="headerlink" href="#using-personal-access-token-pat" title="Link to this heading">¶</a></h3>
302
300
  <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">Client</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s1">&#39;emissions-api-sdk&#39;</span><span class="p">;</span>
303
301
 
304
- <span class="k">async</span><span class="w"> </span><span class="kd">function</span><span class="w"> </span><span class="nx">initialize</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
305
- <span class="w"> </span><span class="k">try</span><span class="w"> </span><span class="p">{</span>
306
- <span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
307
- <span class="w"> </span><span class="nx">apiKey</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;your-api-key&quot;</span><span class="p">,</span>
308
- <span class="w"> </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;your-client-id&quot;</span><span class="p">,</span>
309
- <span class="w"> </span><span class="nx">orgId</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;your-org-id&quot;</span>
310
- <span class="w"> </span><span class="p">});</span>
311
- <span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">&quot;Client initialized successfully&quot;</span><span class="p">);</span>
312
- <span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="nx">error</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
313
- <span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s2">&quot;Failed to initialize client:&quot;</span><span class="p">,</span><span class="w"> </span><span class="nx">error</span><span class="p">);</span>
314
- <span class="w"> </span><span class="p">}</span>
315
- <span class="p">}</span>
316
-
317
- <span class="nx">initialize</span><span class="p">();</span>
302
+ <span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
303
+ <span class="w"> </span><span class="nx">patToken</span><span class="o">:</span><span class="w"> </span><span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ENVIZI_PAT_TOKEN</span><span class="p">,</span>
304
+ <span class="w"> </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ENVIZI_CLIENT_ID</span>
305
+ <span class="p">});</span>
318
306
  </pre></div>
319
307
  </div>
308
+ <div class="admonition note">
309
+ <p class="admonition-title">Note</p>
310
+ <p>When using a PAT token, do not provide <code class="docutils literal notranslate"><span class="pre">orgId</span></code>.</p>
311
+ </div>
320
312
  </section>
321
- <section id="using-pre-generated-token">
322
- <h3>Using Pre-generated Token<a class="headerlink" href="#using-pre-generated-token" title="Link to this heading">¶</a></h3>
323
- <p>If you already have a token, you can use it directly:</p>
313
+ <section id="using-api-key">
314
+ <h3>Using API Key<a class="headerlink" href="#using-api-key" title="Link to this heading">¶</a></h3>
324
315
  <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">Client</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s1">&#39;emissions-api-sdk&#39;</span><span class="p">;</span>
325
316
 
326
- <span class="k">async</span><span class="w"> </span><span class="kd">function</span><span class="w"> </span><span class="nx">initialize</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
327
- <span class="w"> </span><span class="k">try</span><span class="w"> </span><span class="p">{</span>
328
- <span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
329
- <span class="w"> </span><span class="nx">token</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;your-pre-generated-token&quot;</span><span class="p">,</span>
330
- <span class="w"> </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;your-client-id&quot;</span>
331
- <span class="w"> </span><span class="p">});</span>
332
- <span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">&quot;Client initialized successfully&quot;</span><span class="p">);</span>
333
- <span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="nx">error</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
334
- <span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s2">&quot;Failed to initialize client:&quot;</span><span class="p">,</span><span class="w"> </span><span class="nx">error</span><span class="p">);</span>
335
- <span class="w"> </span><span class="p">}</span>
336
- <span class="p">}</span>
317
+ <span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
318
+ <span class="w"> </span><span class="nx">apiKey</span><span class="o">:</span><span class="w"> </span><span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ENVIZI_API_KEY</span><span class="p">,</span>
319
+ <span class="w"> </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ENVIZI_CLIENT_ID</span><span class="p">,</span>
320
+ <span class="w"> </span><span class="nx">orgId</span><span class="o">:</span><span class="w"> </span><span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ENVIZI_ORG_ID</span>
321
+ <span class="p">});</span>
322
+ </pre></div>
323
+ </div>
324
+ </section>
325
+ <section id="using-pre-generated-jwt-token">
326
+ <h3>Using Pre-generated JWT Token<a class="headerlink" href="#using-pre-generated-jwt-token" title="Link to this heading">¶</a></h3>
327
+ <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">Client</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s1">&#39;emissions-api-sdk&#39;</span><span class="p">;</span>
337
328
 
338
- <span class="nx">initialize</span><span class="p">();</span>
329
+ <span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
330
+ <span class="w"> </span><span class="nx">token</span><span class="o">:</span><span class="w"> </span><span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">JWT_TOKEN</span><span class="p">,</span>
331
+ <span class="w"> </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ENVIZI_CLIENT_ID</span>
332
+ <span class="p">});</span>
339
333
  </pre></div>
340
334
  </div>
341
335
  </section>
342
336
  </section>
343
337
  <section id="first-api-call">
344
338
  <h2>First API Call<a class="headerlink" href="#first-api-call" title="Link to this heading">¶</a></h2>
345
- <p>After initializing the client, you can make your first API call. Here’s an example of calculating location-based emissions:</p>
346
- <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">Client</span><span class="p">,</span><span class="w"> </span><span class="nx">LocationEmission</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s1">&#39;emissions-api-sdk&#39;</span><span class="p">;</span>
347
-
348
- <span class="k">async</span><span class="w"> </span><span class="kd">function</span><span class="w"> </span><span class="nx">calculateEmissions</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
349
- <span class="w"> </span><span class="k">try</span><span class="w"> </span><span class="p">{</span>
350
- <span class="w"> </span><span class="c1">// Initialize client</span>
351
- <span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
352
- <span class="w"> </span><span class="nx">apiKey</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;your-api-key&quot;</span><span class="p">,</span>
353
- <span class="w"> </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;your-client-id&quot;</span><span class="p">,</span>
354
- <span class="w"> </span><span class="nx">orgId</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;your-org-id&quot;</span>
355
- <span class="w"> </span><span class="p">});</span>
339
+ <p>After initializing the client, you can make your first API call. Here’s a quick start example of calculating location-based emissions:</p>
340
+ <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">Client</span><span class="p">,</span><span class="w"> </span><span class="nx">Location</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s1">&#39;emissions-api-sdk&#39;</span><span class="p">;</span>
356
341
 
357
- <span class="w"> </span><span class="c1">// Make API call</span>
358
- <span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">LocationEmission</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
359
- <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
360
- <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;USA&quot;</span><span class="p">,</span>
361
- <span class="w"> </span><span class="s2">&quot;stateProvince&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;california&quot;</span>
362
- <span class="w"> </span><span class="p">},</span>
363
- <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
364
- <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;electricity&quot;</span><span class="p">,</span>
365
- <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span><span class="p">,</span>
366
- <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;kWh&quot;</span>
367
- <span class="w"> </span><span class="p">}</span>
368
- <span class="w"> </span><span class="p">});</span>
342
+ <span class="k">await</span><span class="w"> </span><span class="nx">Client</span><span class="p">.</span><span class="nx">getClient</span><span class="p">({</span>
343
+ <span class="w"> </span><span class="nx">patToken</span><span class="o">:</span><span class="w"> </span><span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ENVIZI_PAT_TOKEN</span><span class="p">,</span>
344
+ <span class="w"> </span><span class="nx">clientId</span><span class="o">:</span><span class="w"> </span><span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">ENVIZI_CLIENT_ID</span>
345
+ <span class="p">});</span>
369
346
 
370
- <span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">&quot;Emission calculation result:&quot;</span><span class="p">,</span><span class="w"> </span><span class="nx">result</span><span class="p">);</span>
371
- <span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="nx">error</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
372
- <span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s2">&quot;Error calculating emissions:&quot;</span><span class="p">,</span><span class="w"> </span><span class="nx">error</span><span class="p">);</span>
347
+ <span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">Location</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
348
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
349
+ <span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;USA&quot;</span><span class="p">,</span>
350
+ <span class="w"> </span><span class="s2">&quot;stateProvince&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;california&quot;</span>
351
+ <span class="w"> </span><span class="p">},</span>
352
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
353
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;electricity&quot;</span><span class="p">,</span>
354
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span><span class="p">,</span>
355
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;kWh&quot;</span>
373
356
  <span class="w"> </span><span class="p">}</span>
374
- <span class="p">}</span>
375
-
376
- <span class="nx">calculateEmissions</span><span class="p">();</span>
357
+ <span class="p">});</span>
377
358
  </pre></div>
378
359
  </div>
379
360
  </section>
@@ -393,6 +374,873 @@
393
374
  </pre></div>
394
375
  </div>
395
376
  </section>
377
+ <section id="example-response-with-details">
378
+ <h2>Example Response with Details<a class="headerlink" href="#example-response-with-details" title="Link to this heading">¶</a></h2>
379
+ <p>When you need more detailed information about the emission factors used in calculations, you can request the response to include the <code class="docutils literal notranslate"><span class="pre">details</span></code> object. This provides comprehensive information about the factor set and specific factor used:</p>
380
+ <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
381
+ <span class="w"> </span><span class="nt">&quot;transactionId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;29df5ecd-fc3b-4797-b6fd-da03bc007f30&quot;</span><span class="p">,</span>
382
+ <span class="w"> </span><span class="nt">&quot;totalCO2e&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">5912000</span><span class="p">,</span>
383
+ <span class="w"> </span><span class="nt">&quot;CO2&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">5840000</span><span class="p">,</span>
384
+ <span class="w"> </span><span class="nt">&quot;CH4&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">2000.0000000000002</span><span class="p">,</span>
385
+ <span class="w"> </span><span class="nt">&quot;N2O&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">70000</span><span class="p">,</span>
386
+ <span class="w"> </span><span class="nt">&quot;indirectCO2e&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1340000</span><span class="p">,</span>
387
+ <span class="w"> </span><span class="nt">&quot;unit&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;kgCO2e&quot;</span><span class="p">,</span>
388
+ <span class="w"> </span><span class="nt">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;The Freight - Cargo Ship - Bulk Carrier - 0-9999 dwt emissions factor used to calculate this result was obtained from the DEFRA factor set for the Global region year 2025.&quot;</span><span class="p">,</span>
389
+ <span class="w"> </span><span class="nt">&quot;details&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
390
+ <span class="w"> </span><span class="nt">&quot;factorSet&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
391
+ <span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;DEFRA&quot;</span><span class="p">,</span>
392
+ <span class="w"> </span><span class="nt">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;The UK Government and DEFRA publish GHG emission factors covering Scope 1, Scope 2, and selected Scope 3 sources. While primarily intended for UK-based reporting, many organizations apply these factors across European sites—especially for air travel-related emissions.&quot;</span><span class="p">,</span>
393
+ <span class="w"> </span><span class="nt">&quot;provider&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;His Majesty&#39;s Government (United Kingdom of Great Britain and Northern Ireland): Department for Energy Security and Net Zero&quot;</span><span class="p">,</span>
394
+ <span class="w"> </span><span class="nt">&quot;sourceUrl&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;https://www.gov.uk/government/publications/greenhouse-gas-reporting-conversion-factors-2024&quot;</span>
395
+ <span class="w"> </span><span class="p">},</span>
396
+ <span class="w"> </span><span class="nt">&quot;factor&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
397
+ <span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Bulk carrier - 0–9999 dwt - 2025&quot;</span><span class="p">,</span>
398
+ <span class="w"> </span><span class="nt">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Cargo ship - tonne.km&quot;</span><span class="p">,</span>
399
+ <span class="w"> </span><span class="nt">&quot;totalCO2e&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">0.02956</span><span class="p">,</span>
400
+ <span class="w"> </span><span class="nt">&quot;CO2&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">0.0292</span><span class="p">,</span>
401
+ <span class="w"> </span><span class="nt">&quot;CH4&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">0.00001</span><span class="p">,</span>
402
+ <span class="w"> </span><span class="nt">&quot;N2O&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">0.00035</span><span class="p">,</span>
403
+ <span class="w"> </span><span class="nt">&quot;indirectCO2e&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">0.0067</span><span class="p">,</span>
404
+ <span class="w"> </span><span class="nt">&quot;inputUnit&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;t-km&quot;</span><span class="p">,</span>
405
+ <span class="w"> </span><span class="nt">&quot;unit&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;tonne.km&quot;</span><span class="p">,</span>
406
+ <span class="w"> </span><span class="nt">&quot;conversionRatio&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;1:1&quot;</span><span class="p">,</span>
407
+ <span class="w"> </span><span class="nt">&quot;activityType&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Freight - Cargo Ship - Bulk Carrier - 0-9999 dwt&quot;</span><span class="p">,</span>
408
+ <span class="w"> </span><span class="nt">&quot;activitySubtype&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Default Factor&quot;</span><span class="p">,</span>
409
+ <span class="w"> </span><span class="nt">&quot;factorId&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">190405</span><span class="p">,</span>
410
+ <span class="w"> </span><span class="nt">&quot;methodology&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;activity-based&quot;</span><span class="p">,</span>
411
+ <span class="w"> </span><span class="nt">&quot;scopes&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
412
+ <span class="w"> </span><span class="s2">&quot;3.4&quot;</span><span class="p">,</span>
413
+ <span class="w"> </span><span class="s2">&quot;3.9&quot;</span>
414
+ <span class="w"> </span><span class="p">],</span>
415
+ <span class="w"> </span><span class="nt">&quot;areaName&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Earth&quot;</span><span class="p">,</span>
416
+ <span class="w"> </span><span class="nt">&quot;areaType&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Planet&quot;</span><span class="p">,</span>
417
+ <span class="w"> </span><span class="nt">&quot;publishedFrom&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2025-01-01&quot;</span><span class="p">,</span>
418
+ <span class="w"> </span><span class="nt">&quot;source&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2025 Greenhouse Gas Reporting: Conversion Factors 2025 (DEFRA) provided by gov.uk, license - https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/&quot;</span>
419
+ <span class="w"> </span><span class="p">}</span>
420
+ <span class="w"> </span><span class="p">}</span>
421
+ <span class="p">}</span>
422
+ </pre></div>
423
+ </div>
424
+ <section id="response-structure-details">
425
+ <h3>Response Structure Details<a class="headerlink" href="#response-structure-details" title="Link to this heading">¶</a></h3>
426
+ <p>The response includes the following key components:</p>
427
+ <p><strong>Top-level Fields:</strong></p>
428
+ <ul class="simple">
429
+ <li><p><code class="docutils literal notranslate"><span class="pre">transactionId</span></code>: Unique identifier for the calculation</p></li>
430
+ <li><p><code class="docutils literal notranslate"><span class="pre">totalCO2e</span></code>: Total CO2 equivalent emissions</p></li>
431
+ <li><p><code class="docutils literal notranslate"><span class="pre">CO2</span></code>: Carbon dioxide emissions</p></li>
432
+ <li><p><code class="docutils literal notranslate"><span class="pre">CH4</span></code>: Methane emissions</p></li>
433
+ <li><p><code class="docutils literal notranslate"><span class="pre">N2O</span></code>: Nitrous oxide emissions</p></li>
434
+ <li><p><code class="docutils literal notranslate"><span class="pre">indirectCO2e</span></code>: Indirect CO2 equivalent emissions</p></li>
435
+ <li><p><code class="docutils literal notranslate"><span class="pre">unit</span></code>: Unit of measurement (typically kgCO2e)</p></li>
436
+ <li><p><code class="docutils literal notranslate"><span class="pre">description</span></code>: Human-readable description of the calculation</p></li>
437
+ </ul>
438
+ <p><strong>Details Object (when requested):</strong></p>
439
+ <p>The <code class="docutils literal notranslate"><span class="pre">details</span></code> object provides comprehensive information about the emission factors:</p>
440
+ <p><em>Factor Set Information:</em></p>
441
+ <ul class="simple">
442
+ <li><p><code class="docutils literal notranslate"><span class="pre">name</span></code>: Name of the factor set (e.g., DEFRA, EPA)</p></li>
443
+ <li><p><code class="docutils literal notranslate"><span class="pre">description</span></code>: Detailed description of the factor set</p></li>
444
+ <li><p><code class="docutils literal notranslate"><span class="pre">provider</span></code>: Organization that provides the factor set</p></li>
445
+ <li><p><code class="docutils literal notranslate"><span class="pre">sourceUrl</span></code>: URL to the source documentation</p></li>
446
+ </ul>
447
+ <p><em>Factor Information:</em></p>
448
+ <ul class="simple">
449
+ <li><p><code class="docutils literal notranslate"><span class="pre">name</span></code>: Specific name of the emission factor</p></li>
450
+ <li><p><code class="docutils literal notranslate"><span class="pre">description</span></code>: Description of the factor</p></li>
451
+ <li><p><code class="docutils literal notranslate"><span class="pre">totalCO2e</span></code>, <code class="docutils literal notranslate"><span class="pre">CO2</span></code>, <code class="docutils literal notranslate"><span class="pre">CH4</span></code>, <code class="docutils literal notranslate"><span class="pre">N2O</span></code>, <code class="docutils literal notranslate"><span class="pre">indirectCO2e</span></code>: Emission values per unit</p></li>
452
+ <li><p><code class="docutils literal notranslate"><span class="pre">inputUnit</span></code>: Unit for input values</p></li>
453
+ <li><p><code class="docutils literal notranslate"><span class="pre">unit</span></code>: Unit of the factor</p></li>
454
+ <li><p><code class="docutils literal notranslate"><span class="pre">conversionRatio</span></code>: Conversion ratio applied</p></li>
455
+ <li><p><code class="docutils literal notranslate"><span class="pre">activityType</span></code>: Type of activity (e.g., transportation, energy)</p></li>
456
+ <li><p><code class="docutils literal notranslate"><span class="pre">activitySubtype</span></code>: Subtype classification</p></li>
457
+ <li><p><code class="docutils literal notranslate"><span class="pre">factorId</span></code>: Unique identifier for the factor</p></li>
458
+ <li><p><code class="docutils literal notranslate"><span class="pre">methodology</span></code>: Calculation methodology used</p></li>
459
+ <li><p><code class="docutils literal notranslate"><span class="pre">scopes</span></code>: Applicable GHG Protocol scopes</p></li>
460
+ <li><p><code class="docutils literal notranslate"><span class="pre">areaName</span></code>: Geographic area name</p></li>
461
+ <li><p><code class="docutils literal notranslate"><span class="pre">areaType</span></code>: Type of geographic area</p></li>
462
+ <li><p><code class="docutils literal notranslate"><span class="pre">publishedFrom</span></code>: Date from which the factor is valid</p></li>
463
+ </ul>
464
+ </section>
465
+ </section>
466
+ <section id="currency-conversion-support">
467
+ <h2>Currency Conversion Support<a class="headerlink" href="#currency-conversion-support" title="Link to this heading">¶</a></h2>
468
+ <section id="overview">
469
+ <h3>Overview<a class="headerlink" href="#overview" title="Link to this heading">¶</a></h3>
470
+ <p>The SDK supports automatic currency conversion for API methods that accept monetary values. This feature allows you to input values in your preferred currency, and the system will automatically convert them to the appropriate base currency for emissions calculations.</p>
471
+ <p><strong>Supported Methods</strong></p>
472
+ <p>Currency conversion is available for the following calculation methods:</p>
473
+ <ul class="simple">
474
+ <li><p><code class="docutils literal notranslate"><span class="pre">EconomicActivity.calculate()</span></code></p></li>
475
+ <li><p><code class="docutils literal notranslate"><span class="pre">Calculation.calculate()</span></code></p></li>
476
+ </ul>
477
+ </section>
478
+ <section id="supported-currencies">
479
+ <h3>Supported Currencies<a class="headerlink" href="#supported-currencies" title="Link to this heading">¶</a></h3>
480
+ <p>The SDK supports conversion for 170 currencies:</p>
481
+ <div class="table-wrapper colwidths-given docutils container">
482
+ <table class="docutils align-default">
483
+ <colgroup>
484
+ <col style="width: 60.0%" />
485
+ <col style="width: 40.0%" />
486
+ </colgroup>
487
+ <thead>
488
+ <tr class="row-odd"><th class="head"><p>Currency Name</p></th>
489
+ <th class="head"><p>Symbol</p></th>
490
+ </tr>
491
+ </thead>
492
+ <tbody>
493
+ <tr class="row-even"><td><p>ADB Unit of Account</p></td>
494
+ <td><p>XUA</p></td>
495
+ </tr>
496
+ <tr class="row-odd"><td><p>Afghani</p></td>
497
+ <td><p>AFN</p></td>
498
+ </tr>
499
+ <tr class="row-even"><td><p>Algerian Dinar</p></td>
500
+ <td><p>DZD</p></td>
501
+ </tr>
502
+ <tr class="row-odd"><td><p>Arab Accounting Dinar</p></td>
503
+ <td><p>XAD</p></td>
504
+ </tr>
505
+ <tr class="row-even"><td><p>Argentine Peso</p></td>
506
+ <td><p>ARS</p></td>
507
+ </tr>
508
+ <tr class="row-odd"><td><p>Armenian Dram</p></td>
509
+ <td><p>AMD</p></td>
510
+ </tr>
511
+ <tr class="row-even"><td><p>Aruban Florin</p></td>
512
+ <td><p>AWG</p></td>
513
+ </tr>
514
+ <tr class="row-odd"><td><p>Australian Dollar</p></td>
515
+ <td><p>AUD</p></td>
516
+ </tr>
517
+ <tr class="row-even"><td><p>Azerbaijan Manat</p></td>
518
+ <td><p>AZN</p></td>
519
+ </tr>
520
+ <tr class="row-odd"><td><p>Bahamian Dollar</p></td>
521
+ <td><p>BSD</p></td>
522
+ </tr>
523
+ <tr class="row-even"><td><p>Bahraini Dinar</p></td>
524
+ <td><p>BHD</p></td>
525
+ </tr>
526
+ <tr class="row-odd"><td><p>Baht</p></td>
527
+ <td><p>THB</p></td>
528
+ </tr>
529
+ <tr class="row-even"><td><p>Balboa</p></td>
530
+ <td><p>PAB</p></td>
531
+ </tr>
532
+ <tr class="row-odd"><td><p>Barbados Dollar</p></td>
533
+ <td><p>BBD</p></td>
534
+ </tr>
535
+ <tr class="row-even"><td><p>Belarusian Ruble</p></td>
536
+ <td><p>BYN</p></td>
537
+ </tr>
538
+ <tr class="row-odd"><td><p>Belize Dollar</p></td>
539
+ <td><p>BZD</p></td>
540
+ </tr>
541
+ <tr class="row-even"><td><p>Bermudian Dollar</p></td>
542
+ <td><p>BMD</p></td>
543
+ </tr>
544
+ <tr class="row-odd"><td><p>Boliviano</p></td>
545
+ <td><p>BOB</p></td>
546
+ </tr>
547
+ <tr class="row-even"><td><p>Bolívar Soberano</p></td>
548
+ <td><p>VED</p></td>
549
+ </tr>
550
+ <tr class="row-odd"><td><p>Bolívar Soberano</p></td>
551
+ <td><p>VES</p></td>
552
+ </tr>
553
+ <tr class="row-even"><td><p>Brazilian Real</p></td>
554
+ <td><p>BRL</p></td>
555
+ </tr>
556
+ <tr class="row-odd"><td><p>Brunei Dollar</p></td>
557
+ <td><p>BND</p></td>
558
+ </tr>
559
+ <tr class="row-even"><td><p>Bulgarian Lev</p></td>
560
+ <td><p>BGN</p></td>
561
+ </tr>
562
+ <tr class="row-odd"><td><p>Burundi Franc</p></td>
563
+ <td><p>BIF</p></td>
564
+ </tr>
565
+ <tr class="row-even"><td><p>Cabo Verde Escudo</p></td>
566
+ <td><p>CVE</p></td>
567
+ </tr>
568
+ <tr class="row-odd"><td><p>Canadian Dollar</p></td>
569
+ <td><p>CAD</p></td>
570
+ </tr>
571
+ <tr class="row-even"><td><p>Caribbean Guilder</p></td>
572
+ <td><p>XCG</p></td>
573
+ </tr>
574
+ <tr class="row-odd"><td><p>Cayman Islands Dollar</p></td>
575
+ <td><p>KYD</p></td>
576
+ </tr>
577
+ <tr class="row-even"><td><p>CFA Franc BCEAO</p></td>
578
+ <td><p>XOF</p></td>
579
+ </tr>
580
+ <tr class="row-odd"><td><p>CFA Franc BEAC</p></td>
581
+ <td><p>XAF</p></td>
582
+ </tr>
583
+ <tr class="row-even"><td><p>CFP Franc</p></td>
584
+ <td><p>XPF</p></td>
585
+ </tr>
586
+ <tr class="row-odd"><td><p>Chilean Peso</p></td>
587
+ <td><p>CLP</p></td>
588
+ </tr>
589
+ <tr class="row-even"><td><p>Colombian Peso</p></td>
590
+ <td><p>COP</p></td>
591
+ </tr>
592
+ <tr class="row-odd"><td><p>Comorian Franc</p></td>
593
+ <td><p>KMF</p></td>
594
+ </tr>
595
+ <tr class="row-even"><td><p>Congolese Franc</p></td>
596
+ <td><p>CDF</p></td>
597
+ </tr>
598
+ <tr class="row-odd"><td><p>Convertible Mark</p></td>
599
+ <td><p>BAM</p></td>
600
+ </tr>
601
+ <tr class="row-even"><td><p>Cordoba Oro</p></td>
602
+ <td><p>NIO</p></td>
603
+ </tr>
604
+ <tr class="row-odd"><td><p>Costa Rican Colon</p></td>
605
+ <td><p>CRC</p></td>
606
+ </tr>
607
+ <tr class="row-even"><td><p>Cuban Peso</p></td>
608
+ <td><p>CUP</p></td>
609
+ </tr>
610
+ <tr class="row-odd"><td><p>Czech Koruna</p></td>
611
+ <td><p>CZK</p></td>
612
+ </tr>
613
+ <tr class="row-even"><td><p>Dalasi</p></td>
614
+ <td><p>GMD</p></td>
615
+ </tr>
616
+ <tr class="row-odd"><td><p>Danish Krone</p></td>
617
+ <td><p>DKK</p></td>
618
+ </tr>
619
+ <tr class="row-even"><td><p>Denar</p></td>
620
+ <td><p>MKD</p></td>
621
+ </tr>
622
+ <tr class="row-odd"><td><p>Djibouti Franc</p></td>
623
+ <td><p>DJF</p></td>
624
+ </tr>
625
+ <tr class="row-even"><td><p>Dobra</p></td>
626
+ <td><p>STN</p></td>
627
+ </tr>
628
+ <tr class="row-odd"><td><p>Dominican Peso</p></td>
629
+ <td><p>DOP</p></td>
630
+ </tr>
631
+ <tr class="row-even"><td><p>Dong</p></td>
632
+ <td><p>VND</p></td>
633
+ </tr>
634
+ <tr class="row-odd"><td><p>East Caribbean Dollar</p></td>
635
+ <td><p>XCD</p></td>
636
+ </tr>
637
+ <tr class="row-even"><td><p>Egyptian Pound</p></td>
638
+ <td><p>EGP</p></td>
639
+ </tr>
640
+ <tr class="row-odd"><td><p>El Salvador Colon</p></td>
641
+ <td><p>SVC</p></td>
642
+ </tr>
643
+ <tr class="row-even"><td><p>Ethiopian Birr</p></td>
644
+ <td><p>ETB</p></td>
645
+ </tr>
646
+ <tr class="row-odd"><td><p>Euro</p></td>
647
+ <td><p>EUR</p></td>
648
+ </tr>
649
+ <tr class="row-even"><td><p>Falkland Islands Pound</p></td>
650
+ <td><p>FKP</p></td>
651
+ </tr>
652
+ <tr class="row-odd"><td><p>Fiji Dollar</p></td>
653
+ <td><p>FJD</p></td>
654
+ </tr>
655
+ <tr class="row-even"><td><p>Forint</p></td>
656
+ <td><p>HUF</p></td>
657
+ </tr>
658
+ <tr class="row-odd"><td><p>Ghana Cedi</p></td>
659
+ <td><p>GHS</p></td>
660
+ </tr>
661
+ <tr class="row-even"><td><p>Gibraltar Pound</p></td>
662
+ <td><p>GIP</p></td>
663
+ </tr>
664
+ <tr class="row-odd"><td><p>Gourde</p></td>
665
+ <td><p>HTG</p></td>
666
+ </tr>
667
+ <tr class="row-even"><td><p>Guarani</p></td>
668
+ <td><p>PYG</p></td>
669
+ </tr>
670
+ <tr class="row-odd"><td><p>Guinean Franc</p></td>
671
+ <td><p>GNF</p></td>
672
+ </tr>
673
+ <tr class="row-even"><td><p>Guyana Dollar</p></td>
674
+ <td><p>GYD</p></td>
675
+ </tr>
676
+ <tr class="row-odd"><td><p>Hong Kong Dollar</p></td>
677
+ <td><p>HKD</p></td>
678
+ </tr>
679
+ <tr class="row-even"><td><p>Hryvnia</p></td>
680
+ <td><p>UAH</p></td>
681
+ </tr>
682
+ <tr class="row-odd"><td><p>Iceland Krona</p></td>
683
+ <td><p>ISK</p></td>
684
+ </tr>
685
+ <tr class="row-even"><td><p>Indian Rupee</p></td>
686
+ <td><p>INR</p></td>
687
+ </tr>
688
+ <tr class="row-odd"><td><p>Iranian Rial</p></td>
689
+ <td><p>IRR</p></td>
690
+ </tr>
691
+ <tr class="row-even"><td><p>Iraqi Dinar</p></td>
692
+ <td><p>IQD</p></td>
693
+ </tr>
694
+ <tr class="row-odd"><td><p>Jamaican Dollar</p></td>
695
+ <td><p>JMD</p></td>
696
+ </tr>
697
+ <tr class="row-even"><td><p>Jordanian Dinar</p></td>
698
+ <td><p>JOD</p></td>
699
+ </tr>
700
+ <tr class="row-odd"><td><p>Kenyan Shilling</p></td>
701
+ <td><p>KES</p></td>
702
+ </tr>
703
+ <tr class="row-even"><td><p>Kina</p></td>
704
+ <td><p>PGK</p></td>
705
+ </tr>
706
+ <tr class="row-odd"><td><p>Kuwaiti Dinar</p></td>
707
+ <td><p>KWD</p></td>
708
+ </tr>
709
+ <tr class="row-even"><td><p>Kwanza</p></td>
710
+ <td><p>AOA</p></td>
711
+ </tr>
712
+ <tr class="row-odd"><td><p>Kyat</p></td>
713
+ <td><p>MMK</p></td>
714
+ </tr>
715
+ <tr class="row-even"><td><p>Lao Kip</p></td>
716
+ <td><p>LAK</p></td>
717
+ </tr>
718
+ <tr class="row-odd"><td><p>Lari</p></td>
719
+ <td><p>GEL</p></td>
720
+ </tr>
721
+ <tr class="row-even"><td><p>Lebanese Pound</p></td>
722
+ <td><p>LBP</p></td>
723
+ </tr>
724
+ <tr class="row-odd"><td><p>Lek</p></td>
725
+ <td><p>ALL</p></td>
726
+ </tr>
727
+ <tr class="row-even"><td><p>Lempira</p></td>
728
+ <td><p>HNL</p></td>
729
+ </tr>
730
+ <tr class="row-odd"><td><p>Leone</p></td>
731
+ <td><p>SLE</p></td>
732
+ </tr>
733
+ <tr class="row-even"><td><p>Liberian Dollar</p></td>
734
+ <td><p>LRD</p></td>
735
+ </tr>
736
+ <tr class="row-odd"><td><p>Libyan Dinar</p></td>
737
+ <td><p>LYD</p></td>
738
+ </tr>
739
+ <tr class="row-even"><td><p>Lilangeni</p></td>
740
+ <td><p>SZL</p></td>
741
+ </tr>
742
+ <tr class="row-odd"><td><p>Loti</p></td>
743
+ <td><p>LSL</p></td>
744
+ </tr>
745
+ <tr class="row-even"><td><p>Malagasy Ariary</p></td>
746
+ <td><p>MGA</p></td>
747
+ </tr>
748
+ <tr class="row-odd"><td><p>Malawi Kwacha</p></td>
749
+ <td><p>MWK</p></td>
750
+ </tr>
751
+ <tr class="row-even"><td><p>Malaysian Ringgit</p></td>
752
+ <td><p>MYR</p></td>
753
+ </tr>
754
+ <tr class="row-odd"><td><p>Mauritius Rupee</p></td>
755
+ <td><p>MUR</p></td>
756
+ </tr>
757
+ <tr class="row-even"><td><p>Mexican Peso</p></td>
758
+ <td><p>MXN</p></td>
759
+ </tr>
760
+ <tr class="row-odd"><td><p>Mexican Unidad de Inversion (UDI)</p></td>
761
+ <td><p>MXV</p></td>
762
+ </tr>
763
+ <tr class="row-even"><td><p>Moldovan Leu</p></td>
764
+ <td><p>MDL</p></td>
765
+ </tr>
766
+ <tr class="row-odd"><td><p>Moroccan Dirham</p></td>
767
+ <td><p>MAD</p></td>
768
+ </tr>
769
+ <tr class="row-even"><td><p>Mozambique Metical</p></td>
770
+ <td><p>MZN</p></td>
771
+ </tr>
772
+ <tr class="row-odd"><td><p>Mvdol</p></td>
773
+ <td><p>BOV</p></td>
774
+ </tr>
775
+ <tr class="row-even"><td><p>Naira</p></td>
776
+ <td><p>NGN</p></td>
777
+ </tr>
778
+ <tr class="row-odd"><td><p>Nakfa</p></td>
779
+ <td><p>ERN</p></td>
780
+ </tr>
781
+ <tr class="row-even"><td><p>Namibia Dollar</p></td>
782
+ <td><p>NAD</p></td>
783
+ </tr>
784
+ <tr class="row-odd"><td><p>Nepalese Rupee</p></td>
785
+ <td><p>NPR</p></td>
786
+ </tr>
787
+ <tr class="row-even"><td><p>Netherlands Antillean Guilder</p></td>
788
+ <td><p>ANG</p></td>
789
+ </tr>
790
+ <tr class="row-odd"><td><p>New Israeli Sheqel</p></td>
791
+ <td><p>ILS</p></td>
792
+ </tr>
793
+ <tr class="row-even"><td><p>New Taiwan Dollar</p></td>
794
+ <td><p>TWD</p></td>
795
+ </tr>
796
+ <tr class="row-odd"><td><p>New Zealand Dollar</p></td>
797
+ <td><p>NZD</p></td>
798
+ </tr>
799
+ <tr class="row-even"><td><p>Ngultrum</p></td>
800
+ <td><p>BTN</p></td>
801
+ </tr>
802
+ <tr class="row-odd"><td><p>North Korean Won</p></td>
803
+ <td><p>KPW</p></td>
804
+ </tr>
805
+ <tr class="row-even"><td><p>Norwegian Krone</p></td>
806
+ <td><p>NOK</p></td>
807
+ </tr>
808
+ <tr class="row-odd"><td><p>Ouguiya</p></td>
809
+ <td><p>MRU</p></td>
810
+ </tr>
811
+ <tr class="row-even"><td><p>Pa’anga</p></td>
812
+ <td><p>TOP</p></td>
813
+ </tr>
814
+ <tr class="row-odd"><td><p>Pakistan Rupee</p></td>
815
+ <td><p>PKR</p></td>
816
+ </tr>
817
+ <tr class="row-even"><td><p>Pataca</p></td>
818
+ <td><p>MOP</p></td>
819
+ </tr>
820
+ <tr class="row-odd"><td><p>Peso Uruguayo</p></td>
821
+ <td><p>UYU</p></td>
822
+ </tr>
823
+ <tr class="row-even"><td><p>Philippine Peso</p></td>
824
+ <td><p>PHP</p></td>
825
+ </tr>
826
+ <tr class="row-odd"><td><p>Pound Sterling</p></td>
827
+ <td><p>GBP</p></td>
828
+ </tr>
829
+ <tr class="row-even"><td><p>Pula</p></td>
830
+ <td><p>BWP</p></td>
831
+ </tr>
832
+ <tr class="row-odd"><td><p>Qatari Rial</p></td>
833
+ <td><p>QAR</p></td>
834
+ </tr>
835
+ <tr class="row-even"><td><p>Quetzal</p></td>
836
+ <td><p>GTQ</p></td>
837
+ </tr>
838
+ <tr class="row-odd"><td><p>Rand</p></td>
839
+ <td><p>ZAR</p></td>
840
+ </tr>
841
+ <tr class="row-even"><td><p>Rial Omani</p></td>
842
+ <td><p>OMR</p></td>
843
+ </tr>
844
+ <tr class="row-odd"><td><p>Riel</p></td>
845
+ <td><p>KHR</p></td>
846
+ </tr>
847
+ <tr class="row-even"><td><p>Romanian Leu</p></td>
848
+ <td><p>RON</p></td>
849
+ </tr>
850
+ <tr class="row-odd"><td><p>Rufiyaa</p></td>
851
+ <td><p>MVR</p></td>
852
+ </tr>
853
+ <tr class="row-even"><td><p>Rupiah</p></td>
854
+ <td><p>IDR</p></td>
855
+ </tr>
856
+ <tr class="row-odd"><td><p>Russian Ruble</p></td>
857
+ <td><p>RUB</p></td>
858
+ </tr>
859
+ <tr class="row-even"><td><p>Rwanda Franc</p></td>
860
+ <td><p>RWF</p></td>
861
+ </tr>
862
+ <tr class="row-odd"><td><p>Saint Helena Pound</p></td>
863
+ <td><p>SHP</p></td>
864
+ </tr>
865
+ <tr class="row-even"><td><p>Saudi Riyal</p></td>
866
+ <td><p>SAR</p></td>
867
+ </tr>
868
+ <tr class="row-odd"><td><p>SDR (Special Drawing Right)</p></td>
869
+ <td><p>XDR</p></td>
870
+ </tr>
871
+ <tr class="row-even"><td><p>Serbian Dinar</p></td>
872
+ <td><p>RSD</p></td>
873
+ </tr>
874
+ <tr class="row-odd"><td><p>Seychelles Rupee</p></td>
875
+ <td><p>SCR</p></td>
876
+ </tr>
877
+ <tr class="row-even"><td><p>Singapore Dollar</p></td>
878
+ <td><p>SGD</p></td>
879
+ </tr>
880
+ <tr class="row-odd"><td><p>Sol</p></td>
881
+ <td><p>PEN</p></td>
882
+ </tr>
883
+ <tr class="row-even"><td><p>Solomon Islands Dollar</p></td>
884
+ <td><p>SBD</p></td>
885
+ </tr>
886
+ <tr class="row-odd"><td><p>Som</p></td>
887
+ <td><p>KGS</p></td>
888
+ </tr>
889
+ <tr class="row-even"><td><p>Somali Shilling</p></td>
890
+ <td><p>SOS</p></td>
891
+ </tr>
892
+ <tr class="row-odd"><td><p>Somoni</p></td>
893
+ <td><p>TJS</p></td>
894
+ </tr>
895
+ <tr class="row-even"><td><p>South Sudanese Pound</p></td>
896
+ <td><p>SSP</p></td>
897
+ </tr>
898
+ <tr class="row-odd"><td><p>Sri Lanka Rupee</p></td>
899
+ <td><p>LKR</p></td>
900
+ </tr>
901
+ <tr class="row-even"><td><p>Sucre</p></td>
902
+ <td><p>XSU</p></td>
903
+ </tr>
904
+ <tr class="row-odd"><td><p>Sudanese Pound</p></td>
905
+ <td><p>SDG</p></td>
906
+ </tr>
907
+ <tr class="row-even"><td><p>Surinam Dollar</p></td>
908
+ <td><p>SRD</p></td>
909
+ </tr>
910
+ <tr class="row-odd"><td><p>Swedish Krona</p></td>
911
+ <td><p>SEK</p></td>
912
+ </tr>
913
+ <tr class="row-even"><td><p>Swiss Franc</p></td>
914
+ <td><p>CHF</p></td>
915
+ </tr>
916
+ <tr class="row-odd"><td><p>Syrian Pound</p></td>
917
+ <td><p>SYP</p></td>
918
+ </tr>
919
+ <tr class="row-even"><td><p>Taka</p></td>
920
+ <td><p>BDT</p></td>
921
+ </tr>
922
+ <tr class="row-odd"><td><p>Tala</p></td>
923
+ <td><p>WST</p></td>
924
+ </tr>
925
+ <tr class="row-even"><td><p>Tanzanian Shilling</p></td>
926
+ <td><p>TZS</p></td>
927
+ </tr>
928
+ <tr class="row-odd"><td><p>Tenge</p></td>
929
+ <td><p>KZT</p></td>
930
+ </tr>
931
+ <tr class="row-even"><td><p>Trinidad and Tobago Dollar</p></td>
932
+ <td><p>TTD</p></td>
933
+ </tr>
934
+ <tr class="row-odd"><td><p>Tugrik</p></td>
935
+ <td><p>MNT</p></td>
936
+ </tr>
937
+ <tr class="row-even"><td><p>Tunisian Dinar</p></td>
938
+ <td><p>TND</p></td>
939
+ </tr>
940
+ <tr class="row-odd"><td><p>Turkish Lira</p></td>
941
+ <td><p>TRY</p></td>
942
+ </tr>
943
+ <tr class="row-even"><td><p>Turkmenistan New Manat</p></td>
944
+ <td><p>TMT</p></td>
945
+ </tr>
946
+ <tr class="row-odd"><td><p>UAE Dirham</p></td>
947
+ <td><p>AED</p></td>
948
+ </tr>
949
+ <tr class="row-even"><td><p>Uganda Shilling</p></td>
950
+ <td><p>UGX</p></td>
951
+ </tr>
952
+ <tr class="row-odd"><td><p>Unidad de Fomento</p></td>
953
+ <td><p>CLF</p></td>
954
+ </tr>
955
+ <tr class="row-even"><td><p>Unidad de Valor Real</p></td>
956
+ <td><p>COU</p></td>
957
+ </tr>
958
+ <tr class="row-odd"><td><p>Unidad Previsional</p></td>
959
+ <td><p>UYW</p></td>
960
+ </tr>
961
+ <tr class="row-even"><td><p>United States dollar</p></td>
962
+ <td><p>USD</p></td>
963
+ </tr>
964
+ <tr class="row-odd"><td><p>Uruguay Peso en Unidades Indexadas (UI)</p></td>
965
+ <td><p>UYI</p></td>
966
+ </tr>
967
+ <tr class="row-even"><td><p>US Dollar (Next day)</p></td>
968
+ <td><p>USN</p></td>
969
+ </tr>
970
+ <tr class="row-odd"><td><p>Uzbekistan Sum</p></td>
971
+ <td><p>UZS</p></td>
972
+ </tr>
973
+ <tr class="row-even"><td><p>Vatu</p></td>
974
+ <td><p>VUV</p></td>
975
+ </tr>
976
+ <tr class="row-odd"><td><p>WIR Euro</p></td>
977
+ <td><p>CHE</p></td>
978
+ </tr>
979
+ <tr class="row-even"><td><p>WIR Franc</p></td>
980
+ <td><p>CHW</p></td>
981
+ </tr>
982
+ <tr class="row-odd"><td><p>Won</p></td>
983
+ <td><p>KRW</p></td>
984
+ </tr>
985
+ <tr class="row-even"><td><p>Yemeni Rial</p></td>
986
+ <td><p>YER</p></td>
987
+ </tr>
988
+ <tr class="row-odd"><td><p>Yen</p></td>
989
+ <td><p>JPY</p></td>
990
+ </tr>
991
+ <tr class="row-even"><td><p>Yuan Renminbi</p></td>
992
+ <td><p>CNY</p></td>
993
+ </tr>
994
+ <tr class="row-odd"><td><p>Zambian Kwacha</p></td>
995
+ <td><p>ZMW</p></td>
996
+ </tr>
997
+ <tr class="row-even"><td><p>Zimbabwe Gold</p></td>
998
+ <td><p>ZWG</p></td>
999
+ </tr>
1000
+ <tr class="row-odd"><td><p>Zloty</p></td>
1001
+ <td><p>PLN</p></td>
1002
+ </tr>
1003
+ </tbody>
1004
+ </table>
1005
+ </div>
1006
+ </section>
1007
+ <section id="exchange-rate-data">
1008
+ <h3>Exchange Rate Data<a class="headerlink" href="#exchange-rate-data" title="Link to this heading">¶</a></h3>
1009
+ <p><strong>Data Source</strong></p>
1010
+ <p>Exchange rates are sourced from the U.S. Department of the Treasury’s Fiscal Data API, which provides official exchange rates used by the U.S. government for accounting and reporting purposes.</p>
1011
+ <ul class="simple">
1012
+ <li><p><strong>API Source</strong>: <a class="reference external" href="https://api.fiscaldata.treasury.gov/services/api/fiscal_service">https://api.fiscaldata.treasury.gov/services/api/fiscal_service</a></p></li>
1013
+ <li><p><strong>Data Provider</strong>: U.S. Department of the Treasury, Bureau of the Fiscal Service</p></li>
1014
+ </ul>
1015
+ <p><strong>Historical Coverage</strong></p>
1016
+ <p>Exchange rate data is available from <strong>March 31, 2001</strong> onwards. If you specify a date earlier than this, the system will use the earliest available rate.</p>
1017
+ <p><strong>Data Updates</strong></p>
1018
+ <p>The exchange rate database is automatically synchronized with the Treasury API to ensure you always have access to the most current rates. Updates are captured as soon as they become available from the Treasury.</p>
1019
+ <ul class="simple">
1020
+ <li><p><strong>Update Frequency</strong>: The U.S. Treasury typically publishes exchange rates on a <strong>quarterly basis</strong></p></li>
1021
+ <li><p><strong>Amendment Policy</strong>: If current rates deviate from the published rates by 10% or more, Treasury will issue amendments to the quarterly report</p></li>
1022
+ <li><p><code class="docutils literal notranslate"><span class="pre">source</span></code>: Source citation and license information</p></li>
1023
+ </ul>
1024
+ </section>
1025
+ </section>
1026
+ <section id="finance-emissions-apis">
1027
+ <h2>Finance Emissions APIs<a class="headerlink" href="#finance-emissions-apis" title="Link to this heading">¶</a></h2>
1028
+ <p>The SDK supports three scope 3 finance-based emission APIs: <strong>Real Estate</strong>, <strong>Physical Activity</strong>, and <strong>Economic Activity</strong>. Each supports optional PCAF attribution to proportionally allocate emissions.</p>
1029
+ <section id="real-estate">
1030
+ <h3>Real Estate<a class="headerlink" href="#real-estate" title="Link to this heading">¶</a></h3>
1031
+ <p>Real Estate calculates scope 3 emissions from commercial and residential property. Attribution uses <code class="docutils literal notranslate"><span class="pre">propertyValue</span></code> to compute an attribution factor.</p>
1032
+ <p><strong>Without attribution:</strong></p>
1033
+ <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">RealEstate</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
1034
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2022-01-01&quot;</span><span class="w"> </span><span class="p">},</span>
1035
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;stateProvince&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;new york&quot;</span><span class="w"> </span><span class="p">},</span>
1036
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1037
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;Commercial Real Estate:Office&quot;</span><span class="p">,</span>
1038
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">123456.0</span><span class="p">,</span>
1039
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;m2&quot;</span>
1040
+ <span class="w"> </span><span class="p">},</span>
1041
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
1042
+ <span class="p">});</span>
1043
+ </pre></div>
1044
+ </div>
1045
+ <p><strong>With attribution (property value based):</strong></p>
1046
+ <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">RealEstate</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
1047
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2022-01-01&quot;</span><span class="w"> </span><span class="p">},</span>
1048
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;stateProvince&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;new york&quot;</span><span class="w"> </span><span class="p">},</span>
1049
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1050
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;Commercial Real Estate:Office&quot;</span><span class="p">,</span>
1051
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">123456.0</span><span class="p">,</span>
1052
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;m2&quot;</span>
1053
+ <span class="w"> </span><span class="p">},</span>
1054
+ <span class="w"> </span><span class="s2">&quot;attribution&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1055
+ <span class="w"> </span><span class="s2">&quot;outstandingAmount&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1000000.0</span><span class="p">,</span>
1056
+ <span class="w"> </span><span class="s2">&quot;propertyValue&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">5000000.0</span>
1057
+ <span class="w"> </span><span class="p">},</span>
1058
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
1059
+ <span class="p">});</span>
1060
+ </pre></div>
1061
+ </div>
1062
+ <div class="admonition note">
1063
+ <p class="admonition-title">Note</p>
1064
+ <p>Real estate attribution only accepts <code class="docutils literal notranslate"><span class="pre">propertyValue</span></code>. Using <code class="docutils literal notranslate"><span class="pre">totalEquity</span></code>, <code class="docutils literal notranslate"><span class="pre">totalDebt</span></code>, <code class="docutils literal notranslate"><span class="pre">evic</span></code>, or <code class="docutils literal notranslate"><span class="pre">revenue</span></code> will result in a 400 error.</p>
1065
+ </div>
1066
+ </section>
1067
+ <section id="physical-activity">
1068
+ <h3>Physical Activity<a class="headerlink" href="#physical-activity" title="Link to this heading">¶</a></h3>
1069
+ <p>Physical Activity calculates scope 3 emissions from physical activities. Attribution supports two methods: equity/debt for private companies, or EVIC for listed companies.</p>
1070
+ <p><strong>Without attribution:</strong></p>
1071
+ <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">PhysicalActivity</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
1072
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2022-01-01&quot;</span><span class="w"> </span><span class="p">},</span>
1073
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;stateProvince&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;new york&quot;</span><span class="w"> </span><span class="p">},</span>
1074
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1075
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;Physical Activity Type&quot;</span><span class="p">,</span>
1076
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">123456.0</span><span class="p">,</span>
1077
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;kg&quot;</span>
1078
+ <span class="w"> </span><span class="p">},</span>
1079
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
1080
+ <span class="p">});</span>
1081
+ </pre></div>
1082
+ </div>
1083
+ <p><strong>With attribution (equity/debt — private companies):</strong></p>
1084
+ <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">PhysicalActivity</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
1085
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2022-01-01&quot;</span><span class="w"> </span><span class="p">},</span>
1086
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;stateProvince&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;new york&quot;</span><span class="w"> </span><span class="p">},</span>
1087
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1088
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;Physical Activity Type&quot;</span><span class="p">,</span>
1089
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">123456.0</span><span class="p">,</span>
1090
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;kg&quot;</span>
1091
+ <span class="w"> </span><span class="p">},</span>
1092
+ <span class="w"> </span><span class="s2">&quot;attribution&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1093
+ <span class="w"> </span><span class="s2">&quot;outstandingAmount&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1000000.0</span><span class="p">,</span>
1094
+ <span class="w"> </span><span class="s2">&quot;totalEquity&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">3000000.0</span><span class="p">,</span>
1095
+ <span class="w"> </span><span class="s2">&quot;totalDebt&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">2000000.0</span>
1096
+ <span class="w"> </span><span class="p">},</span>
1097
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
1098
+ <span class="p">});</span>
1099
+ </pre></div>
1100
+ </div>
1101
+ <p><strong>With attribution (EVIC — listed companies):</strong></p>
1102
+ <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">PhysicalActivity</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
1103
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2022-01-01&quot;</span><span class="w"> </span><span class="p">},</span>
1104
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;stateProvince&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;new york&quot;</span><span class="w"> </span><span class="p">},</span>
1105
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1106
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;Physical Activity Type&quot;</span><span class="p">,</span>
1107
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">123456.0</span><span class="p">,</span>
1108
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;kg&quot;</span>
1109
+ <span class="w"> </span><span class="p">},</span>
1110
+ <span class="w"> </span><span class="s2">&quot;attribution&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1111
+ <span class="w"> </span><span class="s2">&quot;outstandingAmount&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1000000.0</span><span class="p">,</span>
1112
+ <span class="w"> </span><span class="s2">&quot;evic&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">10000000.0</span>
1113
+ <span class="w"> </span><span class="p">},</span>
1114
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
1115
+ <span class="p">});</span>
1116
+ </pre></div>
1117
+ </div>
1118
+ <div class="admonition note">
1119
+ <p class="admonition-title">Note</p>
1120
+ <p>Physical activity attribution does not accept <code class="docutils literal notranslate"><span class="pre">propertyValue</span></code> or <code class="docutils literal notranslate"><span class="pre">revenue</span></code>. Use <code class="docutils literal notranslate"><span class="pre">totalEquity</span> <span class="pre">+</span> <span class="pre">totalDebt</span></code> for private companies, or <code class="docutils literal notranslate"><span class="pre">evic</span></code> for listed companies — not both.</p>
1121
+ </div>
1122
+ </section>
1123
+ <section id="economic-activity">
1124
+ <h3>Economic Activity<a class="headerlink" href="#economic-activity" title="Link to this heading">¶</a></h3>
1125
+ <p>Economic Activity calculates scope 3 spend-based emissions. Attribution supports equity/debt, EVIC, or revenue-based allocation.</p>
1126
+ <p><strong>Without attribution:</strong></p>
1127
+ <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">EconomicActivity</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
1128
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2022-01-01&quot;</span><span class="w"> </span><span class="p">},</span>
1129
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;stateProvince&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;new york&quot;</span><span class="w"> </span><span class="p">},</span>
1130
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1131
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;Accomodation&quot;</span><span class="p">,</span>
1132
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">123456.0</span><span class="p">,</span>
1133
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usd&quot;</span>
1134
+ <span class="w"> </span><span class="p">},</span>
1135
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">false</span>
1136
+ <span class="p">});</span>
1137
+ </pre></div>
1138
+ </div>
1139
+ <p><strong>With attribution (revenue based):</strong></p>
1140
+ <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">EconomicActivity</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
1141
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-01-04&quot;</span><span class="w"> </span><span class="p">},</span>
1142
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span><span class="w"> </span><span class="p">},</span>
1143
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1144
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;accomodation&quot;</span><span class="p">,</span>
1145
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1500.12</span><span class="p">,</span>
1146
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usd&quot;</span>
1147
+ <span class="w"> </span><span class="p">},</span>
1148
+ <span class="w"> </span><span class="s2">&quot;attribution&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1149
+ <span class="w"> </span><span class="s2">&quot;outstandingAmount&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">500000.0</span><span class="p">,</span>
1150
+ <span class="w"> </span><span class="s2">&quot;revenue&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">2000000.0</span>
1151
+ <span class="w"> </span><span class="p">},</span>
1152
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
1153
+ <span class="p">});</span>
1154
+ </pre></div>
1155
+ </div>
1156
+ <p><strong>With attribution (equity/debt — private companies):</strong></p>
1157
+ <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">EconomicActivity</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
1158
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-01-04&quot;</span><span class="w"> </span><span class="p">},</span>
1159
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span><span class="w"> </span><span class="p">},</span>
1160
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1161
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;accomodation&quot;</span><span class="p">,</span>
1162
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1500.12</span><span class="p">,</span>
1163
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usd&quot;</span>
1164
+ <span class="w"> </span><span class="p">},</span>
1165
+ <span class="w"> </span><span class="s2">&quot;attribution&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1166
+ <span class="w"> </span><span class="s2">&quot;outstandingAmount&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">500000.0</span><span class="p">,</span>
1167
+ <span class="w"> </span><span class="s2">&quot;totalEquity&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">3000000.0</span><span class="p">,</span>
1168
+ <span class="w"> </span><span class="s2">&quot;totalDebt&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">2000000.0</span>
1169
+ <span class="w"> </span><span class="p">},</span>
1170
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
1171
+ <span class="p">});</span>
1172
+ </pre></div>
1173
+ </div>
1174
+ <p><strong>With attribution (EVIC — listed companies):</strong></p>
1175
+ <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">EconomicActivity</span><span class="p">.</span><span class="nx">calculate</span><span class="p">({</span>
1176
+ <span class="w"> </span><span class="s2">&quot;time&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;date&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;2025-01-04&quot;</span><span class="w"> </span><span class="p">},</span>
1177
+ <span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;country&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usa&quot;</span><span class="w"> </span><span class="p">},</span>
1178
+ <span class="w"> </span><span class="s2">&quot;activity&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1179
+ <span class="w"> </span><span class="s2">&quot;type&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;accomodation&quot;</span><span class="p">,</span>
1180
+ <span class="w"> </span><span class="s2">&quot;value&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">1500.12</span><span class="p">,</span>
1181
+ <span class="w"> </span><span class="s2">&quot;unit&quot;</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;usd&quot;</span>
1182
+ <span class="w"> </span><span class="p">},</span>
1183
+ <span class="w"> </span><span class="s2">&quot;attribution&quot;</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
1184
+ <span class="w"> </span><span class="s2">&quot;outstandingAmount&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">500000.0</span><span class="p">,</span>
1185
+ <span class="w"> </span><span class="s2">&quot;evic&quot;</span><span class="o">:</span><span class="w"> </span><span class="mf">10000000.0</span>
1186
+ <span class="w"> </span><span class="p">},</span>
1187
+ <span class="w"> </span><span class="s2">&quot;includeDetails&quot;</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
1188
+ <span class="p">});</span>
1189
+ </pre></div>
1190
+ </div>
1191
+ <div class="admonition note">
1192
+ <p class="admonition-title">Note</p>
1193
+ <p><code class="docutils literal notranslate"><span class="pre">propertyValue</span></code> is not supported for economic activity. <code class="docutils literal notranslate"><span class="pre">totalEquity</span></code> and <code class="docutils literal notranslate"><span class="pre">totalDebt</span></code> must always be provided together.</p>
1194
+ </div>
1195
+ </section>
1196
+ <section id="attribution-summary">
1197
+ <h3>Attribution Summary<a class="headerlink" href="#attribution-summary" title="Link to this heading">¶</a></h3>
1198
+ <div class="table-wrapper colwidths-given docutils container">
1199
+ <table class="docutils align-default">
1200
+ <colgroup>
1201
+ <col style="width: 30.0%" />
1202
+ <col style="width: 14.0%" />
1203
+ <col style="width: 20.0%" />
1204
+ <col style="width: 12.0%" />
1205
+ <col style="width: 12.0%" />
1206
+ <col style="width: 12.0%" />
1207
+ </colgroup>
1208
+ <thead>
1209
+ <tr class="row-odd"><th class="head"><p>API</p></th>
1210
+ <th class="head"><p><code class="docutils literal notranslate"><span class="pre">propertyValue</span></code></p></th>
1211
+ <th class="head"><p><code class="docutils literal notranslate"><span class="pre">totalEquity</span></code> + <code class="docutils literal notranslate"><span class="pre">totalDebt</span></code></p></th>
1212
+ <th class="head"><p><code class="docutils literal notranslate"><span class="pre">evic</span></code></p></th>
1213
+ <th class="head"><p><code class="docutils literal notranslate"><span class="pre">revenue</span></code></p></th>
1214
+ <th class="head"><p><code class="docutils literal notranslate"><span class="pre">outstandingAmount</span></code></p></th>
1215
+ </tr>
1216
+ </thead>
1217
+ <tbody>
1218
+ <tr class="row-even"><td><p>Real Estate</p></td>
1219
+ <td><p>✓</p></td>
1220
+ <td><p>✗</p></td>
1221
+ <td><p>✗</p></td>
1222
+ <td><p>✗</p></td>
1223
+ <td><p>Required</p></td>
1224
+ </tr>
1225
+ <tr class="row-odd"><td><p>Physical Activity</p></td>
1226
+ <td><p>✗</p></td>
1227
+ <td><p>✓</p></td>
1228
+ <td><p>✓</p></td>
1229
+ <td><p>✗</p></td>
1230
+ <td><p>Required</p></td>
1231
+ </tr>
1232
+ <tr class="row-even"><td><p>Economic Activity</p></td>
1233
+ <td><p>✗</p></td>
1234
+ <td><p>✓</p></td>
1235
+ <td><p>✓</p></td>
1236
+ <td><p>✓</p></td>
1237
+ <td><p>Required</p></td>
1238
+ </tr>
1239
+ </tbody>
1240
+ </table>
1241
+ </div>
1242
+ </section>
1243
+ </section>
396
1244
  </section>
397
1245
 
398
1246
  </article>
@@ -457,12 +1305,30 @@
457
1305
  </ul>
458
1306
  </li>
459
1307
  <li><a class="reference internal" href="#authentication">Authentication</a><ul>
460
- <li><a class="reference internal" href="#using-api-key-recommended">Using API Key (Recommended)</a></li>
461
- <li><a class="reference internal" href="#using-pre-generated-token">Using Pre-generated Token</a></li>
1308
+ <li><a class="reference internal" href="#using-personal-access-token-pat">Using Personal Access Token (PAT)</a></li>
1309
+ <li><a class="reference internal" href="#using-api-key">Using API Key</a></li>
1310
+ <li><a class="reference internal" href="#using-pre-generated-jwt-token">Using Pre-generated JWT Token</a></li>
462
1311
  </ul>
463
1312
  </li>
464
1313
  <li><a class="reference internal" href="#first-api-call">First API Call</a></li>
465
1314
  <li><a class="reference internal" href="#example-response">Example Response</a></li>
1315
+ <li><a class="reference internal" href="#example-response-with-details">Example Response with Details</a><ul>
1316
+ <li><a class="reference internal" href="#response-structure-details">Response Structure Details</a></li>
1317
+ </ul>
1318
+ </li>
1319
+ <li><a class="reference internal" href="#currency-conversion-support">Currency Conversion Support</a><ul>
1320
+ <li><a class="reference internal" href="#overview">Overview</a></li>
1321
+ <li><a class="reference internal" href="#supported-currencies">Supported Currencies</a></li>
1322
+ <li><a class="reference internal" href="#exchange-rate-data">Exchange Rate Data</a></li>
1323
+ </ul>
1324
+ </li>
1325
+ <li><a class="reference internal" href="#finance-emissions-apis">Finance Emissions APIs</a><ul>
1326
+ <li><a class="reference internal" href="#real-estate">Real Estate</a></li>
1327
+ <li><a class="reference internal" href="#physical-activity">Physical Activity</a></li>
1328
+ <li><a class="reference internal" href="#economic-activity">Economic Activity</a></li>
1329
+ <li><a class="reference internal" href="#attribution-summary">Attribution Summary</a></li>
1330
+ </ul>
1331
+ </li>
466
1332
  </ul>
467
1333
  </li>
468
1334
  </ul>
@@ -475,8 +1341,8 @@
475
1341
  </aside>
476
1342
  </div>
477
1343
  </div><script src="_static/documentation_options.js?v=5929fcd5"></script>
478
- <script src="_static/doctools.js?v=fd6eb6e6"></script>
479
- <script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
1344
+ <script src="_static/doctools.js?v=9bcbadda"></script>
1345
+ <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
480
1346
  <script src="_static/scripts/furo.js?v=46bd48cc"></script>
481
1347
  </body>
482
1348
  </html>