Skip to main content
GET
/
v1
/
web
/
search
{
  "type": "search",
  "query": {
    "original": "<string>",
    "show_strict_warning": true,
    "altered": "<string>",
    "cleaned": "<string>",
    "safesearch": true,
    "is_navigational": true,
    "is_geolocal": true,
    "local_decision": "<string>",
    "local_locations_idx": 123,
    "is_trending": true,
    "is_news_breaking": true,
    "ask_for_location": true,
    "language": {
      "main": "<string>"
    },
    "spellcheck_off": true,
    "country": "<string>",
    "bad_results": true,
    "should_fallback": true,
    "lat": "<string>",
    "long": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "header_country": "<string>",
    "more_results_available": true,
    "state": "<string>",
    "custom_location_label": "<string>",
    "reddit_cluster": "<string>",
    "summary_key": "<string>",
    "search_operators": {
      "applied": false,
      "cleaned_query": "<string>",
      "sites": [
        "<string>"
      ]
    }
  },
  "discussions": {
    "type": "search",
    "results": [
      {
        "title": "<string>",
        "url": "<string>",
        "is_source_local": false,
        "is_source_both": false,
        "description": "<string>",
        "page_age": "<string>",
        "page_fetched": "<string>",
        "fetched_content_timestamp": 123,
        "profile": {
          "name": "<string>",
          "url": "<string>",
          "long_name": "<string>",
          "img": "<string>"
        },
        "language": "en",
        "family_friendly": true,
        "type": "discussion",
        "subtype": "generic",
        "is_live": false,
        "deep_results": {
          "news": [
            {
              "title": "<any>",
              "url": "<any>",
              "is_source_local": "<any>",
              "is_source_both": "<any>",
              "description": "<any>",
              "page_age": "<any>",
              "page_fetched": "<any>",
              "fetched_content_timestamp": "<any>",
              "profile": "<any>",
              "language": "<any>",
              "family_friendly": "<any>",
              "meta_url": "<any>",
              "source": "<any>",
              "breaking": "<any>",
              "is_live": "<any>",
              "thumbnail": "<any>",
              "age": "<any>",
              "extra_snippets": "<any>",
              "icons": "<any>"
            }
          ],
          "buttons": [
            {
              "type": "<any>",
              "title": "<any>",
              "url": "<any>"
            }
          ],
          "videos": [
            {
              "title": "<any>",
              "url": "<any>",
              "is_source_local": "<any>",
              "is_source_both": "<any>",
              "description": "<any>",
              "page_age": "<any>",
              "page_fetched": "<any>",
              "fetched_content_timestamp": "<any>",
              "profile": "<any>",
              "language": "<any>",
              "family_friendly": "<any>",
              "type": "<any>",
              "video": "<any>",
              "meta_url": "<any>",
              "thumbnail": "<any>",
              "age": "<any>",
              "publisher": "<any>"
            }
          ],
          "images": [
            {
              "thumbnail": "<any>",
              "url": "<any>",
              "properties": "<any>"
            }
          ]
        },
        "schemas": [
          "<any>"
        ],
        "meta_url": {},
        "thumbnail": {
          "src": "<string>",
          "alt": "<any>",
          "height": "<any>",
          "width": "<any>",
          "bg_color": "<any>",
          "original": "<any>",
          "logo": "<any>",
          "duplicated": "<any>",
          "theme": "<any>"
        },
        "age": "<string>",
        "location": {
          "title": "<string>",
          "url": "<string>",
          "is_source_local": false,
          "is_source_both": false,
          "description": "<string>",
          "page_age": "<string>",
          "page_fetched": "<string>",
          "fetched_content_timestamp": 123,
          "profile": {
            "name": "<string>",
            "url": "<string>",
            "long_name": "<string>",
            "img": "<string>"
          },
          "language": "<string>",
          "family_friendly": true,
          "type": "location_result",
          "provider_url": "<string>",
          "coordinates": [
            "<any>"
          ],
          "zoom_level": 7,
          "thumbnail": {
            "src": "<string>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "postal_address": {
            "type": "<string>",
            "country": "<string>",
            "postalCode": "<string>",
            "streetAddress": "<string>",
            "addressRegion": "<string>",
            "addressLocality": "<string>",
            "displayAddress": "<string>"
          },
          "opening_hours": {
            "current_day": [
              "<any>"
            ],
            "days": [
              "<any>"
            ]
          },
          "contact": {
            "email": "<string>",
            "telephone": "<string>"
          },
          "price_range": "<string>",
          "rating": {
            "ratingValue": 1,
            "bestRating": 1,
            "reviewCount": 123,
            "profile": {
              "name": "<any>",
              "url": "<any>",
              "long_name": "<any>",
              "img": "<any>"
            },
            "is_tripadvisor": true
          },
          "distance": {
            "value": 123,
            "units": "<string>"
          },
          "profiles": [
            {
              "type": "<any>",
              "name": "<any>",
              "url": "<any>",
              "long_name": "<any>",
              "img": "<any>"
            }
          ],
          "reviews": {
            "results": [
              "<any>"
            ],
            "viewMoreUrl": "<string>",
            "reviews_in_foreign_language": true
          },
          "pictures": {
            "viewMoreUrl": "<string>",
            "results": [
              "<any>"
            ]
          },
          "action": {
            "type": "<string>",
            "url": "<string>"
          },
          "serves_cuisine": [
            "<string>"
          ],
          "categories": [],
          "icon_category": "<string>",
          "timezone": "<string>",
          "timezone_offset": 123,
          "id": "<string>",
          "results": [
            {
              "title": "<any>",
              "url": "<any>",
              "is_source_local": "<any>",
              "is_source_both": "<any>",
              "description": "<any>",
              "page_age": "<any>",
              "page_fetched": "<any>",
              "fetched_content_timestamp": "<any>",
              "profile": "<any>",
              "language": "<any>",
              "family_friendly": "<any>",
              "meta_url": "<any>"
            }
          ]
        },
        "restaurant": {
          "title": "<string>",
          "url": "<string>",
          "is_source_local": true,
          "is_source_both": true,
          "description": "<string>",
          "page_age": "<string>",
          "page_fetched": "<string>",
          "fetched_content_timestamp": 123,
          "profile": {
            "name": "<string>",
            "url": "<string>",
            "long_name": "<string>",
            "img": "<string>"
          },
          "language": "<string>",
          "family_friendly": true,
          "type": "<string>",
          "provider_url": "<string>",
          "coordinates": [
            "<any>"
          ],
          "zoom_level": 123,
          "thumbnail": {
            "src": "<string>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "postal_address": {
            "type": "<string>",
            "country": "<string>",
            "postalCode": "<string>",
            "streetAddress": "<string>",
            "addressRegion": "<string>",
            "addressLocality": "<string>",
            "displayAddress": "<string>"
          },
          "opening_hours": {
            "current_day": [
              "<any>"
            ],
            "days": [
              "<any>"
            ]
          },
          "contact": {
            "email": "<string>",
            "telephone": "<string>"
          },
          "price_range": "<string>",
          "rating": {
            "ratingValue": 1,
            "bestRating": 1,
            "reviewCount": 123,
            "profile": {},
            "is_tripadvisor": true
          },
          "distance": {
            "value": 123,
            "units": "<string>"
          },
          "profiles": [
            {
              "type": "<any>",
              "name": "<any>",
              "url": "<any>",
              "long_name": "<any>",
              "img": "<any>"
            }
          ],
          "reviews": {
            "results": [
              "<any>"
            ],
            "viewMoreUrl": "<string>",
            "reviews_in_foreign_language": true
          },
          "pictures": {
            "viewMoreUrl": "<string>",
            "results": [
              "<any>"
            ]
          },
          "action": {
            "type": "<string>",
            "url": "<string>"
          },
          "serves_cuisine": [
            "<string>"
          ],
          "categories": [
            "<string>"
          ],
          "icon_category": "<string>",
          "timezone": "<string>",
          "timezone_offset": 123,
          "id": "<string>",
          "results": [
            {
              "title": "<any>",
              "url": "<any>",
              "is_source_local": "<any>",
              "is_source_both": "<any>",
              "description": "<any>",
              "page_age": "<any>",
              "page_fetched": "<any>",
              "fetched_content_timestamp": "<any>",
              "profile": "<any>",
              "language": "<any>",
              "family_friendly": "<any>",
              "meta_url": "<any>"
            }
          ]
        },
        "video": {
          "duration": "<any>",
          "views": "<any>",
          "creator": "<any>",
          "publisher": "<any>",
          "thumbnail": "<any>",
          "tags": "<any>",
          "author": "<any>",
          "requires_subscription": "<any>"
        },
        "movie": {
          "name": "<string>",
          "description": "<string>",
          "url": "<string>",
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "release": "<string>",
          "directors": [
            {}
          ],
          "actors": [
            {}
          ],
          "rating": {
            "ratingValue": 1,
            "bestRating": 1,
            "reviewCount": 123,
            "profile": {},
            "is_tripadvisor": true
          },
          "duration": "<string>",
          "genre": [
            "<string>"
          ],
          "query": "<string>"
        },
        "faq": {
          "items": [
            {
              "question": "<any>",
              "answer": "<any>",
              "title": "<any>",
              "url": "<any>",
              "meta_url": "<any>"
            }
          ]
        },
        "qa": {
          "question": "<string>",
          "answer": {
            "text": "<string>",
            "author": "<string>",
            "upvoteCount": 123,
            "downvoteCount": 123
          }
        },
        "book": {
          "title": "<string>",
          "author": [
            {
              "type": "<any>",
              "name": "<any>",
              "url": "<any>",
              "thumbnail": "<any>",
              "email": "<any>"
            }
          ],
          "date": "<string>",
          "price": {
            "price": "<string>",
            "priceCurrency": "<string>"
          },
          "pages": 123,
          "publisher": {
            "type": "<string>",
            "name": "<string>",
            "url": "<string>",
            "thumbnail": {},
            "email": "<string>"
          },
          "rating": {
            "ratingValue": 1,
            "bestRating": 1,
            "reviewCount": 123,
            "profile": {
              "name": "<any>",
              "url": "<any>",
              "long_name": "<any>",
              "img": "<any>"
            },
            "is_tripadvisor": true
          }
        },
        "rating": {
          "ratingValue": 1,
          "bestRating": 1,
          "reviewCount": 123,
          "profile": {
            "name": "<any>",
            "url": "<any>",
            "long_name": "<any>",
            "img": "<any>"
          },
          "is_tripadvisor": true
        },
        "article": {
          "author": [
            {
              "type": "<any>",
              "name": "<any>",
              "url": "<any>",
              "thumbnail": "<any>",
              "email": "<any>"
            }
          ],
          "date": "<string>",
          "publisher": {
            "type": "<string>",
            "name": "<string>",
            "url": "<string>",
            "thumbnail": {
              "src": "<any>",
              "alt": "<any>",
              "height": "<any>",
              "width": "<any>",
              "bg_color": "<any>",
              "original": "<any>",
              "logo": "<any>",
              "duplicated": "<any>",
              "theme": "<any>"
            },
            "contact_points": [
              "<any>"
            ]
          },
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "isAccessibleForFree": true
        },
        "product": {
          "type": "Product",
          "name": "<string>",
          "url": "<string>",
          "category": "<string>",
          "price": "<string>",
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "description": "<string>",
          "offers": [],
          "rating": {
            "ratingValue": "<any>",
            "bestRating": "<any>",
            "reviewCount": "<any>",
            "profile": "<any>",
            "is_tripadvisor": "<any>"
          }
        },
        "product_cluster": [
          {
            "type": "<string>",
            "name": "<string>",
            "url": "<string>",
            "category": "<string>",
            "price": "<string>",
            "thumbnail": {
              "src": "<any>",
              "alt": "<any>",
              "height": "<any>",
              "width": "<any>",
              "bg_color": "<any>",
              "original": "<any>",
              "logo": "<any>",
              "duplicated": "<any>",
              "theme": "<any>"
            },
            "description": "<string>",
            "offers": [
              "<any>"
            ],
            "rating": {
              "ratingValue": "<any>",
              "bestRating": "<any>",
              "reviewCount": "<any>",
              "profile": "<any>",
              "is_tripadvisor": "<any>"
            }
          }
        ],
        "cluster_type": "<string>",
        "cluster": [
          {
            "title": "<string>",
            "url": "<string>",
            "is_source_local": true,
            "is_source_both": true,
            "description": "<string>",
            "page_age": "<string>",
            "page_fetched": "<string>",
            "fetched_content_timestamp": 123,
            "profile": {
              "name": "<any>",
              "url": "<any>",
              "long_name": "<any>",
              "img": "<any>"
            },
            "language": "<string>",
            "family_friendly": true
          }
        ],
        "creative_work": {
          "name": "<string>",
          "rating": {
            "ratingValue": "<any>",
            "bestRating": "<any>",
            "reviewCount": "<any>",
            "profile": "<any>",
            "is_tripadvisor": "<any>"
          },
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          }
        },
        "music_recording": {
          "name": "<string>",
          "rating": {
            "ratingValue": "<any>",
            "bestRating": "<any>",
            "reviewCount": "<any>",
            "profile": "<any>",
            "is_tripadvisor": "<any>"
          },
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          }
        },
        "review": {
          "type": "<string>",
          "name": "<string>",
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "description": "<string>",
          "rating": {
            "ratingValue": "<any>",
            "bestRating": "<any>",
            "reviewCount": "<any>",
            "profile": "<any>",
            "is_tripadvisor": "<any>"
          }
        },
        "recipe": {
          "title": "<string>",
          "description": "<string>",
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "url": "<string>",
          "domain": "<string>",
          "favicon": "<string>",
          "time": "<string>",
          "prep_time": "<string>",
          "cook_time": "<string>",
          "ingredients": "<string>",
          "instructions": [
            {
              "text": "<any>",
              "name": "<any>",
              "url": "<any>",
              "image": "<any>"
            }
          ],
          "servings": 123,
          "calories": 123,
          "publisher": "<string>",
          "rating": {
            "ratingValue": "<any>",
            "bestRating": "<any>",
            "reviewCount": "<any>",
            "profile": "<any>",
            "is_tripadvisor": "<any>"
          },
          "recipeCategory": "<string>",
          "recipeCuisine": "<string>",
          "video": {
            "duration": "<any>",
            "views": "<any>",
            "creator": "<any>",
            "publisher": "<any>",
            "thumbnail": "<any>",
            "tags": "<any>",
            "author": "<any>",
            "requires_subscription": "<any>"
          }
        },
        "software": {
          "name": "<string>",
          "author": "<string>",
          "version": "<string>",
          "codeRepository": "<string>",
          "homepage": "<string>",
          "datePublished": "<string>",
          "is_npm": true,
          "is_pypi": true,
          "stars": 123,
          "forks": 123,
          "programmingLanguage": "<string>"
        },
        "organization": {
          "type": "<string>",
          "name": "<string>",
          "url": "<string>",
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "contact_points": [
            {}
          ]
        },
        "content_type": "<string>",
        "extra_snippets": [
          "<string>"
        ],
        "icons": [
          {
            "href": "<string>",
            "sizes": "<string>",
            "rel": "<string>",
            "type": "<string>",
            "ext": "<string>"
          }
        ],
        "data": {
          "forum_name": "<string>",
          "num_answers": 123,
          "score": "<string>",
          "title": "<string>",
          "question": "<string>",
          "top_comment": "<string>"
        }
      }
    ],
    "mutated_by_goggles": false
  },
  "faq": {
    "type": "faq",
    "results": [
      {
        "question": "<any>",
        "answer": "<any>",
        "title": "<any>",
        "url": "<any>",
        "meta_url": "<any>"
      }
    ]
  },
  "infobox": {
    "type": "graph",
    "results": [
      {
        "title": "<string>",
        "url": "<string>",
        "is_source_local": false,
        "is_source_both": false,
        "description": "<string>",
        "page_age": "<string>",
        "page_fetched": "<string>",
        "fetched_content_timestamp": 123,
        "profile": {
          "name": "<any>",
          "url": "<any>",
          "long_name": "<any>",
          "img": "<any>"
        },
        "language": "<string>",
        "family_friendly": true,
        "type": "infobox",
        "position": 123,
        "label": "<string>",
        "category": "<string>",
        "long_desc": "<string>",
        "thumbnail": {
          "src": "<any>",
          "alt": "<any>",
          "height": "<any>",
          "width": "<any>",
          "bg_color": "<any>",
          "original": "<any>",
          "logo": "<any>",
          "duplicated": "<any>",
          "theme": "<any>"
        },
        "attributes": [],
        "profiles": [
          {
            "name": "<any>",
            "url": "<any>",
            "long_name": "<any>",
            "img": "<any>"
          }
        ],
        "website_url": "<string>",
        "ratings": [
          {
            "ratingValue": "<any>",
            "bestRating": "<any>",
            "reviewCount": "<any>",
            "profile": "<any>",
            "is_tripadvisor": "<any>"
          }
        ],
        "providers": [
          {
            "type": "<any>",
            "name": "<any>",
            "url": "<any>",
            "long_name": "<any>",
            "img": "<any>"
          }
        ],
        "distance": {
          "value": 123,
          "units": "<string>"
        },
        "images": [
          {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          }
        ],
        "movie": {
          "name": "<string>",
          "description": "<string>",
          "url": "<string>",
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "release": "<string>",
          "directors": [
            {}
          ],
          "actors": [
            {}
          ],
          "rating": {
            "ratingValue": 1,
            "bestRating": 1,
            "reviewCount": 123,
            "profile": {},
            "is_tripadvisor": true
          },
          "duration": "<string>",
          "genre": [
            "<string>"
          ],
          "query": "<string>"
        },
        "subtype": "generic",
        "found_in_urls": [
          "<string>"
        ]
      }
    ]
  },
  "locations": {
    "type": "locations",
    "results": [
      {
        "title": "<string>",
        "url": "<string>",
        "is_source_local": true,
        "is_source_both": true,
        "description": "<string>",
        "page_age": "<string>",
        "page_fetched": "<string>",
        "fetched_content_timestamp": 123,
        "profile": {
          "name": "<string>",
          "url": "<string>",
          "long_name": "<string>",
          "img": "<string>"
        },
        "language": "<string>",
        "family_friendly": true,
        "type": "<string>",
        "provider_url": "<string>",
        "coordinates": [
          "<any>"
        ],
        "zoom_level": 123,
        "thumbnail": {
          "src": "<string>",
          "alt": "<any>",
          "height": "<any>",
          "width": "<any>",
          "bg_color": "<any>",
          "original": "<any>",
          "logo": "<any>",
          "duplicated": "<any>",
          "theme": "<any>"
        },
        "postal_address": {
          "type": "<string>",
          "country": "<string>",
          "postalCode": "<string>",
          "streetAddress": "<string>",
          "addressRegion": "<string>",
          "addressLocality": "<string>",
          "displayAddress": "<string>"
        },
        "opening_hours": {
          "current_day": [
            "<any>"
          ],
          "days": [
            "<any>"
          ]
        },
        "contact": {
          "email": "<string>",
          "telephone": "<string>"
        },
        "price_range": "<string>",
        "rating": {
          "ratingValue": 1,
          "bestRating": 1,
          "reviewCount": 123,
          "profile": {},
          "is_tripadvisor": true
        },
        "distance": {
          "value": 123,
          "units": "<string>"
        },
        "profiles": [
          {}
        ],
        "reviews": {
          "results": [
            "<any>"
          ],
          "viewMoreUrl": "<string>",
          "reviews_in_foreign_language": true
        },
        "pictures": {
          "viewMoreUrl": "<string>",
          "results": [
            "<any>"
          ]
        },
        "action": {
          "type": "<string>",
          "url": "<string>"
        },
        "serves_cuisine": [
          "<string>"
        ],
        "categories": [
          "<string>"
        ],
        "icon_category": "<string>",
        "timezone": "<string>",
        "timezone_offset": 123,
        "id": "<string>",
        "results": [
          {}
        ]
      }
    ],
    "provider": {}
  },
  "mixed": {
    "type": "mixed",
    "main": [
      {
        "type": "<string>",
        "index": 123,
        "all": true
      }
    ],
    "top": [
      {
        "type": "<string>",
        "index": 123,
        "all": true
      }
    ],
    "side": [
      {
        "type": "<string>",
        "index": 123,
        "all": true
      }
    ]
  },
  "news": {
    "type": "news",
    "results": [
      {
        "title": "<any>",
        "url": "<any>",
        "is_source_local": "<any>",
        "is_source_both": "<any>",
        "description": "<any>",
        "page_age": "<any>",
        "page_fetched": "<any>",
        "fetched_content_timestamp": "<any>",
        "profile": "<any>",
        "language": "<any>",
        "family_friendly": "<any>",
        "meta_url": "<any>",
        "source": "<any>",
        "breaking": "<any>",
        "is_live": "<any>",
        "thumbnail": "<any>",
        "age": "<any>",
        "extra_snippets": "<any>",
        "icons": "<any>"
      }
    ],
    "mutated_by_goggles": false
  },
  "videos": {
    "type": "videos",
    "results": [
      {
        "type": "video_result",
        "url": "<string>",
        "title": "<string>",
        "description": "<string>",
        "age": "<string>",
        "page_age": "<string>",
        "page_fetched": "<string>",
        "fetched_content_timestamp": 123,
        "video": {
          "duration": "<string>",
          "views": 123,
          "creator": "<string>",
          "publisher": "<string>",
          "requires_subscription": true,
          "tags": [
            "<string>"
          ],
          "author": {
            "name": "<string>",
            "url": "<string>",
            "long_name": "<string>",
            "img": "<string>"
          }
        },
        "meta_url": {
          "scheme": "<string>",
          "netloc": "<string>",
          "hostname": "<string>",
          "favicon": "<string>",
          "path": "<string>"
        },
        "thumbnail": {
          "src": "<string>",
          "original": "<string>"
        }
      }
    ],
    "mutated_by_goggles": false
  },
  "web": {
    "type": "search",
    "results": [
      {
        "title": "<string>",
        "url": "<string>",
        "is_source_local": false,
        "is_source_both": false,
        "description": "<string>",
        "page_age": "<string>",
        "page_fetched": "<string>",
        "fetched_content_timestamp": 123,
        "profile": {
          "name": "<any>",
          "url": "<any>",
          "long_name": "<any>",
          "img": "<any>"
        },
        "language": "en",
        "family_friendly": true,
        "type": "search_result",
        "subtype": "generic",
        "is_live": false,
        "deep_results": {
          "news": [
            {
              "title": "<any>",
              "url": "<any>",
              "is_source_local": "<any>",
              "is_source_both": "<any>",
              "description": "<any>",
              "page_age": "<any>",
              "page_fetched": "<any>",
              "fetched_content_timestamp": "<any>",
              "profile": "<any>",
              "language": "<any>",
              "family_friendly": "<any>",
              "meta_url": "<any>",
              "source": "<any>",
              "breaking": "<any>",
              "is_live": "<any>",
              "thumbnail": "<any>",
              "age": "<any>",
              "extra_snippets": "<any>",
              "icons": "<any>"
            }
          ],
          "buttons": [
            {
              "type": "<any>",
              "title": "<any>",
              "url": "<any>"
            }
          ],
          "videos": [
            {
              "title": "<any>",
              "url": "<any>",
              "is_source_local": "<any>",
              "is_source_both": "<any>",
              "description": "<any>",
              "page_age": "<any>",
              "page_fetched": "<any>",
              "fetched_content_timestamp": "<any>",
              "profile": "<any>",
              "language": "<any>",
              "family_friendly": "<any>",
              "type": "<any>",
              "video": "<any>",
              "meta_url": "<any>",
              "thumbnail": "<any>",
              "age": "<any>",
              "publisher": "<any>"
            }
          ],
          "images": [
            {
              "thumbnail": "<any>",
              "url": "<any>",
              "properties": "<any>"
            }
          ]
        },
        "schemas": [
          "<any>"
        ],
        "meta_url": {},
        "thumbnail": {
          "src": "<any>",
          "alt": "<any>",
          "height": "<any>",
          "width": "<any>",
          "bg_color": "<any>",
          "original": "<any>",
          "logo": "<any>",
          "duplicated": "<any>",
          "theme": "<any>"
        },
        "age": "<string>",
        "location": {
          "title": "<string>",
          "url": "<string>",
          "is_source_local": true,
          "is_source_both": true,
          "description": "<string>",
          "page_age": "<string>",
          "page_fetched": "<string>",
          "fetched_content_timestamp": 123,
          "profile": {
            "name": "<string>",
            "url": "<string>",
            "long_name": "<string>",
            "img": "<string>"
          },
          "language": "<string>",
          "family_friendly": true,
          "type": "<string>",
          "provider_url": "<string>",
          "coordinates": [
            "<any>"
          ],
          "zoom_level": 123,
          "thumbnail": {
            "src": "<string>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "postal_address": {
            "type": "<string>",
            "country": "<string>",
            "postalCode": "<string>",
            "streetAddress": "<string>",
            "addressRegion": "<string>",
            "addressLocality": "<string>",
            "displayAddress": "<string>"
          },
          "opening_hours": {
            "current_day": [
              "<any>"
            ],
            "days": [
              "<any>"
            ]
          },
          "contact": {
            "email": "<string>",
            "telephone": "<string>"
          },
          "price_range": "<string>",
          "rating": {
            "ratingValue": 1,
            "bestRating": 1,
            "reviewCount": 123,
            "profile": {},
            "is_tripadvisor": true
          },
          "distance": {
            "value": 123,
            "units": "<string>"
          },
          "profiles": [
            {}
          ],
          "reviews": {
            "results": [
              "<any>"
            ],
            "viewMoreUrl": "<string>",
            "reviews_in_foreign_language": true
          },
          "pictures": {
            "viewMoreUrl": "<string>",
            "results": [
              "<any>"
            ]
          },
          "action": {
            "type": "<string>",
            "url": "<string>"
          },
          "serves_cuisine": [
            "<string>"
          ],
          "categories": [
            "<string>"
          ],
          "icon_category": "<string>",
          "timezone": "<string>",
          "timezone_offset": 123,
          "id": "<string>",
          "results": [
            {}
          ]
        },
        "restaurant": {
          "title": "<string>",
          "url": "<string>",
          "is_source_local": true,
          "is_source_both": true,
          "description": "<string>",
          "page_age": "<string>",
          "page_fetched": "<string>",
          "fetched_content_timestamp": 123,
          "profile": {
            "name": "<string>",
            "url": "<string>",
            "long_name": "<string>",
            "img": "<string>"
          },
          "language": "<string>",
          "family_friendly": true,
          "type": "<string>",
          "provider_url": "<string>",
          "coordinates": [
            "<any>"
          ],
          "zoom_level": 123,
          "thumbnail": {
            "src": "<string>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "postal_address": {
            "type": "<string>",
            "country": "<string>",
            "postalCode": "<string>",
            "streetAddress": "<string>",
            "addressRegion": "<string>",
            "addressLocality": "<string>",
            "displayAddress": "<string>"
          },
          "opening_hours": {
            "current_day": [
              "<any>"
            ],
            "days": [
              "<any>"
            ]
          },
          "contact": {
            "email": "<string>",
            "telephone": "<string>"
          },
          "price_range": "<string>",
          "rating": {
            "ratingValue": 1,
            "bestRating": 1,
            "reviewCount": 123,
            "profile": {},
            "is_tripadvisor": true
          },
          "distance": {
            "value": 123,
            "units": "<string>"
          },
          "profiles": [
            {}
          ],
          "reviews": {
            "results": [
              "<any>"
            ],
            "viewMoreUrl": "<string>",
            "reviews_in_foreign_language": true
          },
          "pictures": {
            "viewMoreUrl": "<string>",
            "results": [
              "<any>"
            ]
          },
          "action": {
            "type": "<string>",
            "url": "<string>"
          },
          "serves_cuisine": [
            "<string>"
          ],
          "categories": [
            "<string>"
          ],
          "icon_category": "<string>",
          "timezone": "<string>",
          "timezone_offset": 123,
          "id": "<string>",
          "results": [
            {}
          ]
        },
        "video": {
          "duration": "<any>",
          "views": "<any>",
          "creator": "<any>",
          "publisher": "<any>",
          "thumbnail": "<any>",
          "tags": "<any>",
          "author": "<any>",
          "requires_subscription": "<any>"
        },
        "movie": {
          "name": "<string>",
          "description": "<string>",
          "url": "<string>",
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "release": "<string>",
          "directors": [
            {}
          ],
          "actors": [
            {}
          ],
          "rating": {
            "ratingValue": 1,
            "bestRating": 1,
            "reviewCount": 123,
            "profile": {},
            "is_tripadvisor": true
          },
          "duration": "<string>",
          "genre": [
            "<string>"
          ],
          "query": "<string>"
        },
        "faq": {
          "items": [
            {
              "question": "<any>",
              "answer": "<any>",
              "title": "<any>",
              "url": "<any>",
              "meta_url": "<any>"
            }
          ]
        },
        "qa": {
          "question": "<string>",
          "answer": {
            "text": "<string>",
            "author": "<string>",
            "upvoteCount": 123,
            "downvoteCount": 123
          }
        },
        "book": {
          "title": "<string>",
          "author": [
            {
              "type": "<any>",
              "name": "<any>",
              "url": "<any>",
              "thumbnail": "<any>",
              "email": "<any>"
            }
          ],
          "date": "<string>",
          "price": {
            "price": "<string>",
            "priceCurrency": "<string>"
          },
          "pages": 123,
          "publisher": {
            "type": "<string>",
            "name": "<string>",
            "url": "<string>",
            "thumbnail": {},
            "email": "<string>"
          },
          "rating": {
            "ratingValue": 1,
            "bestRating": 1,
            "reviewCount": 123,
            "profile": {
              "name": "<any>",
              "url": "<any>",
              "long_name": "<any>",
              "img": "<any>"
            },
            "is_tripadvisor": true
          }
        },
        "rating": {
          "ratingValue": "<any>",
          "bestRating": "<any>",
          "reviewCount": "<any>",
          "profile": "<any>",
          "is_tripadvisor": "<any>"
        },
        "article": {
          "author": [
            {
              "type": "<any>",
              "name": "<any>",
              "url": "<any>",
              "thumbnail": "<any>",
              "email": "<any>"
            }
          ],
          "date": "<string>",
          "publisher": {
            "type": "<string>",
            "name": "<string>",
            "url": "<string>",
            "thumbnail": {
              "src": "<any>",
              "alt": "<any>",
              "height": "<any>",
              "width": "<any>",
              "bg_color": "<any>",
              "original": "<any>",
              "logo": "<any>",
              "duplicated": "<any>",
              "theme": "<any>"
            },
            "contact_points": [
              "<any>"
            ]
          },
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "isAccessibleForFree": true
        },
        "product": {
          "type": "<string>",
          "name": "<string>",
          "url": "<string>",
          "category": "<string>",
          "price": "<string>",
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "description": "<string>",
          "offers": [
            "<any>"
          ],
          "rating": {
            "ratingValue": "<any>",
            "bestRating": "<any>",
            "reviewCount": "<any>",
            "profile": "<any>",
            "is_tripadvisor": "<any>"
          }
        },
        "product_cluster": [
          {
            "type": "<string>",
            "name": "<string>",
            "url": "<string>",
            "category": "<string>",
            "price": "<string>",
            "thumbnail": {
              "src": "<any>",
              "alt": "<any>",
              "height": "<any>",
              "width": "<any>",
              "bg_color": "<any>",
              "original": "<any>",
              "logo": "<any>",
              "duplicated": "<any>",
              "theme": "<any>"
            },
            "description": "<string>",
            "offers": [
              "<any>"
            ],
            "rating": {
              "ratingValue": "<any>",
              "bestRating": "<any>",
              "reviewCount": "<any>",
              "profile": "<any>",
              "is_tripadvisor": "<any>"
            }
          }
        ],
        "cluster_type": "<string>",
        "cluster": [
          {
            "title": "<string>",
            "url": "<string>",
            "is_source_local": true,
            "is_source_both": true,
            "description": "<string>",
            "page_age": "<string>",
            "page_fetched": "<string>",
            "fetched_content_timestamp": 123,
            "profile": {
              "name": "<any>",
              "url": "<any>",
              "long_name": "<any>",
              "img": "<any>"
            },
            "language": "<string>",
            "family_friendly": true
          }
        ],
        "creative_work": {
          "name": "<string>",
          "rating": {
            "ratingValue": "<any>",
            "bestRating": "<any>",
            "reviewCount": "<any>",
            "profile": "<any>",
            "is_tripadvisor": "<any>"
          },
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          }
        },
        "music_recording": {
          "name": "<string>",
          "rating": {
            "ratingValue": "<any>",
            "bestRating": "<any>",
            "reviewCount": "<any>",
            "profile": "<any>",
            "is_tripadvisor": "<any>"
          },
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          }
        },
        "review": {
          "type": "<string>",
          "name": "<string>",
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "description": "<string>",
          "rating": {
            "ratingValue": "<any>",
            "bestRating": "<any>",
            "reviewCount": "<any>",
            "profile": "<any>",
            "is_tripadvisor": "<any>"
          }
        },
        "recipe": {
          "title": "<string>",
          "description": "<string>",
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "url": "<string>",
          "domain": "<string>",
          "favicon": "<string>",
          "time": "<string>",
          "prep_time": "<string>",
          "cook_time": "<string>",
          "ingredients": "<string>",
          "instructions": [
            {
              "text": "<any>",
              "name": "<any>",
              "url": "<any>",
              "image": "<any>"
            }
          ],
          "servings": 123,
          "calories": 123,
          "publisher": "<string>",
          "rating": {
            "ratingValue": "<any>",
            "bestRating": "<any>",
            "reviewCount": "<any>",
            "profile": "<any>",
            "is_tripadvisor": "<any>"
          },
          "recipeCategory": "<string>",
          "recipeCuisine": "<string>",
          "video": {
            "duration": "<any>",
            "views": "<any>",
            "creator": "<any>",
            "publisher": "<any>",
            "thumbnail": "<any>",
            "tags": "<any>",
            "author": "<any>",
            "requires_subscription": "<any>"
          }
        },
        "software": {
          "name": "<string>",
          "author": "<string>",
          "version": "<string>",
          "codeRepository": "<string>",
          "homepage": "<string>",
          "datePublished": "<string>",
          "is_npm": true,
          "is_pypi": true,
          "stars": 123,
          "forks": 123,
          "programmingLanguage": "<string>"
        },
        "organization": {
          "type": "<string>",
          "name": "<string>",
          "url": "<string>",
          "thumbnail": {
            "src": "<any>",
            "alt": "<any>",
            "height": "<any>",
            "width": "<any>",
            "bg_color": "<any>",
            "original": "<any>",
            "logo": "<any>",
            "duplicated": "<any>",
            "theme": "<any>"
          },
          "contact_points": [
            {}
          ]
        },
        "content_type": "<string>",
        "extra_snippets": [
          "<string>"
        ],
        "icons": [
          {
            "href": "<string>",
            "sizes": "<string>",
            "rel": "<string>",
            "type": "<string>",
            "ext": "<string>"
          }
        ]
      }
    ],
    "family_friendly": true
  },
  "summarizer": {
    "type": "summarizer",
    "key": "<string>"
  },
  "rich": {
    "type": "rich",
    "hint": {
      "vertical": "calculator",
      "callback_key": "<string>"
    }
  }
}

