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). If not set, all modules will be enabled | |
| ENABLED_PROMPTS | No | Comma-separated list of prompt names to enable. If not set, all prompts from enabled modules will be enabled | |
| DATAFORSEO_PASSWORD | Yes | Your DataForSEO password | |
| DATAFORSEO_USERNAME | Yes | Your DataForSEO username | |
| DATAFORSEO_FULL_RESPONSE | No | Enable full API responses. If not set or set to false, the server will filter and transform API responses to a more concise format. If set to true, the server will return the full, unmodified API responses | false |
| DATAFORSEO_SIMPLE_FILTER | No | Enable simple filter schema. If set to true, a simplified version of the filters schema will be used. This is required for ChatGPT APIs or other LLMs that cannot handle nested structures | 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 |
| on_page_lighthouse | The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps. |
| 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. |