Connect to SerpApi Data in Aqua Data Studio

The CData JDBC Driver for SerpApi integrates SerpApi data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to SerpApi data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The SerpApi data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, SerpApi.
   • Driver Location: Click the Browse button and select the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.api.APIDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:api: and is followed by a semicolon-separated list of connection properties.

     Start by setting the Profile connection property to the location of the SerpAPI Profile on disk (e.g. C:\profiles\SerpAPI.apip). Next, set the ProfileSettings connection property to the connection string for SerpAPI (see below).

     SerpAPI API Profile Settings

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

     1. Sign in to your SerpAPI account at https://serpapi.com
     2. Navigate to the API Key page at https://serpapi.com/manage-api-key
     3. Copy your private API key

     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 SerpAPI private API key.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the SerpApi 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.

     A typical JDBC URL is below:

     jdbc:api:Profile=C:\profiles\SerpAPI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key_here';

   

Query SerpApi Data

You can now query the tables exposed.