### Install n8n-nodes-dataforseo via npm Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/09-configuration-guide.md Use this command to install the DataForSEO nodes package for self-hosted n8n instances. Ensure Node.js and npm are installed. ```bash npm install -g n8n npm install n8n-nodes-dataforseo ``` -------------------------------- ### Get Backlinks Operation Example Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/08-unified-node-operations.md Example of how to configure the 'Get Backlinks' operation for the Backlinks resource. Ensure 'target' is provided and 'mode' is set appropriately. The 'order_by' parameter accepts an array of sort rules. ```text Resource: Backlinks Operation: Get Backlinks target: example.com mode: as_is limit: 100 order_by: [{"fieldName":"domain_rank","direction":"desc"}] ``` -------------------------------- ### Backlinks Summary Example Parameters Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/04-backlinks-api.md Example parameter values for fetching a live backlinks summary. Ensure 'target' is provided and consider 'include_subdomains' and 'backlinks_status_type'. ```text Parameter Values: - target: "example.com" - include_subdomains: true - internal_list_limit: 100 - backlinks_status_type: "live" ``` -------------------------------- ### Batch Processing Input Example Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/09-configuration-guide.md Example of an input array for batch processing, where each item contains a domain for backlink analysis. ```json [ { "json": { "domain": "example1.com" } }, { "json": { "domain": "example2.com" } }, { "json": { "domain": "example3.com" } } ] ``` -------------------------------- ### Backlinks Resource File Example Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/03-node-architecture.md Shows an example of a resource file defining UI parameters for the 'backlinks' resource, including operation selection and target parameter configuration. ```typescript export const BacklinksOperations: INodeProperties[] = [ { displayName: 'Operation', name: 'operation', type: 'options', noDataExpression: true, displayOptions: { show: { resource: ['backlinks'] } }, options: [ { name: 'Get Backlinks', value: 'get-backlinks' }, { name: 'Get Backlink Summary', value: 'get-backlink-summary' } ], default: 'get-backlinks' }, // Operation-specific parameters { displayName: 'Target', name: 'target', type: 'string', default: '', required: true, displayOptions: { show: { resource: ['backlinks'], operation: ['get-backlinks', 'get-backlink-summary'] } }, description: 'Domain, subdomain, or URL to analyze' } // ... more parameters ] ``` -------------------------------- ### DataForSEO API Request Usage Example Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/02-shared-functions.md Example of how to use the dataForSeoRequest function to send a POST request for backlinks data. Ensure the 'dataForSeoRequest' function is imported. ```typescript import { dataForSeoRequest } from '../../../functions/dataForSeoRequest' const params: IHttpRequestOptions = { url: '/backlinks/backlinks/live', body: [{ target: 'example.com', mode: 'as_is', limit: 10 }] } const response = await dataForSeoRequest(ef, params) ``` -------------------------------- ### Get Keyword Ideas Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/10-complete-operation-index.md Retrieves keyword ideas using DataForSeo Labs. ```APIDOC ## POST /dataforseo_labs/google/keyword_ideas/live ### Description Retrieves keyword ideas using DataForSeo Labs. ### Method POST ### Endpoint /dataforseo_labs/google/keyword_ideas/live ### Function getKeywordIdeas() ``` -------------------------------- ### Get Competitors Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Retrieves a list of competitor domains for a given domain. ```APIDOC ## GET /backlinks/competitors/live ### Description Retrieves a list of competitor domains for a given domain. ### Method GET ### Endpoint /backlinks/competitors/live ### Parameters #### Query Parameters - **domain** (string) - Required - The domain to find competitors for. - **api_key** (string) - Required - Your DataForSEO API key. - **limit** (integer) - Optional - The maximum number of competitors to return (default: 100). - **offset** (integer) - Optional - The offset for pagination (default: 0). ### Request Example ```bash curl -X GET "https://api.dataforseo.com/v3/backlinks/competitors/live?domain=example.com&limit=30&api_key=YOUR_API_KEY" ``` ### Response #### Success Response (200) - **status_code** (integer) - The status code of the response. - **status_message** (string) - The status message of the response. - **time_taken** (float) - The time taken to process the request in seconds. - **data** (array) - An array of competitor domain objects. - Each object contains: - **domain** (string) - The competitor domain. - **links_count** (integer) - The number of backlinks shared with the target domain. - **domain_authority** (float) - The domain authority of the competitor. #### Response Example ```json { "status_code": 200, "status_message": "OK", "time_taken": 0.035, "data": [ { "domain": "competitor1.com", "links_count": 80000, "domain_authority": 92.1 }, { "domain": "competitor2.net", "links_count": 75000, "domain_authority": 91.5 } ] } ``` ``` -------------------------------- ### Get Finance Explore Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/10-complete-operation-index.md Explores financial data within Google SERP results. ```APIDOC ## POST /serp/google/finance_explore/live/advanced ### Description Explores financial data in Google SERP results. ### Method POST ### Endpoint /serp/google/finance_explore/live/advanced ### Function getFinanceExplore() ``` -------------------------------- ### Get App Info Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/07-specialized-apis.md Retrieve detailed information about a specific app. ```APIDOC ## Get App Info ### Description Retrieve detailed app information. ### Method POST ### Endpoint https://api.dataforseo.com/v3/app_data/get/app_info ### Parameters #### Query Parameters - **app_id** (string) - Required - App ID or Bundle ID ### Response #### Success Response (200) (includes: description, permissions, screenshots, IAP, etc.) ``` -------------------------------- ### Get Keyword Suggestions Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/10-complete-operation-index.md Retrieves keyword suggestions using DataForSeo Labs. ```APIDOC ## POST /dataforseo_labs/google/keyword_suggestions/live ### Description Retrieves keyword suggestions using DataForSeo Labs. ### Method POST ### Endpoint /dataforseo_labs/google/keyword_suggestions/live ### Function getKeywordSuggestions() ``` -------------------------------- ### Get Business Listings Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/10-complete-operation-index.md Retrieves business listing information from various sources. ```APIDOC ## POST /business_data/business_listings/search/live ### Description Retrieves business listing information. ### Method POST ### Endpoint /business_data/business_listings/search/live ### Function getBusinessListings() ``` -------------------------------- ### Get Bulk Backlinks Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/04-backlinks-api.md Get backlink counts for up to 1,000 domains simultaneously. ```APIDOC ## POST /backlinks/bulk_backlinks/live ### Description Get backlink counts for up to 1,000 domains. ### Method POST ### Endpoint /backlinks/bulk_backlinks/live ### Parameters #### Query Parameters - **targets** (array) - Required - Array of domains/URLs (max 1000). ``` -------------------------------- ### Build and Development Commands Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/00-project-overview.md Essential commands for building the project, watching for changes during development, linting, and formatting code. ```bash tsc && gulp build:icons ``` ```bash tsc --watch ``` ```bash eslint nodes credentials package.json ``` ```bash prettier nodes credentials --write ``` -------------------------------- ### Get Bulk Ranks Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/04-backlinks-api.md Get rank scores for up to 1,000 domains simultaneously. ```APIDOC ## POST /backlinks/bulk_ranks/live ### Description Get rank scores for up to 1,000 domains simultaneously. ### Method POST ### Endpoint /backlinks/bulk_ranks/live ### Parameters #### Query Parameters - **targets** (array) - Required - Array of domains/URLs (max 1000). ### Response #### Success Response (200) - **tasks** (array) - Contains task results. - **result** (array) - List of rank scores. - **target** (string) - The domain or URL. - **domain_rank** (number) - The domain rank. - **page_rank** (number) - The PageRank. ``` -------------------------------- ### Get Domain Pages Summary Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/04-backlinks-api.md Get summary statistics for pages within a domain. ```APIDOC ## POST /backlinks/domain_pages_summary/live ### Description Get summary statistics for pages within a domain. ### Method POST ### Endpoint /backlinks/domain_pages_summary/live ### Parameters #### Request Body - **target** (string) - Required - Domain to analyze ``` -------------------------------- ### Get Referring Networks Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/04-backlinks-api.md Get referring networks/organizations linking to a target domain, subdomain, or URL. ```APIDOC ## POST /backlinks/referring_networks/live ### Description Get referring networks/organizations linking to target. ### Method POST ### Endpoint /backlinks/referring_networks/live ### Parameters #### Request Body - **target** (string) - Required - Domain, subdomain, or URL - **limit** (number) - Optional - Max networks (max 10000), Default: 10 - **offset** (number) - Optional - Offset in results, Default: 0 ``` -------------------------------- ### Get Live Finance Explore SERP Advanced Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Retrieves live Google Finance Explore SERP data in an advanced format. ```APIDOC ## GET /serp/google/finance_explore/live/advanced ### Description Fetches live Google Finance Explore SERP results in an advanced format. ### Method GET ### Endpoint /serp/google/finance_explore/live/advanced ### Parameters #### Query Parameters - **api_key** (string) - Required - Your DataForSEO API key. - **search_parameters** (object) - Required - Parameters for the search query. - **keyword** (string) - Required - Keyword to search for. - **location_name** (string) - Optional - Location for the search. - **language_code** (string) - Optional - Language code for the search. ### Request Example ```json { "api_key": "YOUR_API_KEY", "search_parameters": { "keyword": "example keyword", "location_name": "United States", "language_code": "en" } } ``` ### Response #### Success Response (200) - **status_code** (integer) - Status code of the operation. - **status_message** (string) - Message describing the status. - **time_taken** (string) - Time taken to complete the request. - **data** (object) - SERP data. #### Response Example ```json { "status_code": 200, "status_message": "OK", "time_taken": "1.40s", "data": { "finance_explore": [ { "title": "Example Finance Result", "exchange_rate": "1.00" } ] } } ``` ``` -------------------------------- ### Get Keyword Suggestions Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Get search terms that are relevant to the product or service categories of all the specified keywords. ```APIDOC ## Get Keyword Suggestions ### Description Get search terms that are relevant to the product or service categories of all the specified keywords. ### Parameters #### Query Parameters - **location** (string) - Required - The full name of the search engine location. You can find the supported locations in the DataForSEO [Supported Locations page](https://docs.dataforseo.com/v3/serp/google/locations/). - **language** (string) - Required - The full name of the search engine language. You can find the list of supported languages in the DataForSEO [Supported Languages page](https://docs.dataforseo.com/v3/serp/google/languages/). - **keyword** (string) - Required - The keyword for which you want to retrieve suggestions. - **limit** (integer) - Optional - The maximum number of keyword suggestions to retrieve (up to 1000). - **offset** (integer) - Optional - The offset in the results array. For example, if set to 10, the first 10 results will be skipped, and the data will start from the subsequent result. - **sort** (string) - Optional - The sorting criteria for keyword suggestions. ``` -------------------------------- ### Get Backlinks Timeseries Summary Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/04-backlinks-api.md Get backlink count trends over time for a given domain, subdomain, or URL. ```APIDOC ## POST /backlinks/timeseries_summary/live ### Description Get backlink count trends over time. ### Method POST ### Endpoint /backlinks/timeseries_summary/live ### Parameters #### Request Body - **target** (string) - Required - Domain, subdomain, or URL - **include_subdomains** (boolean) - Optional - Include subdomains, Default: false ``` -------------------------------- ### DataForSEO Batch Processing Flow Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/09-configuration-guide.md Illustrates how DataForSEO nodes handle multiple input items, processing each individually and maintaining output pairing. ```text Input: [Item1, Item2, Item3] ↓ (for each item) Process Item1 → Operation1 → Result1 Process Item2 → Operation1 → Result2 Process Item3 → Operation1 → Result3 ↓ Output: [Item1 with Result1, Item2 with Result2, Item3 with Result3] ``` -------------------------------- ### Get Referring Domains Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/04-backlinks-api.md Get a list of domains linking to the target with detailed statistics, supporting sorting and pagination. ```APIDOC ## POST /backlinks/referring_domains/live ### Description Get list of domains linking to the target with detailed statistics. ### Method POST ### Endpoint /backlinks/referring_domains/live ### Parameters #### Query Parameters - **target** (string) - Required - Domain, subdomain, or URL - **limit** (number) - Optional - Max results (max 10000), defaults to 10 - **offset** (number) - Optional - Offset in results, defaults to 0 - **order_by** (array) - Optional - Sort rules (max 3). Example: `[{"fieldName":"rank","direction":"asc"}]`. Available fields: `referring_domain`, `domain_rank`, `page_rank`, `last_seen`, `first_seen`. - **include_subdomains** (boolean) - Optional - Include subdomains in the search, defaults to false. ``` -------------------------------- ### Get Live Google Local Finder SERP Advanced Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Retrieves live Google Local Finder SERP data in an advanced format. ```APIDOC ## GET /serp/google/local_finder/live/advanced ### Description Fetches live Google Local Finder SERP results in an advanced format. ### Method GET ### Endpoint /serp/google/local_finder/live/advanced ### Parameters #### Query Parameters - **api_key** (string) - Required - Your DataForSEO API key. - **search_parameters** (object) - Required - Parameters for the search query. - **keyword** (string) - Required - Keyword to search for. - **location_name** (string) - Optional - Location for the search. - **language_code** (string) - Optional - Language code for the search. ### Request Example ```json { "api_key": "YOUR_API_KEY", "search_parameters": { "keyword": "example keyword", "location_name": "United States", "language_code": "en" } } ``` ### Response #### Success Response (200) - **status_code** (integer) - Status code of the operation. - **status_message** (string) - Message describing the status. - **time_taken** (string) - Time taken to complete the request. - **data** (object) - SERP data. #### Response Example ```json { "status_code": 200, "status_message": "OK", "time_taken": "1.60s", "data": { "local_finder": [ { "title": "Example Local Result", "address": "123 Example St" } ] } } ``` ``` -------------------------------- ### Get Live Google Organic SERP (Advanced) Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/05-serp-api.md Retrieve live Google results with advanced features and detailed metrics, including keyword difficulty and feature analysis. ```APIDOC ## Get Live Google Organic SERP (Advanced) ### Description Retrieve live Google results with advanced features and detailed metrics. ### Method POST ### Endpoint /serp/google/organic/live/advanced ### Parameters #### Query Parameters - **keyword** (string) - Required - Search query (max 700 characters) - **location** (string) - Optional - Location name or code (default: United States) - **language** (string) - Optional - Language name or code (default: English) - **device** (enum) - Optional - desktop | mobile (default: desktop) - **os** (enum) - Optional - windows | macos | android | ios (default: windows) - **domain** (string) - Optional - Search engine domain (e.g., google.com, google.co.uk) (default: auto) - **depth** (number) - Optional - Number of results to retrieve (max 700) (default: 10) - **calculate_keyword_difficulty** (boolean) - Optional - Include keyword difficulty metric (default: false) - **include_serp_features** (boolean) - Optional - Include feature analysis (default: false) - **include_html** (boolean) - Optional - Include raw HTML (Large response) (default: false) ### Response #### Success Response (200) - **tasks** (array) - Contains task results. - **result** (array) - Contains search result items. - **keyword** (string) - The search query. - **type** (string) - Type of search result. - **se_results_count** (number) - Number of search engine results. - **items_count** (number) - Number of items in the results. - **items** (array) - Array of search result items. - **type** (string) - Type of the search result item. - **position** (number) - Position of the item in the SERP. - **title** (string) - Title of the search result. - **description** (string) - Description of the search result. - **url** (string) - URL of the search result. - **domain** (string) - Domain of the search result. - **date_published** (string) - Publication date of the result. - **links** (array) - Array of related links. - **title** (string) - Title of the related link. - **url** (string) - URL of the related link. - **keyword_difficulty** (number) - Estimated difficulty ranking 0-100 (if `calculate_keyword_difficulty` is true). - **serp_features** (object) - Rich snippets, featured snippets, knowledge panels, etc. (if `include_serp_features` is true). - **related_searches** (array) - Suggested related search terms (if `include_serp_features` is true). - **question_answers** (array) - "People also ask" section items (if `include_serp_features` is true). ``` -------------------------------- ### Content Analysis API - Get Rating Distribution Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/07-specialized-apis.md Get the distribution of review ratings for content analysis using the get-rating-distribution operation. ```APIDOC ## GET /v3/content_analysis/get-rating-distribution ### Description Gets review ratings distribution for content analysis. ### Method GET ### Endpoint /v3/content_analysis/get-rating-distribution ### Parameters #### Query Parameters - **keyword** (string) - Required - Content analysis keyword - **location** (string) - Optional - Location - **language** (string) - Optional - Language ``` -------------------------------- ### Passing Data from Previous Node Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/09-configuration-guide.md Demonstrates how to reference data from a previous node's output (e.g., 'Split Data') within a DataForSEO node's parameters using mustache syntax. ```text Node 1: Split Data → [item1, item2, item3] Node 2: DataForSEO (Backlinks) - target: {{ $json.domain }} // Reference from Node 1 output ``` -------------------------------- ### Get Live Finance Explore SERP HTML Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Retrieves live Google Finance Explore SERP data in HTML format. ```APIDOC ## GET /serp/google/finance_explore/live/html ### Description Fetches live Google Finance Explore SERP results in HTML format. ### Method GET ### Endpoint /serp/google/finance_explore/live/html ### Parameters #### Query Parameters - **api_key** (string) - Required - Your DataForSEO API key. - **search_parameters** (object) - Required - Parameters for the search query. - **keyword** (string) - Required - Keyword to search for. - **location_name** (string) - Optional - Location for the search. - **language_code** (string) - Optional - Language code for the search. ### Request Example ```json { "api_key": "YOUR_API_KEY", "search_parameters": { "keyword": "example keyword", "location_name": "United States", "language_code": "en" } } ``` ### Response #### Success Response (200) - **status_code** (integer) - Status code of the operation. - **status_message** (string) - Message describing the status. - **time_taken** (string) - Time taken to complete the request. - **html** (string) - The HTML content of the SERP page. #### Response Example ```json { "status_code": 200, "status_message": "OK", "time_taken": "1.35s", "html": "..." } ``` ``` -------------------------------- ### Get Referring Domains with Filters Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/04-backlinks-api.md Get a list of domains linking to the target with detailed statistics. Supports sorting and including subdomains. ```typescript { "target": "example.com", "limit": 100, "offset": 0, "order_by": [ { "fieldName": "referring_domain", "direction": "desc" } ], "include_subdomains": true } ``` -------------------------------- ### Get Business Listings Categories Aggregation Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/08-unified-node-operations.md Aggregates business listings by categories. Uses the same parameters as the 'Get Business Listings' operation. ```APIDOC ## POST /business_data/business_listings/categories_aggregation/live ### Description Aggregates business listings by categories. Uses the same parameters as the 'Get Business Listings' operation. ### Method POST ### Endpoint /business_data/business_listings/categories_aggregation/live ### Parameters #### Query Parameters - **location_coordinate** (string) - Optional - Latitude,longitude,radius - **title** (string) - Optional - Business name - **description** (string) - Optional - Business description keywords - **categories** (array) - Optional - Business categories (max 10) - **is_claimed** (boolean) - Optional - Claimed status filter - **limit** (number) - Optional - Max results (max 1000) - **offset** (number) - Optional - Offset in results - **sort** (array) - Optional - Sort rules ``` -------------------------------- ### Get Live Google Local Finder SERP HTML Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Retrieves live Google Local Finder SERP data in HTML format. ```APIDOC ## GET /serp/google/local_finder/live/html ### Description Fetches live Google Local Finder SERP results in HTML format. ### Method GET ### Endpoint /serp/google/local_finder/live/html ### Parameters #### Query Parameters - **api_key** (string) - Required - Your DataForSEO API key. - **search_parameters** (object) - Required - Parameters for the search query. - **keyword** (string) - Required - Keyword to search for. - **location_name** (string) - Optional - Location for the search. - **language_code** (string) - Optional - Language code for the search. ### Request Example ```json { "api_key": "YOUR_API_KEY", "search_parameters": { "keyword": "example keyword", "location_name": "United States", "language_code": "en" } } ``` ### Response #### Success Response (200) - **status_code** (integer) - Status code of the operation. - **status_message** (string) - Message describing the status. - **time_taken** (string) - Time taken to complete the request. - **html** (string) - The HTML content of the SERP page. #### Response Example ```json { "status_code": 200, "status_message": "OK", "time_taken": "1.55s", "html": "..." } ``` ``` -------------------------------- ### Get Pages Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Retrieves a list of pages based on specified criteria. This endpoint is useful for getting an overview of pages within a project or scan. ```APIDOC ## GET /v3/on_page/pages ### Description Retrieves a list of pages within the specified task. ### Method GET ### Endpoint /v3/on_page/pages ### Parameters #### Query Parameters - **se_type** (string) - Required - Search engine type - **date_from** (string) - Optional - Date from which to retrieve data - **date_to** (string) - Optional - Date to which to retrieve data - **limit** (integer) - Optional - Maximum number of results to return - **offset** (integer) - Optional - Offset for paginating results ### Response #### Success Response (200) - **status_code** (integer) - HTTP status code - **status_message** (string) - HTTP status message - **time** (string) - Response time in HH:mm:ss format - **cost** (float) - Cost of the operation in credits - **data** (object) - Contains data on pages - **items** (array) - Array of page objects - **url** (string) - URL of the page - **first_seen** (string) - Date and time when the page was first seen - **last_seen** (string) - Date and time when the page was last seen - **status** (string) - Status of the page - **tags** (array) - Array of tags associated with the page - **resource** (string) - Resource identifier for the page ### Request Example ```bash curl -X GET "https://api.dataforseo.com/v3/on_page/pages?se_type=google&limit=10" ``` ### Response Example ```json { "status_code": 200, "status_message": "OK", "time": "00:00:01,123", "cost": 0.001, "data": { "items": [ { "url": "https://example.com", "first_seen": "2023-01-01 10:00:00", "last_seen": "2023-01-01 10:00:00", "status": "success", "tags": ["tag1", "tag2"], "resource": "example.com" } ] } } ``` ``` -------------------------------- ### Get Live Google Finance Explore SERP Advanced Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/10-complete-operation-index.md Retrieves live advanced data for Google Finance Explore SERP. ```APIDOC ## POST /serp/google/finance_explore/live/advanced ### Description Retrieves live advanced data for Google Finance Explore SERP. ### Method POST ### Endpoint /serp/google/finance_explore/live/advanced ``` -------------------------------- ### Get Shopping Products Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/07-specialized-apis.md Retrieve product listings from shopping engines like Google Shopping and Amazon. ```APIDOC ## Get Shopping Products ### Description Retrieve product listings from shopping engines. ### Method POST ### Endpoint https://api.dataforseo.com/v3/merchant/get/shopping/products ### Parameters #### Query Parameters - **keyword** (string) - Required - Product search query - **location** (string) - Optional - Location (Default: United States) - **language** (string) - Optional - Language (Default: English) - **depth** (number) - Optional - Max results (Default: 10) ### Response #### Success Response (200) - **tasks** (array) - Array of tasks, each containing a result. - **result** (array) - Array of product items. - **keyword** (string) - The keyword used for the search. - **items** (array) - Array of product details. - **product_id** (string) - Unique identifier for the product. - **title** (string) - The title of the product. - **description** (string) - A brief description of the product. - **price** (number) - The price of the product. - **currency** (string) - The currency of the product price. - **availability** (string) - The availability status of the product. - **rating** (number) - The average rating of the product. - **review_count** (number) - The number of reviews for the product. - **seller** (string) - The name of the seller. - **url** (string) - The URL of the product listing. ``` -------------------------------- ### Get Live Lighthouse Audit Results Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Retrieves Lighthouse audit results in real-time. This endpoint is useful for getting up-to-date performance and quality scores for a page. ```APIDOC ## GET /v3/on_page/lighthouse/live/json ### Description Retrieves Lighthouse audit results in real-time. ### Method GET ### Endpoint /v3/on_page/lighthouse/live/json ### Parameters #### Query Parameters - **se_type** (string) - Required - Search engine type - **url** (string) - Required - URL of the page to audit ### Response #### Success Response (200) - **status_code** (integer) - HTTP status code - **status_message** (string) - HTTP status message - **time** (string) - Response time in HH:mm:ss format - **cost** (float) - Cost of the operation in credits - **data** (object) - Contains Lighthouse audit results - **url** (string) - URL of the page - **lighthouse_results** (object) - Lighthouse audit details - **performance** (float) - Performance score - **accessibility** (float) - Accessibility score - **seo** (float) - SEO score - **best_practices** (float) - Best practices score - **pwa** (float) - PWA score ### Request Example ```bash curl -X GET "https://api.dataforseo.com/v3/on_page/lighthouse/live/json?se_type=google&url=https://example.com" ``` ### Response Example ```json { "status_code": 200, "status_message": "OK", "time": "00:00:01,123", "cost": 0.001, "data": { "url": "https://example.com", "lighthouse_results": { "performance": 90.5, "accessibility": 85.2, "seo": 95.0, "best_practices": 88.8, "pwa": 75.3 } } } ``` ``` -------------------------------- ### Get Finance Explore SERP Advanced Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Retrieves Google Finance Explore SERP data from a completed task in an advanced format. ```APIDOC ## GET /serp/google/finance_explore/task_get/advanced ### Description Retrieves Google Finance Explore SERP data from a completed task in an advanced format. ### Method GET ### Endpoint /serp/google/finance_explore/task_get/advanced ### Parameters #### Query Parameters - **api_key** (string) - Required - Your DataForSEO API key. - **task_id** (string) - Required - The ID of the completed task. ### Request Example ```json { "api_key": "YOUR_API_KEY", "task_id": "your_task_id" } ``` ### Response #### Success Response (200) - **status_code** (integer) - Status code of the operation. - **status_message** (string) - Message describing the status. - **time_taken** (string) - Time taken to complete the request. - **data** (object) - SERP data. #### Response Example ```json { "status_code": 200, "status_message": "OK", "time_taken": "0.70s", "data": { "finance_explore": [ { "title": "Example Finance Result", "exchange_rate": "1.00" } ] } } ``` ``` -------------------------------- ### Get Live Google Search Volume Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Retrieves live Google Search Volume data. This endpoint is useful for getting real-time search volume information for keywords. ```APIDOC ## GET /v3/keywords_data/google_ads/search_volume/live/ ### Description Retrieves live Google Search Volume data for keywords. ### Method GET ### Endpoint /v3/keywords_data/google_ads/search_volume/live/ ### Parameters #### Query Parameters - **api_key** (string) - Required - Your DataForSEO API key. - **keyword** (string) - Required - The keyword you want to get search volume for. - **location** (string) - Optional - Specifies the location to get search volume for. Example: "United States". - **language** (string) - Optional - Specifies the language to get search volume for. Example: "en". ### Response #### Success Response (200) - **keyword** (string) - The keyword. - **search_volume** (integer) - The search volume for the keyword. ### Response Example { "keyword": "example keyword", "search_volume": 10000 } ``` -------------------------------- ### Get Live Google Organic SERP Regular Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Retrieves live Google Organic SERP data in a regular format. ```APIDOC ## GET /serp/google/organic/live/regular ### Description Fetches live Google Organic SERP results in a regular format. ### Method GET ### Endpoint /serp/google/organic/live/regular ### Parameters #### Query Parameters - **api_key** (string) - Required - Your DataForSEO API key. - **search_parameters** (object) - Required - Parameters for the search query. - **keyword** (string) - Required - Keyword to search for. - **location_name** (string) - Optional - Location for the search. - **language_code** (string) - Optional - Language code for the search. ### Request Example ```json { "api_key": "YOUR_API_KEY", "search_parameters": { "keyword": "example keyword", "location_name": "United States", "language_code": "en" } } ``` ### Response #### Success Response (200) - **status_code** (integer) - Status code of the operation. - **status_message** (string) - Message describing the status. - **time_taken** (string) - Time taken to complete the request. - **data** (object) - SERP data. #### Response Example ```json { "status_code": 200, "status_message": "OK", "time_taken": "1.23s", "data": { "organic": [ { "title": "Example Result Title", "url": "https://www.example.com", "snippet": "This is an example snippet." } ] } } ``` ``` -------------------------------- ### HTTP Basic Authentication Configuration Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/01-credentials.md Configures generic HTTP Basic Authentication for the DataForSEO API, using API login and password from credentials. 'sendImmediately: true' ensures the auth header is sent on the first request. ```typescript authenticate: IAuthenticateGeneric = { type: 'generic', properties: { auth: { username: '={{$credentials.apiLogin}}', password: '={{$credentials.apiPassword}}', sendImmediately: true } } } ``` -------------------------------- ### Get Live Bing Search Volume Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Retrieves live Bing Search Volume data. This endpoint is used to get real-time search volume information for keywords on Bing. ```APIDOC ## GET /v3/keywords_data/bing/search_volume/live/ ### Description Retrieves live Bing Search Volume data for keywords. ### Method GET ### Endpoint /v3/keywords_data/bing/search_volume/live/ ### Parameters #### Query Parameters - **api_key** (string) - Required - Your DataForSEO API key. - **keyword** (string) - Required - The keyword you want to get search volume for. - **location** (string) - Optional - Specifies the location to get search volume for. Example: "United States". - **language** (string) - Optional - Specifies the language to get search volume for. Example: "en". ### Response #### Success Response (200) - **keyword** (string) - The keyword. - **search_volume** (integer) - The search volume for the keyword. ### Response Example { "keyword": "example keyword", "search_volume": 8000 } ``` -------------------------------- ### Get Live Google Organic SERP HTML Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Retrieves live Google Organic SERP data in HTML format. ```APIDOC ## GET /serp/google/organic/live/html ### Description Fetches live Google Organic SERP results in HTML format. ### Method GET ### Endpoint /serp/google/organic/live/html ### Parameters #### Query Parameters - **api_key** (string) - Required - Your DataForSEO API key. - **search_parameters** (object) - Required - Parameters for the search query. - **keyword** (string) - Required - Keyword to search for. - **location_name** (string) - Optional - Location for the search. - **language_code** (string) - Optional - Language code for the search. ### Request Example ```json { "api_key": "YOUR_API_KEY", "search_parameters": { "keyword": "example keyword", "location_name": "United States", "language_code": "en" } } ``` ### Response #### Success Response (200) - **status_code** (integer) - Status code of the operation. - **status_message** (string) - Message describing the status. - **time_taken** (string) - Time taken to complete the request. - **html** (string) - The HTML content of the SERP page. #### Response Example ```json { "status_code": 200, "status_message": "OK", "time_taken": "1.15s", "html": "..." } ``` ``` -------------------------------- ### Get Historical Traffic Stats Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/06-keywords-labs-business-api.md Fetch historical traffic data over time for a domain. This operation uses the same parameters as 'Get Organic Traffic Stats' but returns time series data. ```typescript { tasks: [{ result: [ { target: string, date: string, traffic_volume: number, traffic_growth: number, keywords_count: number } ] }] } ``` -------------------------------- ### Get Finance Explore SERP HTML Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Retrieves HTML data for Google Finance Explore SERP. ```APIDOC ## GET /serp/google/finance_explore/task_get/html/ ### Description Retrieves HTML data for Google Finance Explore SERP. ### Method GET ### Endpoint /serp/google/finance_explore/task_get/html/ ``` -------------------------------- ### Get Live Finance Markets SERP Advanced Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Retrieves advanced data for live Google Finance Markets SERP. ```APIDOC ## GET /serp/google/finance_markets/live/advanced/ ### Description Retrieves advanced data for live Google Finance Markets SERP. ### Method GET ### Endpoint /serp/google/finance_markets/live/advanced/ ``` -------------------------------- ### Get Live Bing Local Finder SERP HTML Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Retrieves HTML data for live Bing Local Finder SERP. Note: This endpoint appears to be a duplicate of Get Live Bing Organic SERP HTML based on the URL. ```APIDOC ## GET /serp/bing/organic/task_get/html/ ### Description Retrieves HTML data for live Bing Local Finder SERP. Note: This endpoint appears to be a duplicate of Get Live Bing Organic SERP HTML based on the URL. ### Method GET ### Endpoint /serp/bing/organic/task_get/html/ ``` -------------------------------- ### Get Live Google Organic SERP (Regular) Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/05-serp-api.md Retrieve live Google search results with standard parameters. This operation fetches organic results for a given keyword. ```APIDOC ## Get Live Google Organic SERP (Regular) ### Description Retrieve live Google search results with standard parameters. ### Method POST ### Endpoint /serp/google/organic/live/regular ### Parameters #### Query Parameters - **keyword** (string) - Required - Search query (max 700 characters) - **location** (string) - Optional - Location name or code (default: United States) - **language** (string) - Optional - Language name or code (default: English) - **device** (enum) - Optional - desktop | mobile (default: desktop) - **os** (enum) - Optional - windows | macos | android | ios (default: windows) - **domain** (string) - Optional - Search engine domain (e.g., google.com, google.co.uk) (default: auto) - **depth** (number) - Optional - Number of results to retrieve (max 700) (default: 10) ### Response #### Success Response (200) - **tasks** (array) - Contains task results. - **result** (array) - Contains search result items. - **keyword** (string) - The search query. - **type** (string) - Type of search result. - **se_results_count** (number) - Number of search engine results. - **items_count** (number) - Number of items in the results. - **items** (array) - Array of search result items. - **type** (string) - Type of the search result item. - **position** (number) - Position of the item in the SERP. - **title** (string) - Title of the search result. - **description** (string) - Description of the search result. - **url** (string) - URL of the search result. - **domain** (string) - Domain of the search result. - **date_published** (string) - Publication date of the result. - **links** (array) - Array of related links. - **title** (string) - Title of the related link. - **url** (string) - URL of the related link. ``` -------------------------------- ### Get Live Bing Local Finder SERP Regular Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/README.md Retrieves regular data for live Bing Local Finder SERP. Note: This endpoint appears to be a duplicate of Get Live Bing Organic SERP Regular based on the URL. ```APIDOC ## GET /serp/bing/organic/task_get/regular/ ### Description Retrieves regular data for live Bing Local Finder SERP. Note: This endpoint appears to be a duplicate of Get Live Bing Organic SERP Regular based on the URL. ### Method GET ### Endpoint /serp/bing/organic/task_get/regular/ ``` -------------------------------- ### Get Google AI Mode SERP Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/08-unified-node-operations.md Fetches SERP data using Google's AI mode. Includes all parameters from 'Get Parsed SERP' plus additional options for calculating pixel rankings and specifying browser dimensions. ```APIDOC ## POST /serp/google/ai_mode/live/advanced ### Description Fetches SERP data using Google's AI mode. Includes all parameters from 'Get Parsed SERP' plus additional options for calculating pixel rankings and specifying browser dimensions. ### Method POST ### Endpoint /serp/google/ai_mode/live/advanced ### Parameters #### Query Parameters - **keyword** (string) - Required - Search query (max 700 chars) - **location** (string) - Optional - Location name, defaults to United States - **language** (string) - Optional - Language name, defaults to English - **device** (enum) - Optional - Device type (desktop|mobile), defaults to desktop - **os** (enum) - Optional - Operating system (windows|macos|android|ios), defaults to windows - **domain** (string) - Optional - Search domain (e.g., google.com), defaults to auto - **depth** (number) - Optional - Number of results (max 700), defaults to 10 - **target** (string) - Optional - Target domain (optional filter) - **calculate_pixel_rankings** (boolean) - Optional - Calculate pixel position metrics, defaults to false - **browser_screen_width** (number) - Optional - Browser width for pixel calc, defaults to 1920 - **browser_screen_height** (number) - Optional - Browser height for pixel calc, defaults to 1080 - **browser_screen_resolution_ratio** (number) - Optional - Screen resolution ratio, defaults to 1 ``` -------------------------------- ### Get Live Google Dataset Info Advanced Source: https://github.com/dataforseo/n8n-nodes-dataforseo/blob/master/_autodocs/10-complete-operation-index.md Retrieves live advanced data for Google Dataset Info SERP. ```APIDOC ## POST /serp/google/dataset_info/live/advanced ### Description Retrieves live advanced data for Google Dataset Info SERP. ### Method POST ### Endpoint /serp/google/dataset_info/live/advanced ```