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

Using pip:

pip install apiverve-streetaddressparser

Using pip3:

pip3 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


Quick Start

Here's a simple example to get you started quickly:

from apiverve_streetaddressparser.apiClient import StreetaddressparserAPIClient

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

query = { "address": "1600 Amphitheatre Parkway, Mountain View, CA 90210" }

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The Street Address Parser API documentation is found here: https://docs.apiverve.com/ref/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 90210" }
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 90210",
    "parsed": {
      "streetNumber": "1600",
      "streetType": "Pkwy",
      "streetAddress": "Amphitheatre",
      "cityName": "Mountain View",
      "stateName": "CA",
      "zipCode": "90210"
    }
  }
}

Error Handling

The API client provides comprehensive error handling through the StreetaddressparserAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_streetaddressparser.apiClient import StreetaddressparserAPIClient, StreetaddressparserAPIClientError

api = StreetaddressparserAPIClient("[YOUR_API_KEY]")

query = { "address": "1600 Amphitheatre Parkway, Mountain View, CA 90210" }

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except StreetaddressparserAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_streetaddressparser.apiClient import StreetaddressparserAPIClient, StreetaddressparserAPIClientError

api = StreetaddressparserAPIClient("[YOUR_API_KEY]")

query = { "address": "1600 Amphitheatre Parkway, Mountain View, CA 90210" }

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except StreetaddressparserAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_streetaddressparser.apiClient import StreetaddressparserAPIClient, StreetaddressparserAPIClientError

query = { "address": "1600 Amphitheatre Parkway, Mountain View, CA 90210" }

# Using context manager ensures proper cleanup
with StreetaddressparserAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except StreetaddressparserAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_streetaddressparser.apiClient import StreetaddressparserAPIClient

# Enable debug mode
api = StreetaddressparserAPIClient("[YOUR_API_KEY]", debug=True)

query = { "address": "1600 Amphitheatre Parkway, Mountain View, CA 90210" }

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_streetaddressparser.apiClient import StreetaddressparserAPIClient

api = StreetaddressparserAPIClient("[YOUR_API_KEY]")

query = { "address": "1600 Amphitheatre Parkway, Mountain View, CA 90210" }

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

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 (©) 2026 APIVerve, and EvlarSoft 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 Distribution

apiverve_streetaddressparser-1.1.14.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_streetaddressparser-1.1.14-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_streetaddressparser-1.1.14.tar.gz.

File metadata

File hashes

Hashes for apiverve_streetaddressparser-1.1.14.tar.gz
Algorithm Hash digest
SHA256 35f110385742ed1aa2a2ad69e9f69705ba4783992adef8a207f11438773f217f
MD5 cf3dde7d9824f8492b7014a279ace098
BLAKE2b-256 5ff508ee3e21e69ee67efa80f3152aedcce7702276004f2585a8c686fdecbd39

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apiverve_streetaddressparser-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 e7bd33cafcc23a0271a829f1d646d47c804a3189ec6a664c3aa006846dddd864
MD5 84cd5ded641a62e4cdcb63ac561b01a8
BLAKE2b-256 6d8dbd5cafb62f8c41628949cef1b8b087cec17c8d3f2472a2fa0f4213ce2765

See more details on using hashes here.

Supported by

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