NAV Navbar
Logo

Introduction

Welcome to the PlugShare API! You can use our REST API to access PlugShare API endpoints, which can get information on charging stations, reviews, and photos in our database. The PlugShare API is a REST API

Using The API

Generally, you’ll want to use a search method to return a list of locations. Each location will contain one or more stations, each of which may contain one or more outlets. Not all information about a location is returned from the search method; for reviews, photos, and more you’ll want to request the location directly using its unique identifier.
Here are some examples to get you started. Try out GET /locations/nearby and GET /locations/region

Access Instructions

PlugShare uses API keys to allow access to the API. You can register a new PlugShare API key at our developer portal.

HTTPS + HTTP Basic auth is required when making API requests. After obtaining an API key/secret, the key and secret have to be specified in the request with HTTP Basic Auth, i.e. converted into an Authorization header.

URL: https://api.plugshare.com/

Core Data Entities

A location or station may also have zero to many promos, and a location may also have zero to many amenities.

Location

A driver identifiable destination where Charging Stations (Stations) are located. As a general rule if stations are within visible range of each other they are organized together into a location.

Object Properties

Example Response:

{
  "valid_outlets": [
    {
      "connector": 1
    },
    {
      "connector": 2
    },
    {
      "connector": 3
    },
    {
      "connector": 13
    },
    {
      "connector": 4
    },
    {
      "connector": 6
    },
    {
      "connector": 5
    }
  ],
  "description": "No Public Access.",
  "opening_date": "None",
  "updated_at": "2016-12-09T10:16:23Z",
  "hours": "",
  "phone": "",
  "promos": [],
  "cost": true,
  "pwps_version": 2,
  "address": "1015 Abbot Kinney Blvd Los Angeles, CA 90291",
  "score": 10,
  "id": 20667,
  "parking_type_name": "Free",
  "icon": "https://s3.amazonaws.com/plugshare.production.assets/icons/B.png",
  "cost_description": "",
  "reviews": [],
  "name": "PlugShare API Station",
  "url": "http://api.plugshare.com/view/location/20667",
  "created_at": "2013-11-19T22:26:33Z",
  "icon_type": "B",
  "all_promos": [
    {
      "link_url": null,
      "tag": null,
      "image_url": null,
      "name": "EZ-Charge",
      "link_action": null,
      "lat": null,
      "lng": null,
      "image_url_2x": null,
      "id": 2,
      "app_id": null
    }
  ],
  "longitude": -118.4721,
  "access": 2,
  "locale": "US",
  "under_repair": true,
  "amenities": [
    {
      "location_id": 20667,
      "type": 1
    }
  ],
  "poi_name": "Workplace Private",
  "coming_soon": null,
  "latitude": 33.992476,
  "photos": [
    {
      "user_id": 85274,
      "url": "https://s3.amazonaws.com/plugshare.production.photos/photos/165827.jpg",
      "created_at": "2016-11-29T17:57:14Z",
      "thumbnail": "https://s3.amazonaws.com/plugshare.production.photos/thumb/165827.png",
      "caption": "PlugShare Garage",
      "thumbnail2x": "https://s3.amazonaws.com/plugshare.production.photos/thumb2x/165827.png",
      "order": 1,
      "id": 127483
    }
  ],
  "open247": false,
  "stations": [
    {
      "qr_enabled": true,
      "cost": 2,
      "pwps_version": 2,
      "location_id": 20840,
      "id": 37558,
      "cost_description": "$1/hour: first 4 hours. $20/hour thereafter. 50 cent minimum. Fees continue while car is connected even if not charging.",
      "pre_charge_instructions": null,
      "network": {
        "description": "GE's networked platform that allows users to manage and monitor the charging of their electric cars.",
        "url": "https://www.gewattstation.com/connect/",
        "image": "https://s3.amazonaws.com/plugshare.production.assets/network-images/watt.png",
        "action_name": "Sign Up",
        "phone": "8554433873",
        "action_url": "https://www.gewattstation.com/connect/",
        "id": 4,
        "name": "GE WattStation"
      },
      "latitude": 33.992305,
      "available": 1,
      "outlets": [
        {
          "available": null,
          "description": null,
          "power": 0,
          "connector": 2,
          "id": 95845,
          "outlet_index": null
        }
      ],
      "hours": "",
      "promos": [],
      "manufacturer": "GE WattStation",
      "name": "PRIVATE LOCATION",
      "network_id": 4,
      "created_at": "2013-11-19T22:26:35Z",
      "longitude": -118.472993,
      "model": "",
    }
  ]
}
Property Description
id
Number (integer)
Unique and immutable identifier.
name
String
Descriptive name of the parking structure, business, etc.
latitude
Number
Latitude coordinate for this location.
longitude
Number
Longitude coordinate for this location.
description
String
Unicode string describing a location, can include HTML elements.
stations
Array
Contains station objects. Each location will have at least 1 station object.
reviews
Array
Contains review objects. Ordered from the most recent to oldest. This array can be empty.
valid_outlets
Array
The types of outlets that are valid for this location’s locale. This is not a list of outlet types that are present.
photos
Array
Contains photo objects. Ordered from the most recent to oldest. This array can be empty.
promos
Array
Contains promo objects. This will only return promos at the location level. This array can be empty.
all_promos
Array
Contains promo objects. This will return all promos at both the location level and station level. This array can be empty.
score
Number (decimal)
The location’s PlugScore - If a location has enough data to be scored this is a decimal number with 1 significant digit from 0.0 (worst) - 10.0 (best). Score is based on recency weighted reviews and may also be affected by cost, available power, and other factors.
cost
Boolean
If true, then there is a cost associated with this location (check cost_description). If false, then cost is unknown. This field supplements cost values at each station location. Generally cost values at stations are provided by 3rd parties, while cost values at locations are provided by PlugShare members.
cost_description
String
A description of fees for charging and parking at this location.
access
Number (integer enum)
1 = A public location.
2 = A restricted location. Not available for general public use. Examples include workplace charging and car dealerships with charging policy restrictions.
3 = A residential location that has been shared. Not available for public use without prior permission.
url
String (URL)
A shareable link that redirects to this PlugShare location (platform aware: opens apps if user is on mobile, otherwise directs to web).
icon
String (URL)
A recommended icon for displaying the location.
icon_type
String
The stripped file name of the icon’s URL path.
phone
String
Formatting of this field is not currently guaranteed.
address
String
Street address of the location.
pwps_version
Number (integer)
The Pay with PlugShare version protocol required to be supported by the client to activate this station.
created_at
String (timestamp)
ISO 8601 Format “yyyy-mm-ddThh:mm:ssZ”.
updated_at
String (timestamp)
Timestamp of the last time this location was updated. “yyyy-mm-dd hh:mm:ss” format.
qr_enabled
Boolean
True if this station is tagged with a QR code for station identification and activation flows.
poi_name
String
Point of interest / location type name. Selected from a list of 40+ types, including Gas Station, Park, Restaurant, etc.
parking_type_name
String
The types of parking available. Customers Only, Free, Pay, Restricted, Unknown, “, or null.
locale
String
This location’s locale. US, UK, EU, AU, JP, WW.
opening_date
String (date)
Date when location is anticipated to open in the future. "yyyy-mm-dd” format.
hours
String
String for hours of availability. Commonly 24/7 or specified time frames.
open247
Boolean
Flag if the location is open 24 hours a day, 7 days a week.
coming_soon
Boolean
Flag if the location is not currently active and is anticipated to be coming soon.
under_repair
Boolean
Flag if the location is currently under repair.
compass_bearing
Number (float)
A compass bearing from the specified address or coordinate. Note: this field will only appear for locations returned by the /locations/nearby endpoint.
distance_meters
Number (float)
A distance in meters from the specified address or coordinate. Note: this field will only appear for locations returned by the /locations/nearby endpoint.

