diff --git a/source/docs/transportation/alt-fuel-stations-v1/_ev_charging_units_response_common.html.md.erb b/source/docs/transportation/alt-fuel-stations-v1/_ev_charging_units_response_common.html.md.erb new file mode 100644 index 00000000..0ca8ab5e --- /dev/null +++ b/source/docs/transportation/alt-fuel-stations-v1/_ev_charging_units_response_common.html.md.erb @@ -0,0 +1,71 @@ +The response is a CSV data download that includes information about EV charging power output by connector type matching the requested query. Each row in the spreadsheet represents an EV charging unit that might have one or more ports and one or more connectors. A single station location may have multiple rows in the spreadsheet. + +The table below documents the columns unique to this data download. For documentation on the remaining columns in the CSV, see the response fields for the [All Stations endpoint](/docs/transportation/alt-fuel-stations-v1/all/#response-fields). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
EV Level1 EVSE NumTotal number of Level 1 charging ports at station location
EV Level2 EVSE NumTotal number of Level 2 charging ports at station location
EV DC Fast CountTotal number of DC Fast charging ports at station location
EV J1772 Connector CountTotal number of J1772 connectors at station location
EV J1772 Power Output (kW)Power output in kilowatts of J1772 ports
EV CCS Connector CountTotal number of CCS/J1772 Combo connectors at station location
EV CCS Power Output (kW)Power output in kilowatts of CCS/J1772 Combo ports
EV CHAdeMO Connector CountTotal number of CHAdeMO connectors at station location
EV CHAdeMO Power Output (kW)Power output in kilowatts of CHAdeMO ports
EV J3400 Connector CountTotal number of NACS/J3400 connectors at station location
EV J3400 Power Output (kW)Power output in kilowatts of NACS/J3400 ports
EV J3271 Connector CountTotal number of MCS/J3271 connectors at station location
EV J3271 Power Output (kW)Power output in kilowatts of MCS/J3271 ports
Snapshot DateDate that the data was requested
+ diff --git a/source/docs/transportation/alt-fuel-stations-v1/all.html.md.erb b/source/docs/transportation/alt-fuel-stations-v1/all.html.md.erb index 07ba4b1b..a62b8dac 100644 --- a/source/docs/transportation/alt-fuel-stations-v1/all.html.md.erb +++ b/source/docs/transportation/alt-fuel-stations-v1/all.html.md.erb @@ -35,6 +35,7 @@ The following query parameters may be passed in the request to control the outpu <%= partial("docs/transportation/alt-fuel-stations-v1/request_params_common2") %> <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/ids") %> <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/limit") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/offset") %> diff --git a/source/docs/transportation/alt-fuel-stations-v1/ev-charging-units-nearest.html.md.erb b/source/docs/transportation/alt-fuel-stations-v1/ev-charging-units-nearest.html.md.erb new file mode 100644 index 00000000..233e65cc --- /dev/null +++ b/source/docs/transportation/alt-fuel-stations-v1/ev-charging-units-nearest.html.md.erb @@ -0,0 +1,80 @@ +--- +title: Nearest Electric Vehicle Charging Ports +summary: Return a CSV file of EV charging ports for the nearest alternative fuel stations within a distance of a given location. For JSON or other file formats, this information is available via the Nearest Stations API. +url: GET /api/alt-fuel-stations/v1/ev-charging-units/nearest +sort_value: "65" +--- + +# <%= current_page.data.title %> (<%= current_page.data.url %>) +<%= current_page.data.summary %> + +{:toc} + +<%= partial "layouts/toc" %> + +## Request URL + +
GET /api/alt-fuel-stations/v1/ev-charging-units/nearest.csv?parameters
+ +## Request Parameters + +The following query parameters may be passed in the request to control the output: + + + + + + + + + + + + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/access") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/api_key") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/latitude") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/longitude") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/radius") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/cards_accepted") %> + <%= partial "docs/transportation/alt-fuel-stations-v1/request_params/country", locals: {resources: "stations"} %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/ev_charging_level") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/ev_connector_type") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/ev_connector_type_operator") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/ev_network") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/ev_power_kw_max") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/ev_power_kw_min") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/facility_type") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/federal_agency") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/nearest_limit") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/offset") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/status") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/state") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/zip") %> + +
ParameterRequiredValueDescription
+ +## Response Fields +<%= partial("docs/transportation/alt-fuel-stations-v1/ev_charging_units_response_common") %> + +## Rate Limits + +[Standard rate limits](/docs/rate-limits) apply. No more than 1,000 requests may be made in any hour + +## Errors + +[Standard errors](/docs/errors) may be returned. In addition, the following service-specific errors may be returned: + + + + + + + + + + + + + + +
HTTP Status CodeDescription
422Unprocessable Entity - An invalid value was given for a query parameter. The response body will describe the specific error.
diff --git a/source/docs/transportation/alt-fuel-stations-v1/ev-charging-units.html.md.erb b/source/docs/transportation/alt-fuel-stations-v1/ev-charging-units.html.md.erb index cd323e69..9dbeec52 100644 --- a/source/docs/transportation/alt-fuel-stations-v1/ev-charging-units.html.md.erb +++ b/source/docs/transportation/alt-fuel-stations-v1/ev-charging-units.html.md.erb @@ -43,6 +43,7 @@ The following query parameters may be passed in the request to control the outpu <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/facility_type") %> <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/federal_agency") %> <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/limit") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/offset") %> <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/status") %> <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/state") %> <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/zip") %> @@ -50,73 +51,7 @@ The following query parameters may be passed in the request to control the outpu ## Response Fields - -The response is a CSV data download that includes information about EV charging power output by connector type matching the requested query. Each row in the spreadsheet represents an EV charging unit that might have one or more ports and one or more connectors. A single station location may have multiple rows in the spreadsheet. - -The table below documents the columns unique to this data download. For documentation on the remaining columns in the CSV, see the response fields for the [All Stations endpoint](/docs/transportation/alt-fuel-stations-v1/all/#response-fields). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
EV Level1 EVSE NumTotal number of Level 1 charging ports at station location
EV Level2 EVSE NumTotal number of Level 2 charging ports at station location
EV DC Fast CountTotal number of DC Fast charging ports at station location
EV J1772 Connector CountTotal number of J1772 connectors at station location
EV J1772 Power Output (kW)Power output in kilowatts of J1772 ports
EV CCS Connector CountTotal number of CCS/J1772 Combo connectors at station location
EV CCS Power Output (kW)Power output in kilowatts of CCS/J1772 Combo ports
EV CHAdeMO Connector CountTotal number of CHAdeMO connectors at station location
EV CHAdeMO Power Output (kW)Power output in kilowatts of CHAdeMO ports
EV J3400 Connector CountTotal number of NACS/J3400 connectors at station location
EV J3400 Power Output (kW)Power output in kilowatts of NACS/J3400 ports
EV J3271 Connector CountTotal number of MCS/J3271 connectors at station location
EV J3271 Power Output (kW)Power output in kilowatts of MCS/J3271 ports
+<%= partial("docs/transportation/alt-fuel-stations-v1/ev_charging_units_response_common") %> ## Rate Limits diff --git a/source/docs/transportation/alt-fuel-stations-v1/nearby-route.html.md.erb b/source/docs/transportation/alt-fuel-stations-v1/nearby-route.html.md.erb index fa6cb985..f8684b7b 100644 --- a/source/docs/transportation/alt-fuel-stations-v1/nearby-route.html.md.erb +++ b/source/docs/transportation/alt-fuel-stations-v1/nearby-route.html.md.erb @@ -106,38 +106,8 @@ LINESTRING(-74.0 40.7, -87.63 41.87, -104.98 39.76) <%= partial("docs/transportation/alt-fuel-stations-v1/request_params_common2") %> - - limit - No - -
- Type: integer or string -
-
- Default: all -
-
- Range: 0 to 200, or all -
- - The maximum number of results to return. An explicit limit of up to 200 may be passed in, or the special all string may be passed in to return all results. - - - offset - No - -
- Type: integer -
-
- Default: 0 -
-
- Minimum: 0 -
- - Offset the results found (can be used with the limit parameter to paginate the results). - + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/limit") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/offset") %> diff --git a/source/docs/transportation/alt-fuel-stations-v1/nearest.html.md.erb b/source/docs/transportation/alt-fuel-stations-v1/nearest.html.md.erb index b72daba7..fea6d09f 100644 --- a/source/docs/transportation/alt-fuel-stations-v1/nearest.html.md.erb +++ b/source/docs/transportation/alt-fuel-stations-v1/nearest.html.md.erb @@ -31,73 +31,12 @@ The following query parameters may be passed in the request to control the outpu <%= partial("docs/transportation/alt-fuel-stations-v1/request_params_common1") %> <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/response_format") %> - - latitude - Yes - -
- Type: decimal -
-
- Range: -90 to 90 -
- - -

