← Tools Reference

SearchApi

SearchApi integration (Data, Location). Imported from open-connector.

API key4 toolshttps://www.searchapi.io
GET
search_api_get_account_info
Retrieve account usage statistics for the connected SearchApi API key.

/me

GET
search_api_search
Run one SearchApi search request with the first-pass common query parameters.

/search

21 parameters
ParamTypeRequiredDescription
enginestringrequiredSearch engine identifier accepted by SearchApi.
qstringrequiredSearch query sent to SearchApi.
locationstringoptionalCanonical search location accepted by SearchApi.
glstringoptionalTwo-letter country code used for localized results.
hlstringoptionalTwo-letter language code used for localized results.
lrstringoptionalDocument language restriction sent to SearchApi.
crstringoptionalCountry restriction sent to SearchApi.
numintegeroptionalMaximum number of results to request.
pageintegeroptionalResult page number for pagination.
safestringoptionalSafe search mode sent to SearchApi.
uulestringoptionalGoogle encoded location parameter sent to SearchApi.
kgmidstringoptionalKnowledge Graph identifier sent to SearchApi.
devicestringoptionalDevice type used for the search request.
filterintegeroptionalDuplicate filtering mode sent to SearchApi.
nfprintegeroptionalWhether to exclude auto-corrected results.
googleDomainstringoptionalGoogle domain override sent to SearchApi.
timePeriodstringoptionalRelative date filter sent to SearchApi.
timePeriodMinstringoptionalCustom date range start in MM/DD/YYYY format.
timePeriodMaxstringoptionalCustom date range end in MM/DD/YYYY format.
optimizationStrategystringoptionalOptimization strategy sent to SearchApi.
zeroRetentionbooleanoptionalWhether SearchApi should disable logging for the request.
GET
search_api_get_locations
Look up canonical SearchApi locations for geo-targeted search queries.

/locations

3 parameters
ParamTypeRequiredDescription
qstringrequiredSearch query used to match locations.
limitintegeroptionalMaximum number of location matches to return.
zeroRetentionbooleanoptionalWhether SearchApi should disable logging for the request.
GET
search_api_get_cached_search_html
Retrieve one cached SearchApi search result in HTML format by search identifier.

/api/v1/

1 parameter
ParamTypeRequiredDescription
searchIdstringoptionalSearch identifier returned by SearchApi.