Custom Search API
Stay organized with collections
Save and categorize content based on your preferences.
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. |
| Methods |
list |
GET /customsearch/v1/siterestrict
Returns metadata about the search performed, metadata about the engine used for the search, and the search results. |
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\u003eThe Custom Search JSON API allows you to perform searches over a website or collection of websites.\u003c/p\u003e\n"],["\u003cp\u003eClient 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.\u003c/p\u003e\n"],["\u003cp\u003eThe service provides a discovery document for building tools and client libraries that interact with the Custom Search JSON API.\u003c/p\u003e\n"],["\u003cp\u003eThe service endpoint is \u003ccode\u003ehttps://customsearch.googleapis.com\u003c/code\u003e, and all URIs are relative to this endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe API offers two REST resources, "cse" and "cse.siterestrict," which enable you to retrieve search results and metadata.\u003c/p\u003e\n"]]],[],null,["# Custom Search API\n\nSearches over a website or collection of websites\n\n- [REST Resource: cse](#cse)\n- [REST Resource: cse.siterestrict](#cse.siterestrict)\n\nService: customsearch.googleapis.com\n------------------------------------\n\nTo call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) 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:\n\n- \u003chttps://www.googleapis.com/discovery/v1/apis/customsearch/v1/rest\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_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:\n\n- `https://customsearch.googleapis.com`\n\nREST Resource: [cse](/custom-search/v1/reference/rest/v1/cse)\n-------------------------------------------------------------\n\n| Methods ||\n|------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|\n| [list](/custom-search/v1/reference/rest/v1/cse/list) | `GET /customsearch/v1` Returns metadata about the search performed, metadata about the engine used for the search, and the search results. |\n\nREST Resource: [cse.siterestrict](/custom-search/v1/reference/rest/v1/cse.siterestrict)\n---------------------------------------------------------------------------------------\n\n| Methods ||\n|-------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [list](/custom-search/v1/reference/rest/v1/cse.siterestrict/list) | `GET /customsearch/v1/siterestrict` Returns metadata about the search performed, metadata about the engine used for the search, and the search results. |"]]