# Serphouse

High Volume API for SEO companies, data mining services, and SEO Tool Suite as a SaaS.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 18
- **Triggers:** 0
- **Slug:** `SERPHOUSE`
- **Version:** 00000000_00

## Tools

### Get Account Information

**Slug:** `SERPHOUSE_ACCOUNT_INFO`

Tool to retrieve account information including active plan, credit usage, and account details. Use when you need to check account status, remaining credits, or active subscription plans.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Domain List

**Slug:** `SERPHOUSE_DOMAIN_LIST`

Tool to retrieve comprehensive list of search engine domains supported by the SERP API including Google, Bing, and Yahoo. Use when you need to know which domains are available for search queries.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Google Jobs Search

**Slug:** `SERPHOUSE_GOOGLE_JOBS_SEARCH`

Tool to perform real-time Google Jobs search to retrieve job listings. Use when you need to search for job postings on Google with specific query terms, location, and filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | Search phrase to query for job listings. |
| `loc` | string | No | Location name as string (e.g., 'New York,New York,United States'). Mutually exclusive with loc_id - provide either loc or loc_id, not both. |
| `lang` | string | Yes | Language code for search results (e.g., 'en' for English, 'fr' for French). |
| `domain` | string | Yes | Google domain to search (e.g., 'google.com', 'google.co.uk'). |
| `loc_id` | integer | No | Location ID as integer. Mutually exclusive with loc - provide either loc or loc_id, not both. |
| `date_range` | string | No | Filter by posting date. Accepts 'h' (past hour), 'd' (24 hours), 'w' (week), 'm' (month), 'y' (year), or custom date range format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Schedule Google SERP Advanced Search

**Slug:** `SERPHOUSE_GOOGLE_SERP_ADVANCED_SCHEDULED`

Tool to schedule Google SERP scraping tasks that fetch up to 100 results by iterating through multiple result pages. Use when you need comprehensive search results beyond Google's 10-result limit. Credits are reserved upfront based on max_pages (1 page = 1 credit), with automatic refunds for unused pages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | List of search tasks to schedule. Each task will retrieve up to 100 results across multiple pages. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Language List

**Slug:** `SERPHOUSE_LANGUAGE_LIST`

Tool to retrieve full list of languages supported by Google, Bing, and Yahoo for SERP requests. Use when you need language codes for making SERP API requests or when configuring language-specific searches.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("google" | "bing" | "yahoo") | Yes | Specifies the search engine source. Valid values are 'google', 'bing', or 'yahoo' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Locations

**Slug:** `SERPHOUSE_LOCATION_SEARCH`

Tool to search and retrieve available locations for SERP API from Google or Bing geographical targeting data. Use when you need to find valid location targets before making SERP API requests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | Search term to filter the location database. This is the location name or keyword you want to search for. |
| `type` | string ("google" | "bing") | Yes | Specifies the location provider. Must be either 'google' or 'bing'. Different providers have different location lists. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check SERP Task Status

**Slug:** `SERPHOUSE_SERP_CHECK`

Tool to check the status of a previously submitted SERP task. Use when monitoring task completion progress or verifying whether a SERP task has finished processing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the SERP task to check status for. This ID is returned when the task was initially created. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### SERP Live Search (GET)

**Slug:** `SERPHOUSE_SERP_LIVE_GET`

Tool to execute real-time search requests and retrieve search engine results immediately via HTTP GET. Use when you need to perform searches on Google, Bing, or Yahoo and get instant SERP data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | Search phrase to query. |
| `loc` | string | No | Location name for geographically targeted results. Mutually exclusive with loc_id. |
| `lang` | string | Yes | Result language using ISO language codes (e.g., 'en', 'fr', 'es'). |
| `page` | string | No | Results page number to retrieve. Defaults to first page. |
| `device` | string ("desktop" | "tablet" | "mobile") | Yes | Device type for the search. |
| `domain` | string ("google.com" | "bing.com" | "yahoo.com") | Yes | Search engine domain to use. |
| `loc_id` | string | No | Location ID for geographically targeted results. Mutually exclusive with loc. |
| `gfilter` | string ("0" | "1") | No | Filter similar or omitted results. '0' to disable, '1' to enable (default). |
| `verbatim` | string ("0" | "1") | No | Google verbatim search mode. '0' for disabled, '1' for enabled. |
| `serp_type` | string ("web" | "news" | "image") | Yes | Type of search results to retrieve. |
| `date_range` | string | No | Publication timeframe. Use 'h'/'d'/'w'/'m'/'y' for relative dates or 'YYYY-MM-DD,YYYY-MM-DD' format for date ranges. |
| `num_result` | string | No | Number of results per page. Defaults to 100. |
| `responseType` | string ("html" | "json") | No | Response format type. Defaults to 'json'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Execute SERP Live POST Search

**Slug:** `SERPHOUSE_SERP_LIVE_POST`