The latitude of the desired location.

- - - - longitude - Yes - -
- Type: decimal -
-
- Range: -180 to 180 -
- - -

The longitude of the desired location.

- - - - radius - No - -
- Type: decimal or string -
-
- Default: 5.0 -
-
- Range: 0.0 to 500.0, or infinite -
- - -

The radius (in miles) around the search location to search for stations within.

-

An explicit radius of up to 500.0 miles may be passed in, or the special infinite string may be passed in to find the nearest stations regardless of distance.

- - + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/latitude") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/longitude") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/radius") %> <%= partial("docs/transportation/alt-fuel-stations-v1/request_params_common2") %> - <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/limit", locals: {default: "20", bonus_description: " except when the radius is infinite"}) %> - - offset - No - -
- Type: integer -
-
- Default: 0 -
-
- Minimum: 0 -
- - Offset the results found (can be used with the limit parameter to paginate the results). - + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/nearest_limit") %> + <%= partial("docs/transportation/alt-fuel-stations-v1/request_params/offset") %> diff --git a/source/docs/transportation/alt-fuel-stations-v1/request_params/_latitude.html.md.erb b/source/docs/transportation/alt-fuel-stations-v1/request_params/_latitude.html.md.erb new file mode 100644 index 00000000..8e338e9b --- /dev/null +++ b/source/docs/transportation/alt-fuel-stations-v1/request_params/_latitude.html.md.erb @@ -0,0 +1,15 @@ + + latitude + Yes + +
+ Type: decimal +
+
+ Range: -90 to 90 +
+ + +

