The Greenspark Estimations SDK provides access to the Greenspark Estimations API from applications running on a server or in a browser.
See the @greenspark/estimations
API docs for details.
Node 16 or higher.
Install the package with:
npm install @getgreenspark/estimations --save
The SDK use the production
environment by default. You only need to provide your API key.
const estimationsApi = new EstimationsApi({apiKey: "<YOUR_API_KEY>"})
The SDK use the production
environment by default. You can use the sandbox
environment for testing and development by providing the sandbox
environment basePath
and your API key.
const estimationsApi = new EstimationsApi({basePath: "https://sandbox.getgreenspark.com", apiKey: "<YOUR_API_KEY>"})
The SDK needs to be configured with your Greenspark API key, which is available in the Greenspark Dashboard.
import {
Estimation,
EstimationsApi,
EstimationsByMCCRequestBodyGeoEnum,
EstimationsByMCCRequestBodyUserTypeEnum
} from "@greenspark/estimations";
const estimationsApi = new EstimationsApi({apiKey: "<YOUR_API_KEY>"})
const {data}: Estimation = await estimationsApi.fetchCarbonEstimateOfATransactionByMCC({
"price": 1000,
"mcc": "5411",
"currencyISO": "EUR",
"merchant": "Superstore",
"geo": EstimationsByMCCRequestBodyGeoEnum.EUUK,
"userType": EstimationsByMCCRequestBodyUserTypeEnum.PERSONAL,
"metadata": [
{
"key": "customerId",
"value": "743ce227-22ef-4c6e-9c06-725f97b99690"
}
]
})
console.log(data);