Tool to execute real-time search requests and retrieve search engine results immediately using HTTP POST method. Use when you need to get fresh SERP data from Google, Bing, or Yahoo with specific location and device targeting. Supports web, news, image, and shopping search types with advanced filtering options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | Search phrase or query to search for. |
| `loc` | string | No | Location name for the search (e.g., 'New York,New York,United States'). Either loc or loc_id must be specified. |
| `lang` | string | Yes | Language code for the search (e.g., 'en' for English, 'fr' for French). |
| `page` | integer | No | Page number of results to retrieve. Default is 1. |
| `device` | string ("desktop" | "tablet" | "mobile") | Yes | Device type to simulate for the search. |
| `domain` | string ("google.com" | "bing.com" | "yahoo.com") | Yes | Search engine domain to use for the search. |
| `loc_id` | integer | No | Location ID for the search. Either loc or loc_id must be specified. |
| `gfilter` | integer ("0" | "1") | No | Similar/Omitted results filter. Default is 1. 0 = disabled, 1 = enabled. |
| `verbatim` | integer ("0" | "1") | No | Google Verbatim search mode. 0 = disabled, 1 = enabled. |
| `serp_type` | string ("web" | "news" | "image" | "shop") | Yes | Type of search results to retrieve. |
| `date_range` | string | No | Date filter for results. Use 'h' (hour), 'd' (day), 'w' (week), 'm' (month), 'y' (year), or custom range 'YYYY-MM-DD,YYYY-MM-DD'. |
| `num_result` | integer | No | Number of results per page. Default is 100. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Schedule SERP Tasks

**Slug:** `SERPHOUSE_SERP_SCHEDULE`

Tool to schedule SERP search tasks for asynchronous processing. Use when you need to queue multiple search tasks (up to 100 at once) for later execution. Results can be retrieved via webhook or polling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Array of SERP tasks to schedule. Maximum 100 tasks per request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trends Categories List

**Slug:** `SERPHOUSE_TRENDS_CATEGORIES_LIST`

Tool to retrieve the full list of categories and subcategories for Google Trends searches. Use when you need category IDs for filtering trends analysis.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check Trend Search Status

**Slug:** `SERPHOUSE_TRENDS_CHECK`

Tool to check the status of a previously submitted trend search task. Use when you need to monitor completion progress of a trend search.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the SERP task to check status for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trends Country List

**Slug:** `SERPHOUSE_TRENDS_COUNTRY_LIST`

Tool to retrieve the full list of countries and states for Google Trends searches. Use when you need geographic targeting options for trends analysis.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trend Search Results

**Slug:** `SERPHOUSE_TRENDS_GET`

Tool to retrieve the results of a completed trend search query. Use when you need to fetch trend data for a specific task ID that was previously submitted. The task must be completed before results are available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of your trend search task. This is the task ID returned from the trend search request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trends Language List

**Slug:** `SERPHOUSE_TRENDS_LANGUAGE_LIST`

Tool to retrieve the full list of supported languages for Google Trends searches. Use when you need to identify valid language codes for trend search requests.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Schedule Google Trends Search

**Slug:** `SERPHOUSE_TRENDS_SCHEDULE`

Tool to schedule Google Trends search tasks with configuration for keywords, time ranges, and geographic locations. Use when you need to collect Google Trends data for specific keywords, time periods, or regions. Supports batch processing of up to 100 tasks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Array of trend search tasks to schedule (max 100 tasks in batch) |
| `pingback_url` | string | No | Notification URL for task completion via GET request |
| `postback_url` | string | No | Webhook URL for result delivery via POST request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Perform Google Trends Search

**Slug:** `SERPHOUSE_TRENDS_SEARCH`

Tool to perform real-time Google Trends search to retrieve trend data for specified keywords. Use when you need to analyze keyword popularity across time periods and geographic locations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `geo` | string | No | Geographic location. '' for Worldwide or country/state code. |
| `time` | string | Yes | Time range specification. Valid values: 'now 1-H', 'now 4-H', 'now 1-d', 'now 7-d', 'today 1-m', 'today 3-m', 'today 12-m', 'today 5-y', or custom range 'YYYY-MM-DD YYYY-MM-DD'. |
| `category` | integer | No | Category filter. 0 for all categories or specific category ID. |
| `keywords` | string | Yes | Search terms (max 5). Single term like 'google' or comma-separated like 'google,youtube'. |
| `property` | string | No | Search property type. Valid values: '' (Web), 'images', 'news', 'froogle', 'youtube'. |
| `langauge_code` | string | No | Language code. 'en' or other language codes. |
| `time_zone_offset` | integer | Yes | Timezone offset value. Available offsets from timezone list endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trends Timezone List

**Slug:** `SERPHOUSE_TRENDS_TIMEZONE_LIST`

Tool to retrieve full list of timezones and offset values for use in Google Trend search requests. Use when you need timezone information for trend analysis or when configuring timezone-specific trend searches.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |