Skip to content

Add documentation for ev-charging-units/nearest endpoint #436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
littleforest wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Add documentation for ev-charging-units/nearest endpoint #436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b003eff
Add docs for new ev-charging-units/nearest endpoint
littleforest Dec 19, 2025
af0d707
Add offset to 'all' and ev-charging-units endpoints;
littleforest Dec 19, 2025
80c4f87
Describe new Snapshot Date CSV column for ev-charging-units endpoints
littleforest Dec 19, 2025
8c72906
Display nearest limit rules for ev-charging-units/nearest endpoint
littleforest Dec 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions ...e/docs/transportation/alt-fuel-stations-v1/_ev_charging_units_response_common.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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).

<table border="0" cellpadding="0" cellspacing="0" class="doc-parameters">
<thead>
<tr>
<th scope="col">Field</th>
<th scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>EV Level1 EVSE Num</th>
<td>Total number of Level 1 charging ports at station location</td>
</tr>
<tr>
<th>EV Level2 EVSE Num</th>
<td>Total number of Level 2 charging ports at station location</td>
</tr>
<tr>
<th>EV DC Fast Count</th>
<td>Total number of DC Fast charging ports at station location</td>
</tr>
<tr>
<th>EV J1772 Connector Count</th>
<td>Total number of J1772 connectors at station location</td>
</tr>
<tr>
<th>EV J1772 Power Output (kW)</th>
<td>Power output in kilowatts of J1772 ports</td>
</tr>
<tr>
<th>EV CCS Connector Count</th>
<td>Total number of CCS/J1772 Combo connectors at station location</td>
</tr>
<tr>
<th>EV CCS Power Output (kW)</th>
<td>Power output in kilowatts of CCS/J1772 Combo ports</td>
</tr>
<tr>
<th>EV CHAdeMO Connector Count</th>
<td>Total number of CHAdeMO connectors at station location</td>
</tr>
<tr>
<th>EV CHAdeMO Power Output (kW)</th>
<td>Power output in kilowatts of CHAdeMO ports</td>
</tr>
<tr>
<th>EV J3400 Connector Count</th>
<td>Total number of NACS/J3400 connectors at station location</td>
</tr>
<tr>
<th>EV J3400 Power Output (kW)</th>
<td>Power output in kilowatts of NACS/J3400 ports</td>
</tr>
<tr>
<th>EV J3271 Connector Count</th>
<td>Total number of MCS/J3271 connectors at station location</td>
</tr>
<tr>
<th>EV J3271 Power Output (kW)</th>
<td>Power output in kilowatts of MCS/J3271 ports</td>
</tr>
<tr>
<th>Snapshot Date</th>
<td>Date that the data was requested</td>
</tr>
</tbody>
</table>

1 change: 1 addition & 0 deletions source/docs/transportation/alt-fuel-stations-v1/all.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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") %>
</tbody>
</table>

Expand Down
80 changes: 80 additions & 0 deletions source/docs/transportation/alt-fuel-stations-v1/ev-charging-units-nearest.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <a href="/docs/transportation/alt-fuel-stations-v1/nearest/">Nearest Stations</a> API.
url: GET /api/alt-fuel-stations/v1/ev-charging-units/nearest
sort_value: "65"
---

# <%= current_page.data.title %> <span class="url">(<%= current_page.data.url %>)</span>
<%= current_page.data.summary %>

{:toc}

<%= partial "layouts/toc" %>

## Request URL

<pre>GET /api/alt-fuel-stations/v1/ev-charging-units/nearest.csv?parameters</pre>

## Request Parameters

The following query parameters may be passed in the request to control the output:

<table border="0" cellpadding="0" cellspacing="0" class="doc-parameters">
<thead>
<tr>
<th class="doc-parameters-name" scope="col">Parameter</th>
<th class="doc-parameters-required" scope="col">Required</th>
<th class="doc-parameters-value" scope="col">Value</th>
<th class="doc-parameters-description" scope="col">Description</th>
</tr>
</thead>
<tbody>
<%= 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") %>
</tbody>
</table>

