Note: We’re in closed alpha testing, so our servers are not working for requesting API keys yet!

Follow these steps to install the FastOpenData client, get a free API key, and make your first request.

Step 1: Install the client

Use pip to install the FastOpenData client. We recommend using a Python virtual environment and making sure that you’re using the most recent version of pip. The client is supported for Python 3.6 and newer.

pip install fastopendata-client

After installation is complete, you can test your client by asking for help:

fastopendata --help

You should see a brief help message.

Step 2: Get a free API key

In order to use the FastOpenData service, you’ll need an API key to include with each request. Use the client to get one:

fastopendata get-api-key

You will be prompted to enter your email address. As soon as you’ve done so, the client will print your new API key to the terminal. Copy it somewhere; you’ll need it for the next step.

Step 3: Make a request

You can use the client to request data about a specific request like so. Note: be sure to include the double-quotes surrounding your API key and the address.

fastopendata get --api-key="<YOUR_API_KEY_HERE>" --free-form-query="1984 Lower Hawthorne Trail"

If all goes as expected, you’ll see a JSON blob containing data about the address.