County Data Lookup API
============
County Data is a simple tool for getting data about US counties. It returns information such as average income, area, and more based on the county name provided.
![Build Status](https://img.shields.io/badge/build-passing-green)
![Code Climate](https://img.shields.io/badge/maintainability-B-purple)
![Prod Ready](https://img.shields.io/badge/production-ready-blue)
This is a Python API Wrapper for the [County Data Lookup API](https://apiverve.com/marketplace/api/countydata)
---
## Installation
pip install apiverve-countydatalookup
---
## Configuration
Before using the countydata 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 County Data Lookup API documentation is found here: [https://docs.apiverve.com/api/countydata](https://docs.apiverve.com/api/countydata).
You can find parameters, example responses, and status codes documented here.
### Setup
```
# Import the client module
from apiverve_countydatalookup.apiClient import CountydataAPIClient
# Initialize the client with your APIVerve API key
api = CountydataAPIClient("[YOUR_API_KEY]")
```
---
### Perform Request
Using the API client, you can perform requests to the API.
###### Define Query
```
query = { "state": "MO", "county": "Jackson" }
```
###### Simple Request
```
# Make a request to the API
result = api.execute(query)
# Print the result
print(result)
```
###### Example Response
```
{
"status": "ok",
"error": null,
"data": {
"name": "jackson county",
"state": "MO",
"age": {
"0-4": 0.0644100874666257,
"5-9": 0.06532756955438819,
"10-14": 0.065950603902357144,
"15-19": 0.05967616438434107,
"20-24": 0.059725950234064615,
"25-29": 0.081924749399369279,
"30-34": 0.075233531196524664,
"35-39": 0.06868029092005673,
"40-44": 0.058310609649066661,
"45-49": 0.058805623240603636,
"50-54": 0.05858087569042305,
"55-59": 0.0674783182624454,
"60-64": 0.062084377058111463,
"65-69": 0.05099777955110233,
"70-74": 0.038915465049622268,
"75-79": 0.026437708656052324,
"80-84": 0.017489057781457189,
"85+": 0.019971238003388282
},
"male": 339932,
"female": 363079,
"deaths": {
"suicides": 106.71428571428571,
"homicides": 115.42857142857143,
"vehicle": 93,
"firearmsuicides": 55.095238095238095
},
"health": {
"poorhealth": 20.588989742,
"physicallyunhealthydays": 4.247736361,
"mentallyunhealthydays": 4.8111015035,
"lowbirthweightpercent": 9.1518749808,
"smokerspercent": 20.957241772,
"obesitypercent": 31.5,
"foodenvindex": 7.5,
"physicallyinactivepercent": 23.2,
"excessivedrinkingpercent": 18.940103365,
"alcoholimpaireddrivingdeaths": 152,
"teenbirthrate": 31.109351559,
"uninsured": 12.486314662,
"withannualmammogram": 45,
"vaccinated": 51,
"childreninpoverty": 19.6,
"80thpercentileincome": 108296,
"20thpercentileincome": 23275,
"childreninsingleparenthouseholds": 33.224850811,
"violentcrimerate": 941.43198334,
"averagedailypm25": 9.1,
"severehousingproblems": 15.347550638,
"drivealonetowork": 83.470246386,
"longcommutedrivesalone": 33.7
},
"longitude": -94.347496655033936,
"latitude": 39.016701918102484,
"education": {
"lessthanhighschool": 9.4,
"highschool": 28.3,
"somecollege": 30.7,
"bachelors": 31.6
},
"zipcodes": [
"64137",
"64111",
"64053",
"64055",
"64064",
"64029",
"64106",
"64108",
"64034",
"64118",
"64136",
"64139",
"64125",
"64030",
"64014",
"64066",
"64080",
"64123",
"64131",
"64145",
"64128",
"64121",
"64170",
"64050",
"64057",
"64133",
"64109",
"64130",
"64134",
"64129",
"64158",
"64163",
"64070",
"64102",
"64105",
"64086",
"64101",
"64124",
"64157",
"64088",
"64061",
"64051",
"64002",
"64081",
"64013",
"64016",
"64112",
"64114",
"64110",
"64152",
"64127",
"64147",
"64120",
"64146",
"64199",
"64058",
"64054",
"64074",
"64119",
"64138",
"64149",
"64156",
"64132",
"64171",
"64148",
"64141",
"64999",
"64052",
"64015",
"64063",
"64075",
"64056",
"64082",
"64113",
"64155",
"64126",
"64197",
"64065",
"64198"
],
"lifeexpectancy": 77.19,
"avgincome": 47054,
"povertyrate": 13.7,
"costofliving": {
"livingwage": 14.55,
"foodcosts": 3246,
"medicalcosts": 2681,
"housingcosts": 8136,
"taxcosts": 6263
},
"landareakm2": 1565.601892,
"areakm2": 1596.319707
},
"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-countydatalookup",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "county data, county data api, county data tool, county data software, county data service",
"author": null,
"author_email": "APIVerve <hello@apiverve.com>",
"download_url": "https://files.pythonhosted.org/packages/93/64/e950466d3bf4df04c6e47156d6a6f1150bc13677eda12ced9b0e6207361f/apiverve_countydatalookup-1.1.5.tar.gz",
"platform": null,
"description": "County Data Lookup API\r\n============\r\n\r\nCounty Data is a simple tool for getting data about US counties. It returns information such as average income, area, and more based on the county name provided.\r\n\r\n![Build Status](https://img.shields.io/badge/build-passing-green)\r\n![Code Climate](https://img.shields.io/badge/maintainability-B-purple)\r\n![Prod Ready](https://img.shields.io/badge/production-ready-blue)\r\n\r\nThis is a Python API Wrapper for the [County Data Lookup API](https://apiverve.com/marketplace/api/countydata)\r\n\r\n---\r\n\r\n## Installation\r\n\tpip install apiverve-countydatalookup\r\n\r\n---\r\n\r\n## Configuration\r\n\r\nBefore using the countydata 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 County Data Lookup API documentation is found here: [https://docs.apiverve.com/api/countydata](https://docs.apiverve.com/api/countydata). \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_countydatalookup.apiClient import CountydataAPIClient\r\n\r\n# Initialize the client with your APIVerve API key\r\napi = CountydataAPIClient(\"[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 = { \"state\": \"MO\", \"county\": \"Jackson\" }\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 \"name\": \"jackson county\",\r\n \"state\": \"MO\",\r\n \"age\": {\r\n \"0-4\": 0.0644100874666257,\r\n \"5-9\": 0.06532756955438819,\r\n \"10-14\": 0.065950603902357144,\r\n \"15-19\": 0.05967616438434107,\r\n \"20-24\": 0.059725950234064615,\r\n \"25-29\": 0.081924749399369279,\r\n \"30-34\": 0.075233531196524664,\r\n \"35-39\": 0.06868029092005673,\r\n \"40-44\": 0.058310609649066661,\r\n \"45-49\": 0.058805623240603636,\r\n \"50-54\": 0.05858087569042305,\r\n \"55-59\": 0.0674783182624454,\r\n \"60-64\": 0.062084377058111463,\r\n \"65-69\": 0.05099777955110233,\r\n \"70-74\": 0.038915465049622268,\r\n \"75-79\": 0.026437708656052324,\r\n \"80-84\": 0.017489057781457189,\r\n \"85+\": 0.019971238003388282\r\n },\r\n \"male\": 339932,\r\n \"female\": 363079,\r\n \"deaths\": {\r\n \"suicides\": 106.71428571428571,\r\n \"homicides\": 115.42857142857143,\r\n \"vehicle\": 93,\r\n \"firearmsuicides\": 55.095238095238095\r\n },\r\n \"health\": {\r\n \"poorhealth\": 20.588989742,\r\n \"physicallyunhealthydays\": 4.247736361,\r\n \"mentallyunhealthydays\": 4.8111015035,\r\n \"lowbirthweightpercent\": 9.1518749808,\r\n \"smokerspercent\": 20.957241772,\r\n \"obesitypercent\": 31.5,\r\n \"foodenvindex\": 7.5,\r\n \"physicallyinactivepercent\": 23.2,\r\n \"excessivedrinkingpercent\": 18.940103365,\r\n \"alcoholimpaireddrivingdeaths\": 152,\r\n \"teenbirthrate\": 31.109351559,\r\n \"uninsured\": 12.486314662,\r\n \"withannualmammogram\": 45,\r\n \"vaccinated\": 51,\r\n \"childreninpoverty\": 19.6,\r\n \"80thpercentileincome\": 108296,\r\n \"20thpercentileincome\": 23275,\r\n \"childreninsingleparenthouseholds\": 33.224850811,\r\n \"violentcrimerate\": 941.43198334,\r\n \"averagedailypm25\": 9.1,\r\n \"severehousingproblems\": 15.347550638,\r\n \"drivealonetowork\": 83.470246386,\r\n \"longcommutedrivesalone\": 33.7\r\n },\r\n \"longitude\": -94.347496655033936,\r\n \"latitude\": 39.016701918102484,\r\n \"education\": {\r\n \"lessthanhighschool\": 9.4,\r\n \"highschool\": 28.3,\r\n \"somecollege\": 30.7,\r\n \"bachelors\": 31.6\r\n },\r\n \"zipcodes\": [\r\n \"64137\",\r\n \"64111\",\r\n \"64053\",\r\n \"64055\",\r\n \"64064\",\r\n \"64029\",\r\n \"64106\",\r\n \"64108\",\r\n \"64034\",\r\n \"64118\",\r\n \"64136\",\r\n \"64139\",\r\n \"64125\",\r\n \"64030\",\r\n \"64014\",\r\n \"64066\",\r\n \"64080\",\r\n \"64123\",\r\n \"64131\",\r\n \"64145\",\r\n \"64128\",\r\n \"64121\",\r\n \"64170\",\r\n \"64050\",\r\n \"64057\",\r\n \"64133\",\r\n \"64109\",\r\n \"64130\",\r\n \"64134\",\r\n \"64129\",\r\n \"64158\",\r\n \"64163\",\r\n \"64070\",\r\n \"64102\",\r\n \"64105\",\r\n \"64086\",\r\n \"64101\",\r\n \"64124\",\r\n \"64157\",\r\n \"64088\",\r\n \"64061\",\r\n \"64051\",\r\n \"64002\",\r\n \"64081\",\r\n \"64013\",\r\n \"64016\",\r\n \"64112\",\r\n \"64114\",\r\n \"64110\",\r\n \"64152\",\r\n \"64127\",\r\n \"64147\",\r\n \"64120\",\r\n \"64146\",\r\n \"64199\",\r\n \"64058\",\r\n \"64054\",\r\n \"64074\",\r\n \"64119\",\r\n \"64138\",\r\n \"64149\",\r\n \"64156\",\r\n \"64132\",\r\n \"64171\",\r\n \"64148\",\r\n \"64141\",\r\n \"64999\",\r\n \"64052\",\r\n \"64015\",\r\n \"64063\",\r\n \"64075\",\r\n \"64056\",\r\n \"64082\",\r\n \"64113\",\r\n \"64155\",\r\n \"64126\",\r\n \"64197\",\r\n \"64065\",\r\n \"64198\"\r\n ],\r\n \"lifeexpectancy\": 77.19,\r\n \"avgincome\": 47054,\r\n \"povertyrate\": 13.7,\r\n \"costofliving\": {\r\n \"livingwage\": 14.55,\r\n \"foodcosts\": 3246,\r\n \"medicalcosts\": 2681,\r\n \"housingcosts\": 8136,\r\n \"taxcosts\": 6263\r\n },\r\n \"landareakm2\": 1565.601892,\r\n \"areakm2\": 1596.319707\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": "County Data is a simple tool for getting data about US counties. It returns information such as average income, area, and more based on the county name provided.",
"version": "1.1.5",
"project_urls": {
"Documentation": "https://docs.apiverve.com/api/countydata?utm_source=pypi",
"Homepage": "https://apiverve.com?utm_source=pypi",
"Repository": "https://github.com/apiverve/countydata.Python-API",
"Twitter": "https://twitter.com/apivervehq"
},
"split_keywords": [
"county data",
" county data api",
" county data tool",
" county data software",
" county data service"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "87ce92d98c364f0c590afdac39daaee3c45691d0c04e331d624058359ffeb01f",
"md5": "c37d1edacba3f560dea2ee2fecdd6a7a",
"sha256": "69c5d33597ea0b26c9713be9c035672779231e458b277e56b313b24c79b576c3"
},
"downloads": -1,
"filename": "apiverve_countydatalookup-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c37d1edacba3f560dea2ee2fecdd6a7a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 8773,
"upload_time": "2024-09-21T06:40:27",
"upload_time_iso_8601": "2024-09-21T06:40:27.118531Z",
"url": "https://files.pythonhosted.org/packages/87/ce/92d98c364f0c590afdac39daaee3c45691d0c04e331d624058359ffeb01f/apiverve_countydatalookup-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9364e950466d3bf4df04c6e47156d6a6f1150bc13677eda12ced9b0e6207361f",
"md5": "ab97a01a5b82bb3991c43ddea7979910",
"sha256": "f4068e506ee37f7e76f5c7ab4459efd60ee1e30a3ce0d557818dbd19f7bdace8"
},
"downloads": -1,
"filename": "apiverve_countydatalookup-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "ab97a01a5b82bb3991c43ddea7979910",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 9616,
"upload_time": "2024-09-21T06:40:28",
"upload_time_iso_8601": "2024-09-21T06:40:28.231943Z",
"url": "https://files.pythonhosted.org/packages/93/64/e950466d3bf4df04c6e47156d6a6f1150bc13677eda12ced9b0e6207361f/apiverve_countydatalookup-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-21 06:40:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "apiverve",
"github_project": "countydata.Python-API",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "apiverve-countydatalookup"
}