Get Location

Example Request:

GET https://api.plugshare.com/locations/38606

Example Response:

{
    "valid_outlets": [],
    "description": "No Public Access.",
    "opening_date": "None",
    "updated_at": "2016-12-09T10:16:23Z",
    "hours": "",
    "phone": "",
    "promos": [],
    "cost": true,
    "pwps_version": 2,
    "address": "1015 Abbot Kinney Blvd Los Angeles, CA 90291",
    "score": 10,
    "id": 38606,
    "parking_type_name": "Free",
    "icon": "https://s3.amazonaws.com/plugshare.production.assets/icons/B.png",
    "cost_description": "",
    "reviews": [],
    "name": "PlugShare API Station",
    "url": "http://api.plugshare.com/view/location/38606",
    "created_at": "2013-11-19T22:26:33Z",
    "icon_type": "B",
    "all_promos": [],
    "longitude": -118.4721,
    "access": 2,
    "locale": "US",
    "under_repair": true,
    "amenities": [],
    "poi_name": "Workplace Private",
    "coming_soon": null,
    "latitude": 33.992476,
    "photos": [],
    "open247": false,
    "stations": []
}

This endpoint retrieves a location based on location id.

HTTP Request

GET https://api.plugshare.com/locations/{id}

Arguments

id
required
Location id of target location

