Skip to main content
POST
/
v1
/
quotes
/
electricity
Get a carbon credit quote for electricity consumption
curl --request POST \
  --url https://carbon-engine.onrender.com/v1/quotes/electricity \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "electricityConsumed": 123,
  "pricePaid": 123,
  "portfolio_id": "<string>"
}
'
{
  "amount_kg": 123,
  "price_sar_halalas": 123
}

Documentation Index

Fetch the complete documentation index at: https://c-mass.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
electricityConsumed
number
required

Electricity consumed, in kW.

​
pricePaid
number
required

How much was paid for the amount of electricity consumed.

​
portfolio_id
string | null

Optional ID of the portfolio to use for the quote. The quote will be for an order fulfilled from this portfolio. If not specified, the account's default portfolio will be used.

Response

Fetched electricity comsumption quote successfully

​
amount_kg
number

Amount of carbon credits the quote is for, in kilograms

​
price_sar_halalas
number

Price charged for the credits, in halalas (integer)