How to connect to PhantomBuster Data with Squirrel SQL client

The CData JDBC Driver for PhantomBuster enables you to execute queries to PhantomBuster data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for PhantomBuster data and execute queries.

Add the JDBC Driver for PhantomBuster

Follow the steps below to add the driver JAR.

1. In Squirrel SQL, click Windows -> View Drivers.
2. Click the plus icon to open the Add Driver wizard.
3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for PhantomBuster.
4. In the Example URL box, enter jdbc:api:
5. In the Extra Class Path tab, click Add.
6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.api.APIDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

1. Click Windows -> View Aliases.
2. In the pane that lists the aliases, click the plus icon.

3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

   • Name: Enter a name for the alias; for example, CData PhantomBuster Source.
   • Driver: Select the CData JDBC Driver for PhantomBuster.
   • URL: Enter jdbc:api:
   👁 The alias definition, containing the connection parameters. (Salesforce is shown.)
   
4. If you want to define any additional properties, click Properties.
5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
6. In the Specify column, select the checkboxes for the required connection properties.

   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 a typical connection string:

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

   👁 Connection properties automatically detected by Squirrel SQL. (Salesforce is shown.)
   
7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query PhantomBuster Data

After the metadata has loaded, a new tab for the PhantomBuster data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

👁 Column metadata for a table. (Salesforce is shown.)

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT , FROM Agents WHERE = ''