Returns

Returns a location object if the call succeeded.

Get Nearby Locations

Example Request:

GET https://api.plugshare.com/locations/nearby?latitude=33.992476&longitude=-118.4721&count=10

Example Response:

[
    {
        "valid_outlets": [],
        "description": "No Public Access.",
        "opening_date": "None",
        "updated_at": "2016-12-09T10:16:23Z",
        "hours": "",
        "phone": "",
        "promos": [],
        "cost": true,
        "pwps_version": 2,
        "address": "1015 Abbot Kinney Blvd Los Angeles, CA 90291",
        "score": 10,
        "id": 45911,
        "parking_type_name": "Free",
        "icon": "https://s3.amazonaws.com/plugshare.production.assets/icons/B.png",
        "cost_description": "",
        "name": "PlugShare API Station",
        "url": "http://api.plugshare.com/view/location/45911",
        "created_at": "2013-11-19T22:26:33Z",
        "icon_type": "B",
        "all_promos": [],
        "longitude": -118.4721,
        "access": 2,
        "locale": "US",
        "under_repair": true,
        "amenities": [],
        "poi_name": "Workplace Private",
        "coming_soon": null,
        "latitude": 33.992476,
        "open247": false,
        "stations": []
    }
]

This endpoint retrieves locations near a given coordinate.

HTTP Request

GET https://api.plugshare.com/locations/nearby

Arguments

latitude
conditional
Latitude coordinate of target search location.
This endpoint requires either lat/lng coordinates or an address.
longitude
conditional
Longitude coordinate of target search location.
This endpoint requires either lat/lng coordinates or an address.
address
conditional
Address of target search location.
This endpoint requires either lat/lng coordinates or an address.
Will return {code:1} if address cannot be geolocated, and {code:2} if address is ambiguous. Otherwise returns list of locations.
count
optional
Maximum count of locations to return. Count is capped at 500 regardless of specified value.
200-500 is a recommended value for most applications.
radius
optional
Search radius in meters.
outlets
optional
The ‘outlets’ filter is a JSON formatted list of “outlet descriptor” objects. Each object has two optional properties, connector and power. Locations will only be returned if they have a station that contains one or more outlets that match one of these descriptors. A descriptor matches an outlet if each of the descriptor properties matches the corresponding property of the outlet. See Outlet Connector Types
cost
optional, default is true
true = Returns all locations regardless of cost.
false = Does not return locations with a known fee (like parking or $/kw).
access
optional
Filter on a comma separated list of access values. Matches if at least one access value is present.
See Access Values
availability
optional
Filter on a comma separated list of availability values. Matches if at least one availability value is present.
See Availability Values
amenities
optional
Filter on a comma separated list of amenities. Matches if at least one listed amenity is present.
See Amenity Values
exclude_networks
optional
Filter on a comma separated list of network ids to exclude. Passing “exclude_networks=1” will exclude locations which exclusively have ChargePoint stations. If a location has both a ChargePoint station and a station of another network or a non-networked station it will still be eligible to be returned.
See Networks List
networks
optional
Filter on a comma separated list of network ids to include. Matches if at least one network is present.
See Networks List
score
optional
Filter on PlugScore. Accepts a range from 0.0 to 10.0. Will return results greater than or equal to the number provided.

Additional Examples

GET https://api.plugshare.com/locations/nearby?address=venice%2C%20ca&count=10&radius=1000

GET https://api.plugshare.com/locations/nearby?address=venice%2C%20ca&count=10&outlets=[{"connector":2},{"connector":6,"power":1}]

GET https://api.plugshare.com/locations/nearby?latitude=33.992476&longitude=-118.4721&count=10&cost=false