Authorizations

​
x-subscription-token
string
header
required

The subscription token that was generated for the product.

Headers

​
x-loc-lat
number | null

The latitude of the client's geographical location in degrees, to provide relevant local results. The latitiude must be greater than or equal to -90.0 degrees and less than or equal to +90.0 degrees.

Required range: -90 <= x <= 90
​
x-loc-long
number | null

The longitude of the client's geographical location in degrees, to provide relevant local results. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0 degrees.

Required range: -180 <= x <= 180
​
x-loc-timezone
string | null

The IANA timezone for the client's device. For complete list of IANA timezones and location mappings see IANA Database and Geonames Database.

​
x-loc-city
string | null

The generic name of the client city.

​
x-loc-state
string | null

A code which could be up to three characters, that represent the client's state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.

​
x-loc-state-name
string | null

The name of the client's state/region. The region is the first-level subdivision (the broadest or least specific) of the ISO 3166-2 code.

​
x-loc-country
enum<string> | null

The two letter country code for the client's country. For a list of country codes, see ISO 3166-1 alpha-2.

Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BQ,
BR,
BS,
BT,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SX,
SY,
SZ,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UM,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
YE,
YT,
ZA,
ZM,
ZW
​
x-loc-postal-code
string | null

The client's postal code.

​
x-subscription-token
string
required

