Skip to main content

Unofficial Python bindings for the WalkScore API

Project description

(Unofficial) Python Bindings for the WalkScore API

Branch Unit Tests
latest Build Status (Travis CI) Code Coverage Status (Codecov) Documentation Status (ReadTheDocs)
v.1.0 Build Status (Travis CI) Code Coverage Status (Codecov) Documentation Status (ReadTheDocs)
develop Build Status (Travis CI) Code Coverage Status (Codecov) Documentation Status (ReadTheDocs)

The WalkScore Library is a Python library that provides Python bindings for the WalkScore API. It enables you to retrieve WalkScores, TransitScores, and BikeScores from the API within your Python code in Python versions 3.6 and higher.


The WalkScore Library is completely unaffiliated with WalkScore. It is entirely unofficial and was developed based on publicly available documentation of the WalkScore APIs published to the WalkScore website. Use of WalkScore is subject to WalkScore’s licenses and terms of service, and this library is not endorsed by WalkScore or any affiliates thereof.



To install the WalkScore Library, just execute:

$ pip install walkscore-api


Python 3.x

Key WalkScore Features

  • Python representation of WalkScores, TransitScores, and BikeScores.
  • Easy serialization and deserialization of API responses to Python objects, dict objects or JSON
  • Built-in back-off/retry logic if the WalkScore API is unstable at any mometn in time
  • Robust error handling to surface meaningful information to help you debug your code.

Hello, World and Basic Usage

1. Import the WalkScore API

from walkscore import WalkScoreAPI

2. Initialize the API

You can either use a single object to communicate with all of the available WalkScore APIs, or initialize a single object for each API:


walkscore_api = WalkScoreAPI(api_key = api_key)

3. Retrieve a Score

address = '123 Anyplace St Anywhere, AK 12345'

result = walkscore_api.get_score(latitude = 123.45, longitude = 54.321, address = address)

# the WalkScore for the location

# the TransitScore for the location

# the BikeScore for the location

Questions and Issues

You can ask questions and report issues on the project’s Github Issues Page


We welcome contributions and pull requests! For more information, please see the Contributor Guide.


We use TravisCI for our build automation and ReadTheDocs for our documentation.

Detailed information about our test suite and how to run tests locally can be found in our Testing Reference.


WalkScore is made available under an MIT License.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Built Distribution

walkscore_api-1.0.1-py2.py3-none-any.whl (20.5 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page