Learn more
 

Ready to get started?

Download a free trial of the Avalara Driver to get started:

 Download Now

Learn more:

Avalara AvaTax Icon Avalara JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with AvaTax.

In this article

Related articles

Use JayDeBeApi to access Avalara AvaTax Data in Python


Use standard Python scripting and the development environment of your choice to access live Avalara AvaTax data.

Access Avalara AvaTax data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for Avalara and the JayDeBeApi module to work with remote Avalara AvaTax 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 Avalara AvaTax and visualize Avalara AvaTax 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 Avalara AvaTax data in Python using SQL.

The primary method for performing basic authentication is to provide your login credentials, as follows:

  • User: Set this to your username.
  • Password: Set this to your password.

Optionally, if you are making use of a sandbox environment, set the following:

  • UseSandbox: Set this to true if you are authenticating with a sandbox account.

Authenticating Using Account Number and License Key

Alternatively, you can authenticate using your account number and license key. Connect to data using the following:

  • AccountId: Set this to your Account Id. The Account Id is listed in the upper right hand corner of the admin console.
  • LicenseKey: Set this to your Avalara Avatax license key. You can generate a license key by logging into Avalara Avatax as an account administrator and navigating to Settings -> Reset License Key.

Built-in Connection String Designer

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

java -jar cdata.jdbc.avalaraavatax.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:avalaraavatax:User=MyUser;Password=MyPassword;"

Access Avalara AvaTax 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.avalaraavatax.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 Avalara AvaTax:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:avalaraavatax:User=MyUser;Password=MyPassword;" 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.avalaraavatax.jar" conn = jaydebeapi.connect( "cdata.jdbc.avalaraavatax.jar", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM Transactions;") 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 JDBC Driver for Avalara and start working with your live Avalara AvaTax data in Python. Reach out to our Support Team if you have any questions.