GET https://api.plugshare.com/locations/nearby?latitude=33.992476&longitude=-118.4721&count=10&access=1,3

GET https://api.plugshare.com/locations/nearby?latitude=33.992476&longitude=-118.4721&count=10&availability=3

GET https://api.plugshare.com/locations/nearby?latitude=33.992476&longitude=-118.4721&count=10&amenities=1,2

GET https://api.plugshare.com/locations/nearby?latitude=33.992476&longitude=-118.4721&count=10&exclude_networks=1

GET https://api.plugshare.com/locations/nearby?latitude=33.992476&longitude=-118.4721&count=10&networks=3,4

Returns

Returns an array of location objects, containing up to count locations

Get Locations in Region

Example Request:

GET https://api.plugshare.com/locations/region?spanLat=0.15&spanLng=0.10&latitude=33.992476&longitude=-118.4721&count=10

Example Response:

[
    {
        "valid_outlets": [],
        "description": "",
        "opening_date": "None",
        "updated_at": "2016-09-15T10:06:01Z",
        "hours": "",
        "phone": "",
        "promos": [],
        "cost": true,
        "pwps_version": null,
        "address": "210 Market Ave, Los Altos, CA 94022",
        "id": 40025,
        "parking_type_name": "Free",
        "icon": "https://s3.amazonaws.com/plugshare.production.assets/icons/G.png",
        "cost_description": "Variable: $3.00/hour to $6.00/hour",
        "name": "Central Charging Station",
        "url": "http://api.plugshare.com/view/location/40025",
        "created_at": "2016-09-13T20:51:23Z",
        "icon_type": "G",
        "all_promos": [],
        "longitude": -122.105989,
        "access": 1,
        "locale": "US",
        "under_repair": false,
        "amenities": [],
        "poi_name": "Workplace Public",
        "coming_soon": null,
        "latitude": 37.396454,
        "open247": false,
        "stations": []
    }
]

This endpoint retrieves locations in a region based on a given coordinate with latitude and longitude spans.

HTTP Request

GET https://api.plugshare.com/locations/region

Arguments

spanLat
required
Latitude span in degrees of target search region.
spanLng
required
Longitude span in degrees of target search region.
latitude
required
Latitude coordinate of target search location.
longitude
required
Longitude coordinate of target search location.
count
required
Maximum count of locations to return. Count is capped at 500 regardless of specified value.
200-500 is a recommended value for most applications.
outlets
optional
The ‘outlets’ filter is a JSON formatted list of “outlet descriptor” objects. Each object has two optional properties, connector and power. Locations will only be returned if they have a station that contains one or more outlets that match one of these descriptors. A descriptor matches an outlet if each of the descriptor properties matches the corresponding property of the outlet. See Outlet Connector Types
cost
optional, default is true
true = Returns all locations regardless of cost.
false = Does not return locations with a known fee (like parking or $/kw).
access
optional
Filter on a comma separated list of access values. Matches if at least one access value is present.
See Access Values
availability
optional
Filter on a comma separated list of availability values. Matches if at least one availability value is present.
See Availability Values
amenities
optional
Filter on a comma separated list of amenities. Matches if at least one listed amenity is present.
See Amenity Values
exclude_networks
optional
Filter on a comma separated list of network ids to exclude. Passing “exclude_networks=1” will exclude locations which exclusively have ChargePoint stations. If a location has both a ChargePoint station and a station of another network or a non-networked station it will still be eligible to be returned.
See Networks List
networks
optional
Filter on a comma separated list of network ids to include. Matches if at least one network is present.
See Networks List
score
optional
Filter on PlugScore. Accepts a range from 0.0 to 10.0. Will return results greater than or equal to the number provided.

Additional Examples

GET https://api.plugshare.com/locations/region?spanLat=0.15&spanLng=0.10&latitude=33.992476&longitude=-118.4721&count=10&outlets=[{"connector":2}]

GET https://api.plugshare.com/locations/region?spanLat=0.15&spanLng=0.10&latitude=33.992476&longitude=-118.4721&count=10&cost=false

GET https://api.plugshare.com/locations/region?spanLat=0.15&spanLng=0.10&latitude=33.992476&longitude=-118.4721&count=10&access=1,3

