Custom Search JSON API Reference

  • This API reference is organized by resource type, with each type having one or more data representations and methods.

  • The two main resource types are CSE and Cse.siterestrict, each with their own set of methods for interacting with them.

  • The cse.list method allows you to retrieve metadata about a search, the custom search engine used, and the search results themselves using required query parameters cx and q.

  • Similarly, the siterestrict.list method provides similar search metadata and results but utilizes a smaller set of URL patterns and also requires cx and q query parameters.

This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.

Resource types

  1. CSE
  2. Cse.siterestrict

CSE

For CSE Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com, unless otherwise noted
list GET  /customsearch/v1 The cse.list method returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results.  

Required query parameters: cx, q

Cse.siterestrict

For Cse.siterestrict Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com, unless otherwise noted
list GET  /customsearch/v1/siterestrict Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results. Uses a small set of url patterns.

Required query parameters: cx, q