Use JayDeBeApi to access ZeroBounce Data in Python

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use standard Python scripting and the development environment of your choice to access live ZeroBounce data.

Access ZeroBounce data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData API Driver for JDBC and the JayDeBeApi module to work with remote ZeroBounce data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to ZeroBounce and visualize ZeroBounce data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with ZeroBounce data in Python using SQL.

Using API Key Authentication

ZeroBounce uses API key authentication. To obtain an API key:

  1. Log in to your ZeroBounce account at https://app.zerobounce.net
  2. Navigate to the API tab in your account dashboard
  3. Copy the API key displayed on the page

After obtaining your API key, set the following connection properties:

  • AuthScheme: Set this to APIKey.
Set the following in the ProfileSettings connection property:
  • APIKey: Set this to your ZeroBounce API key.

Example Connection String

Profile=C:\profiles\ZeroBounce.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the ZeroBounce JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.api.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a sample variable assignment, including a typical JDBC connection string:

jdbc_url = "jdbc:api:Profile=C:\profiles\ZeroBounce.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";"

Access ZeroBounce data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.api.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from ZeroBounce:

import jaydebeapi

#The JDBC connection string
jdbc_url = "jdbc:api:Profile=C:\profiles\ZeroBounce.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";"

username = "****"
password = "****"

#The absolute Path to the JDBC driver JAR file, typically:
jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.api.jar"

conn = jaydebeapi.connect(
   "cdata.jdbc.api.APIDriver",
   jdbc_url,
   [username, password],
   jdbc_driver_jar,
)

cursor = conn.cursor()
cursor.execute("SELECT * FROM Credits;")


results = cursor.fetchall()
for row in results:
    print(row)

cursor.close()
conn.close()

Free trial & more information

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live ZeroBounce data in Python. Reach out to our Support Team if you have any questions.

Ready to get started?

Connect to live data from ZeroBounce with the API Driver

Connect to ZeroBounce