GET https://api.plugshare.com/locations/region?spanLat=0.15&spanLng=0.10&latitude=33.992476&longitude=-118.4721&count=10&availability=3

GET https://api.plugshare.com/locations/region?spanLat=0.15&spanLng=0.10&latitude=33.992476&longitude=-118.4721&count=10&amenities=1,2

GET https://api.plugshare.com/locations/region?spanLat=0.15&spanLng=0.10&latitude=33.992476&longitude=-118.4721&count=10&exclude_networks=1

GET https://api.plugshare.com/locations/region?spanLat=0.15&spanLng=0.10&latitude=33.992476&longitude=-118.4721&count=10&networks=3,4

Returns

Returns an array of location objects, containing up to count locations

Search Locations

Example Request:

GET https://api.plugshare.com/locations/search?query=venice%2C%20ca&count=10

Example Response:

[
  {
    "valid_outlets": [],
    "description": "Please call first.",
    "opening_date": "None",
    "updated_at": "2014-10-15T22:53:50Z",
    "hours": "",
    "phone": "3109231567",
    "promos": [],
    "cost": false,
    "pwps_version": null,
    "address": "Glencoe Ave Venice, CA 90291",
    "owner": "",
    "id": 58226,
    "parking_type_name": null,
    "icon": "https://s3.amazonaws.com/plugshare.production.assets/icons/H.png",
    "cost_description": "",
    "name": "",
    "url": "http://api.plugshare.com/view/location/58226",
    "created_at": "2014-09-06T01:21:10Z",
    "icon_type": "H",
    "all_promos": [],
    "longitude": -118.449509,
    "access": 3,
    "locale": "US",
    "under_repair": false,
    "amenities": [],
    "poi_name": null,
    "coming_soon": null,
    "latitude": 34.000126,
    "open247": false,
    "stations": []
  }
]

This endpoint returns locations whose name or address contains a specified search query.

HTTP Request

GET https://api.plugshare.com/locations/search

Arguments

query
required
The search query. Matches on name or address.
count
optional
Maximum count of locations to return. Count is capped at 500 regardless of specified value.
200-500 is a recommended value for most applications.
page
optional
This method supports paging. If page is specified, count must be specified as well.
This returns results based on the page index number, with 100 results showing per page.
outlets
optional
The ‘outlets’ filter is a JSON formatted list of “outlet descriptor” objects. Each object has two optional properties, connector and power. Locations will only be returned if they have a station that contains one or more outlets that match one of these descriptors. A descriptor matches an outlet if each of the descriptor properties matches the corresponding property of the outlet. See Outlet Connector Types
cost
optional, default is true
true = Returns all locations regardless of cost.
false = Does not return locations with a known fee (like parking or $/kw).
access
optional
Filter on a comma separated list of access values. Matches if at least one access value is present.
See Access Values
exclude_networks
optional
Filter on a comma separated list of network ids to exclude. Passing “exclude_networks=1” will exclude locations which exclusively have ChargePoint stations. If a location has both a ChargePoint station and a station of another network or a non-networked station it will still be eligible to be returned.
See Networks List
networks
optional
Filter on a comma separated list of network ids to include. Matches if at least one network is present.
See Networks List
score
optional
Filter on PlugScore. Accepts a range from 0.0 to 10.0. Will return results greater than or equal to the number provided.

Additional Examples

GET https://api.plugshare.com/locations/search?query=recargo

GET https://api.plugshare.com/locations/search?query=california&count=500&page=2

GET https://api.plugshare.com/locations/search?query=venice%2C%20ca&count=10&outlets=[{"connector":2},{"connector":6,"power":1}]

GET https://api.plugshare.com/locations/search?query=palo%20alto&count=100&networks=3,4&outlets=[{"connector":2},{"connector":6,"power":1}]

GET https://api.plugshare.com/locations/search?query=palo%20alto&count=100&access=1,2,3&cost=false

Returns

Returns an array of location objects, containing up to count locations

Fetch Locations Along Route

Example Request:

POST https://api.plugshare.com/locations/polyline?minimal=1

POST body:
{
   "distance":9654,
   "outlets":"[{\"connector\":2},{\"connector\":6,\"power\":1}]",
   "access":"1,2,3",
   "polyline":"33.96515,-118.38001000000001,33.96537,33.992140000000006,-118.47224000000001",
   "exclude_networks":"2,19,3,1,26,34,5"
}

