FastOpenData Client
The Python client for FastOpenData.
To use this client to retrieve data, you must have an API key. You can use the client itself to get a free API key that's suitable for evaluation purposes:
>>> from fastopendata_client import FastOpenData
>>> api_key = FastOpenData.get_api_key('YOUR_EMAIL_ADDRESS')
Save your API key somewhere; you will use it each time you invoke the FastOpenData client. If you lose your key, you can call this method again with the same email address.
The free API key is rate limited and not suitable for production purposes. To subscribe to the FastOpenData service and receive a key that will provide unlimited access, please visit https://fastopendata.com. If you have questions about the service or your particular use-case, email zac@fastopendata.com.
The main class for this client is FastOpenData which is invoked like so:
>>> from fastopendata_client import FastOpenData
>>> session = FastOpenData(api_key="<YOUR_API_KEY>")
>>> data = session.request(free_form_query="123 Main Street, Tallahassee, FL, 12345")
data now contains a dictionary with all the data from the FastOpenData server.
If you have a Pandas dataframe, you can append new columns containing data from
FastOpenData by calling FastOpenData.append_to_dataframe and specifying which
columns contain address information. For example, if COLUMN_NAME contains
unstructured address strings, you can do this:
>>> import pandas as pd
>>> from fastopendata_client import FastOpenData
>>> session = FastOpenData(api_key="<YOUR_API_KEY>")
>>> df = pd.DataFrame(...)
>>> session.append_to_dataframe(df, free_form_query=COLUMN_NAME)
Now df contains many new columns containing data from the FastOpenData server.
If your dataframe has columns containing structured address information, you can do:
>>> session.append_to_dataframe(
df,
address1=ADDRESS1_COLUMN,
address2=ADDRESS2_COLUMN,
city=CITY_COLUMN,
state=STATE_COLUMN,
zip_code=ZIP_CODE_COLUMN
)
Note that you have the option of specifying either free_form_query or the column names for structured address data, but not both. Doing so will raise an exception.
1 maintainer
Metadata
1 maintainer
Release files for fastopendata_client 0.0.33
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| fastopendata_client-0.0.33.tar.gz | 11.2 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fastopendata_client-0.0.33-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 22.7 kB
Release files / fastopendata_client-0.0.33.tar.gz
| Download URL | fastopendata_client-0.0.33.tar.gz |
|---|---|
| Size | 11.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bd19a3b5387784fda6d76a79562ebb7757363cea0fb9cbf98cdfba9eebff48c6
|
|
BLAKE2b-256 checksum How to use checksums |
f27b58fb880c1a475f3478c8072b3b1c267544490bd26f591deb134ff82a34cd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.24.1
|
Release files / fastopendata_client-0.0.33-py3-none-any.whl
| Download URL | fastopendata_client-0.0.33-py3-none-any.whl |
|---|---|
| Size | 11.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f7ec61b0e562e32ee8b9d25472919581f76cf39ddd528892365b8eb6132f5cb9
|
|
BLAKE2b-256 checksum How to use checksums |
7ab57db12a5089771261f585d77311ba0b262305ccbedff4e4e6122389d7a5cd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.24.1
|
Security for fastopendata_client 0.0.33
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
