SerpAPI Search API

https://serpapi.com/search-api
Admin
SerpAPI Search API allows developers to scrape and access search results from Google and other...
Tokens:8,289
Snippets:61
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Google Search API JSON Response Example

Source: https://serpapi.com/search-api

This is an example of the JSON response you can expect from the SerpApi Google Search API. It includes metadata, search parameters, and various result types like recipes and shopping items.

```JSON
{
  "search_metadata": {
    "id": "61afb3ace7d08a685b3bcbb1",
    "status": "Success",
    "json_endpoint": "https://serpapi.com/searches/c292c1c1fe17fc58/61afb3ace7d08a685b3bcbb1.json",
    "created_at": "2021-12-07 19:19:08 UTC",
    "processed_at": "2021-12-07 19:19:08 UTC",
    "google_url": "https://www.google.com/search?q=coffee&oq=coffee&uule=w+CAIQICIaQXVzdGluLFRleGFzLFVuaXRlZCBTdGF0ZXM&hl=en&gl=us&sourceid=chrome&ie=UTF-8",
    "raw_html_file": "https://serpapi.com/searches/c292c1c1fe17fc58/61afb3ace7d08a685b3bcbb1.html",
    "total_time_taken": 1.52
  },
  "search_parameters": {
    "engine": "google",
    "q": "coffee",
    "location_requested": "Austin, Texas, United States",
    "location_used": "Austin,Texas,United States",
    "google_domain": "google.com",
    "hl": "en",
    "gl": "us",
    "device": "desktop"
  },
  "search_information": {
    "organic_results_state": "Results for exact spelling",
    "query_displayed": "coffee",
    "total_results": 1340000000,
    "time_taken_displayed": 0.99
  },
  "recipes_results": [
    {
      "title": "Bulletproof Coffee Recipe",
      "link": "https://www.bulletproof.com/recipes/bulletproof-diet-recipes/bulletproof-coffee-recipe/",
      "source": "Bulletproof",
      "total_time": "5 min",
      "ingredients": [
        "Mct oil",
        "bulletproof coffee",
        "grass fed"
      ],
      "thumbnail": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTBL6y0xwQPtXHfPXpTETKfmTlFKCc53AZ66YJ4wmBf4BZQbMmR2szgOg&s=0"
    },
    {
      "title": "Whipped Coffee",
      "link": "https://cooking.nytimes.com/recipes/1021005-whipped-coffee",
      "source": "NYT Cooking - The New York Times",
      "rating": 4,
      "reviews": 770,
      "ingredients": [
        "Instant coffee",
        "ice",
        "milk",
        "hot water"
      ],
      "thumbnail": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRfvf7kwy5yjTVCoKUpROKBXX2UY9TH4Ko0WIxieGKGIwKUkgAxaTwTdg&s=0"
    },
    {
      "title": "Coffee recipes",
      "link": "https://www.bbcgoodfood.com/recipes/collection/coffee-recipes",
      "source": "BBC Good Food",
      "ingredients": [
        "Instant coffee"
      ],
      "thumbnail": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSlgcwczn4_p-f4SEiHM8jGoIGyUiTuTxTrsGvsggtcbkyGqk5wkLRsjw&s=0"
    }
  ],
  "shopping_results": [
    {
      "position": 1,
      "block_position": "top",
      "title": "mudwtr.com - MUD\WTR | Mushroom Coffee Alternative, 30 servings",
      "price": "$50.00",
      "extracted_price": 50,
      "link": "https://www.google.com/aclk?sa=l&ai=DChcSEwiZtL6MtNL0AhWBn7MKHTqRDpEYABAEGgJxbg&ae=2&sig=AOD64_2QRwv8qgRnd6Jr65C9UhyHPLwhXA&ctype=5&q=&ved=2ahUKEwi3g66MtNL0AhX7qpUCHdSwBGIQ5bgDegQIAhA9&adurl=",
      "source": "mudwtr.com",
      "reviews": 6000,
      "thumbnail": "https://serpapi.com/searches/61afb3ace7d08a685b3bcbb1/images/3dfd005c088bc5e4e2b7ab1c2868aa47743a6687f658162aac59c78c75d56d1d.png"
    },
    {
      "position": 2,
      "block_position": "top",
      "title": "mudwtr.com - MUD\WTR | Mushroom Coffee Replacement, 90 servings",
      "price": "$125.00",
      "extracted_price": 125,
      "link": "https://www.google.com/aclk?sa=l&ai=DChcSEwiZtL6MtNL0AhWBn7MKHTqRDpEYABADGgJxbg&ae=2&sig=AOD64_37xmneT6EL2jcvAGOifAFCwRsKLg&ctype=5&q=&ved=2ahUKEwi3g66MtNL0AhX7qpUCHdSwBGIQ5bgDegQIAhBI&adurl=",
      "source": "mudwtr.com",
      "reviews": 2000,
      "thumbnail": "https://serpapi.com/searches/61afb3ace7d08a685b3bcbb1/images/3dfd005c088bc5e4e2b7ab1c2868aa4728d69aa6f14be4eb6102830c5aa2461d.jpeg"
    },
    {
      "position": 3,
      "block_position": "top",
      "title": "Angelino's Coffee - 96ct Flavored Coffee Experience",
      "price": "$49.95",
      "extracted_price": 49.95,
      "link": "https://www.google.com/aclk?sa=l&ai=DChcSEwiZtL6MtNL0AhWBn7MKHTqRDpEYABAFGgJxbg&ae=2&sig=AOD64_0OyhR7klpz0J1QXcXRHdOf6zGtAA&ctype=5&q=&ved=2ahUKEwi3g66MtNL0AhX7qpUCHdSwBGIQ5bgDegQIAhBT&adurl=",
      "source": "Angelino's Coffee",
      "reviews": 55,
      "thumbnail": "https://serpapi.com/searches/61afb3ace7d08a685b3bcbb1/images/3dfd005c088bc5e4e2b7ab1c2868aa4785ccdcf05a2f2c29fef1863c2e52c20a.png"
    }
  ],
  "local_map": {
    "link": "https://www.google.com/search?gl=us&hl=en&q=coffee&npsic=0&rflfq=1&rldoc=1&rllag=30267485,-97742560,126&tbm=lcl&sa=X&ved=2ahUKEwi3g66MtNL0AhX7qpUCHdSwBGIQtgN6BAgfEAc"
  }
}

```