Example Response:

[
   {
      "access":1,
      "url":"http://api.plugshare.com/view/location/1553",
      "score":10.0,
      "name":"Electric St. Garage",
      "stations":[
         {
            "id":2385,
            "outlets":[
               {
                  "connector":2,
                  "id":50627,
                  "power":0
               }
            ]
         }
      ],
      "latitude":34.00208,
      "owner":{
         "first_name":"julius",
         "id":137549
      },
      "icon_type":"G",
      "id":2116,
      "longitude":-81.04077,
      "icon":"https://s3.amazonaws.com/plugshare.staging.assets/icons/G.png"
   }
]

This endpoint returns locations who are a certain distance away from the polyline path.

HTTP Request

POST https://api.plugshare.com/locations/polyline?minimal=1

Arguments

polyline
required
A list of coordinates describing the route in the form of lat1,lng1,lat2,lng2…
distance
required
The search distance in meters around the route.
count
optional
Maximum count of locations to return. Count is capped at 500 regardless of specified value.
200-500 is a recommended value for most applications
page
optional
This method supports paging. If page is specified, count must be specified as well.
This returns results based on the page index number, with 100 results showing per page.
outlets
optional
The ‘outlets’ filter is a JSON formatted list of “outlet descriptor” objects. Each object has two optional properties, connector and power. Locations will only be returned if they have a station that contains one or more outlets that match one of these descriptors. A descriptor matches an outlet if each of the descriptor properties matches the corresponding property of the outlet. See Outlet Connector Types
cost
optional, default is true
true = Returns all locations regardless of cost.
false = Does not return locations with a known fee (like parking or $/kw).
access
optional
Filter on a comma separated list of access values. Matches if at least one access value is present.
See Access Values
exclude_networks
optional
Filter on a comma separated list of network ids to exclude. Passing “exclude_networks=1” will exclude locations which exclusively have ChargePoint stations. If a location has both a ChargePoint station and a station of another network or a non-networked station it will still be eligible to be returned.
See Networks List
networks
optional
Filter on a comma separated list of network ids to include. Matches if at least one network is present.
See Networks List
score
optional
Filter on PlugScore. Accepts a range from 0.0 to 10.0. Will return results greater than or equal to the number provided.
minimal
optional
1 = Return minimalized data as response is typically very large.

Additional Examples

POST https://api.plugshare.com/locations/polyline

Returns

Returns an array of location objects, containing up to count locations

Amenities List

id amenity id amenity id amenity
1 Lodging 4 EV Parking 7 WiFi
2 Dining 5 Valet Parking 8 Shopping
3 Restrooms 6 Park 9 Grocery

Station

A physical charging unit installed on the ground or wall. In EV industry terms this is also frequently referred to as an EVSE (Electric Vehicle Service Equipment). Stations can be network managed. Stations frequently support real time availability data.

Object Properties

Example Response:

[
    {
        "qr_enabled": true,
        "cost": 2,
        "pwps_version": 2,
        "location_id": 20840,
        "id": 38416,
        "cost_description": "$1/hour: first 4 hours. $20/hour thereafter. 50 cent minimum. Fees continue while car is connected even if not charging.",
        "pre_charge_instructions": null,
        "network": "",
        "latitude": 33.992305,
        "available": 1,
        "outlets": [
          {
            "available": null,
            "description": null,
            "power": 0,
            "connector": 2,
            "id": 78351,
            "outlet_index": null
          }
        ],
        "hours": "",
        "promos": [],
        "manufacturer": "GE WattStation",
        "name": "PRIVATE LOCATION",
        "network_id": 4,
        "created_at": "2013-11-19T22:26:35Z",
        "longitude": -118.472993,
        "model": "",
    }
]
Property Description
id
Number (integer)
Unique and immutable identifier.
name
String
The name attribute of a station is the user-facing identifier for the station. Typically the name is found somewhere on the physical station.
network
Object
The network that owns or directly manages this station.
network_id
Number (integer)
Network id of the station.
cost
Number (integer enum)
0 = Unknown
1 = Free
2 = Fee
cost_description
String
Describes the cost of charging at this location. Examples include $2/hr, $0.10/kWh, $8 per session.
manufacturer
String
The manufacturer of this station.
model
String
The hardware model type.
pwps_version
Number (integer)
The Pay with PlugShare version protocol required to be supported by the client to activate this station.
latitude
Number
Latitude coordinate for this station.
longitude
Number
Longitude coordinate for this station.
outlets
Array
Contains outlet objects. Each station will have at least 1 outlet object.
promos
Array
Contains promo objects. This will only return promos on the station level. This array can be empty.
available
Number (integer enum)
0 = Unknown
1 = Available
2 = In Use
3 = Offline
4 = Under Repair
hours
String
String for hours of availability. Commonly 24/7 or specified time frames.
location_id
Number (integer)
The id of the station’s parent location.
pre_charge_instructions
String
Optional network provided instructions to display before charging.
qr_enabled
Boolean
True if this station is tagged with a QR code for station identification and activation flows.
created_at
String (date)
ISO 8601 Format “yyyy-mm-ddThh:mm:ssZ”.

