BIN Lookup API
============
BIN Lookup is a simple tool for looking up BIN number information. It returns information such as the bank, card type, and more based on the BIN number 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 [BIN Lookup API](https://apiverve.com/marketplace/api/binlookup)
---
## Installation
pip install apiverve-binlookup
---
## Configuration
Before using the binlookup 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 BIN Lookup API documentation is found here: [https://docs.apiverve.com/api/binlookup](https://docs.apiverve.com/api/binlookup).
You can find parameters, example responses, and status codes documented here.
### Setup
```
# Import the client module
from apiverve_binlookup.apiClient import BinlookupAPIClient
# Initialize the client with your APIVerve API key
api = BinlookupAPIClient("[YOUR_API_KEY]")
```
---
### Perform Request
Using the API client, you can perform requests to the API.
###### Define Query
```
query = { "bin": "448590" }
```
###### Simple Request
```
# Make a request to the API
result = api.execute(query)
# Print the result
print(result)
```
###### Example Response
```
{
"status": "ok",
"error": null,
"data": {
"bin": "448590",
"brand": "VISA",
"type": "CREDIT",
"category": "PURCHASING",
"issuer": {
"name": "JPMORGAN CHASE BANK, N.A.",
"country": "United States",
"phone": "1-800-432-3117",
"website": "www.chase.com"
},
"location": {
"country": "United States",
"latitude": "37.0902",
"longitude": "-95.7129",
"alpha2": "US",
"alpha3": "USA"
}
},
"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-binlookup",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "bin lookup, bin lookup api, bin lookup tool, bin lookup software, bin lookup service",
"author": null,
"author_email": "APIVerve <hello@apiverve.com>",
"download_url": "https://files.pythonhosted.org/packages/04/af/7d39d9601269797cdf245c88605959df5ce55573b53c1a1c7d832ecf5e4e/apiverve_binlookup-1.1.5.tar.gz",
"platform": null,
"description": "BIN Lookup API\r\n============\r\n\r\nBIN Lookup is a simple tool for looking up BIN number information. It returns information such as the bank, card type, and more based on the BIN number 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 [BIN Lookup API](https://apiverve.com/marketplace/api/binlookup)\r\n\r\n---\r\n\r\n## Installation\r\n\tpip install apiverve-binlookup\r\n\r\n---\r\n\r\n## Configuration\r\n\r\nBefore using the binlookup 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 BIN Lookup API documentation is found here: [https://docs.apiverve.com/api/binlookup](https://docs.apiverve.com/api/binlookup). \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_binlookup.apiClient import BinlookupAPIClient\r\n\r\n# Initialize the client with your APIVerve API key\r\napi = BinlookupAPIClient(\"[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 = { \"bin\": \"448590\" }\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 \"bin\": \"448590\",\r\n \"brand\": \"VISA\",\r\n \"type\": \"CREDIT\",\r\n \"category\": \"PURCHASING\",\r\n \"issuer\": {\r\n \"name\": \"JPMORGAN CHASE BANK, N.A.\",\r\n \"country\": \"United States\",\r\n \"phone\": \"1-800-432-3117\",\r\n \"website\": \"www.chase.com\"\r\n },\r\n \"location\": {\r\n \"country\": \"United States\",\r\n \"latitude\": \"37.0902\",\r\n \"longitude\": \"-95.7129\",\r\n \"alpha2\": \"US\",\r\n \"alpha3\": \"USA\"\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": "BIN Lookup is a simple tool for looking up BIN number information. It returns information such as the bank, card type, and more based on the BIN number provided.",
"version": "1.1.5",
"project_urls": {
"Documentation": "https://docs.apiverve.com/api/binlookup?utm_source=pypi",
"Homepage": "https://apiverve.com?utm_source=pypi",
"Repository": "https://github.com/apiverve/binlookup.Python-API",
"Twitter": "https://twitter.com/apivervehq"
},
"split_keywords": [
"bin lookup",
" bin lookup api",
" bin lookup tool",
" bin lookup software",
" bin lookup service"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4920064bc53c3bbf1ce283e7e2727f6b0b073005148230906ca46562e3b49cbb",
"md5": "2fc9938c109768d51b24bc7f67fe390b",
"sha256": "db069cc0c41396b444f358f219e23d466de4a20db31bba0c3dec27ca3d361046"
},
"downloads": -1,
"filename": "apiverve_binlookup-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2fc9938c109768d51b24bc7f67fe390b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 4230,
"upload_time": "2024-09-21T06:36:17",
"upload_time_iso_8601": "2024-09-21T06:36:17.725724Z",
"url": "https://files.pythonhosted.org/packages/49/20/064bc53c3bbf1ce283e7e2727f6b0b073005148230906ca46562e3b49cbb/apiverve_binlookup-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "04af7d39d9601269797cdf245c88605959df5ce55573b53c1a1c7d832ecf5e4e",
"md5": "b8fc6d9469fbdc42e31635796f97d133",
"sha256": "5269a51705c34daf9bec84a4f99f93589861680551473457a4bf55de64ea6198"
},
"downloads": -1,
"filename": "apiverve_binlookup-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "b8fc6d9469fbdc42e31635796f97d133",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 4133,
"upload_time": "2024-09-21T06:36:18",
"upload_time_iso_8601": "2024-09-21T06:36:18.923699Z",
"url": "https://files.pythonhosted.org/packages/04/af/7d39d9601269797cdf245c88605959df5ce55573b53c1a1c7d832ecf5e4e/apiverve_binlookup-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-21 06:36:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "apiverve",
"github_project": "binlookup.Python-API",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "apiverve-binlookup"
}