The SerpApi connector lets your AI agent act in each user's SerpApi account. Each user connects their own SerpApi API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 19 tools.
- Tools
- 19
- What they doRead · write · destructive
- 19 · 0 · 019 read0 write0 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the SerpApi connection
In AgentKit > Connections, create a SerpApi connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'serpapi'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize SerpApi:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'serpapi_account_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "serpapi"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize SerpApi:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="serpapi_account_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their SerpApi credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolserpapi_account_getGet the SerpApi account's plan, remaining searches and usage.Read-onlyGet Account
Get the SerpApi account's plan, remaining searches and usage. This call is free. Returns account_email, account_status, plan_name, searches_per_month, plan_searches_left, extra_credits, total_searches_left, this_month_usage, this_hour_searches, last_hour_searches and account_rate_limit_per_hour. Use this before a large batch of searches to check the remaining balance and hourly limit.
Inputs
This tool takes no inputs.
serpapi_amazon_searchSearch Amazon product listings through SerpApi, by keyword or by category node.Read-onlyAmazon Search
Search Amazon product listings through SerpApi, by keyword or by category node. Returns organic_results with position, asin, title, link, price, extracted_price, rating, reviews, prime, delivery and thumbnail, plus product_ads, featured_products, related_searches, filters and serpapi_pagination. Use this for Amazon-only product results. Use serpapi_google_shopping_search to compare prices across many stores.
Inputs
amazon_domainstring- Amazon site to search. SerpApi uses amazon.com when omitted. Example: amazon.co.uk
asyncboolean- Set true to submit the search and return at once with only search_metadata (id and status Processing); fetch the results later with serpapi_search_archive_get using search_metadata.id. Do not combine with no_cache. Example: false
dcboolean- Set true to exclude results for an auto-corrected spelling of the query (default false). Example: true
delivery_zipstring- ZIP or postal code to show delivery and availability for. Not valid on amazon.ae, amazon.sa or amazon.eg. Example: 10001
json_restrictorstring- Limit the response to the listed fields to keep it small, using SerpApi's JSON Restrictor syntax: comma-separated top-level keys, with dots, brackets and braces for nested fields. Example: organic_results[0:5].{title,link,snippet}
kstring- The Amazon search query. Required unless node is set; cannot be combined with node. Example: usb c charger 65w
languagestring- Language as language_REGION. Example: en_US
no_cacheboolean- Set true to force a fresh search instead of a cached result. SerpApi serves an identical search run in the last hour from its cache for free; a fresh search spends one search credit. Do not combine with async. Example: false
nodestring- Amazon category node ID to browse instead of a keyword search. Cannot be combined with k. Example: 172282
pageinteger- Results page, starting at 1. Each page is a separate search. Example: 2
rhstring- Attribute filters as comma-separated key:value pairs, taken from filters in an earlier result. Example: n:16318031,p_72:1248897011
sstring- Sort order: relevanceblender featured (default), price-asc-rank, price-desc-rank, review-rank (average review), date-desc-rank (newest), exact-aware-popularity-rank (best sellers).one of
relevanceblenderprice-asc-rankprice-desc-rankreview-rankdate-desc-rankexact-aware-popularity-rank
serpapi_bing_news_searchSearch Bing News through SerpApi, optionally limited to a recent time window or sorted by date.Read-onlyBing News Search
Search Bing News through SerpApi, optionally limited to a recent time window or sorted by date. Returns organic_results with title, link, snippet, source, date and thumbnail. Use this for Bing's news coverage of a topic. Use serpapi_google_news_search for Google News.
Inputs
qstringrequired- The news search query. Bing operators such as site: work. Example: electric vehicle battery recycling
asyncboolean- Set true to submit the search and return at once with only search_metadata (id and status Processing); fetch the results later with serpapi_search_archive_get using search_metadata.id. Do not combine with no_cache. Example: false
ccstring- Two-letter country code to search from, such as us or de. Cannot be combined with mkt. Example: gb
countinteger- Suggested number of results per page; Bing may return a different number. Example: 20
firstinteger- Position of the first result to return, for pagination (default 1). Example: 11
json_restrictorstring- Limit the response to the listed fields to keep it small, using SerpApi's JSON Restrictor syntax: comma-separated top-level keys, with dots, brackets and braces for nested fields. Example: organic_results[0:5].{title,link,snippet}
mktstring- Bing market as language-country, such as en-US or de-DE. Cannot be combined with cc. Example: en-US
no_cacheboolean- Set true to force a fresh search instead of a cached result. SerpApi serves an identical search run in the last hour from its cache for free; a fresh search spends one search credit. Do not combine with async. Example: false
qftstring- Time filter or sort: interval="4" past hour, interval="7" past 24 hours, interval="8" past 7 days, interval="9" past 30 days, sortbydate="1" newest first. Omit for best match.one of
interval="4"interval="7"interval="8"interval="9"sortbydate="1" safeSearchstring- Adult content filter: Off, Moderate (adult text allowed, no adult images or videos) or Strict.one of
OffModerateStrict
serpapi_bing_searchSearch Bing web results through SerpApi.Read-onlyBing Search
Search Bing web results through SerpApi. Returns organic_results with position, title, link, displayed_link and snippet, plus ads, answer_box, knowledge_graph, related_questions, related_searches and serpapi_pagination when Bing shows them. Use this for Bing's web index or to cross-check Google. Use serpapi_google_search for Google results and serpapi_bing_news_search for Bing news.
Inputs
qstringrequired- The search query. Bing operators such as site:, NOT and OR work. Example: open source vector database
asyncboolean- Set true to submit the search and return at once with only search_metadata (id and status Processing); fetch the results later with serpapi_search_archive_get using search_metadata.id. Do not combine with no_cache. Example: false
ccstring- Two-letter country code to search from, such as us or de. Cannot be combined with mkt. Example: gb
devicestring- Device type to emulate: desktop (default), tablet or mobile. Results and layout differ by device.one of
desktoptabletmobile filtersstring- Bing filter string, such as a date range, copied from the filters parameter of a Bing results URL. Example: ex1:"ez1"
firstinteger- Position of the first result to return, for pagination (default 1). Example: 11 for the second page.
json_restrictorstring- Limit the response to the listed fields to keep it small, using SerpApi's JSON Restrictor syntax: comma-separated top-level keys, with dots, brackets and braces for nested fields. Example: organic_results[0:5].{title,link,snippet}
locationstring- Place the search runs from, as a location name (city level works best). Example: Austin, Texas, United States
mktstring- Bing market as language-country, such as en-US or de-DE. Cannot be combined with cc. Example: en-US
no_cacheboolean- Set true to force a fresh search instead of a cached result. SerpApi serves an identical search run in the last hour from its cache for free; a fresh search spends one search credit. Do not combine with async. Example: false
safeSearchstring- Adult content filter: Off, Moderate (adult text allowed, no adult images or videos) or Strict.one of
OffModerateStrict
serpapi_google_autocompleteGet Google's autocomplete suggestions for a partial query through SerpApi.Read-onlyGoogle Autocomplete
Get Google's autocomplete suggestions for a partial query through SerpApi. Returns suggestions with value (the suggested query), relevance and type, plus verbatim_relevance. Use this to expand keywords or see how people phrase a search. Use serpapi_google_trends_search for popularity over time.
Inputs
qstringrequired- The partial query to complete. Example: how to make cold br
asyncboolean- Set true to submit the search and return at once with only search_metadata (id and status Processing); fetch the results later with serpapi_search_archive_get using search_metadata.id. Do not combine with no_cache. Example: false
cpinteger- Cursor position in the query, starting at 0; suggestions complete the text at this position. Defaults to the end of the query. Example: 10
glstring- Two-letter country code (Google's gl parameter, lowercase) that sets which country's results to return. Example: us
hlstring- Language code for the results (Google's hl parameter): a two-letter language code, optionally with a region, such as en, fr, en-gb or es-419. Example: en
json_restrictorstring- Limit the response to the listed fields to keep it small, using SerpApi's JSON Restrictor syntax: comma-separated top-level keys, with dots, brackets and braces for nested fields. Example: organic_results[0:5].{title,link,snippet}
no_cacheboolean- Set true to force a fresh search instead of a cached result. SerpApi serves an identical search run in the last hour from its cache for free; a fresh search spends one search credit. Do not combine with async. Example: false
serpapi_google_images_searchSearch Google Images through SerpApi, with optional size, color, type, license and date filters.Read-onlyGoogle Images Search
Search Google Images through SerpApi, with optional size, color, type, license and date filters. Returns images_results with position, title, source, link (page), original (full-size image URL), original_width, original_height and thumbnail, plus suggested_searches and serpapi_pagination. Use this to find images on a subject. Use serpapi_google_search for web pages and serpapi_google_shopping_search for product listings.
Inputs
qstringrequired- The image search query. Operators such as site: and intitle: work. Example: golden gate bridge at night
asyncboolean- Set true to submit the search and return at once with only search_metadata (id and status Processing); fetch the results later with serpapi_search_archive_get using search_metadata.id. Do not combine with no_cache. Example: false
devicestring- Device type to emulate: desktop (default), tablet or mobile. Results and layout differ by device.one of
desktoptabletmobile end_datestring- Latest image date, as YYYYMMDD. Cannot be combined with period_unit. Example: 20261031
glstring- Two-letter country code (Google's gl parameter, lowercase) that sets which country's results to return. Example: us
google_domainstring- Google domain to search on. SerpApi uses google.com when omitted. Example: google.co.uk
hlstring- Language code for the results (Google's hl parameter): a two-letter language code, optionally with a region, such as en, fr, en-gb or es-419. Example: en
ijninteger- Page number of image results, starting at 0 (up to 99). Each page is a separate search. Example: 1
image_colorstring- Dominant color filter: bw (black and white), trans (transparent), or a color name.one of
bwtransredorangeyellowgreentealbluepurplepinkwhitegrayblackbrown image_typestring- Image type filter: face, photo, clipart, lineart or animated.one of
facephotoclipartlineartanimated imgarstring- Aspect ratio filter: s square, t tall, w wide, xw panoramic.one of
stwxw imgszstring- Size filter: l large, m medium, i icon, or a minimum size such as qsvga, vga, svga, xga, 2mp, 4mp, 6mp, 8mp, 10mp, 12mp, 15mp, 20mp, 40mp or 70mp. Example: l
json_restrictorstring- Limit the response to the listed fields to keep it small, using SerpApi's JSON Restrictor syntax: comma-separated top-level keys, with dots, brackets and braces for nested fields. Example: organic_results[0:5].{title,link,snippet}
licensesstring- Usage rights filter: f free to use or share, fc free to use or share even commercially, fm free to use, share or modify, fmc free to use, share or modify even commercially, cl Creative Commons licenses, ol commercial and other licenses.one of
ffcfmfmcclol locationstring- Place the search runs from, as a location name (city level works best, most specific first). Results are localized as if searched there. Find valid names with serpapi_locations_search. Example: Austin, Texas, United States
no_cacheboolean- Set true to force a fresh search instead of a cached result. SerpApi serves an identical search run in the last hour from its cache for free; a fresh search spends one search credit. Do not combine with async. Example: false
period_unitstring- Only return images from the recent past, in this unit: s second, n minute, h hour, d day, w week, m month, y year. Combine with period_value. Cannot be combined with start_date or end_date.one of
snhdwmy period_valueinteger- How many period_unit units back to look (SerpApi uses 1 when omitted). Example: 2 with period_unit w means the past two weeks.
safestring- Adult content filter: active to filter explicit results, off to turn filtering off. Google blurs explicit content when omitted.one of
activeoff start_datestring- Earliest image date, as YYYYMMDD. Cannot be combined with period_unit. Example: 20260101
serpapi_google_jobs_searchSearch job listings that Google Jobs aggregates from job boards and company sites, through SerpApi.Read-onlyGoogle Jobs Search
Search job listings that Google Jobs aggregates from job boards and company sites, through SerpApi. Returns jobs_results with title, company_name, location, via (source), description, job_highlights, detected_extensions (posted_at, schedule_type, salary), apply_options and job_id, plus filters and serpapi_pagination.next_page_token (up to 10 jobs per page). Use this to find open roles by title, skill or company and place.
Inputs
qstringrequired- The job search query, such as a title, skill or company. Example: senior data engineer
asyncboolean- Set true to submit the search and return at once with only search_metadata (id and status Processing); fetch the results later with serpapi_search_archive_get using search_metadata.id. Do not combine with no_cache. Example: false
glstring- Two-letter country code (Google's gl parameter, lowercase) that sets which country's results to return. Example: us
google_domainstring- Google domain to search on. SerpApi uses google.com when omitted. Example: google.co.uk
hlstring- Language code for the results (Google's hl parameter): a two-letter language code, optionally with a region, such as en, fr, en-gb or es-419. Example: en
json_restrictorstring- Limit the response to the listed fields to keep it small, using SerpApi's JSON Restrictor syntax: comma-separated top-level keys, with dots, brackets and braces for nested fields. Example: organic_results[0:5].{title,link,snippet}
locationstring- Place the search runs from, as a location name (city level works best, most specific first). Results are localized as if searched there. Find valid names with serpapi_locations_search. Example: Austin, Texas, United States
lradinteger- Search radius in kilometers around the location. It biases results and is not a strict limit. Example: 25
next_page_tokenstring- Token for the next page, from serpapi_pagination.next_page_token of the previous result. Example: eyJmYyI6IkVvd0RDc3dDUVVGQlFXRXRVa0Z
no_cacheboolean- Set true to force a fresh search instead of a cached result. SerpApi serves an identical search run in the last hour from its cache for free; a fresh search spends one search credit. Do not combine with async. Example: false
udsstring- Filter string from a filters entry of an earlier result (for example a date posted or job type filter). Example: ADvngMjcH0KdF7qJ
serpapi_google_local_searchSearch Google's local results (the Places list behind the local pack) through SerpApi.Read-onlyGoogle Local Search
Search Google's local results (the Places list behind the local pack) through SerpApi. Returns local_results with position, title, place_id, rating, reviews, price, type, address, phone, hours, gps_coordinates and thumbnail, plus local_map. Use this for a ranked list of local businesses as Google Search shows them. Use serpapi_google_maps_search for map-based search with zoom and rating filters.
Inputs
qstringrequired- What to look for, optionally with a place. Example: dentist near Mission District
asyncboolean- Set true to submit the search and return at once with only search_metadata (id and status Processing); fetch the results later with serpapi_search_archive_get using search_metadata.id. Do not combine with no_cache. Example: false
devicestring- Device type to emulate: desktop (default), tablet or mobile. Results and layout differ by device.one of
desktoptabletmobile glstring- Two-letter country code (Google's gl parameter, lowercase) that sets which country's results to return. Example: us
google_domainstring- Google domain to search on. SerpApi uses google.com when omitted. Example: google.co.uk
hlstring- Language code for the results (Google's hl parameter): a two-letter language code, optionally with a region, such as en, fr, en-gb or es-419. Example: en
json_restrictorstring- Limit the response to the listed fields to keep it small, using SerpApi's JSON Restrictor syntax: comma-separated top-level keys, with dots, brackets and braces for nested fields. Example: organic_results[0:5].{title,link,snippet}
locationstring- Place the search runs from, as a location name (city level works best, most specific first). Results are localized as if searched there. Find valid names with serpapi_locations_search. Example: Austin, Texas, United States
no_cacheboolean- Set true to force a fresh search instead of a cached result. SerpApi serves an identical search run in the last hour from its cache for free; a fresh search spends one search credit. Do not combine with async. Example: false
startinteger- Number of results to skip, for pagination: 0 is the first page, 20 the second, 40 the third. Each page is a separate search. SerpApi recommends following serpapi_pagination.next. Example: 20
serpapi_google_maps_place_getGet the Google Maps details of one place by its place_id or data_cid through SerpApi.Read-onlyGet Google Maps Place
Get the Google Maps details of one place by its place_id or data_cid through SerpApi. Returns place_results with title, place_id, data_id, data_cid, address, phone, website, gps_coordinates, rating, reviews, type, hours, price, popular times, user review highlights and images. Use this when you already have a place id. Use serpapi_google_maps_search to find places and serpapi_google_maps_reviews_list for the full review list. Get place_id or data_cid from serpapi_google_maps_search or serpapi_google_local_search.
Inputs
asyncboolean- Set true to submit the search and return at once with only search_metadata (id and status Processing); fetch the results later with serpapi_search_archive_get using search_metadata.id. Do not combine with no_cache. Example: false
data_cidstring- Google customer ID (CID) of the place, from data_cid in serpapi_google_maps_search results. Set place_id or data_cid, not both. Example: 8756438412640839890
glstring- Two-letter country code (Google's gl parameter, lowercase) that sets which country's results to return. Example: us
google_domainstring- Google domain to search on. SerpApi uses google.com when omitted. Example: google.co.uk
hlstring- Language code for the results (Google's hl parameter): a two-letter language code, optionally with a region, such as en, fr, en-gb or es-419. Example: en
json_restrictorstring- Limit the response to the listed fields to keep it small, using SerpApi's JSON Restrictor syntax: comma-separated top-level keys, with dots, brackets and braces for nested fields. Example: organic_results[0:5].{title,link,snippet}
no_cacheboolean- Set true to force a fresh search instead of a cached result. SerpApi serves an identical search run in the last hour from its cache for free; a fresh search spends one search credit. Do not combine with async. Example: false
place_idstring- Google place ID of the place, from a place_id in serpapi_google_maps_search results. Set place_id or data_cid, not both. Example: ChIJT2h1HKZZwokR0kgzEtsa03k
serpapi_google_maps_reviews_listList the Google Maps reviews of one place through SerpApi, sorted and optionally filtered by topic or text.Read-onlyList Google Maps Reviews
List the Google Maps reviews of one place through SerpApi, sorted and optionally filtered by topic or text. Returns place_info (title, address, rating, reviews count), topics with topic_id, and reviews with user, rating, date, snippet, likes and owner response, plus serpapi_pagination.next_page_token. Use this to read what customers say about a place. Use serpapi_google_maps_place_get for the place's details and review highlights. Get data_id or place_id from serpapi_google_maps_search.
Inputs
asyncboolean- Set true to submit the search and return at once with only search_metadata (id and status Processing); fetch the results later with serpapi_search_archive_get using search_metadata.id. Do not combine with no_cache. Example: false
data_idstring- Google Maps data ID of the place, from data_id in serpapi_google_maps_search results. Set data_id or place_id. Example: 0x89c259a61c75684f:0x79d31adb123348d2
hlstring- Language code for the results (Google's hl parameter): a two-letter language code, optionally with a region, such as en, fr, en-gb or es-419. Example: en
json_restrictorstring- Limit the response to the listed fields to keep it small, using SerpApi's JSON Restrictor syntax: comma-separated top-level keys, with dots, brackets and braces for nested fields. Example: organic_results[0:5].{title,link,snippet}
next_page_tokenstring- Token for the next page of reviews, from serpapi_pagination.next_page_token of the previous result. Example: CAESY0NBRVFDaHFBQVZIVWJLb1BqVm9VZFc4N1AxUlNiUQ
no_cacheboolean- Set true to force a fresh search instead of a cached result. SerpApi serves an identical search run in the last hour from its cache for free; a fresh search spends one search credit. Do not combine with async. Example: false
numinteger- Maximum number of reviews to return, 1 to 60 (default 10). Example: 20
place_idstring- Google place ID of the place, from place_id in serpapi_google_maps_search results. Set data_id or place_id. Example: ChIJT2h1HKZZwokR0kgzEtsa03k
querystring- Only reviews mentioning this text. Returns at most 5 reviews with no pagination. Cannot be combined with topic_id. Example: parking
sort_bystring- Review order: qualityScore most relevant (default), newestFirst, ratingHigh or ratingLow.one of
qualityScorenewestFirstratingHighratingLow topic_idstring- Only reviews about one topic, using a topic_id from the topics list of an earlier result. Returns at most 5 reviews with no pagination. Cannot be combined with query. Example: /m/0k0m
serpapi_google_maps_searchSearch Google Maps through SerpApi for places matching a query near a location.Read-onlyGoogle Maps Search
Search Google Maps through SerpApi for places matching a query near a location. Returns local_results with title, place_id, data_id, data_cid, gps_coordinates, rating, reviews, price, type, address, phone, website, operating_hours and thumbnail, plus serpapi_pagination. Use this to find businesses or places on a map. Use serpapi_google_maps_place_get for one place's full details, serpapi_google_maps_reviews_list for its reviews and serpapi_google_local_search for Google's local results list.
Inputs
qstringrequired- What to look for on Google Maps, optionally with a place. Example: coffee shops in Brooklyn
asyncboolean- Set true to submit the search and return at once with only search_metadata (id and status Processing); fetch the results later with serpapi_search_archive_get using search_metadata.id. Do not combine with no_cache. Example: false
google_domainstring- Google domain to search on. SerpApi uses google.com when omitted. Example: google.co.uk
hlstring- Language code for the results (Google's hl parameter): a two-letter language code, optionally with a region, such as en, fr, en-gb or es-419. Example: en
json_restrictorstring- Limit the response to the listed fields to keep it small, using SerpApi's JSON Restrictor syntax: comma-separated top-level keys, with dots, brackets and braces for nested fields. Example: organic_results[0:5].{title,link,snippet}
llstring- Map center and zoom as @latitude,longitude,zoom (zoom 3z to 30z) or @latitude,longitude,height in meters. Cannot be combined with location. Example: @40.7455096,-74.0083012,14z
locationstring- Place name to center the map on, used with z or m. Cannot be combined with ll. Example: Austin, Texas, United States
minteger- Map height in meters, 1 to 15028132. Use instead of z with location. Example: 10000
min_ratingstring- Prefer places rated at least this many stars: 2.0, 2.5, 3.0, 3.5, 4.0 or 4.5. Lower-rated places may still appear lower down.one of
2.02.53.03.54.04.5 no_cacheboolean- Set true to force a fresh search instead of a cached result. SerpApi serves an identical search run in the last hour from its cache for free; a fresh search spends one search credit. Do not combine with async. Example: false
open_statestring- Only places open now (now) or open 24 hours (24h).one of
now24h startinteger- Number of results to skip, for pagination: 0 is the first page, 20 the second, 40 the third. Each page is a separate search. SerpApi recommends staying at or below 100. Example: 20
zinteger- Map zoom level, 3 to 30 (effective maximum about 18 to 23). Required with location unless m is set. Example: 14
serpapi_google_news_searchSearch Google News through SerpApi, or open a news topic, publication or full-coverage story by its token.Read-onlyGoogle News Search
Search Google News through SerpApi, or open a news topic, publication or full-coverage story by its token. Returns news_results with title, link, source (name, icon), date, thumbnail and nested stories, plus menu_links, related_topics and related_publications that carry topic_token and publication_token values. Use this for recent news on a subject. Use serpapi_google_search for general web pages and serpapi_bing_news_search for Bing's news index.
Inputs
asyncboolean- Set true to submit the search and return at once with only search_metadata (id and status Processing); fetch the results later with serpapi_search_archive_get using search_metadata.id. Do not combine with no_cache. Example: false
glstring- Two-letter country code (Google's gl parameter, lowercase) that sets which country's results to return. SerpApi uses us when omitted. Example: us
hlstring- Language code for the results (Google's hl parameter): a two-letter language code, optionally with a region, such as en, fr, en-gb or es-419. Example: en
json_restrictorstring- Limit the response to the listed fields to keep it small, using SerpApi's JSON Restrictor syntax: comma-separated top-level keys, with dots, brackets and braces for nested fields. Example: organic_results[0:5].{title,link,snippet}
kgmidstring- Google Knowledge Graph ID of a topic or place (starts with /m/ or /g/) to get news about it. Must be used alone, without q or tokens. Example: /m/02mjmr
no_cacheboolean- Set true to force a fresh search instead of a cached result. SerpApi serves an identical search run in the last hour from its cache for free; a fresh search spends one search credit. Do not combine with async. Example: false
publication_tokenstring- Token of a publisher, taken from related_publications or a news result's source in an earlier result, to list that publisher's news. Can be combined with section_token. Example: CAAqBwgKMKHL9QowkqbaAg
qstring- The news search query. Leave empty when you pass topic_token, publication_token, story_token or kgmid instead; q cannot be combined with them. Example: semiconductor export rules
section_tokenstring- Token of a sub-section within a topic or publication, taken from an earlier result. Use with topic_token or publication_token. Example: CAQiS0NCQVNNZ29JTDIwdk1EZGpNWFlTQW1WdUdnSlZVeUlQQ0FRYUN3b0pMMjB2TURWeU5tY3pLZ0FxQ3dvSkVnZFNiMkp2ZEdsamN5Z0FQAVAB
sointeger- Sort order for a story_token or section_token result: 0 relevance (default) or 1 date.one of
01 story_tokenstring- Token of a story, taken from a news result's story_token, to get the full coverage of that story from many outlets. Example: CAAqNggKIjBDQklTSGpvSmMzUnZjbmt0TXpZd1NoRUtEd2pBM2Y3YkJCRUFOZXo5WWI0QzhpZ0FQAQ
topic_tokenstring- Token of a Google News topic (such as Technology or World), taken from menu_links or related_topics in an earlier result. Can be combined with section_token. Example: CAAqJggKIiBDQkFTRWdvSUwyMHZNRGRqTVhZU0FtVnVHZ0pWVXlnQVAB
serpapi_google_scholar_searchSearch Google Scholar through SerpApi for papers, or list the papers citing one article or all versions of it.Read-onlyGoogle Scholar Search
Search Google Scholar through SerpApi for papers, or list the papers citing one article or all versions of it. Returns organic_results with position, title, result_id, link, snippet, publication_info (authors, journal, year), resources (PDF links) and inline_links (cited_by total and cites_id, versions cluster_id), plus serpapi_pagination. Use this for academic literature. Use serpapi_google_search for general web pages.
Inputs
as_rrinteger- Set 1 to show only review articles, 0 for all results (default).one of
01 as_sdtstring- Search type and filter: 0 exclude patents (default), 7 include patents, 4 case law; for case law add comma-separated court codes after 4. Example: 4,33,192
as_visinteger- Set 1 to exclude citation-only results, 0 to include them (default).one of
01 as_yhiinteger- Latest publication year to include. Example: 2025
as_ylointeger- Earliest publication year to include. Example: 2020
asyncboolean- Set true to submit the search and return at once with only search_metadata (id and status Processing); fetch the results later with serpapi_search_archive_get using search_metadata.id. Do not combine with no_cache. Example: false
citesstring- Article ID whose citing papers to list (Cited By), from inline_links.cited_by.cites_id of an earlier result. With q, searches within the citing papers. Example: 1275980731835430123
clusterstring- Article ID whose versions to list (All Versions), from inline_links.versions.cluster_id of an earlier result. Cannot be combined with q or cites. Example: 1275980731835430123
hlstring- Language code for the results (Google's hl parameter): a two-letter language code, optionally with a region, such as en, fr, en-gb or es-419. Example: en
json_restrictorstring- Limit the response to the listed fields to keep it small, using SerpApi's JSON Restrictor syntax: comma-separated top-level keys, with dots, brackets and braces for nested fields. Example: organic_results[0:5].{title,link,snippet}
lrstring- Limit results to one or more languages, as lang_xx codes joined by |. Example: lang_en|lang_de
no_cacheboolean- Set true to force a fresh search instead of a cached result. SerpApi serves an identical search run in the last hour from its cache for free; a fresh search spends one search credit. Do not combine with async. Example: false
numinteger- Number of results to return, 1 to 20 (default 10). Example: 20
qstring- The Scholar query. Helpers such as author: and source: work. Required unless cites or cluster is set; not allowed with cluster. Example: transformer attention mechanism
scisbdinteger- Sort by date, showing only articles added in the past year: 0 sort by relevance (default), 1 by date with abstracts only, 2 by date with everything.one of
012 startinteger- Number of results to skip, for pagination: 0 is the first page, 10 the second, 20 the third. Each page is a separate search. Example: 10
serpapi_google_searchSearch Google web results through SerpApi.Read-onlyGoogle Search
Search Google web results through SerpApi. Returns organic_results (position, title, link, snippet, source), plus answer_box, knowledge_graph, related_questions, local_results, top_stories, related_searches and serpapi_pagination when Google shows them, with search_metadata.id for the archive. Use this for general web search. Use serpapi_google_news_search for news articles, serpapi_google_images_search for images and serpapi_google_shopping_search for products.
Inputs
qstringrequired- The search query, as you would type it into Google. Operators such as site:, intitle:, inurl: and quotes work. Example: best espresso machine 2026
asyncboolean- Set true to submit the search and return at once with only search_metadata (id and status Processing); fetch the results later with serpapi_search_archive_get using search_metadata.id. Do not combine with no_cache. Example: false
devicestring- Device type to emulate: desktop (default), tablet or mobile. Results and layout differ by device.one of
desktoptabletmobile glstring- Two-letter country code (Google's gl parameter, lowercase) that sets which country's results to return. Example: us
google_domainstring- Google domain to search on. SerpApi uses google.com when omitted. Example: google.co.uk
hlstring- Language code for the results (Google's hl parameter): a two-letter language code, optionally with a region, such as en, fr, en-gb or es-419. Example: en
json_restrictorstring- Limit the response to the listed fields to keep it small, using SerpApi's JSON Restrictor syntax: comma-separated top-level keys, with dots, brackets and braces for nested fields. Example: organic_results[0:5].{title,link,snippet}
locationstring- Place the search runs from, as a location name (city level works best, most specific first). Results are localized as if searched there. Find valid names with serpapi_locations_search. Example: Austin, Texas, United States
lrstring- Limit results to one or more languages, as lang_xx codes joined by |. Example: lang_en|lang_fr
no_cacheboolean- Set true to force a fresh search instead of a cached result. SerpApi serves an identical search run in the last hour from its cache for free; a fresh search spends one search credit. Do not combine with async. Example: false
safestring- Adult content filter: active to filter explicit results, off to turn filtering off. Google blurs explicit content when omitted.one of
activeoff startinteger- Number of results to skip, for pagination: 0 is the first page, 10 the second, 20 the third. Each page is a separate search. Example: 10
tbsstring- Advanced Google filter string (the tbs parameter), most often a time range: qdr:h past hour, qdr:d past 24 hours, qdr:w past week, qdr:m past month, qdr:y past year. Example: qdr:w
serpapi_google_shopping_searchSearch Google Shopping through SerpApi for products and offers.Read-onlyGoogle Shopping Search
Search Google Shopping through SerpApi for products and offers. Returns shopping_results with position, title, product_id, product_link, source (store), price, extracted_price, old_price, rating, reviews, delivery and thumbnail, plus filters that carry shoprs tokens. Use this to compare product prices across stores. Use serpapi_amazon_search for Amazon listings only. Each call returns the first page only (about 40 products); SerpApi currently ignores pagination for this engine.
Inputs
asyncboolean- Set true to submit the search and return at once with only search_metadata (id and status Processing); fetch the results later with serpapi_search_archive_get using search_metadata.id. Do not combine with no_cache. Example: false
devicestring- Device type to emulate: desktop (default), tablet or mobile. Results and layout differ by device.one of
desktoptabletmobile free_shippingboolean- Set true to show only products with free shipping. Example: true
glstring- Two-letter country code (Google's gl parameter, lowercase) that sets which country's results to return. Example: us
google_domainstring- Google domain to search on. SerpApi uses google.com when omitted. Example: google.co.uk
hlstring- Language code for the results (Google's hl parameter): a two-letter language code, optionally with a region, such as en, fr, en-gb or es-419. Example: en
json_restrictorstring- Limit the response to the listed fields to keep it small, using SerpApi's JSON Restrictor syntax: comma-separated top-level keys, with dots, brackets and braces for nested fields. Example: organic_results[0:5].{title,link,snippet}
locationstring- Place the search runs from, as a location name (city level works best, most specific first). Results are localized as if searched there. Find valid names with serpapi_locations_search. Example: Austin, Texas, United States
max_pricenumber- Highest price to include, in the local currency. Example: 300
min_pricenumber- Lowest price to include, in the local currency. Example: 50
no_cacheboolean- Set true to force a fresh search instead of a cached result. SerpApi serves an identical search run in the last hour from its cache for free; a fresh search spends one search credit. Do not combine with async. Example: false
on_saleboolean- Set true to show only products on sale. Example: true
qstring- The product search query. Optional only when shoprs is set. Example: noise cancelling headphones
safestring- Adult content filter: active to filter explicit results, off to turn filtering off. Google blurs explicit content when omitted.one of
activeoff shoprsstring- Filter token from a filters entry of an earlier result; it carries the query and the chosen filters. Join several with ||. Example: CAEYASoTbm9pc2UgY2FuY2VsbGluZyBoZWFkcGhvbmVz
small_businessboolean- Set true to show only products from small businesses. Example: true
sort_byinteger- Sort order: 1 price low to high, 2 price high to low. Omit for relevance.one of
12
serpapi_google_trends_searchGet Google Trends data for one or more search terms through SerpApi: interest over time, interest by region, or related topics and queries.Read-onlyGoogle Trends Search
Get Google Trends data for one or more search terms through SerpApi: interest over time, interest by region, or related topics and queries. Returns interest_over_time.timeline_data (date, values per query) for TIMESERIES, interest_by_region or compared_breakdown_by_region for GEO_MAP_0 and GEO_MAP, and related_topics or related_queries (rising and top) for those data types. Use this to compare popularity or see what people search alongside a term. Use serpapi_google_autocomplete for live query suggestions.
Inputs
qstringrequired- Search term or terms, comma-separated (up to 5 for TIMESERIES and GEO_MAP, one for the other data types). Each term is at most 100 characters. Example: coffee,tea
asyncboolean- Set true to submit the search and return at once with only search_metadata (id and status Processing); fetch the results later with serpapi_search_archive_get using search_metadata.id. Do not combine with no_cache. Example: false
catinteger- Category ID to limit the data to, from Google Trends' category list. 0 (default) means all categories. Example: 71 (Food & Drink)
data_typestring- Kind of data: TIMESERIES interest over time (default), GEO_MAP comparison by region (2 to 5 terms), GEO_MAP_0 interest by region (one term), RELATED_TOPICS or RELATED_QUERIES (one term).one of
TIMESERIESGEO_MAPGEO_MAP_0RELATED_TOPICSRELATED_QUERIES datestring- Time range: now 1-H, now 4-H, now 1-d, now 7-d, today 1-m, today 3-m, today 12-m (default), today 5-y, all (since 2004), or a custom range yyyy-mm-dd yyyy-mm-dd. Example: today 3-m
geostring- Location code, such as a country (US) or region (US-CA). Worldwide when omitted. Example: US
gpropstring- Google property to measure: web search when omitted, or images, news, froogle (Google Shopping) or youtube.one of
imagesnewsfroogleyoutube hlstring- Language code for the results (Google's hl parameter): a two-letter language code, optionally with a region, such as en, fr, en-gb or es-419. Example: en
include_low_search_volumeboolean- Set true to include regions with low search volume. Only applies to GEO_MAP and GEO_MAP_0. Example: true
json_restrictorstring- Limit the response to the listed fields to keep it small, using SerpApi's JSON Restrictor syntax: comma-separated top-level keys, with dots, brackets and braces for nested fields. Example: organic_results[0:5].{title,link,snippet}
no_cacheboolean- Set true to force a fresh search instead of a cached result. SerpApi serves an identical search run in the last hour from its cache for free; a fresh search spends one search credit. Do not combine with async. Example: false
regionstring- Region level for GEO_MAP and GEO_MAP_0: COUNTRY, REGION, DMA or CITY. Not every level has data for every location.one of
COUNTRYREGIONDMACITY tzinteger- Time zone offset in minutes from UTC, with the sign reversed as in JavaScript (420 is UTC-7, -540 is UTC+9). Range -1439 to 1439; SerpApi uses 420 when omitted. Example: 0
serpapi_locations_searchFind SerpApi location names that match a text, for the location input of the search tools.Read-onlySearch Locations
Find SerpApi location names that match a text, for the location input of the search tools. This call is free. Returns a list ordered by reach, each with id, name, canonical_name, country_code, target_type (City, Region, Country and others), reach and gps. Use this to get an exact canonical_name before setting location on serpapi_google_search, serpapi_google_local_search or other search tools.
Inputs
limitinteger- Maximum number of locations to return, up to 10. Example: 5
qstring- Text the location name must contain. Example: Austin
serpapi_search_archive_getGet the results of an earlier SerpApi search by its search ID, for up to 31 days after it ran.Read-onlyGet Archived Search
Get the results of an earlier SerpApi search by its search ID, for up to 31 days after it ran. Returns the same JSON the original search returned, with search_metadata.status of Queued, Processing, Success or Error; results are present once the status is Success. Use this to collect the results of a search sent with async true, or to reread an earlier search without running it again. Get the search ID from search_metadata.id of any SerpApi search tool's result.
Inputs
search_idstringrequired- ID of the earlier search, from search_metadata.id in its result. Example: 5b50d58a304bda2fca30bac9
serpapi_youtube_searchSearch YouTube videos, channels and playlists through SerpApi.Read-onlyYouTube Search
Search YouTube videos, channels and playlists through SerpApi. Returns video_results with position_on_page, title, link, channel (name, link), published_date, views, length, description and thumbnail, plus channel_results, playlist_results, shorts_results and serpapi_pagination with an sp token for the next page. Use this to find videos on a topic. Use serpapi_google_search with a video query for videos hosted elsewhere.
Inputs
search_querystringrequired- The YouTube search query. Example: how to repot a monstera
asyncboolean- Set true to submit the search and return at once with only search_metadata (id and status Processing); fetch the results later with serpapi_search_archive_get using search_metadata.id. Do not combine with no_cache. Example: false
glstring- Two-letter country code (Google's gl parameter, lowercase) that sets which country's results to return. Example: us
hlstring- Language code for the results (Google's hl parameter): a two-letter language code, optionally with a region, such as en, fr, en-gb or es-419. Example: en
json_restrictorstring- Limit the response to the listed fields to keep it small, using SerpApi's JSON Restrictor syntax: comma-separated top-level keys, with dots, brackets and braces for nested fields. Example: organic_results[0:5].{title,link,snippet}
no_cacheboolean- Set true to force a fresh search instead of a cached result. SerpApi serves an identical search run in the last hour from its cache for free; a fresh search spends one search credit. Do not combine with async. Example: false
spstring- YouTube filter or pagination token: the sp value from serpapi_pagination of a previous result for the next page, or a filter copied from a YouTube URL's sp parameter, URL-decoded (CAI= sort by upload date, EgJwAQ== 4K, QgIIAQ== exact spelling). Pass it decoded, for example CAI= rather than CAI%3D, because the value is URL-encoded when sent. Example: CAI=
No tools match.