Outlet

A physical vehicle-to-station connection point: either a plug or a socket. Stations can have multiple outlets. Stations can have outlets of varying types.

Object Properties

Example Response:

[
    {
        "available": null,
        "power": 0,
        "connector": 2,
        "id": 85911,
    }
]
Property Description
id
number (integer)
Unique and immutable identifier.
connector
Number (integer enum)
See Outlet Connector Types
power
Number (integer enum)
See Outlet Connector Types
available
string
If null, outlet level availability is unknown (Note: generally, see Station availability instead).

Outlet Connector Types

PlugShare supports all EV charging connectors that are in active use globally.

Connector ID Power Level Description Image North America UK EU JP AU
1 US Wall Outlet Y Y
2 J-1772 Y Y Y Y Y
3 CHAdeMO Y Y Y Y Y
4 Tesla Roadster Y Y Y Y Y
5 NEMA 14-50 Y
6 0 Tesla S HPWC Y Y Y
6 1 Tesla Supercharger Y Y Y
7 Type 2 (Mennekes) Y Y Y
8 Type 3 Y Y
9 BS1363 Y
10 Europlug Y
11 UK Commando Y
12 AS3112 Y
13 SAE Combo DC CCS Y Y Y
14 Three Phase 32A (UK) Y
15 Caravan Mains Socket Y Y Y

Network

A company that operates stations and provides subscription services or access control services for those stations.

Object Properties

Example Response:

{
    "description": "GE's networked platform that allows users to manage and monitor the charging of their electric cars.",
    "url": "https://www.gewattstation.com/connect/",
    "image": "https://s3.amazonaws.com/plugshare.production.assets/network-images/watt.png",
    "action_name": "Sign Up",
    "phone": "8554433873",
    "action_url": "https://www.gewattstation.com/connect/",
    "id": 4,
    "name": "GE WattStation"
}
Property Description
id
number (integer)
Unique and immutable identifier.
name
string
The driver-friendly name for the Network’s Brand such as “SemaCharge”.
description
string
A short marketing summary of the Network’s service offerings.
action_name
string
A description of the URL destination. Examples include “Sign Up” or “Learn More”.
action_url
string (URL)
A URL provided by a network that usually includes a call to action or contact information.
url
string (URL)
A URL that generally links to a network’s home page.
phone
string
Phone number for customer service or activation by phone requests.
image
string (URL)
If available, an approved logo for the Network.

Networks List

id network id network id network id network
1 ChargePoint 7 AddEnergie 19 EVgo 30 Shorepower
2 Blink 8 Tesla Supercharger 22 Lastestasjoner 33 CarCharging
3 Semaconnect 9 AeroVironment 23 Enel Drive 34 JNSH
4 GE WattStation 13 RWE eMobility 25 Volta 35 Tesla Destination
5 Sun Country 14 Oplaadpalen 26 Greenlots 36 ChargeNet
6 Circuit Electrique 15 Endesa 29 OpConnect

Photo

A location photo contributed by the PlugShare community.

Object Properties

Example Response:

