Skip to main content

Street Address Parser is a simple tool for parsing a US street addresses. It returns the parsed components of the street address provided.

Project description

Street Address Parser API

Street Address Parser is a simple tool for parsing a US street addresses. It returns the parsed components of the street address provided.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Street Address Parser API


Installation

pip install apiverve-streetaddressparser

Configuration

Before using the streetaddressparser API client, you have to setup your account and obtain your API Key.
You can get it by signing up at https://apiverve.com


Usage

The Street Address Parser API documentation is found here: https://docs.apiverve.com/api/streetaddressparser.
You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_streetaddressparser.apiClient import StreetaddressparserAPIClient

# Initialize the client with your APIVerve API key
api = StreetaddressparserAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = { "address": "1600 Amphitheatre Parkway, Mountain View, CA" }
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "address": "1600 Amphitheatre Parkway, Mountain View, CA",
    "parsed": {
      "streetNumber": "1600",
      "streetType": "Pkwy",
      "streetAddress": "Amphitheatre",
      "cityName": "Mountain View",
      "stateName": "CA"
    }
  }
}

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2024 APIVerve, and Evlar LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

File details

Details for the file apiverve_streetaddressparser-1.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_streetaddressparser-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0f346c9015e113aa972f97088d6d37ad04261701514e78845801c73f58802f6f
MD5 0a6e47182f13b4dfa3f29cf448181928
BLAKE2b-256 b4ea094bd1d4f6eadb79ac1fec475874998a7cee0b130a96ab937cd4b8584e56

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page