Custom Search API

  • The Custom Search JSON API allows you to perform searches over a website or collection of websites.

  • Client libraries are recommended for interacting with the service, but you can also use your own libraries by referring to the provided information for making API requests.

  • The service provides a discovery document for building tools and client libraries that interact with the Custom Search JSON API.

  • The service endpoint is https://customsearch.googleapis.com, and all URIs are relative to this endpoint.

  • The API offers two REST resources, "cse" and "cse.siterestrict," which enable you to retrieve search results and metadata.

Searches over a website or collection of websites

Service: customsearch.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://customsearch.googleapis.com

REST Resource: cse

Methods
list GET /customsearch/v1
Returns metadata about the search performed, metadata about the engine used for the search, and the search results.

REST Resource: cse.siterestrict

Methods
list GET /customsearch/v1/siterestrict
Returns metadata about the search performed, metadata about the engine used for the search, and the search results.