API Data Provider - Online Help

Connecting to SerpAPI

Using API Key Authentication

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.

Example Connection String

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

Connecting to SerpAPI

Once the authentication is configured, you can connect to SerpAPI and query data from any of the available tables such as GoogleSearch, AmazonSearch, GoogleMaps, and more.

Available Tables

The SerpAPI Profile provides access to the following tables:

  • Account: Query SerpAPI account information including plan details, search quota, and usage statistics
  • AmazonSearch: Search Amazon product listings (requires SearchQuery)
  • BingSearch: Retrieve Bing organic search results (requires SearchQuery)
  • DuckDuckGoMaps: Retrieve DuckDuckGo Maps local results (requires SearchQuery)
  • DuckDuckGoSearch: Retrieve DuckDuckGo organic search results (requires SearchQuery)
  • EbaySearch: Search eBay listing results (requires SearchQuery or CategoryId)
  • FacebookProfile: Retrieve a Facebook public profile or page (requires ProfileId)
  • GoogleEvents: Retrieve Google Events results (requires SearchQuery)
  • GoogleImages: Retrieve Google Images results (requires SearchQuery)
  • GoogleJobs: Retrieve Google Jobs listings (requires SearchQuery)
  • GoogleMaps: Search Google Maps places (requires SearchQuery)
  • GoogleMapsReviews: Retrieve customer reviews for a Google Maps place (requires DataId or PlaceId)
  • GoogleNews: Retrieve Google News results (requires SearchQuery)
  • GooglePatents: Search Google Patents (requires SearchQuery)
  • GoogleScholar: Retrieve Google Scholar academic search results (requires SearchQuery)
  • GoogleScholarArticles: Retrieve articles from a Google Scholar author profile (requires AuthorId)
  • GoogleSearch: Retrieve Google organic search results (requires SearchQuery)
  • GoogleShopping: Retrieve Google Shopping product results (requires SearchQuery)
  • GoogleVideos: Retrieve Google Videos results (requires SearchQuery)
  • Locations: Query the SerpAPI locations directory used to populate the location parameter on other engines
  • TripAdvisorSearch: Search TripAdvisor places (requires SearchQuery)
  • WalmartSearch: Search Walmart product listings (requires SearchQuery or CategoryId)
  • YahooSearch: Retrieve Yahoo organic search results (requires SearchQuery)
  • YahooShopping: Retrieve Yahoo Shopping product results (requires SearchQuery)
  • YandexSearch: Retrieve Yandex organic search results (requires SearchQuery)
  • YouTubeSearch: Retrieve YouTube video search results (requires SearchQuery)

Important Notes

  • Most search tables require a SearchQuery (or equivalent required filter) to be specified as a WHERE clause condition.
  • The SerpAPI key is sent as the api_key URL parameter on every request.
  • Several tables support result-token pagination (e.g. GoogleMapsReviews, YouTubeSearch) and page-number pagination (e.g. GoogleSearch, AmazonSearch).
  • Date fields in search results (e.g. PublishedDate, PostedAt) are returned as human-readable relative strings such as "3 days ago".
  • Rate limiting applies — refer to the SerpAPI plan page for current limits.

API Documentation

For more information about the SerpAPI, see the official SerpAPI documentation.

Usage Examples

Account:

SELECT * FROM Account

AmazonSearch:

SELECT * FROM AmazonSearch WHERE SearchQuery = 'mechanical keyboard'

BingSearch:

SELECT * FROM BingSearch WHERE SearchQuery = 'cdata software'

DuckDuckGoMaps:

SELECT * FROM DuckDuckGoMaps WHERE SearchQuery = 'coffee shops in Austin'

DuckDuckGoSearch:

SELECT * FROM DuckDuckGoSearch WHERE SearchQuery = 'open source databases'

EbaySearch:

SELECT * FROM EbaySearch WHERE SearchQuery = 'vintage camera'

FacebookProfile:

SELECT * FROM FacebookProfile WHERE ProfileId = 'meta'

GoogleEvents:

SELECT * FROM GoogleEvents WHERE SearchQuery = 'music festivals in Austin'

GoogleImages:

SELECT * FROM GoogleImages WHERE SearchQuery = 'aurora borealis'

GoogleJobs:

SELECT * FROM GoogleJobs WHERE SearchQuery = 'software engineer'

GoogleMaps:

SELECT * FROM GoogleMaps WHERE SearchQuery = 'coffee shops in Seattle'

GoogleMapsReviews:

SELECT * FROM GoogleMapsReviews WHERE DataId = '0x12345abcdef:0x67890'

GoogleNews:

SELECT * FROM GoogleNews WHERE SearchQuery = 'artificial intelligence'

GooglePatents:

SELECT * FROM GooglePatents WHERE SearchQuery = '(machine learning) OR (neural network)'

GoogleScholar:

SELECT * FROM GoogleScholar WHERE SearchQuery = 'machine learning'

GoogleScholarArticles:

SELECT * FROM GoogleScholarArticles WHERE AuthorId = 'LSsXyncAAAAJ'

GoogleSearch:

SELECT * FROM GoogleSearch WHERE SearchQuery = 'cdata software'

GoogleShopping:

SELECT * FROM GoogleShopping WHERE SearchQuery = 'wireless headphones'

GoogleVideos:

SELECT * FROM GoogleVideos WHERE SearchQuery = 'sql tutorial'

Locations:

SELECT * FROM Locations WHERE Name = 'Austin'

TripAdvisorSearch:

SELECT * FROM TripAdvisorSearch WHERE SearchQuery = 'hotels in Paris'

WalmartSearch:

SELECT * FROM WalmartSearch WHERE SearchQuery = 'laptop'

YahooSearch:

SELECT * FROM YahooSearch WHERE SearchQuery = 'cdata software'

YahooShopping:

SELECT * FROM YahooShopping WHERE SearchQuery = 'wireless headphones'

YandexSearch:

SELECT * FROM YandexSearch WHERE SearchQuery = 'москва'

YouTubeSearch:

SELECT * FROM YouTubeSearch WHERE SearchQuery = 'sql tutorial'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
APIKey Your SerpAPI private API key from the SerpAPI dashboard.
AuthScheme The scheme used for authentication. Accepted entries are APIKey or None.
Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0