--------------------------------

### Example JSON Response

Source: https://serpapi.com/search-api

A sample JSON response structure returned by the SerpApi search endpoint.

```JSON
{
  "search_metadata": {
    "id": "62d5efcae7d08a486c7b86ad",
    "status": "Success",
    "json_endpoint": "https://serpapi.com/searches/3ed30d31b62f3cfd/62d5efcae7d08a486c7b86ad.json",
    "created_at": "2022-07-18 23:42:02 UTC",
    "processed_at": "2022-07-18 23:42:02 UTC",
    "google_url": "https://www.google.com/search?q=Fresh+Bagels&oq=Fresh+Bagels&uule=w+CAIQICIqU2VhdHRsZS1UYWNvbWEsV0EsV2FzaGluZ3RvbixVbml0ZWQgU3RhdGVz&hl=en&gl=us&safe=active&start=10&sourceid=chrome&ie=UTF-8",
    "raw_html_file": "https://serpapi.com/searches/3ed30d31b62f3cfd/62d5efcae7d08a486c7b86ad.html",
    "total_time_taken": 1.35
  },
  "search_parameters": {
    "engine": "google",
    "q": "Fresh Bagels",
    "location_requested": "Seattle-Tacoma, WA, Washington, United States",
    "location_used": "Seattle-Tacoma,WA,Washington,United States",
    "google_domain": "google.com",
    "hl": "en",
    "gl": "us",
    "safe": "active",
    "start": 10,
    "device": "desktop"
  },
  "search_information": {
    "organic_results_state": "Results for exact spelling",
    "query_displayed": "Fresh Bagels",
    "total_results": 200000000,
    "page_number": 2,
    "time_taken_displayed": 0.63
  },
  "organic_results": [
    {
      "position": 1,
      "title": "The 7 Best Bagel Shops In Seattle - boam",
      "link": "https://boam.com/wa/seattle/best-bagel-shops/",
      "redirect_link": "https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=&cad=rja&uact=8&ved=2ahUKEwj2ht67sK2DAxXlF1kFHZNwCNMQFnoECA4QAQ&url=https%3A%2F%2Fboam.com%2Fwa%2Fseattle%2Fbest-bagel-shops%2F&usg=AOvVaw1G5PhqPw6TVos-9iAP_inH&opi=89978449"
      "displayed_link": "https://boam.com › WA › Seattle",
      "thumbnail": "https://serpapi.com/searches/62d5efcae7d08a486c7b86ad/images/02306781b6e93635966d70cf70c16bc2e20ef7a5b15f3cc76dc37b5107d6e34b.jpeg",
      "date": "May 2, 2022",
      "snippet": "Zylberschtein's Delicatessen & Bakery · The Ultimate List of the Best Bagels In Seattle, Ranked · Seattle Actually Has a Bagel Scene Now.",
      "snippet_highlighted_words": [
        "Best Bagels"
      ],
      "about_this_result": {
        "source": {
          "description": "boam.com was first indexed by Google more than 10 years ago",
          "icon": "https://serpapi.com/searches/62d5efcae7d08a486c7b86ad/images/02306781b6e93635966d70cf70c16bc2538e80db255d5d8270fc12ca4267e08fb2f662f2667d2872a277b3d2ec9557e9.png"
        },
        "keywords": [
          "bagels"
        ],
        "related_keywords": [
          "bagel"
        ],
        "languages": [
          "English"
        ],
        "regions": [
          "the United States"
        ]
      },
      "about_page_link": "https://www.google.com/search?q=About+https://boam.com/wa/seattle/best-bagel-shops/&tbm=ilp&ilps=ADNMCi0YHj-gX85Ugpr7byPA3OZJqM5buA",
      "about_page_serpapi_link": "https://serpapi.com/search.json?engine=google_about_this_result&ilps=ADNMCi0YHj-gX85Ugpr7byPA3OZJqM5buA&q=About+https://boam.com/wa/seattle/best-bagel-shops/",
      "cached_page_link": "https://webcache.googleusercontent.com/search?q=cache:_46756rn-DYJ:https://boam.com/wa/seattle/best-bagel-shops/+&cd=11&hl=en&ct=clnk&gl=us"
    },
    {
      "position": 2,
      "title": "Einstein Bros. Bagels: Home",
      "link": "https://www.einsteinbros.com/",
      "redirect_link": "https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=&cad=rja&uact=8&ved=2ahUKEwjmqP3Hsa2DAxWIF1kFHeISDdEQFnoECBUQAQ&url=https%3A%2F%2Fwww.einsteinbros.com%2F&usg=AOvVaw295ghVT-PGz-aBzCNE_CWq&opi=89978449",
      "displayed_link": "https://www.einsteinbros.com",
      "snippet": "Couple eating Einstein Bros. bagel egg sandwiches with coffee ... Our Menu. Fresh-Baked Bagels, Specialty Sandwiches, Coffee and more.",
      "snippet_highlighted_words": [
        "bagel",
        "Fresh",
        "Bagels"
      ]
```

--------------------------------

### GET /search.json

Source: https://serpapi.com/search-api

Performs a Google search using the specified query and location parameters.

```APIDOC
## GET /search.json

### Description
Performs a Google search and returns the results in JSON format.

### Method
GET

### Endpoint
https://serpapi.com/search.json

### Parameters
#### Query Parameters
- **q** (string) - Required - The search query.
- **location** (string) - Optional - The geographic location for the search origin.
- **uule** (string) - Optional - The Google encoded location.
- **lat** (string) - Optional - GPS latitude for the search origin.
- **lon** (string) - Optional - GPS longitude for the search origin.
- **radius** (integer) - Optional - The distance in meters to bias search results.
- **engine** (string) - Optional - The search engine to use (e.g., google).
- **google_domain** (string) - Optional - The Google domain to use.
- **hl** (string) - Optional - The language of the search.
- **gl** (string) - Optional - The country to use for the search.
- **start** (integer) - Optional - The result offset for pagination.
```

--------------------------------

### Perform a Google Search via HTTP GET

Source: https://serpapi.com/search-api

A direct URL request to the SerpApi endpoint with multiple search parameters.

```HTTP
https://serpapi.com/search.json?engine=google&q=Fresh+Bagels&location=Seattle-Tacoma,+WA,+Washington,+United+States&hl=en&gl=us&google_domain=google.com&start=10&safe=active
```

