Walk Score API
The API returns the Walk Score for any latitude and longitude in the U.S.
Use the API to:
- Add Walk Score to your real estate listings
- Let your customers search by Walk Score
- Create a new urban planning app or walkability study
Note: The Walk Score API requires knowledge of AJAX and RESTful APIs. If that sounds like Greek to you, try using the Walk Score Tile.
Getting Started
To start using the API, request an API key.
API requests are limited to 5K per day. If you'd like more, fill out this form.
Sample API Call
http://api.walkscore.com/score?format=xml&lat=21.39151432&lon=-157.73852137&wsapikey=<YOUR-WSAPIKEY>
Sample API Response
<result>
<status>1</status>
<walkscore>91</walkscore>
<description>Walkers' Paradise</description>
<updated>2008-11-13 23:00:44.407138</updated>
<logo_url>http://www.walkscore.com/images/api-logo.gif</logo_url>
<more_info_icon>http://www.walkscore.com/images/api-more-info.gif</more_info_icon>
<ws_link>
http://walkscore.com/get-score.php?lat=21.39151432&lng=-157.73852137&utm_source=myrealtysite.com&utm_medium=ws_api&utm_campaign=ws_api
</ws_link>
<snapped_lat>21.3915</snapped_lat>
<snapped_lon>-157.7385</snapped_lon>
</result>
Sample Code
View live sample code for adding the Walk Score API to your website.
API Parameters
| Parameter | Description | Required |
|---|---|---|
| lat | The latitude of the requested location. | Yes |
| lon | The longitude of the requested location. | Yes |
| wsapikey | Your Walk Score API Key. Contact us to get one. | Yes |
| format | Return results in XML or JSON (defaults to XML). | No |
API Results
| Result | Description |
|---|---|
| status | Status code of the result (see information below). |
| walkscore | The Walk Score of the location. |
| description | An English description of the Walk Score. E.G. Somewhat Walkable. |
| updated | When the Walk Score was calculated. |
| logo_url | Link to the Walk Score logo. |
| more_info_icon | A question mark icon to display near the score (see branding requirements below). |
| ws_link | A link to the walkscore.com score and map for the point. |
| snapped_lat | All points are "snapped" to a grid (roughly 500 feet wide per grid cell). This value is the snapped latitude for the point. |
| snapped_lon | The snapped longitude for the point. |
Branding Requirements
Walk Scores returned from the API must be displayed in one of the following two ways.
Option 1: Logo + Score
Use the Walk Score logo (logo_url) next to the score. Either the logo or score must link to the property on Walk Score (ws_link).
Option 2: Text + Score
Link the text "Walk Score" to the property on Walk Score (ws_link).
Show a Description Pop-Up
Use the text provided here to show a description of Walk Score in a pop-up window when users click on the question mark icon (try clicking in the examples above to see it in action). The popup can be styled to match an existing site's look and feel.
Walk Score measures how walkable an address is based on the distance to nearby amenities. Learn more.
Handling Unavailable Scores
If a Walk Score is unavailable via the Walk Score API, show the text "Get Score" with a link to the property on Walk Score (ws_link).
Walk Score™: Get Score
If the request to the API fails entirely (network timeout, error response, etc.), this option can be used with a link to the Walk Score homepage instead (www.walkscore.com).
All of these requirements are implemented in our sample code.
Status and Error Codes
Successful API requests return an HTTP 200 response with the following status codes:
| HTTP Response | Status Code | Description |
|---|---|---|
| 200 | 1 | Walk Score successfully returned. |
| 200 | 2 | Score is being calculated and is not currently available. |
| 404 | 30 | Invalid latitude/longitude. |
| 500 series | 31 | Walk Score API internal error. |
| 200 | 40 | Your WSAPIKEY is invalid. |
| 200 | 41 | Your daily API quota has been exceeded. |
| 403 | 42 | Your IP address has been blocked. |
Contact us for tech support.
