×

Custom Web Search API

What is the Custom Web Search API?

ContextualWeb Custom Web Search API is simple HTTP REST API. The way it works is simple: you send a search query and get back web pages from the slice of Web that your Custom Search instance has been defined to crawl.

The Custom Web Search API will return webpages as results. If you'd like to search specifically for news or images, we've got you covered with specialized custom search engines.

Below, you'll find more info about the Custom Web Search API, including:

  • Request URL
  • Header Parameters
  • Request Parameters
  • Optional Parameters
  • Response 200

Header Parameters:

X-RapidAPI-HostStringcustom-search.p.rapidapi.com
X-RapidAPI-KeyStringGet API Key

Request parameters:

qStringThe user's search query string
pageNumberNumberThe page to view
searchEngineIdStringThe id of the custom search engine. To setup a custom search engine go to: cse.contextual.io

Optional Parameters:

fromPublishDateStringShow only articles published after fromPublishedDate.
Click here for the allowed DateTime Formats.
toPublishDateStringShow only articles published after toPublishedDate.
Click here for the allowed DateTime Formats.

Response 200:

"url": "http://taylorswift.com", 

      "description": "The Official Website of <b><b>Taylor Swift</b></b>", 

      "body": "The Official Website of Taylor Swift", 

      "keywords": "", 

      "language": "en", 

      "isSafe": true, 

      "datePublished": "0001-01-01T00:00:00", 

      "provider": { 

        "name": "taylorswift"