Skip to main content
GET
Get Charges

Authorizations

Authorization
string
header
required

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

Path Parameters

vin
string
required

The associated VIN.

Query Parameters

distance_format
enum<string>
default:mi

Whether to return data in miles or kilometers.

Available options:
mi,
km
format
enum<string>
default:json

Whether to output the results in JSON or CSV.

Available options:
json,
csv
superchargers_only
boolean
default:false

Whether to only include charges from Superchargers.

origin_latitude
number

The latitude of the charging station.

Example:

37.4925

origin_longitude
number

The longitude of the charging station.

Example:

121.9447

origin_radius
number

The radius from the charging station, in meters.

Example:

80

exclude_origin
boolean
default:false

Whether to exclude the charging station.

timezone
string
default:UTC

The IANA timezone name.

from
number

The start of the timeframe. Unix timestamp in seconds.

to
number

The end of the timeframe. Unix timestamp in seconds.

minimum_energy_added
number

The minimum energy added to the battery, in kWh.

Example:

1

limit
number

The maximum number of results.

Response

200 - application/json

Success

results
Charge · object[]