Skip to main content
GET
/
estimations
/
{estimation}
Retrieve an estimation
curl --request GET \
  --url https://api.chargeapi.co/v1/estimations/{estimation} \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "id": null,
  "object": null,
  "battery_level": null,
  "battery_target_level": null,
  "cost_breakdown": [
    {
      "cost": null,
      "description": null,
      "quantity": null,
      "type": null,
      "unit": null,
      "unit_price": null,
      "tax_percent": null
    }
  ],
  "created": null,
  "currency": null,
  "estimated_duration": null,
  "estimated_energy_kwh": null,
  "estimated_total_cost": null,
  "charging_station": null,
  "valid_until": null,
  "vehicle": null
}

Path Parameters

​
estimation
string
required

ID of the estimation to retrieve.

Query Parameters

​
expand
string[]

Specifies related objects to expand (e.g., expand[]=charging_station).

Body

application/json · object

Response

Returns the Estimation object for a valid identifier. Raises an error if the estimation has expired or the ID is invalid.

​
id
string

Unique identifier for the estimation object.

Example:

null

​
object
string

String representing the object’s type. Always estimation.

Example:

null

​
battery_level
integer

Current battery level of the vehicle before charging, as a percentage (0–100).

Example:

null

​
battery_target_level
integer

Target battery level for this session, as a percentage (0–100).

Example:

null

​
cost_breakdown
object[]

Itemized list of costs included in the estimate, such as energy, session, and idle fees.

​
created
integer

Time at which the estimation was generated.

Example:

null

​
currency
string

ISO 4217 three-letter currency code (e.g., usd).

Example:

null

​
estimated_duration
integer

Estimated charging duration in seconds.

Example:

null

​
estimated_energy_kwh
number

Estimated energy needed to reach the target battery level, in kilowatt-hours (kWh).

Example:

null

​
estimated_total_cost
number

Total estimated cost for the session in currency units.

Example:

null

​
charging_station
string

ID of the charging station used for this estimation.

Example:

null

​
valid_until
integer

Expiration timestamp for this estimate. The values may change after this point.

Example:

null

​
vehicle
string

ID of the vehicle used for the estimation.

Example:

null