Introduction
Guides
Updates
API reference
Calculate offer price
Calculate an offer price for a given tariff
curl --request POST \
--url https://api.rabot-charge.de/partner/v1/tariffs/{tariffKey}/calculation \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"yearlyConsumptionKwh": 123,
"zipCode": "<string>",
"hasSmartMeter": true,
"hasElectricVehicle": true,
"campaignCode": "rabot.home.2024"
}
'{
"isSuccess": true,
"message": null,
"error": [
{
"severity": "Error",
"code": "validation-failed",
"message": "First name is required for non-business customers.",
"details": null
}
],
"refUri": "<string>",
"data": {
"name": "rabot.smart",
"displayName": "rabot.smart 24 private",
"priceComponents": {
"pricePerMonth": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"unitPrice": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"basePricePerMonth": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"estimatedConsumption": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"estimatedWorkPrice": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"expectedWorkPrice": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"effectiveWorkPrice": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"baseServiceFee": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"variableServiceFee": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"rabotShare": {
"rabotShare": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"rabotSharePercentage": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"totalPriceWithoutRabotShare": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
}
},
"comparisonTariff": {
"workingPrice": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"basePrice": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"totalPrice": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
}
}
},
"durationPeriod": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"noticePeriod": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"features": [
"<string>"
],
"yearlySavingsDetails": {
"price": 180.5,
"co2": 123
}
}
}tariffKey and the prospect’s postcode and yearly energy consumption as minimum input for the calculation.
You can retrieve the available tariffs using the list tariffs endpoint.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Key of the tariff to calculate
Body
Request data object
Data object for a tariff calculation request.
Yearly consumption in kWh.
ZIP code of the household, 5 digits without spaces.
Whether the household energy consumption is metered by a smart meter.
Whether there is an electric vehicle (charger) in the household.
Campaign used by the customer, if existing
"rabot.home.2024"
Response
OK
API response DTO with data.
Success status of the operation based on status code (2xx range).
true
Optional message to provide additional information about the operation result.
null
Optional error details in case of an error(s).
Hide child attributes
Hide child attributes
Severity of the error.
Error, Warning, Notice "Error"
Internal error code for client processing.
"validation-failed"
Error message.
"First name is required for non-business customers."
Additional details about the error.
null
Optional reference URI to point to the resulting resource.
Returned data instance.
Hide child attributes
Hide child attributes
Name of the calculated tariff
"rabot.smart"
Display name of tariff, or the same as name, if none was specified.
"rabot.smart 24 private"
Components of the price.
Hide child attributes
Hide child attributes
Total average cost per month, based on the given yearly consumption. Includes VAT
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
Unit price per kWh. This includes the price of energy, all fees and taxes, and a service fee
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
Base price of the tariff, including monthly grid fees, metering fees and a service fee
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
Estimated consumption per month
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
Estimated work price
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
Expected work price per month
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
Effective work price.
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
Base service fee, per month
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
service fee per kWh
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
RABOT share details, in the tariff is based on a savings share model
Hide child attributes
Hide child attributes
Rabot share
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
Rabot share as percentage value
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
Total price without RABOT share
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
Information about the price conditions of the local default supplier (Grundversorger)
Hide child attributes
Hide child attributes
Working price of the comparison tariff
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
Base price of the comparison tariff
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
Total price of the comparison tariff
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
Duration period of the tariff.
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
Notice period of the tariff.
Hide child attributes
Hide child attributes
Value of the unit.
Unit of the value.
Hide child attributes
Hide child attributes
Main unit.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Per unit in form of main/per or NULL if none.
None, Kwh, Kw, Euro, Cent, Percent, Year, Month, Day, Hour, Minute Textual representation of the unit in German.
Features of the tariff.
Information about yearly savings, compared to the local default supplier (Grundversorger)
Was this page helpful?
curl --request POST \
--url https://api.rabot-charge.de/partner/v1/tariffs/{tariffKey}/calculation \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"yearlyConsumptionKwh": 123,
"zipCode": "<string>",
"hasSmartMeter": true,
"hasElectricVehicle": true,
"campaignCode": "rabot.home.2024"
}
'{
"isSuccess": true,
"message": null,
"error": [
{
"severity": "Error",
"code": "validation-failed",
"message": "First name is required for non-business customers.",
"details": null
}
],
"refUri": "<string>",
"data": {
"name": "rabot.smart",
"displayName": "rabot.smart 24 private",
"priceComponents": {
"pricePerMonth": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"unitPrice": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"basePricePerMonth": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"estimatedConsumption": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"estimatedWorkPrice": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"expectedWorkPrice": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"effectiveWorkPrice": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"baseServiceFee": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"variableServiceFee": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"rabotShare": {
"rabotShare": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"rabotSharePercentage": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"totalPriceWithoutRabotShare": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
}
},
"comparisonTariff": {
"workingPrice": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"basePrice": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"totalPrice": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
}
}
},
"durationPeriod": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"noticePeriod": {
"value": 123,
"unit": {
"main": "None",
"per": "None"
},
"unitText": "<string>"
},
"features": [
"<string>"
],
"yearlySavingsDetails": {
"price": 180.5,
"co2": 123
}
}
}