Skip to main content

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.

Project description

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 Code Climate Prod Ready

This is a Python API Wrapper for the BIN Lookup API


Installation

Using pip:

pip install apiverve-binlookup

Using pip3:

pip3 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


Quick Start

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

from apiverve_binlookup.apiClient import BinlookupAPIClient

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

query = { "bin": "448590" }

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

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

Usage

The BIN Lookup API documentation is found here: https://docs.apiverve.com/ref/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"
    }
  }
}

Error Handling

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

Basic Error Handling

from apiverve_binlookup.apiClient import BinlookupAPIClient, BinlookupAPIClientError

api = BinlookupAPIClient("[YOUR_API_KEY]")

query = { "bin": "448590" }

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

api = BinlookupAPIClient("[YOUR_API_KEY]")

query = { "bin": "448590" }

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 BinlookupAPIClientError 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_binlookup.apiClient import BinlookupAPIClient, BinlookupAPIClientError

query = { "bin": "448590" }

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

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

query = { "bin": "448590" }

# 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_binlookup.apiClient import BinlookupAPIClient

api = BinlookupAPIClient("[YOUR_API_KEY]")

query = { "bin": "448590" }

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

Uploaded Source

Built Distribution

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

apiverve_binlookup-1.1.14-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for apiverve_binlookup-1.1.14.tar.gz
Algorithm Hash digest
SHA256 f280a9a70c57a75ba6dd5772a56f874e60c0db88065ecf1642509f95f5062aae
MD5 4cb87ebfba4a9226106219a65972c639
BLAKE2b-256 84338049034eae7c2e6439aa506e70bf69e8d84eebc98b9300331c15c609c1ac

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apiverve_binlookup-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 b9b908446b56a56309ec1f921f7577a439faae7bfa81d7d6b2602e7bb2122d0d
MD5 daa4b7012054e0933c804a6dee90d2c4
BLAKE2b-256 9adb89df267e563bb59e6a2d13c8ee44318f834e85723666bbf2df4cfba69234

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