--- canonical_url: "https://docs.composio.dev/toolkits/openweb_ninja" markdown_url: "https://docs.composio.dev/toolkits/openweb_ninja.md" product: "platform" version: null last_updated: null --- # OpenWeb Ninja OpenWeb Ninja provides native APIs for web search, AI answers, e-commerce, finance, jobs, maps, news, real estate, contact enrichment, traffic, and web scraping. - **Category:** ai web scraping - **Auth:** API_KEY - **Composio-managed OAuth available?** N/A - **Tools:** 164 - **Triggers:** 0 - **Slug:** `OPENWEB_NINJA` - **Version:** 20260916_00 ## Tools ### Autocomplete local business query **Slug:** `OPENWEB_NINJA_AUTOCOMPLETE_LOCAL_BUSINESS_QUERY` Return geographic place, business, address, and query predictions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Search query. | | `region` | string | No | Two-letter region code used to bias results. | | `language` | string | No | Two-letter language code for results. | | `coordinates` | string | No | Optional latitude,longitude bias. | #### 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 | ### Autocomplete Waze location **Slug:** `OPENWEB_NINJA_AUTOCOMPLETE_WAZE_LOCATION` Return Waze place, point-of-interest, location, and address predictions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Free-text geographic query. | | `language` | string | No | Language code for results. | | `coordinates` | string | Yes | Latitude,longitude coordinates used to bias results. | #### 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 | ### Autocomplete web search **Slug:** `OPENWEB_NINJA_AUTOCOMPLETE_WEB_SEARCH` Get Google Search query suggestions and available Knowledge Graph information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Autocomplete search query. | | `region` | string | No | Two-letter country or region code. | | `language` | string | No | Two-letter result language code. | | `user_agent` | string ("desktop" | "mobile") | No | Device type used for the search. | | `cursor_pointer` | string | No | Cursor position in the query, starting at zero. | #### 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 | ### Bulk autocomplete web searches **Slug:** `OPENWEB_NINJA_BULK_AUTOCOMPLETE_WEB_SEARCHES` Get query suggestions for up to 50 web searches in one request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `region` | string | No | Two-letter country or region code. | | `queries` | array | Yes | Autocomplete queries, up to 50. | | `language` | string | No | Two-letter result language code. | | `user_agent` | string ("desktop" | "mobile") | No | Device type used for searches. | | `cursor_pointer` | integer | No | Cursor position used for the 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 | ### Bulk search local businesses **Slug:** `OPENWEB_NINJA_BULK_SEARCH_LOCAL_BUSINESSES` Search for local businesses with up to 20 queries in one request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `zoom` | integer | No | Map zoom level used for each query. | | `dedup` | boolean | No | Whether to deduplicate overlapping businesses across queries. | | `limit` | integer | No | Maximum businesses returned per query. | | `offset` | integer | No | Businesses skipped per query. | | `region` | string | No | Two-letter country or region code. | | `queries` | array | Yes | Local business search queries, up to 20. | | `language` | string | No | Two-letter result language code. | | `coordinates` | string | No | Optional latitude,longitude location bias. | #### 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 | ### Bulk search web **Slug:** `OPENWEB_NINJA_BULK_SEARCH_WEB` Perform real-time web searches for up to 100 queries in one request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Results returned for each query. | | `queries` | string | Yes | Query or provider-formatted list of up to 100 web search queries. | | `country_code` | string | No | Lowercase country or region code. | | `language_code` | string | No | Lowercase language code. | #### 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 | ### Calculate local rank grid coordinates **Slug:** `OPENWEB_NINJA_CALCULATE_LOCAL_RANK_GRID_COORDINATES` Calculate a geographic coordinate grid from a center point and radius. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `lat` | number | Yes | Grid center latitude. | | `lng` | number | Yes | Grid center longitude. | | `radius` | number | Yes | Distance between adjacent grid points. | | `grid_size` | integer ("3" | "5" | "7" | "9" | "11" | "13" | "15") | Yes | Number of points on each side of the grid. | | `radius_units` | string ("km" | "mi") | No | Distance unit for radius. | #### 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 | ### Chat with ChatGPT **Slug:** `OPENWEB_NINJA_CHAT_WITH_CHATGPT` Chat with ChatGPT with continuous conversation support. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `message` | string | Yes | Message to send to ChatGPT. | | `markdown` | boolean | No | Whether to return the reply in Markdown. | #### 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 | ### Chat with Copilot **Slug:** `OPENWEB_NINJA_CHAT_WITH_COPILOT` Chat with Copilot with web access and continuous conversation support. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mode` | string ("CHAT" | "REASONING" | "SMART") | No | Conversation mode. | | `message` | string | Yes | Message content to send to Copilot. | | `markdown` | boolean | No | Whether to request a Markdown-formatted reply. | | `conversation_id` | string | No | Existing conversation identifier, if continuing a chat. | #### 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 | ### Chat with Gemini **Slug:** `OPENWEB_NINJA_CHAT_WITH_GEMINI` Chat with Google Gemini with web access and continuous conversation support. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `message` | string | Yes | Message to send to Google Gemini. | | `markdown` | boolean | No | Whether to return the reply in Markdown. | | `conversation_id` | string | No | Existing conversation identifier, if continuing a chat. | #### 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 | ### Convert Amazon ASIN to GTIN **Slug:** `OPENWEB_NINJA_CONVERT_AMAZON_ASIN_TO_GTIN` Convert an Amazon ASIN to GTIN, EAN, or UPC identifiers. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `asin` | string | Yes | Amazon ASIN to convert. | | `country` | string ("US" | "AU" | "BR" | "CA" | "CN" | "FR" | "DE" | "IN" | "IT" | "MX" | "NL" | "SG" | "ES" | "TR" | "AE" | "GB" | "JP" | "SA" | "PL" | "SE" | "BE" | "EG" | "ZA" | "IE") | No | Amazon marketplace country. | #### 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 | ### Convert Amazon GTIN to ASIN **Slug:** `OPENWEB_NINJA_CONVERT_AMAZON_GTIN_TO_ASIN` Find Amazon products by GTIN, EAN, UPC, or ISBN. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `country` | string ("US" | "AU" | "BR" | "CA" | "CN" | "FR" | "DE" | "IN" | "IT" | "MX" | "NL" | "SG" | "ES" | "TR" | "AE" | "GB" | "JP" | "SA" | "PL" | "SE" | "BE" | "EG" | "ZA" | "IE") | No | Amazon marketplace country. | | `product_identifier` | string | Yes | GTIN, EAN-13, UPC, or ISBN to look up. | #### 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 | ### Estimate job salary **Slug:** `OPENWEB_NINJA_ESTIMATE_JOB_SALARY` Estimate salary for a job title, location, and experience range. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | string | No | Comma-separated salary fields to return. | | `location` | string | Yes | Location for the salary estimate. | | `job_title` | string | Yes | Job title to estimate. | | `location_type` | string ("ANY" | "CITY" | "STATE" | "COUNTRY") | No | Geographic granularity of location. | | `years_of_experience` | string ("ALL" | "LESS_THAN_ONE" | "ONE_TO_THREE" | "FOUR_TO_SIX" | "SEVEN_TO_NINE" | "TEN_TO_FOURTEEN" | "ABOVE_FIFTEEN") | No | Experience range for the estimate. | #### 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 | ### Fetch web page **Slug:** `OPENWEB_NINJA_FETCH_WEB_PAGE` Fetch a web page with optional JavaScript rendering and load controls. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | URL to fetch. | | `body` | string | No | Request payload for a target method that supports a body. | | `proxy` | string | No | Optional proxy URL used to fetch the target page. | | `cookies` | array | No | Cookies sent to the target page. | | `headers` | object | No | HTTP headers sent to the target page. | | `render_js` | boolean | No | Whether to render JavaScript before returning the page. | | `wait_until` | string ("domloaded" | "load" | "networkidle") | No | Page-load condition used when rendering JavaScript. | | `load_images` | boolean | No | Whether rendered pages may load images. | | `extra_retries` | boolean | No | Whether the provider may perform additional charged retries. | | `load_stylesheets` | boolean | No | Whether rendered pages may load stylesheets. | | `wait_for_timeout` | string | No | Seconds to wait after page load before extraction. | | `failure_selectors` | string | No | CSS selectors indicating a failed page. | | `success_selectors` | string | No | CSS selectors indicating a successful page. | | `wait_for_selector` | string | No | CSS selector to wait for before returning content. | | `min_response_length` | number | No | Minimum successful response body length in bytes. | | `networkidle_timeout` | number | No | Network-idle duration in seconds. | | `success_status_codes` | array | No | Target HTTP status codes considered successful. | #### 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 AI overview **Slug:** `OPENWEB_NINJA_GET_AI_OVERVIEW` Get a Google Search AI Overview with text and reference links. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Search query. | | `location` | string | No | City-level location from which the search originates. | | `country_code` | string | No | Two-letter country or region code. | | `language_code` | string | No | Two-letter search language code. | #### 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 Amazon influencer profile **Slug:** `OPENWEB_NINJA_GET_AMAZON_INFLUENCER_PROFILE` Get profile details from an Amazon Influencer store page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | string | No | Comma-separated profile fields to return. | | `country` | string | No | Amazon marketplace country. | | `language` | string | No | Marketplace language code for results. | | `influencer_name` | string | Yes | Amazon Influencer store name. | #### 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 Amazon product category list **Slug:** `OPENWEB_NINJA_GET_AMAZON_PRODUCT_CATEGORY_LIST` Get Amazon product categories for a marketplace country. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `country` | string | No | Amazon marketplace country. | #### 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 Amazon product details **Slug:** `OPENWEB_NINJA_GET_AMAZON_PRODUCT_DETAILS` Get detailed Amazon product information for one or more ASINs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `asin` | string | Yes | One ASIN or up to 10 comma-separated ASINs. | | `fields` | string | No | Comma-separated product fields to return. | | `country` | string | No | Amazon marketplace country. | | `language` | string | No | Marketplace language code for results. | | `more_info_query` | string | No | Query used to retrieve additional product information. | #### 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 Amazon product review details **Slug:** `OPENWEB_NINJA_GET_AMAZON_PRODUCT_REVIEW_DETAILS` Get details for a specific Amazon product review. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cookie` | string | Yes | Logged-in Amazon cookie used to fetch the review. | | `fields` | string | No | Comma-separated review fields to return. | | `country` | string | No | Amazon marketplace country. | | `language` | string | No | Marketplace language code for results. | | `review_id` | string | Yes | Amazon product review identifier. | #### 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 Amazon promo code details **Slug:** `OPENWEB_NINJA_GET_AMAZON_PROMO_CODE_DETAILS` Get products offered by an Amazon promotion code. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `country` | string | No | Amazon marketplace country. | | `language` | string | No | Marketplace language code for results. | | `promo_code` | string | Yes | Amazon promotion code to inspect. | #### 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 Amazon seller profile **Slug:** `OPENWEB_NINJA_GET_AMAZON_SELLER_PROFILE` Get profile details from an Amazon seller profile page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | string | No | Comma-separated seller profile fields to return. | | `country` | string | No | Amazon marketplace country. | | `language` | string | No | Marketplace language code for results. | | `seller_id` | string | Yes | Amazon seller identifier. | #### 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 API usage **Slug:** `OPENWEB_NINJA_GET_API_USAGE` Get plan, subscription status, billing period, and quota for an API product. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `product_id` | string | Yes | API product identifier whose subscription and quota should be returned. | #### 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 company financial statement **Slug:** `OPENWEB_NINJA_GET_COMPANY_FINANCIAL_STATEMENT` Get a public company's income statement, balance sheet, or cash-flow statement. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `period` | string | No | Reporting period to return. | | `symbol` | string | No | Public company stock ticker. | | `language` | string | No | Two-letter result language code. | | `statement_type` | string ("income_statement" | "balance_sheet" | "cash_flow") | Yes | Financial statement to return. | #### 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 company job salary **Slug:** `OPENWEB_NINJA_GET_COMPANY_JOB_SALARY` Get estimated salary for a job title at a company. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company` | string | Yes | Company name. | | `location` | string | No | Optional location for the estimate. | | `job_title` | string | Yes | Job title to estimate. | | `location_type` | string ("ANY" | "CITY" | "STATE" | "COUNTRY") | No | Geographic granularity of location. | | `years_of_experience` | string ("ALL" | "LESS_THAN_ONE" | "ONE_TO_THREE" | "FOUR_TO_SIX" | "SEVEN_TO_NINE" | "TEN_TO_FOURTEEN" | "ABOVE_FIFTEEN") | No | Experience range for the estimate. | #### 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 Costco product details **Slug:** `OPENWEB_NINJA_GET_COSTCO_PRODUCT_DETAILS` Get full details for a Costco product by item identifier. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `country` | string ("US" | "CA") | No | Costco marketplace country. | | `language` | string ("en-US" | "en-CA" | "fr-CA") | No | Marketplace language for results. | | `product_id` | string | Yes | Costco item identifier returned by product search. | #### 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 driving directions **Slug:** `OPENWEB_NINJA_GET_DRIVING_DIRECTIONS` Get driving directions from an origin to a destination. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `origin` | string | Yes | Origin as a location query or latitude,longitude pair. | | `country` | string | No | Two-letter country or region code. | | `language` | string | No | Two-letter language code. | | `destination` | string | Yes | Destination as a location query or latitude,longitude pair. | | `arrival_time` | number | No | Arrival Unix timestamp in destination local time. | | `avoid_routes` | string | No | Comma-separated route types to avoid: tolls, highways, or ferries. | | `departure_time` | number | No | Departure Unix timestamp in origin local time. | | `distance_units` | string ("auto" | "km" | "mi") | No | Distance units in the response. | #### 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 eBay product details **Slug:** `OPENWEB_NINJA_GET_EBAY_PRODUCT_DETAILS` Get details for an eBay listing by item ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `domain` | string | No | eBay marketplace domain. | | `product_id` | string | Yes | Numeric eBay item identifier. | #### 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 enriched local business details **Slug:** `OPENWEB_NINJA_GET_ENRICHED_LOCAL_BUSINESS_DETAILS` Get full local business details with optional contact and review-keyword enrichments. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | string | No | Comma-separated business fields to return. | | `region` | string | No | Two-letter country or region code. | | `language` | string | No | Two-letter result language code. | | `business_id` | string | Yes | One business or place identifier, or up to 20 comma-separated identifiers. | | `coordinates` | string | No | Optional latitude,longitude location bias. | | `extract_share_link` | boolean | No | Whether to include a Google Maps share link. | | `extract_emails_and_contacts` | boolean | No | Whether to enrich businesses with emails, contacts, and social profiles. | #### 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 event details **Slug:** `OPENWEB_NINJA_GET_EVENT_DETAILS` Get details for an event by its event identifier. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `event_id` | string | Yes | Opaque event identifier returned by event search. | #### 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 | ### Currency Exchange Rate **Slug:** `OPENWEB_NINJA_GET_FINANCE_CURRENCY_EXCHANGE_RATE` Get currency, forex, or cryptocurrency exchange rates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `language` | string | No | Two-letter ISO 639-1 result language code. | | `to_symbol` | string | No | Three-letter ISO 4217 currency code to convert to. | | `from_symbol` | string | No | Three-letter ISO 4217 currency code to convert from. | #### 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 | ### Currency Time Series **Slug:** `OPENWEB_NINJA_GET_FINANCE_CURRENCY_TIME_SERIES` Get forex time series and key events for a selected period. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `period` | string ("1D" | "5D" | "1M" | "6M" | "YTD" | "1Y" | "5Y" | "MAX") | No | Time-series period from one day through all available history. | | `language` | string | No | Two-letter ISO 639-1 result language code. | | `to_symbol` | string | No | Three-letter ISO 4217 currency code to convert to. | | `from_symbol` | string | No | Three-letter ISO 4217 currency code to convert from. | #### 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 | ### Market Trends **Slug:** `OPENWEB_NINJA_GET_FINANCE_MARKET_TRENDS` Get the latest market trends and relevant news. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `country` | string | No | Two-letter ISO 3166 country code. | | `language` | string | No | Two-letter ISO 639-1 result language code. | | `trend_type` | string ("MARKET_INDEXES" | "MOST_ACTIVE" | "GAINERS" | "LOSERS" | "CRYPTO" | "CURRENCIES" | "CLIMATE_LEADERS") | No | Market trend category to return. | #### 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 | ### Stock / Company Overview **Slug:** `OPENWEB_NINJA_GET_FINANCE_STOCK_OVERVIEW` Get stock or public-company details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `symbol` | string | No | Stock symbol or ticker to describe. | | `language` | string | No | Two-letter ISO 639-1 result language code. | #### 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 | ### Stock Quote **Slug:** `OPENWEB_NINJA_GET_FINANCE_STOCK_QUOTE` Get stock-market quotes from Google Finance or Yahoo Finance. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `source` | string ("google_finance" | "yahoo_finance") | No | Market-data source to query. | | `symbol` | string | Yes | Stock ticker or comma-separated list of up to 100 tickers. | | `language` | string | No | Two-letter ISO 639-1 result language code; used only with google_finance. | #### 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 | ### Stock Time Series **Slug:** `OPENWEB_NINJA_GET_FINANCE_STOCK_TIME_SERIES` Get a stock time series from Google Finance or Yahoo Finance. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `period` | string ("1D" | "5D" | "1M" | "6M" | "YTD" | "1Y" | "5Y" | "MAX") | No | Time-series period from one day through all available history. | | `source` | string ("google_finance" | "yahoo_finance") | No | Market-data source to query. | | `symbol` | string | Yes | Stock symbol or ticker. | | `language` | string | No | Two-letter ISO 639-1 result language code; used only with google_finance. | #### 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 | ### Company Overview **Slug:** `OPENWEB_NINJA_GET_GLASSDOOR_COMPANY_OVERVIEW` Get an employer overview and company details from Glassdoor. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `domain` | string ("www.glassdoor.com" | "www.glassdoor.co.uk" | "www.glassdoor.com.ar" | "www.glassdoor.com.au" | "www.glassdoor.be" | "www.glassdoor.com.br" | "www.glassdoor.ca" | "www.glassdoor.de" | "www.glassdoor.es" | "www.glassdoor.fr" | "www.glassdoor.com.hk" | "www.glassdoor.co.in" | "www.glassdoor.ie" | "www.glassdoor.it" | "www.glassdoor.com.mx" | "www.glassdoor.nl" | "www.glassdoor.co.nz" | "www.glassdoor.at" | "de.glassdoor.ch" | "www.glassdoor.sg" | "fr.glassdoor.ch") | No | Glassdoor country domain to query. | | `company_id` | string | Yes | Glassdoor company ID returned by company search. | #### 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 | ### Salary Estimate **Slug:** `OPENWEB_NINJA_GET_GLASSDOOR_SALARY_ESTIMATION` Get Glassdoor salary estimates by job title and location. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `domain` | string ("www.glassdoor.com" | "www.glassdoor.co.uk" | "www.glassdoor.com.ar" | "www.glassdoor.com.au" | "www.glassdoor.be" | "www.glassdoor.com.br" | "www.glassdoor.ca" | "www.glassdoor.de" | "www.glassdoor.es" | "www.glassdoor.fr" | "www.glassdoor.com.hk" | "www.glassdoor.co.in" | "www.glassdoor.ie" | "www.glassdoor.it" | "www.glassdoor.com.mx" | "www.glassdoor.nl" | "www.glassdoor.co.nz" | "www.glassdoor.at" | "de.glassdoor.ch" | "www.glassdoor.sg" | "fr.glassdoor.ch") | No | Glassdoor country domain to query. | | `location` | string | Yes | Location for the salary estimate. | | `job_title` | string | Yes | Job title for the salary estimate. | | `location_type` | string ("ANY" | "CITY" | "STATE" | "COUNTRY") | No | Geographic level represented by location. | | `years_of_experience` | string ("ALL" | "LESS_THAN_ONE" | "ONE_TO_THREE" | "FOUR_TO_SIX" | "SEVEN_TO_NINE" | "TEN_TO_FOURTEEN" | "ABOVE_FIFTEEN") | No | Experience range to use for the estimate. | #### 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 | ### Exact Matches **Slug:** `OPENWEB_NINJA_GET_GOOGLE_LENS_EXACT_MATCHES` Find web pages containing an exact match for an image. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | Public image URL for which to find exact matches. | | `limit` | integer | No | Maximum matching pages to return (1-500). | | `safe_search` | string ("off" | "blur") | No | Whether explicit content is shown or blurred. | #### 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 | ### Object Detection **Slug:** `OPENWEB_NINJA_GET_GOOGLE_LENS_OBJECT_DETECTION` Detect landmarks, products, plants, animals, and other objects in an image. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | Public image URL to analyze for objects. | #### 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 | ### Image to Text (OCR) **Slug:** `OPENWEB_NINJA_GET_GOOGLE_LENS_OCR` Extract paragraph-, sentence-, and word-level text from an image. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | Public image URL from which to extract text. | | `language` | string | No | Two-letter ISO 639-1 result language code. | #### 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 | ### Visual Matches **Slug:** `OPENWEB_NINJA_GET_GOOGLE_LENS_VISUAL_MATCHES` Find visually similar images on the web, optionally refined by a query. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | Public image URL for which to find visual matches. | | `query` | string | No | Optional search query used to refine visual matches. | | `country` | string | No | Two-letter ISO 3166 search country code. | | `language` | string | No | Two-letter ISO 639-1 result language code. | #### 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 | ### Traffic Alerts **Slug:** `OPENWEB_NINJA_GET_GOOGLE_MAPS_TRAFFIC_ALERTS` Get live traffic incidents within a geographic bounding box. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `zoom` | integer | No | Google Maps zoom level (11-16). | | `top_right` | string | Yes | North-east bounding-box corner as latitude,longitude. | | `bottom_left` | string | Yes | South-west bounding-box corner as latitude,longitude. | #### 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 Shopping Product Details **Slug:** `OPENWEB_NINJA_GET_GOOGLE_SHOPPING_PRODUCT_DETAILS` Get full details for a Google Shopping product ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `country` | string | No | Two-letter ISO 3166 country code. | | `language` | string | No | Two-letter ISO 639-1 result language code. | | `product_id` | string | Yes | Google Shopping product ID. | #### 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 Shopping Product Price History **Slug:** `OPENWEB_NINJA_GET_GOOGLE_SHOPPING_PRODUCT_PRICE_HISTORY` Get a Google Shopping product's price history across selected stores. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `country` | string | No | Two-letter ISO 3166 country code. | | `language` | string | No | Two-letter ISO 639-1 result language code. | | `product_id` | string | Yes | Google Shopping product ID. | #### 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 | ### Home Depot Item Lookup **Slug:** `OPENWEB_NINJA_GET_HOME_DEPOT_ITEM_LOOKUP` Look up Home Depot products by model or item number, one page at a time. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `search` | string | Yes | Manufacturer model number or Home Depot internet item number. | | `zipcode` | string | No | Five-digit US ZIP code for localized fulfillment and pricing. | | `store_id` | string | No | Home Depot store number for localized price and inventory. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `items_per_page` | integer | No | Products to return on this page (1-48). | #### 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 | ### Home Depot Product Details **Slug:** `OPENWEB_NINJA_GET_HOME_DEPOT_PRODUCT_DETAILS` Get full details for a Home Depot product by item number or URL. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | No | Home Depot product URL; required when item_id is omitted. | | `item_id` | string | No | Home Depot internet item number; required when url is omitted. | | `zipcode` | string | No | Five-digit US ZIP code for localized fulfillment and pricing. | | `store_id` | string | No | Home Depot store number for localized price and inventory. | #### 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 | ### Job Details **Slug:** `OPENWEB_NINJA_GET_JOB_DETAILS` Get full details, application options, reviews, and salary insights for jobs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | string | No | Comma-separated job fields to include in the response. | | `job_id` | string | Yes | Job ID or comma-separated list of up to 20 job IDs. | | `country` | string | No | Two-letter ISO 3166 country code. | | `language` | string | No | ISO 639 language code; omit to use the country's primary language. | #### 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 | ### Business Details **Slug:** `OPENWEB_NINJA_GET_LOCAL_BUSINESS_DETAILS` Get full local-business details, including optional contact enrichment. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | string | No | Comma-separated business fields to include. | | `region` | string | No | Two-letter region or country code used for the query. | | `language` | string | No | Two-letter result language code. | | `business_id` | string | Yes | Google business ID, place ID, or comma-separated list of up to 20 IDs. | | `coordinates` | string | No | Latitude,longitude coordinates used to bias the query. | | `extract_share_link` | boolean | No | Whether to include a shortened Google Maps share link. | | `extract_emails_and_contacts` | boolean | No | Whether to enrich results with emails and social contacts. | #### 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 | ### Business Photo Details **Slug:** `OPENWEB_NINJA_GET_LOCAL_BUSINESS_PHOTO_DETAILS` Get captions, ownership, and other details for business photos. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `photo_id` | string | Yes | Photo ID or comma-separated list of up to 20 photo IDs. | | `business_id` | string | Yes | Google business ID or place ID for the photo's business. | #### 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 | ### Business Review Details **Slug:** `OPENWEB_NINJA_GET_LOCAL_BUSINESS_REVIEW_DETAILS` Get detailed reviews by business and review-author ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `region` | string | No | Two-letter region or country code used for the query. | | `language` | string | No | Two-letter result language code. | | `business_id` | string | Yes | Google business ID or place ID for the review's business. | | `review_author_id` | string | Yes | Review author ID or comma-separated list of up to 20 author IDs. | #### 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 | ### Ranking at Coordinate Point **Slug:** `OPENWEB_NINJA_GET_LOCAL_RANK_AT_COORDINATE` Get a business's local-search ranking at a geographic coordinate. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `lat` | number | Yes | Search latitude. | | `lng` | number | Yes | Search longitude. | | `zoom` | number | No | Google Maps zoom level (0-18). | | `query` | string | Yes | Search keyword used for ranking. | | `place_id` | string | Yes | Google Place ID of the business to rank. | #### 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 | ### Full Grid Search **Slug:** `OPENWEB_NINJA_GET_LOCAL_RANK_GRID` Get a business's local-search ranking across a coordinate grid. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `lat` | number | Yes | Grid center latitude. | | `lng` | number | Yes | Grid center longitude. | | `zoom` | number | No | Google Maps zoom level used at each point (0-18). | | `query` | string | Yes | Search keyword used for ranking. | | `shape` | string ("square" | "round") | No | Grid shape. | | `radius` | number | Yes | Distance between adjacent grid points. | | `place_id` | string | Yes | Google Place ID of the business to rank. | | `grid_size` | integer ("3" | "5" | "7" | "9" | "11" | "13" | "15") | Yes | Odd grid dimension. | | `radius_units` | string ("km" | "mi") | No | Distance units for radius. | #### 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 | ### Topic News By Section **Slug:** `OPENWEB_NINJA_GET_NEWS_BY_TOPIC_SECTION` Get articles from a section of a news topic or publication. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum news articles to return (1-500). | | `topic` | string ("WORLD" | "NATIONAL" | "BUSINESS" | "TECHNOLOGY" | "ENTERTAINMENT" | "SPORTS" | "SCIENCE" | "HEALTH") | Yes | News topic or publication identifier. | | `country` | string | No | Two-letter country code. | | `section` | string | No | Section within the selected topic or publication. | | `language` | string | No | Two-letter ISO 639-1 result language code. | #### 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 | ### Full Story Coverage **Slug:** `OPENWEB_NINJA_GET_NEWS_FULL_STORY_COVERAGE` Get full coverage for a news story, including related articles and posts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("RELEVANCE" | "DATE") | No | Sort order for the full article list. | | `story` | string | Yes | Google News story ID for which to get full coverage. | #### 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 | ### Play Store App Details **Slug:** `OPENWEB_NINJA_GET_PLAY_STORE_APP_DETAILS` Get full details for one or more Play Store applications. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `app_id` | string | Yes | Play Store app ID or comma-separated list of up to 100 app IDs. | | `region` | string | No | Two-letter ISO 3166 country or region code. | | `language` | string | No | Two-letter ISO 639-1 language code. | #### 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 | ### Redfin Market Trends **Slug:** `OPENWEB_NINJA_GET_REDFIN_MARKET_TRENDS` Get Redfin housing market trends for a region. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `location` | string | Yes | ZIP code, Canadian postal area, or full Redfin region URL. | | `country_code` | string ("US" | "CA") | No | Redfin marketplace country. | #### 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 | ### Redfin Property Details **Slug:** `OPENWEB_NINJA_GET_REDFIN_PROPERTY_DETAILS` Get complete Redfin property details by property ID or listing URL. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | No | Full Redfin listing URL; required when property_id is omitted. | | `property_id` | string | No | Redfin property ID; required when url is omitted. | | `country_code` | string ("US" | "CA") | No | Redfin marketplace country. | #### 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 | ### Related Web Questions **Slug:** `OPENWEB_NINJA_GET_RELATED_WEB_QUESTIONS` Get Google's People Also Ask questions, optionally including answers and sources. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Search query whose People Also Ask questions to return. | | `location` | string | No | City-level location from which the search should originate. | | `country_code` | string | No | ISO 3166-1 alpha-2 search country. | | `fetch_answers` | string ("true" | "false" | "0" | "1") | No | Whether to include answer bodies and source links. | | `language_code` | string | No | ISO 639-1 search language. | #### 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 | ### Trustpilot Category Details **Slug:** `OPENWEB_NINJA_GET_TRUSTPILOT_CATEGORY_DETAILS` Get full details and category relationships for a Trustpilot category. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `locale` | string | No | Trustpilot country and language locale. | | `category_id` | string | Yes | Trustpilot category ID. | #### 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 | ### Trustpilot Company Details **Slug:** `OPENWEB_NINJA_GET_TRUSTPILOT_COMPANY_DETAILS` Get full Trustpilot details for a company domain. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `locale` | string | No | Trustpilot country and language locale. | | `company_domain` | string | Yes | Company domain to look up on Trustpilot. | #### 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 | ### Trustpilot Consumer Details **Slug:** `OPENWEB_NINJA_GET_TRUSTPILOT_CONSUMER_DETAILS` Get the full details of a Trustpilot consumer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `locale` | string | No | Trustpilot country and language locale. | | `consumer_id` | string | Yes | Trustpilot consumer ID. | #### 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 | ### Walmart Product Details **Slug:** `OPENWEB_NINJA_GET_WALMART_PRODUCT_DETAILS` Get details for a Walmart product by product ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `domain` | string ("us" | "ca") | No | Walmart marketplace domain. | | `product_id` | string | Yes | Numeric or alphanumeric Walmart product ID. | #### 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 | ### Wayfair Product Details **Slug:** `OPENWEB_NINJA_GET_WAYFAIR_PRODUCT_DETAILS` Get detailed Wayfair product information by SKU. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sku` | string | Yes | Wayfair product SKU from a product URL or search result. | | `domain` | string | No | Wayfair marketplace domain, such as com, ca, co.uk, ie, or de. | #### 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 | ### Waze Driving Directions **Slug:** `OPENWEB_NINJA_GET_WAZE_DRIVING_DIRECTIONS` Get Waze driving routes and alerts between two coordinate pairs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `arrival_timestamp` | number | No | Optional arrival time as Unix seconds. | | `source_coordinates` | string | Yes | Starting latitude and longitude pair. | | `destination_coordinates` | string | Yes | Destination latitude and longitude pair. | | `return_route_coordinates` | boolean | No | Whether to include route coordinate pairs. | #### 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 | ### Yelp Business Details **Slug:** `OPENWEB_NINJA_GET_YELP_BUSINESS_DETAILS` Fetch details for one or multiple Yelp businesses. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `business_id` | string | Yes | One Yelp business ID or alias, or up to 20 comma-separated values. | | `yelp_domain` | string | No | Yelp marketplace domain to query. | #### 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 | ### Zillow Agent Rental Listings **Slug:** `OPENWEB_NINJA_GET_ZILLOW_AGENT_PROPERTIES_FOR_RENT` Get one page of an agent's current Zillow rental listings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | Agent identifier returned by Zillow agent search. | | `next_cursor` | string | No | Continuation token from the previous response; omit for the first page. | | `include_team` | boolean | No | Whether to include team-member listings. | #### 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 | ### Zillow Agent Active Listings **Slug:** `OPENWEB_NINJA_GET_ZILLOW_AGENT_PROPERTIES_FOR_SALE` Get one page of an agent's current Zillow for-sale listings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | Agent identifier returned by Zillow agent search. | | `next_cursor` | string | No | Continuation token from the previous response; omit for the first page. | | `include_team` | boolean | No | Whether to include team-member listings. | #### 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 | ### Zillow Agent Sold Listings **Slug:** `OPENWEB_NINJA_GET_ZILLOW_AGENT_PROPERTIES_SOLD` Get one page of an agent's past Zillow sales. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `agent_id` | string | Yes | Agent identifier returned by Zillow agent search. | | `next_cursor` | string | No | Continuation token from the previous response; omit for the first page. | #### 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 | ### Zillow Property by Address **Slug:** `OPENWEB_NINJA_GET_ZILLOW_PROPERTY_BY_ADDRESS` Get detailed Zillow property information by street address. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `address` | string | Yes | Full physical address of the property. | #### 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 | ### Zillow Property Details **Slug:** `OPENWEB_NINJA_GET_ZILLOW_PROPERTY_DETAILS` Get detailed Zillow property information by ZPID or listing URL. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | No | Zillow listing URL; required when zpid is omitted. | | `zpid` | string | No | Zillow property ID; required when url is omitted. | #### 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 | ### Zillow Zestimate **Slug:** `OPENWEB_NINJA_GET_ZILLOW_ZESTIMATE` Get the Zestimate value for a Zillow property. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | No | Optional Zillow listing URL. | | `zpid` | string | Yes | Zillow property ID. | #### 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 | ### Amazon Best Sellers **Slug:** `OPENWEB_NINJA_LIST_AMAZON_BEST_SELLERS` Get one page of Amazon best sellers for a category. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | No | Best-seller list type. | | `fields` | string | No | Comma-separated product fields to return. | | `country` | string | No | Amazon marketplace country. | | `category` | string | Yes | Amazon best-seller category or slash-separated category path. | | `language` | string | No | Marketplace result language. | | `next_cursor` | string | No | Continuation token from the previous response; omit for the first page. | #### 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 | ### Amazon Deal Products **Slug:** `OPENWEB_NINJA_LIST_AMAZON_DEAL_PRODUCTS` Get one page of products belonging to an Amazon deal. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | string | No | Comma-separated deal-product fields to return. | | `country` | string | No | Amazon marketplace country. | | `deal_id` | string | Yes | Amazon deal ID whose products to return. | | `sort_by` | string ("FEATURED" | "LOWEST_PRICE" | "HIGHEST_PRICE" | "REVIEWS" | "NEWEST" | "BEST_SELLERS") | No | Product sort order. | | `language` | string | No | Marketplace result language. | | `next_cursor` | string | No | Continuation token from the previous response; omit for the first page. | #### 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 | ### Amazon Deals **Slug:** `OPENWEB_NINJA_LIST_AMAZON_DEALS` Get one page of Amazon deals with category, rating, price, discount, brand, and Prime filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `brands` | string | No | Comma-separated brand names. | | `fields` | string | No | Comma-separated deal fields to return. | | `country` | string | No | Amazon marketplace country. | | `language` | string | No | Marketplace result language. | | `categories` | string | No | Comma-separated Amazon category IDs. | | `next_cursor` | string | No | Continuation token from the previous response; omit for the first page. | | `price_range` | string ("ALL" | "1" | "2" | "3" | "4" | "5") | No | Amazon price-range filter from ALL or 1 through 5. | | `discount_range` | string ("ALL" | "1" | "2" | "3" | "4" | "5") | No | Amazon discount-range filter from ALL or 1 through 5. | | `lightning_deals` | boolean | No | Only return lightning deals. | | `prime_exclusive` | boolean | No | Only return Prime-exclusive deals. | | `prime_early_access` | boolean | No | Only return Prime early-access deals. | | `min_product_star_rating` | string | No | Minimum product star-rating filter. | #### 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 | ### Amazon Influencer Post Products **Slug:** `OPENWEB_NINJA_LIST_AMAZON_INFLUENCER_POST_PRODUCTS` Get one page of products related to an Amazon influencer List post. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `post_id` | string | Yes | ID of a List-type influencer post. | | `language` | string | No | Marketplace result language. | | `next_cursor` | string | No | Continuation token from the previous response; omit for the first page. | | `influencer_name` | string | Yes | Amazon influencer name. | #### 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 | ### Amazon Influencer Posts **Slug:** `OPENWEB_NINJA_LIST_AMAZON_INFLUENCER_POSTS` Get one page of an Amazon influencer's posts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum posts to return on this page. | | `query` | string | No | Optional post search query. | | `scope` | string | No | Post type scope: ALL, IDEA_LISTS, PHOTOS, or VIDEOS. | | `fields` | string | No | Comma-separated influencer-post fields to return. | | `country` | string | No | Amazon marketplace country. | | `language` | string | No | Marketplace result language. | | `next_cursor` | string | No | Continuation token from the previous response; omit for the first page. | | `influencer_name` | string | Yes | Amazon influencer name. | #### 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 | ### Amazon Product Offers **Slug:** `OPENWEB_NINJA_LIST_AMAZON_PRODUCT_OFFERS` Get one page of seller offers and product details for Amazon ASINs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `asin` | string | Yes | One ASIN or up to 10 comma-separated ASINs. | | `limit` | integer | No | Maximum offers to return on this page. | | `fields` | string | No | Comma-separated product fields to return. | | `country` | string | No | Amazon marketplace country. | | `delivery` | string | No | Delivery filter: PRIME_ELIGIBLE or FREE_DELIVERY. | | `language` | string | No | Marketplace result language. | | `next_cursor` | string | No | Continuation token from the previous response; omit for the first page. | | `product_condition` | string | No | Comma-separated product conditions. | #### 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 | ### Amazon Product Reviews **Slug:** `OPENWEB_NINJA_LIST_AMAZON_PRODUCT_REVIEWS` Get one page of Amazon product reviews with optional filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `asin` | string | Yes | Amazon ASIN whose reviews to return. | | `query` | string | No | Optional text to find within reviews. | | `cookie` | string | Yes | Logged-in Amazon session cookie required by the reviews endpoint. | | `fields` | string | No | Comma-separated review fields to return. | | `country` | string | No | Amazon marketplace country. | | `sort_by` | string | No | Review sort order. | | `language` | string | No | Marketplace result language. | | `next_cursor` | string | No | Continuation token from the previous response; omit for the first page. | | `star_rating` | string | No | Star-rating or sentiment filter. | | `current_format_only` | boolean | No | Only include reviews for the current product variant. | | `images_or_videos_only` | boolean | No | Only include reviews with images or videos. | | `verified_purchases_only` | boolean | No | Only include verified-purchase reviews. | #### 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 | ### Amazon Products by Category **Slug:** `OPENWEB_NINJA_LIST_AMAZON_PRODUCTS_BY_CATEGORY` Get one page of Amazon products in a category with pricing and listing filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `brand` | string | No | One brand or comma-separated brands. | | `fields` | string | No | Comma-separated product fields to return. | | `country` | string | No | Amazon marketplace country. | | `sort_by` | string ("RELEVANCE" | "LOWEST_PRICE" | "HIGHEST_PRICE" | "REVIEWS" | "NEWEST" | "BEST_SELLERS") | No | Product sort order. | | `is_prime` | boolean | No | Only return Prime products. | | `language` | string | No | Marketplace result language. | | `max_price` | integer | No | Maximum offer price in marketplace currency. | | `min_price` | number | No | Minimum offer price in marketplace currency. | | `category_id` | string | Yes | One Amazon category ID or comma-separated category IDs. | | `next_cursor` | string | No | Continuation token from the previous response; omit for the first page. | | `four_stars_and_up` | boolean | No | Only return products rated at least four stars. | | `product_condition` | string | No | Product condition filter. | | `additional_filters` | string | No | Comma-separated Amazon rh filter values. | | `deals_and_discounts` | string | No | Deals and discounts filter. | #### 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 | ### Amazon Seller Products **Slug:** `OPENWEB_NINJA_LIST_AMAZON_SELLER_PRODUCTS` Get one page of products sold by an Amazon seller. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | string | No | Comma-separated seller-product fields to return. | | `country` | string | No | Amazon marketplace country. | | `sort_by` | string ("RELEVANCE" | "LOWEST_PRICE" | "HIGHEST_PRICE" | "REVIEWS" | "NEWEST" | "BEST_SELLERS") | No | Product sort order. | | `language` | string | No | Marketplace result language. | | `seller_id` | string | Yes | Amazon seller ID. | | `next_cursor` | string | No | Continuation token from the previous response; omit for the first page. | #### 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 | ### Amazon Seller Reviews **Slug:** `OPENWEB_NINJA_LIST_AMAZON_SELLER_REVIEWS` Get one page of Amazon seller reviews and feedback. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fields` | string | No | Comma-separated seller-review fields to return. | | `country` | string | No | Amazon marketplace country. | | `language` | string | No | Marketplace result language. | | `seller_id` | string | Yes | Amazon seller ID. | | `next_cursor` | string | No | Continuation token from the previous response; omit for the first page. | | `star_rating` | string | No | Star-rating or sentiment filter. | #### 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 | ### Amazon Top Product Reviews **Slug:** `OPENWEB_NINJA_LIST_AMAZON_TOP_PRODUCT_REVIEWS` Get top reviews for an Amazon product by ASIN. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `asin` | string | Yes | Amazon ASIN whose top reviews to return. | | `fields` | string | No | Comma-separated review fields to return. | | `country` | string | No | Amazon marketplace country. | | `language` | string | No | Marketplace result language. | #### 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 | ### eBay Products by Category **Slug:** `OPENWEB_NINJA_LIST_EBAY_PRODUCTS_BY_CATEGORY` Browse one page of eBay products in a category with listing filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | No | Optional search keywords within the category. | | `cookie` | string | No | Optional eBay session cookie for seller data on sold or completed listings. | | `domain` | string | No | eBay marketplace domain. | | `aspects` | string | No | JSON-encoded array of up to 20 category-specific aspect filters. | | `sort_by` | string ("BEST_MATCH" | "ENDING_SOONEST" | "NEWLY_LISTED" | "PRICE_LOWEST" | "PRICE_HIGHEST") | No | Listing sort order. | | `condition` | string | No | One or more comma-separated item conditions. | | `max_price` | number | No | Maximum listing price in marketplace currency. | | `min_price` | number | No | Minimum listing price in marketplace currency. | | `show_only` | string | No | Comma-separated listing attributes to require. | | `category_id` | string | Yes | eBay category ID. | | `next_cursor` | string | No | Continuation token from the previous response; omit for the first page. | | `buying_format` | string | No | Buying format: buy_it_now, auction, or accepts_offers. | #### 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 | ### Seller Feedback **Slug:** `OPENWEB_NINJA_LIST_EBAY_SELLER_FEEDBACK` Get one page of feedback and reviews for an eBay seller. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `domain` | string | No | eBay marketplace domain, such as com or co.uk. | | `seller_id` | string | Yes | The eBay seller user ID, not the store name. | | `product_id` | string | No | Optional eBay item ID to filter feedback for one product. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | #### 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 | ### Currency News **Slug:** `OPENWEB_NINJA_LIST_FINANCE_CURRENCY_NEWS` Get the latest news related to a forex or cryptocurrency pair. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `language` | string | No | Two-letter ISO 639-1 result language. | | `to_symbol` | string | No | Target ISO 4217 currency code or crypto symbol. | | `from_symbol` | string | No | Source ISO 4217 currency code or crypto symbol. | #### 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 | ### Stock News **Slug:** `OPENWEB_NINJA_LIST_FINANCE_STOCK_NEWS` Get the latest news related to a stock. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `symbol` | string | No | Stock ticker symbol to get news for. | | `language` | string | No | Two-letter ISO 639-1 result language. | #### 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 | ### Company Interviews **Slug:** `OPENWEB_NINJA_LIST_GLASSDOOR_COMPANY_INTERVIEWS` Get one page of Glassdoor interview reports for a company. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("POPULAR" | "MOST_RECENT" | "OLDEST" | "EASIEST" | "MOST_DIFFICULT") | No | Interview sort order. | | `domain` | string | No | Glassdoor domain to query. | | `location` | string | No | Location to filter interviews by. | | `job_title` | string | No | Job-title text filter. | | `page_size` | number | No | Maximum interviews returned on this page. | | `company_id` | string | Yes | Glassdoor company ID returned by company search. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | | `job_function` | string | No | Job function to filter interviews by. | | `location_type` | string | No | Location granularity: ANY, CITY, STATE, or COUNTRY. | | `received_offer_only` | boolean | No | Whether to return only interviews that resulted in an offer. | #### 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 | ### Company Jobs **Slug:** `OPENWEB_NINJA_LIST_GLASSDOOR_COMPANY_JOBS` Get one page of jobs posted by a Glassdoor company. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("MOST_RELEVANT" | "MOST_RECENT") | No | Job sort order. | | `domain` | string | No | Glassdoor domain to query. | | `location` | string | No | Location to filter jobs by. | | `company_id` | string | Yes | Glassdoor company ID or name returned by company search. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | | `job_function` | string | No | Job function to filter by. | | `max_age_days` | number | No | Maximum age of returned jobs in days; zero means any age. | | `location_type` | string | No | Location granularity: ANY, CITY, STATE, or COUNTRY. | #### 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 | ### Company Reviews **Slug:** `OPENWEB_NINJA_LIST_GLASSDOOR_COMPANY_REVIEWS` Get one page of filtered Glassdoor employer reviews. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("POPULAR" | "MOST_RECENT" | "HIGHEST_RATING" | "LOWEST_RATING") | No | Review sort order. | | `query` | string | No | Text query to match in reviews. | | `domain` | string | No | Glassdoor domain to query. | | `language` | string | No | Language of reviews to return. | | `company_id` | string | Yes | Glassdoor company ID returned by company search. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | | `employment_statuses` | string | No | Employee job type to filter by. | | `extended_rating_data` | boolean | No | Whether to include extended rating breakdowns. | | `only_current_employees` | string | No | Whether to return reviews by current employees only. | #### 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 | ### Company Salaries **Slug:** `OPENWEB_NINJA_LIST_GLASSDOOR_COMPANY_SALARIES` Get one page of Glassdoor salary data for a company. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("MOST_SALARIES" | "HIGH_TO_LOW" | "MOST_RECENT") | No | Salary result sort order. | | `domain` | string | No | Glassdoor domain to query. | | `location` | string | No | Location for salary estimates. | | `job_title` | string | No | Job title to filter salary estimates by. | | `company_id` | string | Yes | Glassdoor company ID or name returned by company search. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | | `location_type` | string | No | Location granularity: ANY, CITY, STATE, or COUNTRY. | #### 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 | ### Deals **Slug:** `OPENWEB_NINJA_LIST_GOOGLE_SHOPPING_DEALS` Search one page of product deals on Google Shopping. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum products returned on this page. | | `query` | string | Yes | Product deal search query. | | `shoprs` | string | No | Google Shopping refinement token from a previous response. | | `stores` | string | No | Single store or comma-separated store names. | | `country` | string | No | Two-letter result country code. | | `on_sale` | boolean | No | Whether to return only products currently on sale. | | `sort_by` | string ("BEST_MATCH" | "TOP_RATED" | "LOWEST_PRICE" | "HIGHEST_PRICE") | No | Offer sort order. | | `language` | string | No | Two-letter result language code. | | `max_price` | number | No | Maximum product price. | | `min_price` | number | No | Minimum product price. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | | `free_returns` | boolean | No | Whether to require free returns. | | `free_shipping` | boolean | No | Whether to require free shipping. | | `return_filters` | boolean | No | Whether to return Google Shopping refinement filters. | | `product_condition` | string | No | Product condition filter. | #### 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 | ### Product Offers **Slug:** `OPENWEB_NINJA_LIST_GOOGLE_SHOPPING_PRODUCT_OFFERS` Get one page of Google Shopping offers for a product. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `country` | string | No | Two-letter result country code. | | `language` | string | No | Two-letter result language code. | | `product_id` | string | Yes | Google Shopping product ID. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | #### 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 | ### Product Reviews **Slug:** `OPENWEB_NINJA_LIST_GOOGLE_SHOPPING_PRODUCT_REVIEWS` Get one page of Google Shopping product reviews. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum reviews returned on this page. | | `rating` | integer | No | Minimum user rating filter from 1 through 5. | | `country` | string | No | Two-letter result country code. | | `sort_by` | string ("MOST_RELEVANT" | "MOST_RECENT") | No | Review sort order. | | `language` | string | No | Two-letter result language code. | | `product_id` | string | Yes | Google Shopping product ID. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | #### 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 | ### Store Reviews **Slug:** `OPENWEB_NINJA_LIST_GOOGLE_SHOPPING_STORE_REVIEWS` Get one page of Google Shopping store reviews. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum reviews returned on this page. | | `rating` | string ("ALL" | "FIVE_STARS" | "FOUR_STARS" | "THREE_STARS" | "TWO_STARS" | "ONE_STAR") | No | Store-review rating filter. | | `country` | string | No | Two-letter result country code. | | `sort_by` | string ("MOST_HELPFUL" | "MOST_RECENT") | No | Review sort order. | | `language` | string | No | Two-letter result language code. | | `time_frame` | string ("ALL" | "ONE_YEAR" | "TWO_YEARS" | "SIX_MONTHS" | "THREE_MONTHS") | No | Review publication time range. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | | `store_domain` | string | Yes | Store domain, such as amazon.com. | #### 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 | ### Product Reviews **Slug:** `OPENWEB_NINJA_LIST_HOME_DEPOT_PRODUCT_REVIEWS` Get one page of customer reviews for a Home Depot product. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rating` | integer | No | Optional star-rating filter from 1 through 5. | | `item_id` | string | Yes | Home Depot internet item number. | | `sort_by` | string ("helpful" | "newest" | "oldest" | "photos_first" | "highest_rating" | "lowest_rating" | "relevance") | No | Review sort order. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | | `search_text` | string | No | Text that returned reviews must contain. | | `verified_only` | boolean | No | Whether to return only verified-purchaser reviews. | | `items_per_page` | integer | No | Reviews returned on this page. | #### 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 | ### Products By Category **Slug:** `OPENWEB_NINJA_LIST_HOME_DEPOT_PRODUCTS_BY_CATEGORY` Browse one page of Home Depot products in a category. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `brand` | string | No | Brand name to filter products by. | | `sort_by` | string ("best_match" | "top_sellers" | "top_rated" | "price_low_to_high" | "price_high_to_low" | "newest") | No | Product sort order. | | `zipcode` | string | No | Five-digit US ZIP code used to localize delivery and pricing. | | `in_stock` | boolean | No | Whether to return only in-stock products. | | `store_id` | string | No | Store number used to localize inventory and pickup. | | `max_price` | number | No | Maximum product price in US dollars. | | `min_price` | number | No | Minimum product price in US dollars. | | `category_id` | string | Yes | Home Depot category navigation ID. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | | `items_per_page` | integer | No | Products returned on this page. | #### 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 | ### Business Photos **Slug:** `OPENWEB_NINJA_LIST_LOCAL_BUSINESS_PHOTOS` Get one page of photos for a Google Maps business. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | string | No | Maximum photos returned, from 1 through 100. | | `fields` | string | No | Comma-separated response fields to include. | | `region` | string | No | Two-letter region code used for the query. | | `is_video` | boolean | No | Whether to return video media only. | | `business_id` | string | Yes | Google business ID or place ID. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | #### 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 | ### Business Posts **Slug:** `OPENWEB_NINJA_LIST_LOCAL_BUSINESS_POSTS` Get one page of Google Maps posts published by a business owner. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `region` | string | No | Two-letter region code used for the query. | | `language` | string | No | Two-letter result language code. | | `business_id` | string | Yes | Google business ID or place ID. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | #### 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 | ### Business Reviews **Slug:** `OPENWEB_NINJA_LIST_LOCAL_BUSINESS_REVIEWS` Get one page of reviews for a Google Maps business. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | string | No | Maximum reviews returned, from 1 through 100. | | `query` | string | No | Text query that returned reviews must match. | | `fields` | string | No | Comma-separated response fields to include. | | `region` | string | No | Two-letter region code used for the query. | | `sort_by` | string ("most_relevant" | "newest" | "highest_ranking" | "lowest_ranking") | No | Review sort order. | | `language` | string | No | Two-letter result language code. | | `business_id` | string | Yes | Google business ID or place ID. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | | `translate_reviews` | boolean | No | Whether to translate reviews into the requested language. | #### 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 | ### Language List **Slug:** `OPENWEB_NINJA_LIST_NEWS_LANGUAGES` Get valid news languages for a country code. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `country` | string | Yes | Country code whose supported news languages to list. | #### 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 | ### Local Headlines (Geo) **Slug:** `OPENWEB_NINJA_LIST_NEWS_LOCAL_HEADLINES` Get geo-targeted local news headlines. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum news articles to return. | | `query` | string | Yes | Area, city, or country to get local news for. | | `country` | string | No | Two-letter result country code. | | `language` | string | No | Two-letter result language code. | #### 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 | ### Top Headlines **Slug:** `OPENWEB_NINJA_LIST_NEWS_TOP_HEADLINES` Get the latest top news stories for a country. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum news articles to return. | | `country` | string | No | Two-letter result country code. | | `language` | string | No | Two-letter result language code. | #### 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 | ### Topic Headlines **Slug:** `OPENWEB_NINJA_LIST_NEWS_TOPIC_HEADLINES` Get the latest news headlines for a topic or publication. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum news articles to return. | | `topic` | string | Yes | News topic, publication, or provider topic ID. | | `country` | string | No | Two-letter result country code. | | `language` | string | No | Two-letter result language code. | #### 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 | ### App Reviews **Slug:** `OPENWEB_NINJA_LIST_PLAY_STORE_APP_REVIEWS` Get one page of Google Play app reviews. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum reviews returned on this page. | | `app_id` | string | Yes | Google Play application ID. | | `device` | string | No | Device type to filter reviews by. | | `rating` | string ("ANY" | "ONE_STAR" | "TWO_STARS" | "THREE_STARS" | "FOUR_STARS" | "FIVE_STARS") | No | Star-rating category to filter reviews by. | | `region` | string | No | Two-letter result country code. | | `sort_by` | string ("MOST_RELEVANT" | "NEWEST" | "RATING") | No | Review sort order. | | `language` | string | No | Two-letter result language code. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | #### 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 | ### App Categories **Slug:** `OPENWEB_NINJA_LIST_PLAY_STORE_CATEGORIES` Get the full list of Google Play app categories. #### 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 | ### List Play Store Top Chart **Slug:** `OPENWEB_NINJA_LIST_PLAY_STORE_TOP_CHART` Return one Google Play chart selected by app or game and ranking type. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `chart` | string | Yes | Chart to return: top_grossing_apps, top_paid_apps, top_free_apps, top_free_games, top_grossing_games, or top_paid_games. | | `limit` | integer | No | Maximum chart entries; values above 100 may consume two request credits. | | `region` | string | No | Two-letter result country code. | | `category` | string | No | Optional Google Play category, such as SOCIAL. | | `language` | string | No | Two-letter result language code. | #### 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 | ### List Trustpilot Category Companies **Slug:** `OPENWEB_NINJA_LIST_TRUSTPILOT_CATEGORY_COMPANIES` Return one page of companies in a Trustpilot category using the selected order. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("most_relevant" | "reviews_count" | "latest_review") | No | Company sort order. | | `locale` | string | No | Trustpilot locale code. | | `claimed` | boolean | No | Whether to return only claimed companies. | | `country` | string | No | Two-letter company country code. | | `verified` | boolean | No | Whether to return only verified companies. | | `min_rating` | string | No | Minimum company rating: any, 3, 4, or 4.5. | | `category_id` | string | Yes | Trustpilot category ID. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | | `listing_order` | string ("popular" | "recently_reviewed" | "newest") | No | Listing variant: popular, recently_reviewed, or newest. | | `city_or_zip_code` | string | No | City or ZIP code to filter companies by. | #### 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 | ### Company Reviews **Slug:** `OPENWEB_NINJA_LIST_TRUSTPILOT_COMPANY_REVIEWS` Get one page of filtered Trustpilot company reviews. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("most_relevant" | "recency") | No | Review sort order. | | `query` | string | No | Text query that returned reviews must match. | | `cookie` | string | No | Optional logged-in Trustpilot cookie required for pages after page 10. | | `locale` | string | No | Trustpilot locale code. | | `rating` | string | No | Single rating or comma-separated ratings from 1 through 5. | | `verified` | boolean | No | Whether to return only verified reviews. | | `date_posted` | string | No | Review publication time range. | | `next_cursor` | string | No | Continuation token from the previous call; omit for the first page. | | `with_replies` | boolean | No | Whether to return only reviews with owner replies. | | `company_domain` | string | Yes | Company domain whose Trustpilot reviews to return. | #### 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 | ### Consumer Reviews **Slug:** `OPENWEB_NINJA_LIST_TRUSTPILOT_CONSUMER_REVIEWS` Get one page of reviews written by a Trustpilot consumer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `locale` | string | No | Trustpilot locale code, such as en-US or de-DE. | | `consumer_id` | string | Yes | The Trustpilot consumer ID whose reviews to return. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | #### 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 | ### Product Offers **Slug:** `OPENWEB_NINJA_LIST_WALMART_PRODUCT_OFFERS` Get available seller offers for a Walmart product. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `domain` | string ("us" | "ca") | No | Walmart marketplace domain. | | `product_id` | string | Yes | Walmart numeric item ID or alphanumeric product ID. | #### 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 | ### Product Reviews **Slug:** `OPENWEB_NINJA_LIST_WALMART_PRODUCT_REVIEWS` Get one page of customer reviews for a Walmart product. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("relevancy" | "recent" | "rating_high_low" | "rating_low_high") | No | Review sort order. | | `limit` | integer | No | Reviews to return on this page. | | `domain` | string ("us" | "ca") | No | Walmart marketplace domain. | | `rating` | number | No | Star rating to filter reviews by. | | `product_id` | string | Yes | Walmart product ID to review. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | #### 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 | ### Products By Category **Slug:** `OPENWEB_NINJA_LIST_WALMART_PRODUCTS_BY_CATEGORY` Get one page of products from a Walmart category. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `zip` | string | No | ZIP or postal code used to localize results. | | `facet` | string | No | Facet filter string. | | `state` | string | No | US state code used to localize results. | | `domain` | string ("us" | "ca") | No | Walmart marketplace domain. | | `sort_by` | string ("best_match" | "price_low" | "price_high" | "best_seller" | "top_rated") | No | Product sort order. | | `store_id` | string | No | Walmart store ID to filter by. | | `max_price` | number | No | Maximum product price. | | `min_price` | number | No | Minimum product price. | | `category_id` | string | Yes | Walmart category ID. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | #### 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 | ### Product Reviews **Slug:** `OPENWEB_NINJA_LIST_WAYFAIR_PRODUCT_REVIEWS` Get one page of Wayfair product reviews by SKU. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sku` | string | Yes | Wayfair product SKU. | | `star` | string ("1" | "2" | "3" | "4" | "5") | No | Star rating to filter reviews by. | | `domain` | string | No | Wayfair marketplace domain. | | `sort_by` | string ("relevance" | "helpful" | "date_ascending" | "date_descending" | "rating_ascending" | "rating_descending") | No | Review sort order. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | #### 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 | ### Alerts and Jams **Slug:** `OPENWEB_NINJA_LIST_WAZE_ALERTS_AND_JAMS` Get Waze alerts and traffic jams in a geographic area. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `center` | string | No | Optional center latitude,longitude pair. | | `radius` | string | No | Optional search radius around center. | | `max_jams` | integer | No | Maximum traffic jams to return; use 0 to omit jams. | | `top_right` | string | Yes | Top-right latitude,longitude pair of the search rectangle. | | `max_alerts` | integer | No | Maximum alerts to return; use 0 to omit alerts. | | `alert_types` | string | No | Comma-separated alert types to include. | | `bottom_left` | string | Yes | Bottom-left latitude,longitude pair of the search rectangle. | | `radius_units` | string ("KM" | "MI") | No | Unit used for radius. | | `alert_subtypes` | string | No | Comma-separated alert subtypes to include. | #### 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 | ### Venues **Slug:** `OPENWEB_NINJA_LIST_WAZE_VENUES` Get Waze venues in a geographic rectangle. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `top_right` | string | Yes | Top-right latitude,longitude pair of the search rectangle. | | `categories` | string | No | Comma-separated venue categories to include. | | `zoom_level` | string | No | Waze zoom level from 1 to 4, where 4 is closest. | | `bottom_left` | string | Yes | Bottom-left latitude,longitude pair of the search rectangle. | #### 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 | ### Business Reviews **Slug:** `OPENWEB_NINJA_LIST_YELP_BUSINESS_REVIEWS` Get one page of Yelp business reviews. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("BEST_MATCH" | "NEWEST" | "OLDEST" | "HIGHEST_RATED" | "LOWEST_RATED" | "ELITES") | No | Review sort mode. | | `query` | string | No | Text that returned reviews must match. | | `language` | string | No | Language code for returned reviews. | | `num_pages` | integer | No | Provider pages to return in this call. | | `page_size` | integer | No | Reviews to return per provider page. | | `business_id` | string | Yes | Yelp business ID or alias. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | #### 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 | ### AI Mode **Slug:** `OPENWEB_NINJA_QUERY_GOOGLE_AI_MODE` Send a prompt to Google AI Mode and return its structured answer and sources. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `prompt` | string | Yes | Prompt to send to Google AI Mode. | | `country_code` | string | No | Two-letter country or region code. | | `language_code` | string | No | Two-letter result language code. | | `session_token` | string | No | Prior response session token for continuing a conversation. | | `advanced_search_filters` | string | No | Google advanced-search filter expression. | #### 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 | ### Reverse Geocoding **Slug:** `OPENWEB_NINJA_REVERSE_GEOCODE_LOCATION` Resolve latitude and longitude to place or address details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `lat` | string | No | Latitude of the location to resolve. | | `lng` | string | No | Longitude of the location to resolve. | | `fields` | string | No | Comma-separated business fields to include. | | `region` | string | No | Two-letter region or country code. | | `language` | string | No | Two-letter result language code. | #### 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 | ### Scrape By URL **Slug:** `OPENWEB_NINJA_SCRAPE_AMAZON_PRODUCT_URL` Scrape and parse a full Amazon page URL. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | Full Amazon page URL to scrape. | | `cookie` | string | No | Optional custom Amazon cookie string. | | `country` | string | No | Amazon marketplace country code. | | `language` | string | No | Marketplace-supported result language code. | | `return_html` | string ("true" | "false") | No | Whether to include raw page HTML. | #### 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 | ### Scrape Contacts from Website **Slug:** `OPENWEB_NINJA_SCRAPE_WEBSITE_CONTACTS` Find emails, phone numbers, and social links associated with website domains. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Domain or comma-separated domains to inspect, up to 20. | | `external_matching` | boolean | No | Also search external web sources for matching contacts. | | `match_email_domain` | boolean | No | Only return emails on the supplied domain. | #### 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 | ### Product Search **Slug:** `OPENWEB_NINJA_SEARCH_AMAZON_PRODUCTS` Search Amazon products and offers and return one result page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `brand` | string | No | Comma-separated brands to include. | | `query` | string | Yes | Free-form query or Amazon ASIN. | | `fields` | string | No | Comma-separated product fields to include. | | `country` | string | No | Amazon marketplace country code. | | `sort_by` | string ("RELEVANCE" | "LOWEST_PRICE" | "HIGHEST_PRICE" | "REVIEWS" | "NEWEST" | "BEST_SELLERS") | No | Product sort order. | | `category` | string | No | Comma-separated numeric Amazon category IDs. | | `is_prime` | boolean | No | Only return Prime products. | | `language` | string | No | Marketplace-supported result language code. | | `max_price` | integer | No | Maximum offer price in marketplace currency. | | `min_price` | integer | No | Minimum offer price in marketplace currency. | | `seller_id` | string | No | Comma-separated Amazon seller IDs. | | `category_id` | string | No | Amazon department category ID. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `four_stars_and_up` | boolean | No | Only return products rated four stars or higher. | | `product_condition` | string ("ALL" | "NEW" | "USED" | "RENEWED" | "COLLECTIBLE") | No | Product condition filter. | | `additional_filters` | string | No | Amazon rh filter expression from a search URL. | | `deals_and_discounts` | string ("NONE" | "ALL_DISCOUNTS" | "TODAYS_DEALS") | No | Deals and discounts filter. | #### 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 Books **Slug:** `OPENWEB_NINJA_SEARCH_BOOKS` Search books and other publications and return one result page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Book search query or keyword. | | `country` | string | No | Two-letter country code. | | `language` | string | No | Two-letter language code. | | `view_type` | string ("any" | "preview_and_full_view" | "full_view") | No | Availability or preview view type. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `document_type` | string ("any" | "books" | "newspapers" | "magazines") | No | Document type to return. | | `publication_year_to` | number | No | Latest publication year to include. | | `publication_year_from` | number | No | Earliest publication year to include. | #### 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 | ### Reverse Image Search **Slug:** `OPENWEB_NINJA_SEARCH_BY_IMAGE` Find web pages that use or visually match an image URL. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | Public image URL to search. | | `limit` | integer | No | Maximum source pages to return. | | `safe_search` | string ("off" | "blur") | No | Explicit-content handling mode. | #### 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 **Slug:** `OPENWEB_NINJA_SEARCH_COSTCO_PRODUCTS` Search Costco products by keyword and offset. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Costco product search query. | | `start` | integer | No | Number of search results to skip. | | `country` | string | No | Costco country or domain. | | `language` | string | No | Marketplace-supported result language. | #### 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 | ### Product Search **Slug:** `OPENWEB_NINJA_SEARCH_EBAY_PRODUCTS` Search eBay products by keyword and return one listing page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | eBay product search keywords. | | `cookie` | string | No | Optional eBay session cookie for sold or completed listings. | | `domain` | string | No | eBay marketplace domain. | | `aspects` | string | No | JSON-encoded array of category-specific aspect filters. | | `sort_by` | string ("BEST_MATCH" | "ENDING_SOONEST" | "NEWLY_LISTED" | "PRICE_LOWEST" | "PRICE_HIGHEST") | No | Listing sort order. | | `condition` | string | No | Comma-separated item conditions. | | `max_price` | number | No | Maximum listing price in marketplace currency. | | `min_price` | number | No | Minimum listing price in marketplace currency. | | `show_only` | string | No | Comma-separated listing attributes to require. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `buying_format` | string ("buy_it_now" | "auction" | "accepts_offers") | No | Buying format filter. | #### 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 Emails **Slug:** `OPENWEB_NINJA_SEARCH_EMAIL_ADDRESSES` Search the web for email addresses matching a query and domain. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum email addresses to return. | | `query` | string | Yes | Web search query for people or organizations. | | `email_domain` | string | Yes | Company or email-provider domain to match. | #### 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 by Coordinates Point **Slug:** `OPENWEB_NINJA_SEARCH_EV_CHARGERS_BY_COORDINATES` Search for EV charging stations near geographic coordinates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `lat` | number | Yes | Latitude of the search center. | | `lng` | number | Yes | Longitude of the search center. | | `type` | string | No | Comma-separated connector types to match. | | `limit` | integer | No | Maximum charging stations to return. | | `query` | string | No | Optional station name or keyword filter. | | `max_kw` | number | No | Maximum connector power in kilowatts. | | `min_kw` | number | No | Minimum connector power in kilowatts. | | `available` | string | No | Availability filter for station connectors. | #### 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 by Location **Slug:** `OPENWEB_NINJA_SEARCH_EV_CHARGERS_BY_LOCATION` Search for EV charging stations near a named location. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `near` | string | Yes | Free-form location to search near. | | `type` | string | No | Comma-separated connector types to match. | | `limit` | integer | No | Maximum charging stations to return. | | `query` | string | No | Optional station name or keyword filter. | | `max_kw` | number | No | Maximum connector power in kilowatts; 0 uses the provider default. | | `min_kw` | number | No | Minimum connector power in kilowatts. | | `available` | boolean | No | Only return stations with an available connector. | #### 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 Events **Slug:** `OPENWEB_NINJA_SEARCH_EVENTS` Search for local or online events in real time. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string ("any" | "today" | "tomorrow" | "week" | "weekend" | "next_week" | "month" | "next_month") | No | Date phrase to add as a search hint. | | `query` | string | Yes | Event search query including a topic or location. | | `is_virtual` | boolean | No | Prefer virtual or online events as a search hint. | #### 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 **Slug:** `OPENWEB_NINJA_SEARCH_FINANCIAL_SECURITIES` Find financial securities, currencies, and crypto assets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | No | Free-form security name, market, or symbol. | | `language` | string | No | Two-letter result language code. | #### 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 Forums **Slug:** `OPENWEB_NINJA_SEARCH_FORUMS` Search discussions and forums across the web. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `time` | string ("any" | "hour" | "day" | "week" | "month" | "year") | No | Publication time range. | | `query` | string | Yes | Forum and discussion search query. | | `start` | integer | No | Number of results to skip. | | `country` | string | No | Two-letter search country code. | | `language` | string | No | Two-letter search language code. | #### 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 | ### Company Search **Slug:** `OPENWEB_NINJA_SEARCH_GLASSDOOR_COMPANIES` Search for employers on Glassdoor. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum companies to return. | | `query` | string | Yes | Company name, keyword, or Glassdoor company ID. | | `domain` | string | No | Glassdoor marketplace domain. | #### 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 | ### Job Search **Slug:** `OPENWEB_NINJA_SEARCH_GLASSDOOR_JOBS` Search Glassdoor jobs and return one cursor-controlled page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Jobs to return on this page. | | `query` | string | Yes | Job-title or keyword query. | | `domain` | string | No | Glassdoor marketplace domain. | | `location` | string | Yes | Location in which to search for jobs. | | `date_posted` | string ("all" | "today" | "3days" | "week" | "2weeks" | "month") | No | Job posting age filter. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `remote_only` | string | No | Only return remote jobs. | | `location_type` | string ("ANY" | "CITY" | "STATE" | "COUNTRY") | No | How to interpret the location. | | `easy_apply_only` | boolean | No | Only return jobs that support Easy Apply. | | `min_company_rating` | string | No | Minimum employer rating. | #### 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 **Slug:** `OPENWEB_NINJA_SEARCH_GOOGLE_MAPS` Search Google Maps for local businesses with optional contact enrichment. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `lat` | string | No | Latitude used to bias the search. | | `lng` | string | No | Longitude used to bias the search. | | `zoom` | string | No | Google Maps zoom level. | | `limit` | integer | No | Maximum businesses to return. | | `query` | string | Yes | Local-business search query or keyword. | | `fields` | string | No | Comma-separated business fields to include. | | `region` | string | No | Search region or country code. | | `language` | string | No | Result language code. | | `subtypes` | string | No | Comma-separated business categories. | | `verified` | boolean | No | Only return verified businesses. | | `business_status` | string | No | Comma-separated business statuses. | | `extract_emails_and_contacts` | boolean | No | Enrich businesses with website emails, contacts, and social profiles; this consumes extra credits. | #### 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 **Slug:** `OPENWEB_NINJA_SEARCH_GOOGLE_SHOPPING_PRODUCTS` Search Google Shopping and return one offset-controlled product page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Products to return on this page. | | `query` | string | Yes | Product search query. | | `shoprs` | string | No | Google Shopping refinement token. | | `stores` | string | No | Comma-separated stores to include. | | `country` | string | No | Offer country code. | | `on_sale` | boolean | No | Only return products currently on sale. | | `sort_by` | string ("BEST_MATCH" | "TOP_RATED" | "LOWEST_PRICE" | "HIGHEST_PRICE") | No | Offer sort order. | | `language` | string | No | Result language code. | | `max_price` | number | No | Maximum offer price. | | `min_price` | number | No | Minimum offer price. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `free_returns` | boolean | No | Only return offers with free returns. | | `free_shipping` | boolean | No | Only return offers with free shipping. | | `return_filters` | boolean | No | Whether to return search filters and refinements. | | `product_condition` | string ("ANY" | "NEW" | "USED" | "REFURBISHED") | No | Product condition filter. | #### 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 **Slug:** `OPENWEB_NINJA_SEARCH_HOME_DEPOT_PRODUCTS` Search Home Depot products and return one result page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `brand` | string | No | Brand to filter products by. | | `query` | string | Yes | Home Depot product search query. | | `sort_by` | string ("best_match" | "top_sellers" | "top_rated" | "price_low_to_high" | "price_high_to_low" | "newest") | No | Product sort order. | | `zipcode` | string | No | US ZIP code for localized delivery and pricing. | | `in_stock` | boolean | No | Only return currently fulfillable products. | | `store_id` | string | No | Store number for localized pricing and inventory. | | `max_price` | number | No | Maximum product price in USD. | | `min_price` | number | No | Minimum product price in USD. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `items_per_page` | integer | No | Products to return on this page. | #### 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 Images **Slug:** `OPENWEB_NINJA_SEARCH_IMAGES` Search the web for images with format, size, color, and rights filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `size` | string | No | Image size filter. | | `time` | string ("any" | "day" | "week" | "month" | "year") | No | Last-updated time range. | | `type` | string | No | Image content type filter. | | `color` | string | No | Dominant color filter. | | `limit` | integer | No | Maximum images to return. | | `query` | string | Yes | Image search query or keyword. | | `fields` | string | No | Comma-separated image fields to include. | | `region` | string | No | Search region code. | | `country` | string | No | Two-letter publication country code. | | `file_type` | string | No | Image file format. | | `safe_search` | string ("off" | "blur" | "on") | No | Explicit-content handling mode. | | `aspect_ratio` | string ("any" | "tall" | "square" | "wide" | "panoramic") | No | Image aspect-ratio filter. | | `usage_rights` | string ("any" | "creative_commons" | "commercial") | No | Usage-rights filter. | #### 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 | ### Job Search **Slug:** `OPENWEB_NINJA_SEARCH_JOBS` Search for jobs posted on any public job site across the web on the largest job aggregate in the world (Google for Jobs). Returns one page; pass next_cursor to continue. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Free-form jobs search query. It is highly recommended to include job title and location as part of the query, see query examples below. Examples: web development jobs in chicago marketing manager in new york via linkedin | | `fields` | string | No | A comma separated list of job fields to include in the response (field projection). By default all fields are returned. | | `radius` | number | No | Return jobs within a certain distance from location as specified as part of the query (in km). This internally sent as the Google "lrad" parameter and although it might affect the results, it is not strictly followed by Google for Jobs. | | `country` | string | No | Country code of the country from which to return job postings. Please note that this parameter must be set in order to get jobs in a specific country, for example, to query for software developer jobs in Berlin, one should add country=de to the request - e.g. query=software+developers+in +berlin&country=de. For the list of supported values see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 | | `language` | string | No | Language code in which to return job postings. Leave empty to use the primary language in the specified country (country parameter). In case a language not supported by the specified country is used, it is likely that no results will be returned. For the list of supported values see https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes | | `num_pages` | integer | No | Number of pages to return, starting from page. Allowed values: 1-20 Note: Each page (containing up to 10 results) returned by the API consumes one request credit. | | `date_posted` | string ("all" | "today" | "3days" | "week" | "month") | No | Find jobs posted within the time you specify. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `work_from_home` | boolean | No | Only return work from home / remote jobs. | | `employment_types` | string ("FULLTIME" | "CONTRACTOR" | "PARTTIME" | "INTERN") | No | Find jobs of particular employment types, specified as a comma delimited list of the following values: | | `job_requirements` | string ("under_3_years_experience" | "more_than_3_years_experience" | "no_experience" | "no_degree") | No | Find jobs with specific requirements, specified as a comma delimited list of the following values: | | `exclude_job_publishers` | string | No | Exclude jobs published by specific publishers, specified as a comma (,) separated list of publishers to exclude. | #### 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 **Slug:** `OPENWEB_NINJA_SEARCH_LOCAL_BUSINESSES` Search local businesses on Google Maps with an option to pull emails and social profile links from their website (see the extract_emails_and_contacts parameter below). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `lat` | string | No | Latitude of the coordinates point from which the query is applied - recommended to use so that results are biased towards this location. Defaults to some central location in the region (see the region parameter). | | `lng` | string | No | Longitude of the coordinates point from which the query is applied - recommended to use so that results are biased towards this location. Defaults to some central location in the region (see the region parameter). | | `zoom` | string | No | Zoom level on which to make the search (the viewport is determined by lat, lng and zoom). | | `limit` | integer | No | Maximum number of businesses to return. Allowed values: 1-500 | | `query` | string | Yes | Search query / keyword Examples: Plumbers near New-York, USA Bars in 94102, USA | | `fields` | string | No | A comma separated list of business fields to include in the response (field projection). By default all fields are returned. | | `region` | string | No | Query Google Maps from a particular region or country. For a list of supported region/country codes see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code). | | `language` | string | No | Set the language of the results. For a list of supported language codes see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes. | | `subtypes` | string | No | Find businesses with specific subtypes, specified as a comma separated list of types (business categories). For the complete list of types, see https://daltonluka.com/blog/google-my-business-categories. Examples: Plumber,Carpenter,Electrician Night club,Dance club,Bar,Pub | | `verified` | boolean | No | Only return verified businesses | | `business_status` | string | No | Find businesses with specific status, specified as a comma separated list of the following values: OPEN, CLOSED_TEMPORARILY, CLOSED Examples: OPEN CLOSED_TEMPORARILY,CLOSED | | `extract_emails_and_contacts` | boolean | No | Extract emails, contacts and social profiles for each business in the response. In case true, businesses will be enriched with a emails_and_contacts field with emails, phones, Facebook, LinkedIn, Instagram and other social profiles. Note: in case true, the endpoint will scrape emails and contacts from the business website (in case non-empty). For each such business, the API will charge an additional credit. | #### 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 | ### Area Search (Bounding Box) **Slug:** `OPENWEB_NINJA_SEARCH_LOCAL_BUSINESSES_BY_BOUNDING_BOX` Search businesses within a rectangular area defined by its bottom-left (south-west) and top-right (north-east) corner coordinates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | string | No | Maximum number of businesses to return. Allowed values: 1-500 | | `query` | string | Yes | Search query / keyword | | `fields` | string | No | A comma separated list of business fields to include in the response (field projection). By default all fields are returned. | | `region` | string | No | Query Google Maps from a particular region or country. For a list of supported region/country codes see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code). | | `language` | string | No | Set the language of the results. For a list of supported language codes see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes. | | `subtypes` | string | No | Find businesses with specific subtypes, specified as a comma separated list of types (business categories). For the complete list of types, see https://daltonluka.com/blog/google-my-business-categories. Examples: Plumber,Carpenter,Electrician Night club,Dance club,Bar,Pub | | `top_right` | string | Yes | The top-right (north-east) corner of the bounding box to search in, as a "lat,lng" string. | | `bottom_left` | string | Yes | The bottom-left (south-west) corner of the bounding box to search in, as a "lat,lng" string. | | `extract_emails_and_contacts` | boolean | No | Extract emails, contacts and social profiles for each business in the response. In case true, businesses will be enriched with a emails_and_contacts field with emails, phones, Facebook, LinkedIn, Instagram and other social profiles. Note: in case true, the endpoint will scrape emails and contacts from the business website (in case non-empty). For each such business, the API will charge an additional credit. | #### 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 | ### Area Search (Radius) **Slug:** `OPENWEB_NINJA_SEARCH_LOCAL_BUSINESSES_BY_RADIUS` Search businesses within a circular area defined by a center coordinate point (lat, lng) and a radius in meters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `lat` | string | Yes | Latitude of the center coordinate point of the area to search in. | | `lng` | string | Yes | Longitude of the center coordinate point of the area to search in. | | `limit` | string | No | Maximum number of businesses to return. Allowed values: 1-500 | | `query` | string | Yes | Search query / keyword | | `fields` | string | No | A comma separated list of business fields to include in the response (field projection). By default all fields are returned. | | `radius` | string | Yes | The radius (in meters) of the circular search area around the center coordinate point (lat, lng). Allowed values: 1-50000. | | `region` | string | No | Query Google Maps from a particular region or country. For a list of supported region/country codes see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code). | | `language` | string | No | Set the language of the results. For a list of supported language codes see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes. | | `subtypes` | string | No | Find businesses with specific subtypes, specified as a comma separated list of types (business categories). For the complete list of types, see https://daltonluka.com/blog/google-my-business-categories. Examples: Plumber,Carpenter,Electrician Night club,Dance club,Bar,Pub | | `extract_emails_and_contacts` | boolean | No | Extract emails, contacts and social profiles for each business in the response. In case true, businesses will be enriched with a emails_and_contacts field with emails, phones, Facebook, LinkedIn, Instagram and other social profiles. Note: in case true, the endpoint will scrape emails and contacts from the business website (in case non-empty). For each such business, the API will charge an additional credit. | #### 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 In Area **Slug:** `OPENWEB_NINJA_SEARCH_LOCAL_BUSINESSES_IN_AREA` Search businesses in a specific geographic area defined by a center coordinate point and zoom level. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `lat` | string | Yes | Latitude of the center coordinate point of the area to search in. | | `lng` | string | Yes | Longitude of the center coordinate point of the area to search in. | | `zoom` | string | Yes | Zoom level on which to make the search (the search area / viewport is determined by lat, lng and zoom on a 1000x1000 screen) | | `limit` | string | No | Maximum number of businesses to return. Allowed values: 1-500 | | `query` | string | Yes | Search query / keyword | | `fields` | string | No | A comma separated list of business fields to include in the response (field projection). By default all fields are returned. | | `region` | string | No | Query Google Maps from a particular region or country. For a list of supported region/country codes see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code). | | `language` | string | No | Set the language of the results. For a list of supported language codes see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes. | | `subtypes` | string | No | Find businesses with specific subtypes, specified as a comma separated list of types (business categories). For the complete list of types, see https://daltonluka.com/blog/google-my-business-categories. Examples: Plumber,Carpenter,Electrician Night club,Dance club,Bar,Pub | | `extract_emails_and_contacts` | boolean | No | Extract emails, contacts and social profiles for each business in the response. In case true, businesses will be enriched with a emails_and_contacts field with emails, phones, Facebook, LinkedIn, Instagram and other social profiles. Note: in case true, the endpoint will scrape emails and contacts from the business website (in case non-empty). For each such business, the API will charge an additional credit. | #### 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 Business Locations **Slug:** `OPENWEB_NINJA_SEARCH_LOCAL_BUSINESS_LOCATIONS` Returns a list of found Google My Business locations based on search query, including Service Area Businesses (SAB). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `near` | string | No | Narrow down your search results by using a city, state, country or any other free-form location string. | | `query` | string | Yes | Search query. | #### 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 | ### Keyword Search at Coordinate Point **Slug:** `OPENWEB_NINJA_SEARCH_LOCAL_KEYWORD_AT_COORDINATE` Get search results at the specified coordinate point without any rank comparison data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `lat` | number | Yes | Coordinate point latitude value. | | `lng` | number | Yes | Coordinate point longitude value. | | `zoom` | number | No | Google Maps zoom level. Allowed values: 0-18 | | `query` | string | Yes | Search query / keyword. | #### 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 Nearby **Slug:** `OPENWEB_NINJA_SEARCH_NEARBY_LOCAL_BUSINESSES` Search businesses near by specific geographic coordinates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `lat` | string | Yes | Latitude of the geographic coordinates to search near by. | | `lng` | string | Yes | Longitude of the geographic coordinates to search near by. | | `limit` | string | No | Maximum number of businesses to return. Allowed values: 1-500 | | `query` | string | Yes | Search query / keyword Examples: Bars and pubs Plumbers | | `fields` | string | No | A comma separated list of business fields to include in the response (field projection). By default all fields are returned. | | `region` | string | No | Query Google Maps from a particular region or country. For a list of supported region/country codes see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes (Alpha-2 code). | | `language` | string | No | Set the language of the results. For a list of supported language codes see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes. | | `subtypes` | string | No | Find businesses with specific subtypes, specified as a comma separated list of types (business categories). For the complete list of types, see https://daltonluka.com/blog/google-my-business-categories. Examples: Plumber,Carpenter,Electrician Night club,Dance club,Bar,Pub | | `extract_emails_and_contacts` | boolean | No | Extract emails, contacts and social profiles for each business in the response. In case true, businesses will be enriched with a emails_and_contacts field with emails, phones, Facebook, LinkedIn, Instagram and other social profiles. Note: in case true, the endpoint will scrape emails and contacts from the business website (in case non-empty). For each such business, the API will charge an additional credit. | #### 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 **Slug:** `OPENWEB_NINJA_SEARCH_NEWS` Search news articles by query with an option to limit the results to a specific time range. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of news articles to return. | | `query` | string | Yes | Search query for which to get news. | | `source` | string | No | Domain of the source from which to return news articles. | | `country` | string | No | Country code. See all available country codes. | | `language` | string | No | The language to use for the results, specified as a 2-letter language code - see ISO 639-1 alpha-2. | | `time_published` | string | No | Find news articles published in a specific time range. | #### 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 **Slug:** `OPENWEB_NINJA_SEARCH_PLAY_STORE_APPS` Search for apps on the Store. Returns one page; pass next_cursor to continue. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Search query. | | `region` | string | No | The country code of country/region to use, specified as a 2-letter country code - see ISO 3166-1 alpha-2. | | `language` | string | No | The language to use, specified as a 2-letter language code - see ISO 639-1 alpha-2. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | #### 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 **Slug:** `OPENWEB_NINJA_SEARCH_REDFIN_PROPERTIES` Search Redfin property listings by location (5-digit US zip code, Canadian postal-code area, or a Redfin URL). Returns one page; pass next_cursor to continue. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("redfin_recommended" | "newest" | "oldest" | "price_low_high" | "price_high_low" | "beds" | "baths" | "sqft" | "lot_size") | No | Sort order for the results. | | `status` | string ("for_sale" | "sold" | "for_rent" | "coming_soon") | No | Listing status to filter by. Allowed values: for_sale, sold, for_rent, coming_soon. | | `max_hoa` | number | No | Maximum monthly HOA dues. | | `has_pool` | boolean | No | Only return properties with a pool. | | `location` | string | Yes | The location to search. Accepts a 5-digit US zip code (e.g., 90210), a Canadian postal-code area, or a full Redfin region URL (e.g., https://www.redfin.com/city/30749/NY/New-York or https://www.redfin.com/zipcode/90210). | | `max_beds` | integer | No | Maximum number of bedrooms. | | `max_sqft` | integer | No | Maximum interior square footage. | | `min_beds` | integer | No | Minimum number of bedrooms. | | `min_sqft` | integer | No | Minimum interior square footage. | | `max_price` | number | No | Maximum listing price filter. | | `min_baths` | number | No | Minimum number of bathrooms (supports half-baths, e.g., 2.5). | | `min_price` | number | No | Minimum listing price filter. | | `num_homes` | integer | No | Number of homes to return per page. Allowed values: 1 to 350. | | `has_garage` | boolean | No | Only return properties with a garage. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `country_code` | string ("US" | "CA") | No | Country code to scope the search. Use US for redfin.com or CA for redfin.ca. | | `max_lot_size` | integer | No | Maximum lot size in square feet. | | `min_lot_size` | integer | No | Minimum lot size in square feet. | | `is_waterfront` | boolean | No | Only return waterfront properties. | | `max_year_built` | integer | No | Maximum year built. | | `min_year_built` | integer | No | Minimum year built. | | `property_types` | string | No | Comma-separated list of property types to filter by. Allowed values: HOUSE, CONDO, TOWNHOUSE, MULTI_FAMILY, LAND, OTHER, MANUFACTURED, CO_OP. | | `sold_within_days` | integer | No | For status=sold searches, only return properties sold within the last N days. Allowed values: 1 to 1095 (3 years). | | `time_on_market_days` | integer | No | Only return properties on the market within the last N days. | #### 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 by Coordinates **Slug:** `OPENWEB_NINJA_SEARCH_REDFIN_PROPERTIES_BY_COORDINATES` Search Redfin property listings within a geographic bounding box defined by Northeast (NE) and Southwest (SW) latitude/longitude corners. Returns one page; pass next_cursor to continue. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("redfin_recommended" | "newest" | "oldest" | "price_low_high" | "price_high_low" | "beds" | "baths" | "sqft" | "lot_size") | No | Sort order for the results. | | `ne_lat` | number | Yes | Latitude of the Northeast corner of the bounding box. Allowed values: -90 to 90. | | `ne_lng` | number | Yes | Longitude of the Northeast corner of the bounding box. Allowed values: -180 to 180. | | `status` | string ("for_sale" | "sold" | "for_rent" | "coming_soon") | No | Listing status to filter by. Allowed values: for_sale, sold, for_rent, coming_soon. | | `sw_lat` | number | Yes | Latitude of the Southwest corner of the bounding box. Allowed values: -90 to 90. Must be less than ne_lat. | | `sw_lng` | number | Yes | Longitude of the Southwest corner of the bounding box. Allowed values: -180 to 180. Must be less than ne_lng. | | `max_hoa` | number | No | Maximum monthly HOA dues. | | `has_pool` | boolean | No | Only return properties with a pool. | | `max_beds` | integer | No | Maximum number of bedrooms. | | `max_sqft` | integer | No | Maximum interior square footage. | | `min_beds` | integer | No | Minimum number of bedrooms. | | `min_sqft` | integer | No | Minimum interior square footage. | | `max_price` | number | No | Maximum listing price filter. | | `min_baths` | number | No | Minimum number of bathrooms. | | `min_price` | number | No | Minimum listing price filter. | | `num_homes` | integer | No | Number of homes to return per page. Allowed values: 1 to 350. | | `has_garage` | boolean | No | Only return properties with a garage. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `country_code` | string ("US" | "CA") | No | Country code to scope the search. Use US for redfin.com or CA for redfin.ca. | | `max_lot_size` | integer | No | Maximum lot size in square feet. | | `min_lot_size` | integer | No | Minimum lot size in square feet. | | `is_waterfront` | boolean | No | Only return waterfront properties. | | `max_year_built` | integer | No | Maximum year built. | | `min_year_built` | integer | No | Minimum year built. | | `property_types` | string | No | Comma-separated list of property types to filter by. Allowed values: HOUSE, CONDO, TOWNHOUSE, MULTI_FAMILY, LAND, OTHER, MANUFACTURED, CO_OP. | | `sold_within_days` | integer | No | For status=sold searches, only return properties sold within the last N days. | | `time_on_market_days` | integer | No | Only return properties on the market within the last N days. | #### 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 by Polygon **Slug:** `OPENWEB_NINJA_SEARCH_REDFIN_PROPERTIES_BY_POLYGON` Search Redfin property listings within a custom polygon area. Returns one page; pass next_cursor to continue. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("redfin_recommended" | "newest" | "oldest" | "price_low_high" | "price_high_low" | "beds" | "baths" | "sqft" | "lot_size") | No | Sort order for the results. | | `status` | string ("for_sale" | "sold" | "for_rent" | "coming_soon") | No | Listing status to filter by. | | `max_hoa` | number | No | Maximum monthly HOA dues. | | `polygon` | string | Yes | The polygon to search within, specified as a comma-separated list of longitude latitude pairs (at least 3 pairs required). Format: lng1 lat1,lng2 lat2,lng3 lat3,.... The polygon will be closed automatically if not already closed. | | `has_pool` | boolean | No | Only return properties with a pool. | | `max_beds` | integer | No | Maximum number of bedrooms. | | `max_sqft` | integer | No | Maximum interior square footage. | | `min_beds` | integer | No | Minimum number of bedrooms. | | `min_sqft` | integer | No | Minimum interior square footage. | | `max_price` | number | No | Maximum listing price filter. | | `min_baths` | number | No | Minimum number of bathrooms. | | `min_price` | number | No | Minimum listing price filter. | | `num_homes` | integer | No | Number of homes to return per page. Allowed values: 1 to 350. | | `has_garage` | boolean | No | Only return properties with a garage. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `country_code` | string ("US" | "CA") | No | Country code to scope the search. | | `max_lot_size` | integer | No | Maximum lot size in square feet. | | `min_lot_size` | integer | No | Minimum lot size in square feet. | | `is_waterfront` | boolean | No | Only return waterfront properties. | | `max_year_built` | integer | No | Maximum year built. | | `min_year_built` | integer | No | Minimum year built. | | `property_types` | string | No | Comma-separated list of property types to filter by. Allowed values: HOUSE, CONDO, TOWNHOUSE, MULTI_FAMILY, LAND, OTHER, MANUFACTURED, CO_OP. | | `sold_within_days` | integer | No | For status=sold searches, only return properties sold within the last N days. | | `time_on_market_days` | integer | No | Only return properties on the market within the last N days. | #### 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 Shorts **Slug:** `OPENWEB_NINJA_SEARCH_SHORTS` Get real-time short video search results from across the web with pagination and filtering support. Returns one page; pass next_cursor to continue. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `time` | string ("any" | "day" | "week" | "month" | "year") | No | Find shorts posted in a specific relative time range. | | `query` | string | Yes | Search query / keyword. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `high_quality` | boolean | No | Return only shorts of high quality. | | `posted_date_to` | string | No | Find shorts posted before a specific date (e.g. 3/19/2025). | | `closed_captioned` | boolean | No | Return only shorts with closed captions. | | `posted_date_from` | string | No | Find shorts posted after a specific date (e.g. 1/19/2025). | #### 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 Social Links **Slug:** `OPENWEB_NINJA_SEARCH_SOCIAL_LINKS` Get social profile links by search query or keywords. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Social links search query. | | `social_networks` | string | No | Find social links for the specified social networks, specified as a comma delimited list of the following values: facebook, tiktok, instagram, snapchat, twitter, youtube, linkedin, github, pinterest. | #### 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 | ### Category Search **Slug:** `OPENWEB_NINJA_SEARCH_TRUSTPILOT_CATEGORIES` Search all Trustpilot categories. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Search query / keyword | | `locale` | string | No | Locale code to use. Corresponds to the country selector on the Trustpilot website footer. | #### 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 | ### Company Search **Slug:** `OPENWEB_NINJA_SEARCH_TRUSTPILOT_COMPANIES` Search for companies / businesses on Trustpilot. Returns one page; pass next_cursor to continue. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Search query / keyword | | `locale` | string | No | Locale code to use. Corresponds to the country selector on the Trustpilot website footer. | | `min_rating` | string ("any" | "3" | "4" | "4.5") | No | Only return companies with at least the specified rating. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `min_review_count` | string ("any" | "25" | "50" | "100" | "250" | "500") | No | Only return companies with at least the specified number of reviews. | #### 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 **Slug:** `OPENWEB_NINJA_SEARCH_VIDEOS` Search Google Videos for any query and get real-time video results. Returns one page; pass next_cursor to continue. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `safe` | string ("off" | "active") | No | Safe search setting to filter explicit content. Allowed values: off, active Default: off | | `query` | string | Yes | The video search query. Examples: how to invest product demo software lebron james highlights | | `country` | string | No | Country code of the country to return video results for. See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 for supported values. Default: us | | `date_to` | string | No | End date for a custom date range filter, in MM/DD/YYYY format. Must be provided together with date_from. Example: 04/29/2026 | | `sort_by` | string ("relevance" | "date") | No | Sort order for the results. Allowed values: relevance, date Default: relevance | | `duration` | string ("any" | "short" | "medium" | "long") | No | Filter results by video duration. Allowed values: any, short (under 4 minutes), medium (4 to 20 minutes), long (over 20 minutes) Default: any | | `language` | string | No | The language of the results, specified as a 2-letter language code - see ISO 639-1. Default: en | | `date_from` | string | No | Start date for a custom date range filter, in MM/DD/YYYY format. Must be provided together with date_to. Cannot be used together with time_period (other than any). Example: 01/01/2026 | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `time_period` | string ("any" | "last_hour" | "last_day" | "last_week" | "last_month" | "last_year") | No | Filter results to a specific time period. Cannot be used together with date_from/date_to. Allowed values: any, last_hour, last_day, last_week, last_month, last_year Default: any | #### 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 | ### Product Search **Slug:** `OPENWEB_NINJA_SEARCH_WALMART_PRODUCTS` Search for products on Walmart with pagination support and multiple filters and options such as sort by, price range, location, and more. Returns one page; pass next_cursor to continue. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `zip` | string | No | ZIP/postal code to localize search results such as availability and shipping options. | | `facet` | string | No | Facet filter string for refining results (e.g. by brand, category). Obtained from a previous search response's facet data. | | `query` | string | Yes | Search query string. E.g. 'laptop', 'iphone 15', 'nike shoes' | | `state` | string | No | US state code (e.g. 'CA', 'NY') to localize search results such as availability and shipping options. | | `domain` | string ("us" | "ca") | No | Walmart domain to search. 'us' for walmart.com, 'ca' for walmart.ca. Default is 'us'. | | `sort_by` | string ("best_match" | "price_low" | "price_high" | "best_seller" | "top_rated") | No | Sort results by the given criteria. Accepts aliases: price_low, price_high, best_seller, top_rated. Default is best_match. | | `store_id` | string | No | Walmart store ID to filter results by a specific store's availability. | | `max_price` | number | No | Maximum price filter. Must be higher than min_price if both are specified. | | `min_price` | number | No | Minimum price filter. Must be lower than max_price if both are specified. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | #### 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 **Slug:** `OPENWEB_NINJA_SEARCH_WAYFAIR_PRODUCTS` Search for Wayfair products by keyword or browse by brand/manufacturer. Returns one page; pass next_cursor to continue. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `color` | string | No | Filter products by color. Examples: Black, White, Blue, Gray, Brown, Red, Green, Beige, Gold, Silver, Multi Colored | | `query` | string | No | Product keywords; required when manufacturer_id is omitted. | | `domain` | string ("com" | "ca" | "co.uk" | "ie" | "de") | No | Wayfair domain/country for the search. Default: com Allowed values: com, ca, co.uk, ie, de | | `sort_by` | string ("recommended" | "customer_rating" | "price_low_to_high" | "price_high_to_low") | No | Sort order for the results. | | `in_stock` | boolean | No | Only return products that are currently in stock. | | `max_price` | number | No | Only return products with a price less than or equal to this value (in USD). | | `min_price` | number | No | Only return products with a price greater than or equal to this value (in USD). | | `category_id` | string | No | Wayfair category ID to filter results within a specific category. Used with manufacturer_id to browse brand products in a category. | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `items_per_page` | string ("24" | "48" | "96") | No | Number of products to return per page. Allowed values: 24, 48, 96 | | `manufacturer_id` | string | No | Wayfair brand ID from a product URL; required when query is omitted. | #### 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 the Web **Slug:** `OPENWEB_NINJA_SEARCH_WEB` Search the web with standard, full, or lightweight result detail. Returns one page when the selected contract paginates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `num` | integer | No | Maximum number of results to return. Please note that a request credit will be consumed from the quota for each results page (10 results). | | `limit` | integer | No | Maximum number of results to return. | | `query` | string | Yes | Search query. Supports all Google Advanced Search operators (site:, inurl:, intitle:, etc). | | `start` | integer | No | Number of results to skip (for pagination). | | `device` | string ("desktop" | "mobile" | "tablet") | No | The device to simulate for the search. Mobile and tablet return Google's mobile SERP layout, whose rankings and features can differ from desktop. Allowed values: desktop (default), mobile, tablet. | | `location` | string | No | Where you want the search to originate from. It is recommended to specify location at the city level in order to simulate a real users search (e.g. London, England, United Kingdom). | | `extra_speed` | boolean | No | Speed up the endpoint by up to 4x of the original speed on a best effort basis (false by default). Please note that each call with extra_speed=true will consume 2 requests from the quota . Experimental feature. | | `country_code` | string | No | The country / region for which to make the query. Allowed values: 2-letter country code, see ISO 3166-1 alpha-2. | | `language_code` | string | No | The language to use for the search (Google's language_code parameter). Allowed values: 2-letter country code, see ISO 639-1 alpha-2. | | `result_detail` | string ("standard" | "full" | "light") | No | Result detail level: standard search results, full rich results, or lightweight organic results. | | `fetch_ai_overviews` | boolean | No | Whether to return AI Overviews if available (false by default). In case true or 1, AI Overviews will be pulled as well and in case available, the request will consume two request credits from the quota. | | `language_restriction` | string | No | Restrict result languages with lang_{code} values joined by |, such as lang_fr|lang_de. | | `advanced_search_filters` | string | No | This parameter defines advanced search parameters that aren't available using regular query parameters (to be searched). | | `exclude_related_questions` | string ("0" | "1") | No | Set to 1 to exclude related questions such as People also ask, or 0 to include them. | | `exclude_autocorrected_results` | string ("0" | "1") | No | Set to 1 to exclude results for an auto-corrected query, or 0 to include them. | | `return_organic_result_video_thumbnail` | boolean | No | Whether to return the base64 encoded image source for organic video results (false by default). In case true or 1, an additional video_thumbnail field will be returned for organic video results containing the base64 encoded image. | #### 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 | ### Image Search **Slug:** `OPENWEB_NINJA_SEARCH_WITH_GOOGLE_LENS` Search image by url and get visual matches, knowledge graph, and products found on the web. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | URL of an image with which to perform the search. | | `query` | string | No | Search query to further refine the results. | | `country` | string | No | Set the country for the search (Google's country_code parameter). Allowed values: 2-letter country code, see ISO 3166. | | `language` | string | No | Set the language of the results (Google's language_code parameter). Allowed values: 2-letter language code, see ISO 639-1. | #### 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 | ### Business Search **Slug:** `OPENWEB_NINJA_SEARCH_YELP_BUSINESSES` Search for Yelp businesses by query / keyword and location. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Search query / keyword | | `start` | integer | No | Number of results to skip. Mainly used for pagination. | | `sort_by` | string ("RECOMMENDED" | "HIGHEST_RATED" | "REVIEW_COUNT") | No | Return the results in a specific sort order. | | `location` | string | Yes | Search location. | | `price_range` | string | No | Find business with specific price ranges, specified as a comma delimited list of the following values: $, $$, $$$, $$$$. | | `yelp_domain` | string | No | The yelp domain to use for the search. | #### 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 | ### Agent Search **Slug:** `OPENWEB_NINJA_SEARCH_ZILLOW_AGENTS` Search for real estate agents by location and optionally by name. Returns one page; pass next_cursor to continue. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Filter agents by name. | | `location` | string | Yes | Location slug for the agent search (city-state format, e.g. new-york-ny, los-angeles-ca, miami-fl). | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | #### 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 **Slug:** `OPENWEB_NINJA_SEARCH_ZILLOW_PROPERTIES` Search for properties by location (county, neighborhood, city, or zip code) with support for the filters and options available on Zillow.com. Returns one page; pass next_cursor to continue. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("DEFAULT" | "VERIFIED_SOURCE" | "PRICE_HIGH_LOW" | "PRICE_LOW_HIGH" | "NEWEST" | "BEDROOMS" | "BATHROOMS" | "SQUARE_FEET" | "LOT_SIZE") | No | Return the results in a specific sort order. Allowed values for FOR_SALE and RECENTLY_SOLD: DEFAULT PRICE_HIGH_LOW PRICE_LOW_HIGH NEWEST BEDROOMS BATHROOMS SQUARE_FEET LOT_SIZE Allowed values for FOR_RENT: DEFAULT VERIFIED_SOURCE PRICE_HIGH_LOW PRICE_LOW_HIGH NEWEST BEDROOMS BATHROOMS SQUARE_FEET LOT_SIZE Note: For other status types DEFAULT sort order is the equivalent of Homes for you. | | `location` | string | Yes | Location details (county, neighborhood or zip code). | | `max_sqft` | number | No | Sets the maximum square footage for properties. | | `min_sqft` | number | No | Sets the minimum square footage for properties. | | `home_type` | string | No | Filters by comma-separated list of property types (leave empty to include all types): Allowed values for FOR_SALE and RECENTLY_SOLD: HOUSES TOWNHOMES MULTI_FAMILY CONDOS_COOPS LOTSLAND APARTMENTS MANUFACTURED Allowed values for FOR_RENT: HOUSES APARTMENTS_CONDOS_COOPS TOWNHOMES | | `max_price` | number | No | Sets the maximum price for properties in the search results. | | `min_price` | number | No | Sets the minimum price for properties in the search results. | | `space_type` | string | No | Find properties with specified space type (works for FOR_RENT home_status type), specified as a comma separated list of the following values: ENTIRE_PLACE, ROOM. | | `home_status` | string ("FOR_SALE" | "FOR_RENT" | "RECENTLY_SOLD") | No | Filters properties based on their status. | | `max_hoa_fee` | number | No | Sets the maximum Homeowners Association (HOA) fee for properties (0 - no hoa fee). | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `listing_type` | string | No | Listing type of the property. (BY_OWNER_OTHER is for off market properties). | | `max_bedrooms` | number | No | Filters properties by a maximum number of bedrooms. | | `max_lot_size` | number | No | Sets the minimum lot size for properties (in square feet). | | `min_bedrooms` | number | No | Filters properties by a minimum number of bedrooms. | | `min_lot_size` | number | No | Sets the minimum lot size for properties (in square feet). | | `max_bathrooms` | number | No | Filters properties by a maximum number of bathrooms. | | `min_bathrooms` | number | No | Filters properties by a minimum number of bathrooms. | | `for_sale_by_agent` | boolean | No | Filters properties listed by real estate agents. | | `for_sale_by_owner` | boolean | No | Filters properties listed by the owner directly. Note: works only for listing_type BY_OWNER_OTHER. | | `for_sale_is_auction` | boolean | No | Filters for properties that are for sale at auction. | | `max_monthly_payment` | number | No | Sets the maxium monthly payment for properties in the search results (only for FOR_SALE). Includes estimated principal and interest, mortgage insurance, property taxes, home insurance and HOA fees. | | `min_monthly_payment` | number | No | Sets the minimum monthly payment for properties in the search results (only for FOR_SALE). Includes estimated principal and interest, mortgage insurance, property taxes, home insurance and HOA fees. | | `for_sale_is_foreclosed` | boolean | No | Filters for properties which had been foreclosed. These properties are owned by a bank or a lender who took ownership through foreclosure proceedings. They may soon be listed for sale. | | `for_sale_is_foreclosure` | boolean | No | Filters for properties that are foreclosures. These properties are currently listed for sale. They are owned by a bank or a lender who took ownership through foreclosure proceedings. These are also known as bank-owned or real estate owned (REO). | | `for_sale_is_preforeclosure` | boolean | No | Filters for properties in pre-market foreclosure status. The lender initiated foreclosure proceedings on these properties because the owner(s) were in default on their loan obligations. Pre-foreclosures also include properties for which a foreclosure auction is scheduled. | | `includes_homes_no_hoa_data` | boolean | No | Include homes with incomplete HOA data. | | `for_sale_is_new_construction` | boolean | No | Filters for new construction properties. | #### 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 by Coordinates **Slug:** `OPENWEB_NINJA_SEARCH_ZILLOW_PROPERTIES_BY_COORDINATES` Search for properties in a specific geographic location, by a center latitude, longitude point and a diameter. Returns one page; pass next_cursor to continue. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `lat` | number | Yes | Specifies geographic latitude of the area center point for the property search. | | `sort` | string ("DEFAULT" | "VERIFIED_SOURCE" | "PRICE_HIGH_LOW" | "PRICE_LOW_HIGH" | "NEWEST" | "BEDROOMS" | "BATHROOMS" | "SQUARE_FEET" | "LOT_SIZE") | No | Return the results in a specific sort order. Allowed values for FOR_SALE and RECENTLY_SOLD: DEFAULT PRICE_HIGH_LOW PRICE_LOW_HIGH NEWEST BEDROOMS BATHROOMS SQUARE_FEET LOT_SIZE Allowed values for FOR_RENT: DEFAULT VERIFIED_SOURCE PRICE_HIGH_LOW PRICE_LOW_HIGH NEWEST BEDROOMS BATHROOMS SQUARE_FEET LOT_SIZE Note: For other status types DEFAULT sort order is the equivalent of Homes for you. | | `diameter` | number | No | Diameter in miles for the search area around center point defined by long, lat. | | `max_sqft` | number | No | Sets the maximum square footage for properties. | | `min_sqft` | number | No | Sets the minimum square footage for properties. | | `home_type` | string | No | Filters by comma-separated list of property types (leave empty to include all types): Allowed values for FOR_SALE and RECENTLY_SOLD: HOUSES TOWNHOMES MULTI_FAMILY CONDOS_COOPS LOTSLAND APARTMENTS MANUFACTURED Allowed values for FOR_RENT: HOUSES APARTMENTS_CONDOS_COOPS TOWNHOMES | | `longitude` | number | Yes | Specifies geographic longitude of the area center point for the property search. | | `max_price` | number | No | Sets the maximum price for properties in the search results. | | `min_price` | number | No | Sets the minimum price for properties in the search results. | | `space_type` | string | No | Find properties with specified space type (works for FOR_RENT home_status type), specified as a comma separated list of the following values: ENTIRE_PLACE, ROOM. | | `home_status` | string ("FOR_SALE" | "FOR_RENT" | "RECENTLY_SOLD") | No | Filters properties based on their status. | | `max_hoa_fee` | number | No | Sets the maximum Homeowners Association (HOA) fee for properties (0 - no hoa fee). | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `listing_type` | string | No | Listing type of the property. (BY_OWNER_OTHER is for off market properties). | | `max_bedrooms` | number | No | Filters properties by a maximum number of bedrooms. | | `max_lot_size` | number | No | Sets the minimum lot size for properties (in square feet). | | `min_bedrooms` | number | No | Filters properties by a minimum number of bedrooms. | | `min_lot_size` | number | No | Sets the minimum lot size for properties (in square feet). | | `max_bathrooms` | number | No | Filters properties by a maximum number of bathrooms. | | `min_bathrooms` | number | No | Filters properties by a minimum number of bathrooms. | | `for_sale_by_agent` | boolean | No | Filters properties listed by real estate agents. | | `for_sale_by_owner` | boolean | No | Filters properties listed by the owner directly. Note: works only for listing_type BY_OWNER_OTHER. | | `for_sale_is_auction` | boolean | No | Filters for properties that are for sale at auction. | | `max_monthly_payment` | number | No | Sets the maxium monthly payment for properties in the search results (only for FOR_SALE). Includes estimated principal and interest, mortgage insurance, property taxes, home insurance and HOA fees. | | `min_monthly_payment` | number | No | Sets the minimum monthly payment for properties in the search results (only for FOR_SALE). Includes estimated principal and interest, mortgage insurance, property taxes, home insurance and HOA fees. | | `for_sale_is_foreclosed` | boolean | No | Filters for properties which had been foreclosed. These properties are owned by a bank or a lender who took ownership through foreclosure proceedings. They may soon be listed for sale. | | `for_sale_is_foreclosure` | boolean | No | Filters for properties that are foreclosures. These properties are currently listed for sale. They are owned by a bank or a lender who took ownership through foreclosure proceedings. These are also known as bank-owned or real estate owned (REO). | | `for_sale_is_preforeclosure` | boolean | No | Filters for properties in pre-market foreclosure status. The lender initiated foreclosure proceedings on these properties because the owner(s) were in default on their loan obligations. Pre-foreclosures also include properties for which a foreclosure auction is scheduled. | | `includes_homes_no_hoa_data` | boolean | No | Include homes with incomplete HOA data. | | `for_sale_is_new_construction` | boolean | No | Filters for new construction properties. | #### 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 by Polygon **Slug:** `OPENWEB_NINJA_SEARCH_ZILLOW_PROPERTIES_BY_POLYGON` Search for properties in a specific geographic polygon area. Returns one page; pass next_cursor to continue. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("DEFAULT" | "VERIFIED_SOURCE" | "PRICE_HIGH_LOW" | "PRICE_LOW_HIGH" | "NEWEST" | "BEDROOMS" | "BATHROOMS" | "SQUARE_FEET" | "LOT_SIZE") | No | Return the results in a specific sort order. Allowed values for FOR_SALE and RECENTLY_SOLD: DEFAULT PRICE_HIGH_LOW PRICE_LOW_HIGH NEWEST BEDROOMS BATHROOMS SQUARE_FEET LOT_SIZE Allowed values for FOR_RENT: DEFAULT VERIFIED_SOURCE PRICE_HIGH_LOW PRICE_LOW_HIGH NEWEST BEDROOMS BATHROOMS SQUARE_FEET LOT_SIZE Note: For other status types DEFAULT sort order is the equivalent of Homes for you. | | `polygon` | string | Yes | Defines a custom geographic search area by specifying a series of latitude and longitude coordinates that form a closed shape (polygon). Each coordinate pair (lat, lng) represents a point on the map, and the last pair of coordinates must match the first pair to close the polygon. Format: lat lng,lat1 lng1,lat2 lng2,...,lat lng This allows users to search for properties within complex, non-standard boundaries. | | `max_sqft` | number | No | Sets the maximum square footage for properties. | | `min_sqft` | number | No | Sets the minimum square footage for properties. | | `home_type` | string | No | Filters by comma-separated list of property types (leave empty to include all types): Allowed values for FOR_SALE and RECENTLY_SOLD: HOUSES TOWNHOMES MULTI_FAMILY CONDOS_COOPS LOTSLAND APARTMENTS MANUFACTURED Allowed values for FOR_RENT: HOUSES APARTMENTS_CONDOS_COOPS TOWNHOMES | | `max_price` | number | No | Sets the maximum price for properties in the search results. | | `min_price` | number | No | Sets the minimum price for properties in the search results. | | `space_type` | string | No | Find properties with specified space type (works for FOR_RENT home_status type), specified as a comma separated list of the following values: ENTIRE_PLACE, ROOM. | | `home_status` | string ("FOR_SALE" | "FOR_RENT" | "RECENTLY_SOLD") | No | Filters properties based on their status. | | `max_hoa_fee` | number | No | Sets the maximum Homeowners Association (HOA) fee for properties (0 - no hoa fee). | | `next_cursor` | string | No | Continuation token returned by the previous call; omit for the first page. | | `listing_type` | string | No | Listing type of the property. (BY_OWNER_OTHER is for off market properties). | | `max_bedrooms` | number | No | Filters properties by a maximum number of bedrooms. | | `max_lot_size` | number | No | Sets the minimum lot size for properties (in square feet). | | `min_bedrooms` | number | No | Filters properties by a minimum number of bedrooms. | | `min_lot_size` | number | No | Sets the minimum lot size for properties (in square feet). | | `max_bathrooms` | number | No | Filters properties by a maximum number of bathrooms. | | `min_bathrooms` | number | No | Filters properties by a minimum number of bathrooms. | | `for_sale_by_agent` | boolean | No | Filters properties listed by real estate agents. | | `for_sale_by_owner` | boolean | No | Filters properties listed by the owner directly. Note: works only for listing_type BY_OWNER_OTHER. | | `for_sale_is_auction` | boolean | No | Filters for properties that are for sale at auction. | | `max_monthly_payment` | number | No | Sets the maxium monthly payment for properties in the search results (only for FOR_SALE). Includes estimated principal and interest, mortgage insurance, property taxes, home insurance and HOA fees. | | `min_monthly_payment` | number | No | Sets the minimum monthly payment for properties in the search results (only for FOR_SALE). Includes estimated principal and interest, mortgage insurance, property taxes, home insurance and HOA fees. | | `for_sale_is_foreclosed` | boolean | No | Filters for properties which had been foreclosed. These properties are owned by a bank or a lender who took ownership through foreclosure proceedings. They may soon be listed for sale. | | `for_sale_is_foreclosure` | boolean | No | Filters for properties that are foreclosures. These properties are currently listed for sale. They are owned by a bank or a lender who took ownership through foreclosure proceedings. These are also known as bank-owned or real estate owned (REO). | | `for_sale_is_preforeclosure` | boolean | No | Filters for properties in pre-market foreclosure status. The lender initiated foreclosure proceedings on these properties because the owner(s) were in default on their loan obligations. Pre-foreclosures also include properties for which a foreclosure auction is scheduled. | | `includes_homes_no_hoa_data` | boolean | No | Include homes with incomplete HOA data. | | `for_sale_is_new_construction` | boolean | No | Filters for new construction properties. | #### 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 |