[
    {
        "user_id": 75733,
        "url": "https://s3.amazonaws.com/plugshare.production.photos/photos/165827.jpg",
        "created_at": "2016-11-29T17:57:14Z",
        "thumbnail": "https://s3.amazonaws.com/plugshare.production.photos/thumb/165827.png",
        "caption": "PlugShare Garage",
        "thumbnail2x": "https://s3.amazonaws.com/plugshare.production.photos/thumb2x/165827.png",
        "order": 1,
        "id": 192372
    }
]
Property Description
id
Number (integer)
Unique and immutable identifier.
url
String (URL)
The URL to the full size photo.
thumbnail
String (URL)
If available, link to a smaller version of the photo*.
thumbnail2x
String (URL)
If available, link to a smaller version of the photo*, rendered at 2x the standard thumbnail size.
caption
String
User provided caption of the photo.
order
Number (integer)
Arrangement order of pinned photos at this location.
user_id
Number (integer)
The id of the user who uploaded this photo.
created_at
String (timestamp)
ISO 8601 Format “yyyy-mm-ddThh:mm:ssZ”.

*Service side processing of additional formats and dimensions are available as needed.

Review (Check-In)

Check-Ins include:

Object Properties

Example Response:

[
    {
        "comment": "",
        "rating": 1,
        "connector_type": 2,
        "volts": null,
        "created_at": "2014-08-11T23:54:42Z",
        "finished": "2014-08-12T00:53:22Z",
        "waiting": false,
        "user": ""
        "amps": null,
        "vehicle_type": 4,
        "id": 152385
    }
]
Property Description
id
Number (integer)
Unique and immutable identifier.
rating
Number (integer)
1 = Positive / Success
0 = Neutral / Tips etc.
-1 = Trouble charging or other problem
comment
String
The user’s review.
volts
Number (integer)
User submitted data of maximum volts if recorded during this visit, else NULL. Note: depending on vehicle capabilities or limitations, this may be lower than the station’s maximum capabilities.
amps
Number (integer)
User submitted data of maximum amps if recorded during this visit, else NULL. Note: depending on vehicle capabilities or limitations, this may be lower than the station’s maximum capabilities.
finished
String (timestamp)
The date the user plans to leave (or left) the location.
user
Object (User)
User object including in depth information about the user who submitted this review (check-in).
created_at
String (timestamp)
When the Check-In was submitted.

User

A PlugShare user who may be owner of reviews, check-ins, or private locations.

Object Properties

Example Response:

{
    "allow_notifications": true,
    "first_name": "Steven",
    "notify_nearby_radius": 10000,
    "hide_address": true,
    "vehicle_description": "",
    "created_at": "2010-03-10T22:08:56Z",
    "vehicle_color": 9,
    "phone": "",
    "photos": [
        {
            "user_id": 253,
            "url": "https://s3.amazonaws.com/plugshare.production.photos/photos/41329.jpg",
            "created_at": "2013-12-30T07:01:35Z",
            "thumbnail": "https://s3.amazonaws.com/plugshare.production.photos/thumb/41329.png",
            "caption": "",
            "thumbnail2x": "https://s3.amazonaws.com/plugshare.production.photos/thumb2x/41329.png",
            "order": 0,
            "id": 38376
        }
    ],
    "last_login": "2017-03-13T23:02:56Z",
    "vehicle_subtype": 5,
    "about": "",
    "vehicle_type": 52,
    "id": 3590,
    "notify_nearby": 1
}
Property Description
id
Number (integer)
Unique and immutable identifier.
first_name
String
User’s public facing username.
phone
String
Formatting of this field is not currently guaranteed.
about
String
User input, public-facing about me section.
allow_notifications
Boolean
Flag if user allows notifications.
notify_nearby
Number (integer enum)
0 = None.
1 = Nearby All
2 = Nearby Private
3 = Nearby Public
notify_nearby_radius
Number (integer)
User’s set notify if charger within nearby radius. Possible values: 1000, 1600, 5000, 8000, 10000, 16000.
vehicle_type
Number (integer enum)
Number indicating user’s selection of one of many preset vehicle types.
vehicle_subtype
Number (integer enum)
Number indicating user’s selection of one of many preset vehicle subtypes.
vehicle_color
Number (integer enum)
Number indicating user’s selection of one of many preset vehicle colors.
vehicle_description
String
User input, self describe their own vehicle.
hide_address
Boolean
Flag if user opted to hide personal address information.
last_login
String (timestamp)
ISO 8601 Format “yyyy-mm-ddThh:mm:ssZ”.
created_at
String (timestamp)
ISO 8601 Format “yyyy-mm-ddThh:mm:ssZ”.