## 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:

<table border="0" cellpadding="0" cellspacing="0" class="doc-parameters">
<thead>
<tr>
<th class="doc-parameters-name" scope="col">HTTP Status Code</th>
<th class="doc-parameters-required" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr>
<th class="doc-parameter-name" scope="row">422</th>
<td class="doc-parameter-description">Unprocessable Entity - An invalid value was given for a query parameter. The response body will describe the specific error.</td>
</tr>
</tbody>
</table>
69 changes: 2 additions & 67 deletions source/docs/transportation/alt-fuel-stations-v1/ev-charging-units.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,80 +43,15 @@ 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") %>
</tbody>
</table>

## 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).

<table border="0" cellpadding="0" cellspacing="0" class="doc-parameters">
<thead>
<tr>
<th scope="col">Field</th>
<th scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>EV Level1 EVSE Num</th>
<td>Total number of Level 1 charging ports at station location</td>
</tr>
<tr>
<th>EV Level2 EVSE Num</th>
<td>Total number of Level 2 charging ports at station location</td>
</tr>
<tr>
<th>EV DC Fast Count</th>
<td>Total number of DC Fast charging ports at station location</td>
</tr>
<tr>
<th>EV J1772 Connector Count</th>
<td>Total number of J1772 connectors at station location</td>
</tr>
<tr>
<th>EV J1772 Power Output (kW)</th>
<td>Power output in kilowatts of J1772 ports</td>
</tr>
<tr>
<th>EV CCS Connector Count</th>
<td>Total number of CCS/J1772 Combo connectors at station location</td>
</tr>
<tr>
<th>EV CCS Power Output (kW)</th>
<td>Power output in kilowatts of CCS/J1772 Combo ports</td>
</tr>
<tr>
<th>EV CHAdeMO Connector Count</th>
<td>Total number of CHAdeMO connectors at station location</td>
</tr>
<tr>
<th>EV CHAdeMO Power Output (kW)</th>
<td>Power output in kilowatts of CHAdeMO ports</td>
</tr>
<tr>
<th>EV J3400 Connector Count</th>
<td>Total number of NACS/J3400 connectors at station location</td>
</tr>
<tr>
<th>EV J3400 Power Output (kW)</th>
<td>Power output in kilowatts of NACS/J3400 ports</td>
</tr>
<tr>
<th>EV J3271 Connector Count</th>
<td>Total number of MCS/J3271 connectors at station location</td>
</tr>
<tr>
<th>EV J3271 Power Output (kW)</th>
<td>Power output in kilowatts of MCS/J3271 ports</td>
</tr>
</tbody>
</table>
<%= partial("docs/transportation/alt-fuel-stations-v1/ev_charging_units_response_common") %>

## Rate Limits

Expand Down
34 changes: 2 additions & 32 deletions source/docs/transportation/alt-fuel-stations-v1/nearby-route.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,38 +106,8 @@ LINESTRING(-74.0 40.7, -87.63 41.87, -104.98 39.76)
</td>
</tr>
<%= partial("docs/transportation/alt-fuel-stations-v1/request_params_common2") %>
<tr>
<th class="doc-parameter-name" scope="row">limit</th>
<td class="doc-parameter-required">No</td>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> integer or string
</div>
<div class="doc-parameter-value-field">
<strong>Default:</strong> all
</div>
<div class="doc-parameter-value-field">
<strong>Range:</strong> <em>0</em> to <em>200</em>, or <em>all</em>
</div>
</td>
<td class="doc-parameter-description">The maximum number of results to return. An explicit limit of up to 200 may be passed in, or the special <code>all</code> string may be passed in to return all results.</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">offset</th>
<td class="doc-parameter-required">No</td>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> integer
</div>
<div class="doc-parameter-value-field">
<strong>Default:</strong> 0
</div>
<div class="doc-parameter-value-field">
<strong>Minimum:</strong> <i>0</i>
</div>
</td>
<td class="doc-parameter-description">Offset the results found (can be used with the <em>limit</em> parameter to paginate the results).</td>
</tr>
<%= partial("docs/transportation/alt-fuel-stations-v1/request_params/limit") %>
<%= partial("docs/transportation/alt-fuel-stations-v1/request_params/offset") %>
</tbody>
</table>