The latitude of the desired location.

+ + diff --git a/source/docs/transportation/alt-fuel-stations-v1/request_params/_longitude.html.md.erb b/source/docs/transportation/alt-fuel-stations-v1/request_params/_longitude.html.md.erb new file mode 100644 index 00000000..c283ad56 --- /dev/null +++ b/source/docs/transportation/alt-fuel-stations-v1/request_params/_longitude.html.md.erb @@ -0,0 +1,15 @@ + + longitude + Yes + +
+ Type: decimal +
+
+ Range: -180 to 180 +
+ + +

The longitude of the desired location.

+ + diff --git a/source/docs/transportation/alt-fuel-stations-v1/request_params/_nearest_limit.html.md.erb b/source/docs/transportation/alt-fuel-stations-v1/request_params/_nearest_limit.html.md.erb new file mode 100644 index 00000000..cfa30243 --- /dev/null +++ b/source/docs/transportation/alt-fuel-stations-v1/request_params/_nearest_limit.html.md.erb @@ -0,0 +1 @@ +<%= partial("docs/transportation/alt-fuel-stations-v1/request_params/limit", locals: {default: "20", bonus_description: " except when the radius is infinite"}) %> diff --git a/source/docs/transportation/alt-fuel-stations-v1/request_params/_offset.html.md.erb b/source/docs/transportation/alt-fuel-stations-v1/request_params/_offset.html.md.erb new file mode 100644 index 00000000..f46f10f1 --- /dev/null +++ b/source/docs/transportation/alt-fuel-stations-v1/request_params/_offset.html.md.erb @@ -0,0 +1,16 @@ + + offset + No + +
+ Type: integer +
+
+ Default: 0 +
+
+ Minimum: 0 +
+ + Offset the results found (can be used with the limit parameter to paginate the results). + diff --git a/source/docs/transportation/alt-fuel-stations-v1/request_params/_radius.html.md.erb b/source/docs/transportation/alt-fuel-stations-v1/request_params/_radius.html.md.erb new file mode 100644 index 00000000..39112c45 --- /dev/null +++ b/source/docs/transportation/alt-fuel-stations-v1/request_params/_radius.html.md.erb @@ -0,0 +1,20 @@ + + radius + No + +
+ Type: decimal or string +
+
+ Default: 5.0 +
+
+ Range: 0.0 to 500.0, or infinite +
+ + +

The radius (in miles) around the search location to search for stations within.

+

An explicit radius of up to 500.0 miles may be passed in, or the special infinite string may be passed in to find the nearest stations regardless of distance.

+ + +