{"openapi":"3.0.0","info":{"description":"Searches over a website or collection of websites","version":[{"name":"v1","value":"v1"}]},"servers":[{"description":"Searches over a website or collection of websites","url":"https://api.apirails.com/googlecustomsearch"}],"paths":{"/customsearch/v1":{"get":{"tags":["Search Indexing"],"parameters":[{"name":"c2coff","in":"query","description":"Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)","schema":{"type":"string","example":""}},{"name":"cr","in":"query","description":"Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) page for a list of valid values for this parameter.","schema":{"type":"string","example":""}},{"name":"cx","in":"query","description":"The Programmable Search Engine ID to use for this request.","schema":{"type":"string","example":""}},{"name":"dateRestrict","in":"query","description":"Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.","schema":{"type":"string","example":""}},{"name":"enableAlternateSearchHandler","in":"query","description":"Optional. Enables routing of Programmable Search Engine requests to an alternate search handler.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"exactTerms","in":"query","description":"Identifies a phrase that all documents in the search results must contain.","schema":{"type":"string","example":""}},{"name":"excludeTerms","in":"query","description":"Identifies a word or phrase that should not appear in any documents in the search results.","schema":{"type":"string","example":""}},{"name":"fileType","in":"query","description":"Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287).","schema":{"type":"string","example":""}},{"name":"filter","in":"query","description":"Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter.","schema":{"type":"string","example":""}},{"name":"gl","in":"query","description":"Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States.","schema":{"type":"string","example":""}},{"name":"googlehost","in":"query","description":"**Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search.","schema":{"type":"string","example":""}},{"name":"highRange","in":"query","description":"Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.","schema":{"type":"string","example":""}},{"name":"hl","in":"query","description":"Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.","schema":{"type":"string","example":""}},{"name":"hq","in":"query","description":"Appends the specified query terms to the query, as if they were combined with a logical AND operator.","schema":{"type":"string","example":""}},{"name":"imgColorType","in":"query","description":"Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `\"color\"` * `\"gray\"` * `\"mono\"`: black and white * `\"trans\"`: transparent background","schema":{"type":"string","example":"","items":{"type":"string","enum":["imgColorTypeUndefined","mono","gray","color","trans"]}}},{"name":"imgDominantColor","in":"query","description":"Returns images of a specific dominant color. Acceptable values are: * `\"black\"` * `\"blue\"` * `\"brown\"` * `\"gray\"` * `\"green\"` * `\"orange\"` * `\"pink\"` * `\"purple\"` * `\"red\"` * `\"teal\"` * `\"white\"` * `\"yellow\"`","schema":{"type":"string","example":"","items":{"type":"string","enum":["imgDominantColorUndefined","black","blue","brown","gray","green","orange","pink","purple","red","teal","white","yellow"]}}},{"name":"imgSize","in":"query","description":"Returns images of a specified size. Acceptable values are: * `\"huge\"` * `\"icon\"` * `\"large\"` * `\"medium\"` * `\"small\"` * `\"xlarge\"` * `\"xxlarge\"`","schema":{"type":"string","example":"","items":{"type":"string","enum":["imgSizeUndefined","HUGE","ICON","LARGE","MEDIUM","SMALL","XLARGE","XXLARGE"]}}},{"name":"imgType","in":"query","description":"Returns images of a type. Acceptable values are: * `\"clipart\"` * `\"face\"` * `\"lineart\"` * `\"stock\"` * `\"photo\"` * `\"animated\"`","schema":{"type":"string","example":"","items":{"type":"string","enum":["imgTypeUndefined","clipart","face","lineart","stock","photo","animated"]}}},{"name":"linkSite","in":"query","description":"Specifies that all search results should contain a link to a particular URL.","schema":{"type":"string","example":""}},{"name":"lowRange","in":"query","description":"Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.","schema":{"type":"string","example":""}},{"name":"lr","in":"query","description":"Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `\"lang_ar\"`: Arabic * `\"lang_bg\"`: Bulgarian * `\"lang_ca\"`: Catalan * `\"lang_cs\"`: Czech * `\"lang_da\"`: Danish * `\"lang_de\"`: German * `\"lang_el\"`: Greek * `\"lang_en\"`: English * `\"lang_es\"`: Spanish * `\"lang_et\"`: Estonian * `\"lang_fi\"`: Finnish * `\"lang_fr\"`: French * `\"lang_hr\"`: Croatian * `\"lang_hu\"`: Hungarian * `\"lang_id\"`: Indonesian * `\"lang_is\"`: Icelandic * `\"lang_it\"`: Italian * `\"lang_iw\"`: Hebrew * `\"lang_ja\"`: Japanese * `\"lang_ko\"`: Korean * `\"lang_lt\"`: Lithuanian * `\"lang_lv\"`: Latvian * `\"lang_nl\"`: Dutch * `\"lang_no\"`: Norwegian * `\"lang_pl\"`: Polish * `\"lang_pt\"`: Portuguese * `\"lang_ro\"`: Romanian * `\"lang_ru\"`: Russian * `\"lang_sk\"`: Slovak * `\"lang_sl\"`: Slovenian * `\"lang_sr\"`: Serbian * `\"lang_sv\"`: Swedish * `\"lang_tr\"`: Turkish * `\"lang_zh-CN\"`: Chinese (Simplified) * `\"lang_zh-TW\"`: Chinese (Traditional)","schema":{"type":"string","example":""}},{"name":"num","in":"query","description":"Number of search results to return. * Valid values are integers between 1 and 10, inclusive.","schema":{"type":"number","example":""}},{"name":"orTerms","in":"query","description":"Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms.","schema":{"type":"string","example":""}},{"name":"q","in":"query","description":"Query","schema":{"type":"string","example":""}},{"name":"relatedSite","in":"query","description":"Deprecated.","schema":{"type":"string","example":""}},{"name":"rights","in":"query","description":"Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).","schema":{"type":"string","example":""}},{"name":"safe","in":"query","description":"Search safety level. Acceptable values are: * `\"active\"`: Enables SafeSearch filtering. * `\"off\"`: Disables SafeSearch filtering. (default)","schema":{"type":"string","example":"","items":{"type":"string","enum":["safeUndefined","active","high","medium","off"]}}},{"name":"searchType","in":"query","description":"Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `\"image\"`: custom image search.","schema":{"type":"string","example":"","items":{"type":"string","enum":["searchTypeUndefined","image"]}}},{"name":"siteSearch","in":"query","description":"Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).","schema":{"type":"string","example":""}},{"name":"siteSearchFilter","in":"query","description":"Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `\"e\"`: exclude * `\"i\"`: include","schema":{"type":"string","example":"","items":{"type":"string","enum":["siteSearchFilterUndefined","e","i"]}}},{"name":"snippetLength","in":"query","description":"Optional. Maximum length of snippet text, in characters, to be returned with results. Note: this feature is limited to specific engines. * Valid values are integers between 161 and 1000, inclusive.","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).","schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/custom-search/v1/reference/rest/v1/cse/list","api_endpoint":"https://customsearch.googleapis.com/customsearch/v1"},"summary":"Returns metadata about the search performed, metadata about the engine used for the search, and the search results.","description":"Returns metadata about the search performed, metadata about the engine used for the search, and the search results.","security":[{"bearerAuth":[]}]}},"/customsearch/v1/siterestrict":{"get":{"tags":["Site Restrict"],"parameters":[{"name":"c2coff","in":"query","description":"Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)","schema":{"type":"string","example":""}},{"name":"cr","in":"query","description":"Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) page for a list of valid values for this parameter.","schema":{"type":"string","example":""}},{"name":"cx","in":"query","description":"The Programmable Search Engine ID to use for this request.","schema":{"type":"string","example":""}},{"name":"dateRestrict","in":"query","description":"Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.","schema":{"type":"string","example":""}},{"name":"enableAlternateSearchHandler","in":"query","description":"Optional. Enables routing of Programmable Search Engine requests to an alternate search handler.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"exactTerms","in":"query","description":"Identifies a phrase that all documents in the search results must contain.","schema":{"type":"string","example":""}},{"name":"excludeTerms","in":"query","description":"Identifies a word or phrase that should not appear in any documents in the search results.","schema":{"type":"string","example":""}},{"name":"fileType","in":"query","description":"Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287).","schema":{"type":"string","example":""}},{"name":"filter","in":"query","description":"Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter.","schema":{"type":"string","example":""}},{"name":"gl","in":"query","description":"Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States.","schema":{"type":"string","example":""}},{"name":"googlehost","in":"query","description":"**Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search.","schema":{"type":"string","example":""}},{"name":"highRange","in":"query","description":"Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.","schema":{"type":"string","example":""}},{"name":"hl","in":"query","description":"Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.","schema":{"type":"string","example":""}},{"name":"hq","in":"query","description":"Appends the specified query terms to the query, as if they were combined with a logical AND operator.","schema":{"type":"string","example":""}},{"name":"imgColorType","in":"query","description":"Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `\"color\"` * `\"gray\"` * `\"mono\"`: black and white * `\"trans\"`: transparent background","schema":{"type":"string","example":"","items":{"type":"string","enum":["imgColorTypeUndefined","mono","gray","color","trans"]}}},{"name":"imgDominantColor","in":"query","description":"Returns images of a specific dominant color. Acceptable values are: * `\"black\"` * `\"blue\"` * `\"brown\"` * `\"gray\"` * `\"green\"` * `\"orange\"` * `\"pink\"` * `\"purple\"` * `\"red\"` * `\"teal\"` * `\"white\"` * `\"yellow\"`","schema":{"type":"string","example":"","items":{"type":"string","enum":["imgDominantColorUndefined","black","blue","brown","gray","green","orange","pink","purple","red","teal","white","yellow"]}}},{"name":"imgSize","in":"query","description":"Returns images of a specified size. Acceptable values are: * `\"huge\"` * `\"icon\"` * `\"large\"` * `\"medium\"` * `\"small\"` * `\"xlarge\"` * `\"xxlarge\"`","schema":{"type":"string","example":"","items":{"type":"string","enum":["imgSizeUndefined","HUGE","ICON","LARGE","MEDIUM","SMALL","XLARGE","XXLARGE"]}}},{"name":"imgType","in":"query","description":"Returns images of a type. Acceptable values are: * `\"clipart\"` * `\"face\"` * `\"lineart\"` * `\"stock\"` * `\"photo\"` * `\"animated\"`","schema":{"type":"string","example":"","items":{"type":"string","enum":["imgTypeUndefined","clipart","face","lineart","stock","photo","animated"]}}},{"name":"linkSite","in":"query","description":"Specifies that all search results should contain a link to a particular URL.","schema":{"type":"string","example":""}},{"name":"lowRange","in":"query","description":"Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.","schema":{"type":"string","example":""}},{"name":"lr","in":"query","description":"Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `\"lang_ar\"`: Arabic * `\"lang_bg\"`: Bulgarian * `\"lang_ca\"`: Catalan * `\"lang_cs\"`: Czech * `\"lang_da\"`: Danish * `\"lang_de\"`: German * `\"lang_el\"`: Greek * `\"lang_en\"`: English * `\"lang_es\"`: Spanish * `\"lang_et\"`: Estonian * `\"lang_fi\"`: Finnish * `\"lang_fr\"`: French * `\"lang_hr\"`: Croatian * `\"lang_hu\"`: Hungarian * `\"lang_id\"`: Indonesian * `\"lang_is\"`: Icelandic * `\"lang_it\"`: Italian * `\"lang_iw\"`: Hebrew * `\"lang_ja\"`: Japanese * `\"lang_ko\"`: Korean * `\"lang_lt\"`: Lithuanian * `\"lang_lv\"`: Latvian * `\"lang_nl\"`: Dutch * `\"lang_no\"`: Norwegian * `\"lang_pl\"`: Polish * `\"lang_pt\"`: Portuguese * `\"lang_ro\"`: Romanian * `\"lang_ru\"`: Russian * `\"lang_sk\"`: Slovak * `\"lang_sl\"`: Slovenian * `\"lang_sr\"`: Serbian * `\"lang_sv\"`: Swedish * `\"lang_tr\"`: Turkish * `\"lang_zh-CN\"`: Chinese (Simplified) * `\"lang_zh-TW\"`: Chinese (Traditional)","schema":{"type":"string","example":""}},{"name":"num","in":"query","description":"Number of search results to return. * Valid values are integers between 1 and 10, inclusive.","schema":{"type":"number","example":""}},{"name":"orTerms","in":"query","description":"Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms.","schema":{"type":"string","example":""}},{"name":"q","in":"query","description":"Query","schema":{"type":"string","example":""}},{"name":"relatedSite","in":"query","description":"Deprecated.","schema":{"type":"string","example":""}},{"name":"rights","in":"query","description":"Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).","schema":{"type":"string","example":""}},{"name":"safe","in":"query","description":"Search safety level. Acceptable values are: * `\"active\"`: Enables SafeSearch filtering. * `\"off\"`: Disables SafeSearch filtering. (default)","schema":{"type":"string","example":"","items":{"type":"string","enum":["safeUndefined","active","high","medium","off"]}}},{"name":"searchType","in":"query","description":"Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `\"image\"`: custom image search.","schema":{"type":"string","example":"","items":{"type":"string","enum":["searchTypeUndefined","image"]}}},{"name":"siteSearch","in":"query","description":"Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).","schema":{"type":"string","example":""}},{"name":"siteSearchFilter","in":"query","description":"Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `\"e\"`: exclude * `\"i\"`: include","schema":{"type":"string","example":"","items":{"type":"string","enum":["siteSearchFilterUndefined","e","i"]}}},{"name":"snippetLength","in":"query","description":"Optional. Maximum length of snippet text, in characters, to be returned with results. Note: this feature is limited to specific engines. * Valid values are integers between 161 and 1000, inclusive.","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).","schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/custom-search/v1/reference/rest/v1/cse.siterestrict/list","api_endpoint":"https://customsearch.googleapis.com/customsearch/v1/siterestrict"},"summary":"Returns metadata about the search performed, metadata about the engine used for the search, and the search results. U...","description":"Returns metadata about the search performed, metadata about the engine used for the search, and the search results. Uses a small set of url patterns.","security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}