--------------------------------

### Direct Google Search API GET Request

Source: https://serpapi.com/search-api

This is a direct GET request to the SerpApi Google Search API. It's useful for quick tests or when you don't need to integrate into a larger application.

```HTTP
https://serpapi.com/search.json?engine=google&q=Coffee
```

--------------------------------

### Integrate SerpApi with Ruby

Source: https://serpapi.com/search-api

Integrate SerpApi into your Ruby projects. Ensure you have the 'serpapi' gem installed and provide your API key. This snippet demonstrates a basic search for 'Coffee'.

```Ruby
require "serpapi" 

client = SerpApi::Client.new(
  engine: "google",
  q: "Coffee",
  location: "Austin, Texas, United States",
  google_domain: "google.com",
  hl: "en",
  gl: "us",
  api_key: "secret_api_key"
)

results = client.search
```

--------------------------------

### Basic Google Search URL

Source: https://serpapi.com/search-api

This is a basic example of a Google search URL using the SerpApi. It specifies the engine, search query, location, and Google domain.

```URL
https://serpapi.com/search.json?engine=google&q=Coffee&location=Austin,+Texas,+United+States&google_domain=google.com&hl=en&gl=us
```

--------------------------------

### Integrate Google Search API with Ruby

Source: https://serpapi.com/search-api

This Ruby code snippet demonstrates how to use the SerpApi client to perform a Google search for 'Coffee'. Ensure you have the 'serpapi' gem installed and replace 'secret_api_key' with your actual API key.

```Ruby
require "serpapi"

client = SerpApi::Client.new(
  engine: "google",
  q: "Coffee",
  api_key: "secret_api_key"
)

results = client.search
organic_results = results[:organic_results]

```

--------------------------------

### GET /search

Source: https://serpapi.com/search-api

Endpoint to perform a search query using the SerpApi engine with various configuration parameters.

```APIDOC
## GET /search

### Description
Perform a search query using the SerpApi engine. This endpoint supports various configuration parameters to control the device, caching, and output format.

### Method
GET

### Endpoint
/search

### Parameters
#### Query Parameters
- **api_key** (string) - Required - The SerpApi private key.
- **engine** (string) - Optional - The search engine to use (default: google).
- **device** (string) - Optional - Device type: desktop (default), tablet, or mobile.
- **no_cache** (boolean) - Optional - Force fetch results even if cached (default: false).
- **async** (boolean) - Optional - Submit search and retrieve later (default: false).
- **zero_trace** (boolean) - Optional - Enterprise only: skip storing search metadata (default: false).
- **output** (string) - Optional - Format of the results: json (default) or html.

### Response
#### Success Response (200)
- **search_metadata** (object) - Contains search status and ID.
- **organic_results** (array) - Structured organic search results.
- **local_results** (object) - Local search results.
- **ad_results** (array) - Ad search results.
- **knowledge_graph** (object) - Knowledge graph data.
- **direct_answer_box** (object) - Direct answer box content.
- **images_results** (array) - Image search results.
- **news_results** (array) - News search results.
- **shopping_results** (array) - Shopping search results.
- **video_results** (array) - Video search results.
```

