Custom Search JSON API Reference
Stay organized with collections
Save and categorize content based on your preferences.
This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.
Resource types
-
CSE
-
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 |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-21 UTC.
[null,null,["Last updated 2024-08-21 UTC."],[[["\u003cp\u003eThis API reference is organized by resource type, with each type having one or more data representations and methods.\u003c/p\u003e\n"],["\u003cp\u003eThe two main resource types are CSE and Cse.siterestrict, each with their own set of methods for interacting with them.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ecse.list\u003c/code\u003e method allows you to retrieve metadata about a search, the custom search engine used, and the search results themselves using required query parameters \u003ccode\u003ecx\u003c/code\u003e and \u003ccode\u003eq\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eSimilarly, the \u003ccode\u003esiterestrict.list\u003c/code\u003e method provides similar search metadata and results but utilizes a smaller set of URL patterns and also requires \u003ccode\u003ecx\u003c/code\u003e and \u003ccode\u003eq\u003c/code\u003e query parameters.\u003c/p\u003e\n"]]],[],null,["# Custom Search JSON API Reference\n\nThis API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.\n\nResource types\n--------------\n\n1. [CSE](#CSE)\n2. [Cse.siterestrict](#Cse.siterestrict)\n\nCSE\n---\n\nFor CSE Resource details, see the [resource representation](/custom-search/v1/cse#resource) page.\n\n| Method | HTTP request | Description |\n|------------------------------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| URIs relative to https://www.googleapis.com, unless otherwise noted |||\n| [list](/custom-search/v1/cse/list) | `GET /customsearch/v1` | The [cse.list](#method_search.cse.list) method returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results. \u003cbr /\u003e **Required query parameters:** `cx`, `q` |\n\nCse.siterestrict\n----------------\n\nFor Cse.siterestrict Resource details, see the [resource representation](/custom-search/v1/cse/siterestrict#resource) page.\n\n| Method | HTTP request | Description |\n|-------------------------------------------------|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| URIs relative to https://www.googleapis.com, unless otherwise noted |||\n| [list](/custom-search/v1/cse/siterestrict/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. \u003cbr /\u003e **Required query parameters:** `cx`, `q` |"]]