Expand Down
71 changes: 5 additions & 66 deletions source/docs/transportation/alt-fuel-stations-v1/nearest.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,73 +31,12 @@ The following query parameters may be passed in the request to control the outpu
<tbody>
<%= partial("docs/transportation/alt-fuel-stations-v1/request_params_common1") %>
<%= partial("docs/transportation/alt-fuel-stations-v1/request_params/response_format") %>
<tr>
<th class="doc-parameter-name" scope="row">latitude</th>
<td class="doc-parameter-required">Yes</td>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> decimal
</div>
<div class="doc-parameter-value-field">
<strong>Range:</strong> <em>-90</em> to <em>90</em>
</div>
</td>
<td class="doc-parameter-description">
<p>The latitude of the desired location.</p>
</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">longitude</th>
<td class="doc-parameter-required">Yes</td>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> decimal
</div>
<div class="doc-parameter-value-field">
<strong>Range:</strong> <em>-180</em> to <em>180</em>
</div>
</td>
<td class="doc-parameter-description">
<p>The longitude of the desired location.</p>
</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">radius</th>
<td class="doc-parameter-required">No</td>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> decimal or string
</div>
<div class="doc-parameter-value-field">
<strong>Default:</strong> <i>5.0</i>
</div>
<div class="doc-parameter-value-field">
<strong>Range:</strong> <em>0.0</em> to <em>500.0</em>, or <em>infinite</em>
</div>
</td>
<td class="doc-parameter-description">
<p>The radius (in miles) around the search location to search for stations within.</p>
<p>An explicit radius of up to 500.0 miles may be passed in, or the special <code>infinite</code> string may be passed in to find the nearest stations regardless of distance.</p>
</td>
</tr>
<%= 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 <code>infinite</code>"}) %>
<tr>
<th class="doc-parameter-name" scope="row">offset</th>
<td class="doc-parameter-required">No</td>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> integer
</div>
<div class="doc-parameter-value-field">
<strong>Default:</strong> 0
</div>
<div class="doc-parameter-value-field">
<strong>Minimum:</strong> <i>0</i>
</div>
</td>
<td class="doc-parameter-description">Offset the results found (can be used with the <em>limit</em> parameter to paginate the results).</td>
</tr>
<%= partial("docs/transportation/alt-fuel-stations-v1/request_params/nearest_limit") %>
<%= partial("docs/transportation/alt-fuel-stations-v1/request_params/offset") %>
</tbody>
</table>

Expand Down
15 changes: 15 additions & 0 deletions source/docs/transportation/alt-fuel-stations-v1/request_params/_latitude.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<tr>
<th class="doc-parameter-name" scope="row">latitude</th>
<td class="doc-parameter-required">Yes</td>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> decimal
</div>
<div class="doc-parameter-value-field">
<strong>Range:</strong> <em>-90</em> to <em>90</em>
</div>
</td>
<td class="doc-parameter-description">
<p>The latitude of the desired location.</p>
</td>
</tr>
15 changes: 15 additions & 0 deletions source/docs/transportation/alt-fuel-stations-v1/request_params/_longitude.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<tr>
<th class="doc-parameter-name" scope="row">longitude</th>
<td class="doc-parameter-required">Yes</td>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> decimal
</div>
<div class="doc-parameter-value-field">
<strong>Range:</strong> <em>-180</em> to <em>180</em>
</div>
</td>
<td class="doc-parameter-description">
<p>The longitude of the desired location.</p>
</td>
</tr>
1 change: 1 addition & 0 deletions source/docs/transportation/alt-fuel-stations-v1/request_params/_nearest_limit.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<%= partial("docs/transportation/alt-fuel-stations-v1/request_params/limit", locals: {default: "20", bonus_description: " except when the radius is <code>infinite</code>"}) %>
Loading
Loading