Connect to Instantly Data in DBArtisan

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use wizards in DBArtisan to configure Instantly data as a data source.

The CData ODBC Driver for Instantly seamlessly integrates Instantly data into database management tools like DBArtisan by enabling you to access Instantly data as a database. This article shows how to create an data source for Instantly in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.

Integrate Instantly Data into DBArtisan Projects

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Using API Key Authentication

Instantly uses API keys to authenticate requests. You can find or create your API key in the Instantly workspace settings under API & Webhooks.

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

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your Instantly API key (Bearer token for API v2).

Example connection string

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

You can then follow the steps below to register Instantly data as a database instance in your project:

  1. In DBArtisan, click Data Source -> Register Datasource.
  2. Select Generic ODBC.
  3. Enter a name for the data source and select the DSN.
  4. Finish the wizard to connect to Instantly data. Instantly entities are displayed in the Datasource Explorer.

You can now work with Instantly data as you work with any other database. See the driver help documentation for more information on the queries supported by the Instantly API.

Ready to get started?

Connect to live data from Instantly with the API Driver

Connect to Instantly