--------------------------------

### Google Search API JSON Response

Source: https://serpapi.com/search-api

Example of the structured JSON data returned by the Google Search API, containing search metadata, parameters, and local results.

```json
{
  "search_metadata": {
    "id": "695925908c24bd247f1be798",
    "status": "Success",
    "json_endpoint": "https://serpapi.com/searches/0da7852b459370f1/695925908c24bd247f1be798.json",
    "created_at": "2026-01-03 14:20:00 UTC",
    "processed_at": "2026-01-03 14:20:00 UTC",
    "google_url": "https://www.google.com/search?q=Coffee&oq=Coffee&uule=w+CAIQICIaQXVzdGluLFRleGFzLFVuaXRlZCBTdGF0ZXM&sourceid=chrome&ie=UTF-8",
    "raw_html_file": "https://serpapi.com/searches/0da7852b459370f1/695925908c24bd247f1be798.html",
    "total_time_taken": 0.86
  },
  "search_parameters": {
    "engine": "google",
    "q": "Coffee",
    "location_requested": "Austin, Texas, United States",
    "location_used": "Austin,Texas,United States",
    "google_domain": "google.com",
    "device": "desktop"
  },
  "search_information": {
    "query_displayed": "Coffee",
    "total_results": 3140000000,
    "time_taken_displayed": 0.34,
    "organic_results_state": "Results for exact spelling",
    "results_for": "Austin, TX"
  },
  "local_map": {
    "link": "https://www.google.com/search?q=Coffee&sca_esv=82729a62d7e47fe1&udm=1&lsack=kyVZaaXZMJixqtsPiOfE0AY&sa=X&ved=2ahUKEwjl7omtyO-RAxWYmGoFHYgzEWoQtgN6BAgzEAM",
    "image": "https://serpapi.com/searches/695925908c24bd247f1be798/images/876a39b5911b0f0e2081f6a0b5bbc2e2.png",
    "gps_coordinates": {
      "latitude": 30.27196615,
      "longitude": -97.74716377
    }
  },
  "local_results": {
    "places": [
      {
        "position": 1,
        "rating": 4.5,
        "reviews": 1200,
        "reviews_original": "(1.2K)",
        "price": "$1–10",
        "description": "Cozy hangout for carefully sourced brews",
        "lsig": "AB86z5Vdw6C2pJpM0xQ6JUx2KONU",
        "thumbnail": "https://serpapi.com/searches/695925908c24bd247f1be798/images/3755275d949c7f5c6d1fa19931f37f8e632f6c78db8189f8418783af89d224382e588be7effee25f.jpeg",
        "place_id": "11265938073076301333",
        "place_id_search": "https://serpapi.com/search.json?device=desktop&engine=google&google_domain=google.com&location=Austin%2C+Texas%2C+United+States&ludocid=11265938073076301333&q=Coffee",
        "gps_coordinates": {
          "latitude": 30.266216,
          "longitude": -97.743065
        },
        "title": "Houndstooth Coffee",
        "type": "Coffee shop",
        "address": "401 Congress Ave. #100c"
      },
      {
        "position": 2,
        "rating": 4.3,
        "reviews": 655,
        "reviews_original": "(655)",
        "price": "$1–10",
        "description": "Area institution with a theater upstairs",
        "lsig": "AB86z5WSxdnDKVF_iLXNN6Lg0UQ5",
        "thumbnail": "https://serpapi.com/searches/695925908c24bd247f1be798/images/3755275d949c7f5c6d1fa19931f37f8ecac8bb5798c112f1b4b6800b45dd719422dcbcd8cda3e53e.jpeg",
        "place_id": "15498522356495312950",
        "place_id_search": "https://serpapi.com/search.json?device=desktop&engine=google&google_domain=google.com&location=Austin%2C+Texas%2C+United+States&ludocid=15498522356495312950&q=Coffee",
        "gps_coordinates": {
          "latitude": 30.268621,
          "longitude": -97.74239
        },
        "title": "The Hideout Coffee House",
        "type": "Coffee shop",
        "address": "617 Congress Ave."
      },
      {
        "position": 3,
        "rating": 4.4,
        "reviews": 1400,
        "reviews_original": "(1.4K)",
        "price": "$10–20",
        "description": "Coffee & snacks in a vibrant space",
        "lsig": "AB86z5W-D9ge8F2-bWtU5dLVhQZd",
        "thumbnail": "https://serpapi.com/searches/695925908c24bd247f1be798/images/3755275d949c7f5c6d1fa19931f37f8e73ac9935d17dd78dbf477c1d6152746ddc6107ad71f98895.jpeg",
        "place_id": "12201203717436125290",
        "place_id_search": "https://serpapi.com/search.json?device=desktop&engine=google&google_domain=google.com&location=Austin%2C+Texas%2C+United+States&ludocid=12201203717436125290&q=Coffee",
        "gps_coordinates": {
          "latitude": 30.265017,
          "longitude": -97.746086
        },
        "title": "Jo's Coffee – Downtown",
        "type": "Coffee shop",
        "address": "242 W 2nd St"
      }
    ]
  }
}
```