The subscription token that was generated for the product.

Examples:

"BSAgdIxiH0OLq6fnx6F-xp8Yplv4uOp"

​
api-version
string | null

The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available.

​
accept
enum<string>

The default supported media type is application/json.

Available options:
application/json,
*/*
​
cache-control
enum<string> | null

Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.

Available options:
TitleConst
CacheControlno-cache
​
user-agent
string | null

The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.

Examples:

"**Android** Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36"

"**iOS** Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1"

"**macOS** Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36"

"**Windows** Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36"

Query Parameters

​
q
string
required

The user's search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.

Required string length: 1 - 400
​
country
enum<string>

The 2 character country code where the search results come from. The default value is US.

Available options:
AR,
AU,
AT,
BE,
BR,
CA,
CL,
DK,
FI,
FR,
DE,
GR,
HK,
IN,
ID,
IT,
JP,
KR,
MY,
MX,
NL,
NZ,
NO,
CN,
PL,
PT,
PH,
RU,
SA,
ZA,
ES,
SE,
CH,
TW,
TR,
GB,
US,
ALL
​
search_lang
enum<string>

The 2 or more character language code for which the search results are provided.

Available options:
ar,
eu,
bn,
bg,
ca,
zh-hans,
zh-hant,
hr,
cs,
da,
nl,
en,
en-gb,
et,
fi,
fr,
gl,
de,
el,
gu,
he,
hi,
hu,
is,
it,
jp,
kn,
ko,
lv,
lt,
ms,
ml,
mr,
nb,
pl,
pt-br,
pt-pt,
pa,
ro,
ru,
sr,
sk,
sl,
es,
sv,
ta,
te,
th,
tr,
uk,
vi
​
ui_lang
enum<string>

User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110.

Available options:
es-AR,
en-AU,
de-AT,
nl-BE,
fr-BE,
pt-BR,
en-CA,
fr-CA,
es-CL,
da-DK,
fi-FI,
fr-FR,
de-DE,
el-GR,
zh-HK,
en-IN,
en-ID,
it-IT,
ja-JP,
ko-KR,
en-MY,
es-MX,
nl-NL,
en-NZ,
no-NO,
zh-CN,
pl-PL,
en-PH,
ru-RU,
en-ZA,
es-ES,
sv-SE,
fr-CH,
de-CH,
zh-TW,
tr-TR,
en-GB,
en-US,
es-US
​
count
integer
default:20

The number of search results returned in response. The maximum is 20. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.

NOTE: Count only applies to web results.

Required range: 1 <= x <= 50
​
offset
integer
default:0

The zero based offset that indicates number of search result pages (count) to skip before returning the result. The default is 0 and the maximum is 9. The actual number delivered may be less than requested.

Use this parameter along with the count parameter to page results. For example, if your user interface displays 10 search results per page, set count to 10 and offset to 0 to get the first page of results. For each subsequent page, increment offset by 1 (for example, 0, 1, 2). It is possible for multiple pages to include some overlap in results.

Required range: 0 <= x <= 9
​
safesearch
enum<string>

Filters search results for adult content. The following values are supported:

  • off - No filtering is done.
  • moderate - Filters explicit content, like images and videos, but allows adult domains in the search results.
  • strict - Drops all adult content from search results.
Available options:
off,
moderate,
strict
​
spellcheck
boolean
default:true

Whether to spellcheck provided query. If the spellchecker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.

​
freshness
string
default:""

Filters search results by when they were discovered. The following values are supported:

  • pd - Discovered within the last 24 hours.
  • pw - Discovered within the last 7 Days.
  • pm - Discovered within the last 31 Days.
  • py - Discovered within the last 365 Days.
  • YYYY-MM-DDtoYYYY-MM-DD - timeframe is also supported by specifying the date range e.g. 2022-04-01to2022-07-30.
​
text_decorations
boolean
default:true

Whether display strings (e.g. result snippets) should include decoration markers (e.g. highlighting characters).

​
result_filter
string[] | null

A comma delimited string of result types to include in the search response. Not specifying this parameter will return back all result types in search response where data is available and a plan with the corresponding option is subscribed. The response always includes query and type to identify any query modifications and response type respectively. Available result filter values are: discussions, faq, infobox, news, query, summarizer, videos, web, locations.

NOTE: count only applies to web results.

​
units
enum<string> | null

The measurement units. Possible values are:

  • metric - The standardized measurement system
  • imperial - The British Imperial system of units
Available options:
imperial,
metric
​
goggles_id
string | null
deprecated

Goggles act as a custom re-ranking on top of Brave's search index. For more details, refer to the Goggles repository. This parameter is deprecated. Please use the goggles parameter.

​
goggles

Goggles act as a custom re-ranking on top of Brave's search index. The parameter supports both a url where the Goggle is hosted or the definition of the goggle. For more details, refer to the Goggles repository. The parameter can be repeated to query with multiple goggles.

​
extra_snippets
boolean | null

A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts.

​
summary
boolean | null

This parameter enables summary key generation in web search results. This is required for summarizer to be enabled.

​
enable_rich_callback
boolean
default:false

Enable rich callback

​
include_fetch_metadata
boolean
default:false

Include fetch metadata

​
operators
boolean
default:true

Whether to apply search operators

Response

Successful Response

​
type
enum<string>
default:search
Available options:
TitleConst
Typesearch
​
query
object | null

Search query string and its modifications that are used for search.

​
discussions
object | null

Discussions clusters aggregated from forum posts that are relevant to the query.

​
faq
object | null

Frequently asked questions that are relevant to the search query.

​
infobox
object | null

Aggregated information on an entity showable as an infobox.

​
locations
object | null

Places of interest (POIs) relevant to location sensitive queries.

​
mixed
object | null

Preferred ranked order of search results.

​
news
object | null

News results relevant to the query.

​
videos
object | null

Videos results relevant to the query.

​
web
object | null

Web results relevant to the query.

​
summarizer
object | null

Summary key to get summary results for the query.

​
rich
object | null

Callback information to retrieve rich results.

⌘I