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.
This is a Python API Wrapper for the [Reverse Geocode API](https://apiverve.com/marketplace/api/reversegeocode)
---
## Installation
pip 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](https://apiverve.com)
---
## Usage
The Reverse Geocode API documentation is found here: [https://docs.apiverve.com/api/reversegeocode](https://docs.apiverve.com/api/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.65017573007586638,
"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"
]
},
"code": 200
}
```
---
## Customer Support
Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).
---
## Updates
Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
---
## Legal
All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "apiverve-reversegeocode",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "reverse geocode, reverse geocode api, reverse geocode tool, reverse geocode software, reverse geocode service",
"author": null,
"author_email": "APIVerve <hello@apiverve.com>",
"download_url": "https://files.pythonhosted.org/packages/2b/55/d1216c4bb085e9a4d1d8b244cd3033f116a724e8e6a4a129ee2485eae189/apiverve_reversegeocode-1.1.5.tar.gz",
"platform": null,
"description": "Reverse Geocode API\r\n============\r\n\r\nReverse 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.\r\n\r\n\r\n\r\n\r\n\r\nThis is a Python API Wrapper for the [Reverse Geocode API](https://apiverve.com/marketplace/api/reversegeocode)\r\n\r\n---\r\n\r\n## Installation\r\n\tpip install apiverve-reversegeocode\r\n\r\n---\r\n\r\n## Configuration\r\n\r\nBefore using the reversegeocode API client, you have to setup your account and obtain your API Key. \r\nYou can get it by signing up at [https://apiverve.com](https://apiverve.com)\r\n\r\n---\r\n\r\n## Usage\r\n\r\nThe Reverse Geocode API documentation is found here: [https://docs.apiverve.com/api/reversegeocode](https://docs.apiverve.com/api/reversegeocode). \r\nYou can find parameters, example responses, and status codes documented here.\r\n\r\n### Setup\r\n\r\n```\r\n# Import the client module\r\nfrom apiverve_reversegeocode.apiClient import ReversegeocodeAPIClient\r\n\r\n# Initialize the client with your APIVerve API key\r\napi = ReversegeocodeAPIClient(\"[YOUR_API_KEY]\")\r\n```\r\n\r\n---\r\n\r\n\r\n### Perform Request\r\nUsing the API client, you can perform requests to the API.\r\n\r\n###### Define Query\r\n\r\n```\r\nquery = { \"lat\": 40.714224, \"lon\": -73.961452 }\r\n```\r\n\r\n###### Simple Request\r\n\r\n```\r\n# Make a request to the API\r\nresult = api.execute(query)\r\n\r\n# Print the result\r\nprint(result)\r\n```\r\n\r\n###### Example Response\r\n\r\n```\r\n{\r\n \"status\": \"ok\",\r\n \"error\": null,\r\n \"data\": {\r\n \"zipcode\": \"11211\",\r\n \"state_abbr\": \"NY\",\r\n \"city\": \"Brooklyn\",\r\n \"state\": \"New York\",\r\n \"distance\": 0.65017573007586638,\r\n \"latitudeClosest\": \"40.712090\",\r\n \"longitudeClosest\": \"-73.95427\",\r\n \"countryCode\": \"US\",\r\n \"latitudeClosestCity\": null,\r\n \"longitudeClosestCity\": null,\r\n \"latitude\": 40.714224,\r\n \"longitude\": -73.961452,\r\n \"estimatedCity\": true,\r\n \"nearestCities\": [\r\n \"Brooklyn\",\r\n \"Brooklyn Park\",\r\n \"East Brooklyn\",\r\n \"Brooklyn Center\",\r\n \"Brooklyn Heights\"\r\n ]\r\n },\r\n \"code\": 200\r\n}\r\n```\r\n\r\n---\r\n\r\n## Customer Support\r\n\r\nNeed any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).\r\n\r\n---\r\n\r\n## Updates\r\nStay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.\r\n\r\n---\r\n\r\n## Legal\r\n\r\nAll usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.\r\n\r\n---\r\n\r\n## License\r\nLicensed under the The MIT License (MIT)\r\n\r\nCopyright (©) 2024 APIVerve, and Evlar LLC\r\n\r\nPermission 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:\r\n\r\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\r\n\r\nTHE 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.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "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.",
"version": "1.1.5",
"project_urls": {
"Documentation": "https://docs.apiverve.com/api/reversegeocode?utm_source=pypi",
"Homepage": "https://apiverve.com?utm_source=pypi",
"Repository": "https://github.com/apiverve/reversegeocode.Python-API",
"Twitter": "https://twitter.com/apivervehq"
},
"split_keywords": [
"reverse geocode",
" reverse geocode api",
" reverse geocode tool",
" reverse geocode software",
" reverse geocode service"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27de03293db0d1d9f969748c5e193890549c9aa4d8826755a0489d65e1897306",
"md5": "9d5b6b46e9e80bb6e436ad6853a30e70",
"sha256": "fa11106184e6f15c13b98020068a3db4138b63e82b6cc463fd97dd92394159c2"
},
"downloads": -1,
"filename": "apiverve_reversegeocode-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9d5b6b46e9e80bb6e436ad6853a30e70",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 7563,
"upload_time": "2024-09-21T06:58:56",
"upload_time_iso_8601": "2024-09-21T06:58:56.651946Z",
"url": "https://files.pythonhosted.org/packages/27/de/03293db0d1d9f969748c5e193890549c9aa4d8826755a0489d65e1897306/apiverve_reversegeocode-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2b55d1216c4bb085e9a4d1d8b244cd3033f116a724e8e6a4a129ee2485eae189",
"md5": "a3770c8e799ae86279b64fe042adbfb8",
"sha256": "9ce60a0edda645bafbd468ddd122252fbc26e7c7c8d513a143622cc0d1a5de12"
},
"downloads": -1,
"filename": "apiverve_reversegeocode-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "a3770c8e799ae86279b64fe042adbfb8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 7271,
"upload_time": "2024-09-21T06:58:57",
"upload_time_iso_8601": "2024-09-21T06:58:57.511341Z",
"url": "https://files.pythonhosted.org/packages/2b/55/d1216c4bb085e9a4d1d8b244cd3033f116a724e8e6a4a129ee2485eae189/apiverve_reversegeocode-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-21 06:58:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "apiverve",
"github_project": "reversegeocode.Python-API",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "apiverve-reversegeocode"
}
JSON
