Server Configuration
Describes the environment variables required to run the server.
Name | Required | Description | Default |
---|---|---|---|
ENABLED_MODULES | No | Comma-separated list of modules to enable (e.g., 'SERP,KEYWORDS_DATA,ONPAGE,DATAFORSEO_LABS,BACKLINKS,BUSINESS_DATA,DOMAIN_ANALYTICS,CONTENT_ANALYSIS'). If not set, all modules will be enabled. | |
DATAFORSEO_PASSWORD | Yes | Your DataForSEO API password | |
DATAFORSEO_USERNAME | Yes | Your DataForSEO API username | |
DATAFORSEO_FULL_RESPONSE | No | If set to 'true', the server will return full, unmodified API responses. If not set or set to 'false', responses will be filtered and transformed to a more concise format. | false |
Schema
Prompts
Interactive templates invoked by user choice
Name | Description |
---|---|
No prompts |
Resources
Contextual data attached and managed by the client
Name | Description |
---|---|
No resources |
Tools
Functions exposed to the LLM to take actions
Name | Description |
---|---|
serp_organic_live_advanced | Get organic search results for a keyword in specified search engine |
serp_locations | Utility tool for serp_organic_live_advanced to get list of availible locations |
serp_youtube_locations | Utility tool to get list of available locations for: serp_youtube_organic_live_advanced, serp_youtube_video_info_live_advanced, serp_youtube_video_comments_live_advanced, serp_youtube_video_subtitles_live_advanced |
serp_youtube_organic_live_advanced | provides top 20 blocks of youtube search engine results for a keyword |
serp_youtube_video_info_live_advanced | provides data on the video you specify |
serp_youtube_video_comments_live_advanced | provides data on the video comments you specify |
serp_youtube_video_subtitles_live_advanced | provides data on the video subtitles you specify |
keywords_data_google_ads_search_volume | Get search volume data for keywords from Google Ads |
keywords_data_dataforseo_trends_demography | This endpoint will provide you with the demographic breakdown (by age and gender) of keyword popularity per each specified term based on DataForSEO Trends data |
keywords_data_dataforseo_trends_subregion_interests | This endpoint will provide you with location-specific keyword popularity data from DataForSEO Trends |
keywords_data_dataforseo_trends_explore | This endpoint will provide you with the keyword popularity data from DataForSEO Trends. You can check keyword trends for Google Search, Google News, and Google Shopping |
keywords_data_google_trends_categories | This endpoint will provide you list of Google Trends Categories |
keywords_data_google_trends_explore | This endpoint will provide you with the keyword popularity data from the ‘Explore’ feature of Google Trends. You can check keyword trends for Google Search, Google News, Google Images, Google Shopping, and YouTube |
on_page_content_parsing | This endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content. |
on_page_instant_pages | Using this function you will get page-specific data with detailed information on how well a particular page is optimized for organic search |
dataforseo_labs_google_ranked_keywords | This endpoint will provide you with the list of keywords that any domain or webpage is ranking for. You will also get SERP elements related to the keyword position, as well as impressions, monthly searches and other data relevant to the returned keywords. |
dataforseo_labs_google_competitors_domain | This endpoint will provide you with a full overview of ranking and traffic data of the competitor domains from organic and paid search. In addition to that, you will get the metrics specific to the keywords both competitor domains and your domain rank for within the same SERP. |
dataforseo_labs_google_domain_rank_overview | This endpoint will provide you with ranking and traffic data from organic and paid search for the specified domain. You will be able to review the domain ranking distribution in SERPs as well as estimated monthly traffic volume for both organic and paid results. |
dataforseo_labs_google_keyword_ideas | The Keyword Ideas provides search terms that are relevant to the product or service categories of the specified keywords. The algorithm selects the keywords which fall into the same categories as the seed keywords specified in a POST array. As a result, you will get a list of relevant keyword ideas for up to 200 seed keywords. Along with each keyword idea, you will get its search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values. Moreover, this endpoint supplies minimum, maximum and average values of daily impressions, clicks and CPC for each result. |
dataforseo_labs_google_related_keywords | The Related Keywords endpoint provides keywords appearing in the "searches related to" SERP element You can get up to 4680 keyword ideas by specifying the search depth. Each related keyword comes with the list of relevant product categories, search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values. Moreover, this endpoint supplies minimum, maximum and average values of daily impressions, clicks and CPC for each result. Datasource: DataForSEO SERPs Database Search algorithm: depth-first search for queries appearing in the "search related to" element of SERP for the specified seed keyword. |
dataforseo_labs_google_keyword_suggestions | The Keyword Suggestions provides search queries that include the specified seed keyword. The algorithm is based on the full-text search for the specified keyword and therefore returns only those search terms that contain the keyword you set in the POST array with additional words before, after, or within the specified key phrase. Returned keyword suggestions can contain the words from the specified key phrase in a sequence different from the one you specify. As a result, you will get a list of long-tail keywords with each keyword in the list matching the specified search term. Along with each suggested keyword, you will get its search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values. Moreover, this endpoint supplies minimum, maximum and average values of daily impressions, clicks and CPC for each result. |
dataforseo_labs_google_historical_serp | This endpoint will provide you with Google SERPs collected within the specified time frame. You will also receive a complete overview of featured snippets and other extra elements that were present within the specified dates. The data will allow you to analyze the dynamics of keyword rankings over time for the specified keyword and location. |
dataforseo_labs_google_serp_competitors | This endpoint will provide you with a list of domains ranking for the keywords you specify. You will also get SERP rankings, rating, estimated traffic volume, and visibility values the provided domains gain from the specified keywords. |
dataforseo_labs_bulk_keyword_difficulty | This endpoint will provide you with the Keyword Difficulty metric for a maximum of 1,000 keywords in one API request. Keyword Difficulty stands for the relative difficulty of ranking in the first top-10 organic results for the related keyword. Keyword Difficulty in DataForSEO API responses indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100. |
dataforseo_labs_google_subdomains | This endpoint will provide you with a list of subdomains of the specified domain, along with the ranking distribution across organic and paid search. In addition to that, you will also get the estimated traffic volume of subdomains based on search volume. |
dataforseo_labs_google_keyword_overview | This endpoint provides Google keyword data for specified keywords. For each keyword, you will receive current cost-per-click, competition values for paid search, search volume, search intent, monthly searches |
dataforseo_labs_google_top_searches | The Top Searches endpoint of DataForSEO Labs API can provide you with over 7 billion keywords from the DataForSEO Keyword Database. Each keyword in the API response is provided with a set of relevant keyword data with Google Ads metrics |
dataforseo_labs_search_intent | This endpoint will provide you with search intent data for up to 1,000 keywords. For each keyword that you specify when setting a task, the API will return the keyword's search intent and intent probability. Besides the highest probable search intent, the results will also provide you with other likely search intent(s) and their probability. Based on keyword data and search results data, our system has been trained to detect four types of search intent: informational, navigational, commercial, transactional. |
dataforseo_labs_google_keywords_for_site | The Keywords For Site endpoint will provide you with a list of keywords relevant to the target domain. Each keyword is supplied with relevant, search volume data for the last month, cost-per-click, competition |
dataforseo_labs_google_domain_intersection | This endpoint will provide you with the keywords for which both specified domains rank within the same SERP. You will get search volume, competition, cost-per-click and impressions data on each intersecting keyword. Along with that, you will get data on the first and second domain's SERP element discovered for this keyword, as well as the estimated traffic volume and cost of ad traffic. |
dataforseo_labs_google_historical_rank_overview | This endpoint will provide you with historical data on rankings and traffic of the specified domain, such as domain ranking distribution in SERPs and estimated monthly traffic volume for both organic and paid results |
dataforseo_labs_google_page_intersection | This endpoint will provide you with the keywords for which specified pages rank within the same SERP. You will get search volume, competition, cost-per-click and impressions data on each intersecting keyword. Along with that, you will get data on SERP elements that specified pages rank for in search results, as well as the estimated traffic volume and cost of ad traffic. Page Intersection endpoint supports organic, paid, local pack and featured snippet results. Find keywords several webpages rank for: If you would like to get the keywords several pages rank for, you need to specify webpages only in the pages object. This way, you will receive intersected ranked keywords for the specified URLs. Find keywords your competitors rank for but you do not: If you would like to receive all keywords several pages rank for, but particular pages do not, you need to use the exclude_pages array as well. This way you will receive the keywords for which the URLs from the pages object rank for, but the URLs from the exclude_pages array do not |
dataforseo_labs_bulk_traffic_estimation | This endpoint will provide you with estimated monthly traffic volumes for up to 1,000 domains, subdomains, or webpages. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results. |
dataforseo_labs_available_filters | Here you will find all the necessary information about filters that can be used with DataForSEO Labs API endpoints. Please, keep in mind that filters are associated with a certain object in the result array, and should be specified accordingly. |
dataforseo_labs_google_historical_keyword_data | This endpoint provides Google historical keyword data for specified keywords, including search volume, cost-per-click, competition values for paid search, monthly searches, and search volume trends. You can get historical keyword data since August, 2021, depending on keywords along with location and language combination |
backlinks_backlinks | This endpoint will provide you with a list of backlinks and relevant data for the specified domain, subdomain, or webpage |
backlinks_anchors | This endpoint will provide you with a detailed overview of anchors used when linking to the specified website with relevant backlink data for each of them |
backlinks_bulk_backlinks | This endpoint will provide you with the number of backlinks pointing to domains, subdomains, and pages specified in the targets array. The returned numbers correspond to all live backlinks, that is, total number of referring links with all attributes (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check. Note that if you indicate a domain as a target, you will get results for the root domain (domain with all of its subdomains), e.g. dataforseo.com and app.dataforseo.com |
backlinks_bulk_new_lost_referring_domains | This endpoint will provide you with the number of referring domains pointing to the domains, subdomains and pages specified in the targets array. Note that if you indicate a domain as a target, you will get result for the root domain (domain with all of its subdomains), e.g. dataforseo.com and app.dataforseo.com |
backlinks_bulk_new_lost_backlinks | This endpoint will provide you with the number of referring domains pointing to domains, subdomains, and pages specified in the targets array. The returned numbers are based on all live referring domains, that is, total number of domains pointing to the target with any type of backlinks (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check. Note that if you indicate a domain as a target, you will get result for the root domain (domain with all of its subdomains), e.g. dataforseo.com and app.dataforseo.com |
backlinks_bulk_ranks | This endpoint will provide you with rank scores of the domains, subdomains, and pages specified in the targets array. The score is based on the number of referring domains pointing to the specified domains, subdomains, or pages. The rank values represent real-time data for the date of the request and range from 0 (no backlinks detected) to 1,000 (highest rank). A similar scoring system is used in Google’s Page Rank algorithm |
backlinks_bulk_referring_domains | This endpoint will provide you with the number of referring domains pointing to domains, subdomains, and pages specified in the targets array. The returned numbers are based on all live referring domains, that is, total number of domains pointing to the target with any type of backlinks (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check. Note that if you indicate a domain as a target, you will get result for the root domain (domain with all of its subdomains), e.g. dataforseo.com and app.dataforseo.com |
backlinks_bulk_spam_score | This endpoint will provide you with spam scores of the domains, subdomains, and pages you specified in the targets array. Spam Score is DataForSEO’s proprietary metric that indicates how “spammy” your target is on a scale from 0 to 100 |
backlinks_competitors | This endpoint will provide you with a list of competitors that share some part of the backlink profile with a target website, along with a number of backlink intersections and the rank of every competing website |
backlinks_domain_intersection | This endpoint will provide you with the list of domains pointing to the specified websites. This endpoint is especially useful for creating a Link Gap feature that shows what domains link to your competitors but do not link out to your website |
backlinks_domain_pages_summary | This endpoint will provide you with detailed summary data on all backlinks and related metrics for each page of the target domain or subdomain you specify. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page |
backlinks_domain_pages | This endpoint will provide you with a detailed overview of domain pages with backlink data for each page |
backlinks_page_intersection | This endpoint will provide you with the list of domains pointing to the specified websites. This endpoint is especially useful for creating a Link Gap feature that shows what domains link to your competitors but do not link out to your website |
backlinks_referring_domains | This endpoint will provide you with a detailed overview of referring domains pointing to the target you specify |
backlinks_referring_networks | This endpoint will provide you with a detailed overview of referring domains pointing to the target you specify |
backlinks_summary | This endpoint will provide you with an overview of backlinks data available for a given domain, subdomain, or webpage |
backlinks_timeseries_new_lost_summary | This endpoint will provide you with the number of new and lost backlinks and referring domains for the domain specified in the target field. The results will be provided for a period between the two indicated dates, and metrics will be grouped by the time range that you define: day, week, month, or year. Data from this endpoint will be especially helpful for building time-series graphs of new and lost backlinks and referring domains. |
backlinks_timeseries_summary | This endpoint will provide you with an overview of backlink data for the target domain available during a period between the two indicated dates. Backlink metrics will be grouped by the time range that you define: day, week, month, or year. Data from this endpoint will be especially helpful for building time-series graphs of daily, weekly, monthly, and yearly link-building progress |
backlinks_bulk_pages_summary | This endpoint will provide you with a comprehensive overview of backlinks and related data for a bulk of up to 1000 pages, domains, or subdomains. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page. |
backlinks_available_filters | Here you will find all the necessary information about filters that can be used with DataForSEO Backlinks API endpoints. Please, keep in mind that filters are associated with a certain object in the result array, and should be specified accordingly. |
business_data_business_listings_search | Business Listings Search API provides results containing information about business entities listed on Google Maps in the specified categories. You will receive the address, contacts, rating, working hours, and other relevant data |
domain_analytics_whois_overview | This endpoint will provide you with Whois data enriched with backlink stats, and ranking and traffic info from organic and paid search results. Using this endpoint you will be able to get all these data for the domains matching the parameters you specify in the request |
domain_analytics_whois_available_filters | Here you will find all the necessary information about filters that can be used with DataForSEO WHOIS API endpoints. Please, keep in mind that filters are associated with a certain object in the result array, and should be specified accordingly. |
domain_analytics_technologies_domain_technologies | Using this endpoint you will get a list of technologies used in a particular domain |
domain_analytics_technologies_available_filters | Here you will find all the necessary information about filters that can be used with DataForSEO Technologies API endpoints. Please, keep in mind that filters are associated with a certain object in the result array, and should be specified accordingly. |
content_analysis_search | This endpoint will provide you with detailed citation data available for the target keyword |
content_analysis_summary | This endpoint will provide you with an overview of citation data available for the target keyword |
content_analysis_phrase_trends | This endpoint will provide you with data on all citations of the target keyword for the indicated date range |