--------------------------------

### Perform a Google Search with Ruby

Source: https://serpapi.com/search-api

Using the SerpApi Ruby client to execute a search with specific parameters.

```Ruby
require "serpapi" 

client = SerpApi::Client.new(
  engine: "google",
  q: "Fresh Bagels",
  location: "Seattle-Tacoma, WA, Washington, United States",
  hl: "en",
  gl: "us",
  google_domain: "google.com",
  start: "10",
  safe: "active",
  api_key: "secret_api_key"
)

results = client.search
organic_results = results[:organic_results]
```

--------------------------------

### Google Search API Parameters

Source: https://serpapi.com/search-api

A comprehensive list of query parameters used to refine Google search requests via SerpApi.

```APIDOC
## GET /search

### Description
Refine Google search results using advanced parameters for localization, filtering, and specific search types.

### Method
GET

### Endpoint
/search

### Parameters
#### Query Parameters
- **ludocid** (string) - Optional - Google CID (customer identifier) of a place.
- **lsig** (string) - Optional - ID to force knowledge graph map view.
- **kgmid** (string) - Optional - Google Knowledge Graph ID.
- **si** (string) - Optional - Cached search parameters.
- **ibp** (string) - Optional - Parameter for rendering layouts and expansions.
- **uds** (string) - Optional - Filter string provided by Google.
- **google_domain** (string) - Optional - Google domain to use (e.g., google.com).
- **gl** (string) - Optional - Two-letter country code for localization.
- **hl** (string) - Optional - Two-letter language code for localization.
- **cr** (string) - Optional - Country restriction (e.g., countryFR|countryDE).
- **lr** (string) - Optional - Language restriction (e.g., lang_fr|lang_de).
- **tbs** (string) - Optional - Advanced search parameters (dates, news, etc.).
- **safe** (string) - Optional - Adult content filtering (active or off).
- **nfpr** (integer) - Optional - Exclude auto-corrected query results (1 or 0).
- **filter** (integer) - Optional - Enable/disable 'Similar Results' and 'Omitted Results' (1 or 0).
- **tbm** (string) - Optional - Search type (isch, lcl, vid, nws, shop, pts).
- **start** (integer) - Optional - Result offset for pagination.
```
Tokens:
Raw