Using the CData ODBC Driver for PhantomBuster in PyCharm

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to PhantomBuster as an ODBC data source in PyCharm using the CData ODBC Driver for PhantomBuster.

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for PhantomBuster from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for PhantomBuster as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

  1. Click File -> Settings to open the project settings window.
  2. Click Project Interpreter from the Project: YourProjectName menu.
  3. To add pyodbc, click the + button and enter pyodbc.
  4. Click Install Package to install pyodbc.

Connect to PhantomBuster

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

Using API Key Authentication

To use the Phantombuster API, you need to obtain an API key from your Phantombuster account settings. Navigate to phantombuster.com, click your profile icon, select Settings, and copy the API key from the API section.

After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your Phantombuster API key from the account settings page.

Multi-Organization Accounts

If your API key is associated with multiple organizations, you can target a specific organization by setting the OrganizationId connection property to the desired organization identifier. When set, it is sent as the X-Phantombuster-Org request header.

Example connection string:

Profile=C:\profiles\Phantombuster.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key_here"

Below is the syntax for a DSN:

[CData API Source]
Driver = CData ODBC Driver for PhantomBuster
Description = My Description
Profile = C:\profiles\Phantombuster.apip
AuthScheme = APIKey
ProfileSettings = "APIKey = your_api_key_here"

Execute SQL to PhantomBuster

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for API};Profile = C:\profiles\Phantombuster.apip;AuthScheme = APIKey;ProfileSettings = "APIKey = your_api_key_here"')
cursor = cnxn.cursor()
cursor.execute("SELECT ,  FROM Agents WHERE  = ''")
rows = cursor.fetchall()
for row in rows:
  print(row., row.)

After connecting to PhantomBuster in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to PhantomBuster data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].

Ready to get started?

Connect to live data from PhantomBuster with the API Driver

Connect to PhantomBuster