Skip to main content

Reverse Geocode is a simple tool for getting the location of a set of coordinates. Only supports USA and Canada Coordinates. It returns the city, state, and more.

Project description

Reverse Geocode API

Reverse Geocode is a simple tool for getting the location of a set of coordinates. Only supports USA and Canada Coordinates. It returns the city, state, and more.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Reverse Geocode API


Installation

Using pip:

pip install apiverve-reversegeocode

Using pip3:

pip3 install apiverve-reversegeocode

Configuration

Before using the reversegeocode 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_reversegeocode.apiClient import ReversegeocodeAPIClient

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

query = {
    "lat": 40.714224,
    "lon": -73.961452
}

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

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

Usage

The Reverse Geocode API documentation is found here: https://docs.apiverve.com/ref/reversegeocode. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_reversegeocode.apiClient import ReversegeocodeAPIClient

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

Perform Request

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

Define Query
query = {
    "lat": 40.714224,
    "lon": -73.961452
}
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "zipcode": "11211",
    "state_abbr": "NY",
    "city": "Brooklyn",
    "state": "New York",
    "distance": 0.6501757300758664,
    "latitudeClosest": "40.712090",
    "longitudeClosest": "-73.95427",
    "countryCode": "US",
    "latitudeClosestCity": null,
    "longitudeClosestCity": null,
    "latitude": 40.714224,
    "longitude": -73.961452,
    "estimatedCity": true,
    "nearestCities": [
      "Brooklyn",
      "Brooklyn Park",
      "East Brooklyn",
      "Brooklyn Center",
      "Brooklyn Heights"
    ]
  }
}

Error Handling

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

Basic Error Handling

from apiverve_reversegeocode.apiClient import ReversegeocodeAPIClient, ReversegeocodeAPIClientError

api = ReversegeocodeAPIClient("[YOUR_API_KEY]")

query = {
    "lat": 40.714224,
    "lon": -73.961452
}

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except ReversegeocodeAPIClientError 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_reversegeocode.apiClient import ReversegeocodeAPIClient, ReversegeocodeAPIClientError

api = ReversegeocodeAPIClient("[YOUR_API_KEY]")

query = {
    "lat": 40.714224,
    "lon": -73.961452
}

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 ReversegeocodeAPIClientError 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_reversegeocode.apiClient import ReversegeocodeAPIClient, ReversegeocodeAPIClientError

query = {
    "lat": 40.714224,
    "lon": -73.961452
}

# Using context manager ensures proper cleanup
with ReversegeocodeAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except ReversegeocodeAPIClientError 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_reversegeocode.apiClient import ReversegeocodeAPIClient

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

query = {
    "lat": 40.714224,
    "lon": -73.961452
}

# 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_reversegeocode.apiClient import ReversegeocodeAPIClient

api = ReversegeocodeAPIClient("[YOUR_API_KEY]")

query = {
    "lat": 40.714224,
    "lon": -73.961452
}

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_reversegeocode-1.1.14.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

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

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: apiverve_reversegeocode-1.1.14.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.10

File hashes

Hashes for apiverve_reversegeocode-1.1.14.tar.gz
Algorithm Hash digest
SHA256 e0c9b37ee82e3418c1477f7f76027370908d91de4e5fe954d0dc9343e70af86e
MD5 084ecd4b7bce1a05230212056b8a6fd0
BLAKE2b-256 7a9c3bf55b13630f82db9b7edd5df09448c566cd6d9334339cf575574147174a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apiverve_reversegeocode-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 f514560d30f2091335d610b0c92dc1f0c1e71991be6905dee26057f0a921ebb8
MD5 91c79aa60b9323e15e90d15dfe0b9dce
BLAKE2b-256 f46b712de827c04186adc642487eeb96c092b329125679c06a4a328eaf4fe542

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