# Custom Search API API

> Custom Search API API on Apizie: 2 endpoints (Returns metadata about the search performed, metadata about the engine used for the search, and the search…, Returns metadata about the search performed, metadata about the engine used for the search, and the search…) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/analytics:googleapis-customsearch/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `analytics:googleapis-customsearch`
- Category: Analytics
- Status: byok
- Source: https://developers.google.com/custom-search/v1/introduction
- Page: https://www.apizie.tech/api/analytics/googleapis-customsearch
- OpenAPI: https://www.apizie.tech/api/analytics/googleapis-customsearch/openapi.json

Searches over a website or collection of websites

## Endpoints

### Returns metadata about the search performed, metadata about the engine used for the search, and the search…
`GET https://www.apizie.tech/v1/analytics:googleapis-customsearch/search-cse-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| c2coff | string | no | Enables or disables [Simplified and Traditional Chinese… |
| cr | string | no | Restricts search results to documents originating in a particular country. You may use [Boolean… |
| cx | string | no | The Programmable Search Engine ID to use for this request. |
| dateRestrict | string | no | Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days.… |
| enableAlternateSearchHandler | boolean | no | Optional. Enables routing of Programmable Search Engine requests to an alternate search handler. |
| exactTerms | string | no | Identifies a phrase that all documents in the search results must contain. |
| excludeTerms | string | no | Identifies a word or phrase that should not appear in any documents in the search results. |
| fileType | string | no | Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help… |
| filter | string | no | Controls turning on or off the duplicate content filter. * See [Automatic… |
| gl | string | no | Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country… |
| googlehost | string | no | **Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to… |
| highRange | string | no | Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of… |
| hl | string | no | Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. *… |
| hq | string | no | Appends the specified query terms to the query, as if they were combined with a logical AND operator. |
| imgColorType | string | no | Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and… |
| imgDominantColor | string | no | Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"`… |
| imgSize | string | no | Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` *… |
| imgType | string | no | Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` |
| linkSite | string | no | Specifies that all search results should contain a link to a particular URL. |
| lowRange | string | no | Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of… |
| lr | string | no | Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic *… |
| num | integer | no | Number of search results to return. * Valid values are integers between 1 and 10, inclusive. |
| orTerms | string | no | Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the… |
| q | string | no | Query |
| relatedSite | string | no | Deprecated. |
| rights | string | no | Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`,… |
| safe | string | no | Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) |
| searchType | string | no | Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image… |
| siteSearch | string | no | Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). |
| siteSearchFilter | string | no | Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude… |
| snippetLength | integer | no | Optional. Maximum length of snippet text, in characters, to be returned with results. Note: this feature is limited to specific engines. *… |
| sort | string | no | The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression… |
| start | integer | no | 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… |

### Returns metadata about the search performed, metadata about the engine used for the search, and the search…
`GET https://www.apizie.tech/v1/analytics:googleapis-customsearch/search-cse-siterestrict-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| c2coff | string | no | Enables or disables [Simplified and Traditional Chinese… |
| cr | string | no | Restricts search results to documents originating in a particular country. You may use [Boolean… |
| cx | string | no | The Programmable Search Engine ID to use for this request. |
| dateRestrict | string | no | Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days.… |
| enableAlternateSearchHandler | boolean | no | Optional. Enables routing of Programmable Search Engine requests to an alternate search handler. |
| exactTerms | string | no | Identifies a phrase that all documents in the search results must contain. |
| excludeTerms | string | no | Identifies a word or phrase that should not appear in any documents in the search results. |
| fileType | string | no | Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help… |
| filter | string | no | Controls turning on or off the duplicate content filter. * See [Automatic… |
| gl | string | no | Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country… |
| googlehost | string | no | **Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to… |
| highRange | string | no | Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of… |
| hl | string | no | Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. *… |
| hq | string | no | Appends the specified query terms to the query, as if they were combined with a logical AND operator. |
| imgColorType | string | no | Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and… |
| imgDominantColor | string | no | Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"`… |
| imgSize | string | no | Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` *… |
| imgType | string | no | Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` |
| linkSite | string | no | Specifies that all search results should contain a link to a particular URL. |
| lowRange | string | no | Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of… |
| lr | string | no | Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic *… |
| num | integer | no | Number of search results to return. * Valid values are integers between 1 and 10, inclusive. |
| orTerms | string | no | Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the… |
| q | string | no | Query |
| relatedSite | string | no | Deprecated. |
| rights | string | no | Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`,… |
| safe | string | no | Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) |
| searchType | string | no | Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image… |
| siteSearch | string | no | Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). |
| siteSearchFilter | string | no | Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude… |
| snippetLength | integer | no | Optional. Maximum length of snippet text, in characters, to be returned with results. Note: this feature is limited to specific engines. *… |
| sort | string | no | The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression… |
| start | integer | no | 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… |

## Example
```
curl "https://www.apizie.tech/v1/analytics:googleapis-customsearch/search-cse-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Custom Search API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/analytics:googleapis-customsearch/search-cse-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Custom Search API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Custom Search API itself also needs your own key from googleapis.com.

### Can AI agents use the Custom Search API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key analytics:googleapis-customsearch.

### What is the status of the Custom Search API API?
Needs your own provider key (bring your own key)