Custom Search JSON API Reference

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

  • Two resource types are detailed: CSE and Cse.siterestrict.

  • The list method for CSE returns search metadata and results, requiring cx and q query parameters.

  • The list method for Cse.siterestrict also returns search metadata and results, using URL patterns and requiring cx and q.

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