### GET Request Example Source: https://seranking.com/api/data/backlinks Demonstrates how to fetch new referring domains using a GET request. Ensure apikey and output are always included as GET parameters. ```http GET: https://api.seranking.com/v1/backlinks/refdomains/history?apikey=XXX&target=https://www.seranking.com&mode=domain&new_lost_type=new&date_from=2023-01-15&date_to=2023-01-16&output=json ``` -------------------------------- ### Example GET Request with API Key Source: https://seranking.com/api/project/getting-started Demonstrates how to make a GET request to the /v1/project-management/users/me endpoint using an API key in the Authorization header. ```bash curl -X GET "https://api.seranking.com/v1/project-management/users/me" -H "Authorization: Token YOUR_API_KEY" ``` -------------------------------- ### Get Question Keywords API Request Example Source: https://seranking.com/api/data/keyword-research This example demonstrates how to call the Get Question Keywords API with various filters and sorting options. Ensure you replace 'YOUR_API_KEY' with your actual API token. ```bash curl --location --globoff 'https://api.seranking.com/v1/keywords/questions?source=us&keyword=avocado&limit=10&offset=0&sort=keyword&sort_order=asc&history_trend=true&filter[volume][from]=100&filter[volume][to]=100000&filter[difficulty][from]=0&filter[difficulty][to]=30&filter[cpc][from]=0&filter[cpc][to]=100&filter[competition][from]=0&filter[competition][to]=0.1&filter[keyword_count][from]=3&filter[keyword_count][to]=8&filter[characters_count][from]=15&filter[characters_count][to]=50&filter[serp_features]=sge,images&filter[intents]=I,C&filter[multi_keyword_included]=[[{"type":"contains","value":"oil"}],[{"type":"exact","value":"avocado recipes"}]]' \ --header 'Authorization: Token YOUR_API_KEY' ``` -------------------------------- ### Example API Request Source: https://seranking.com/api/project/getting-started This example demonstrates how to make a GET request to the /v1/project-management/users/me endpoint using an API key for authentication. ```APIDOC ## GET /v1/project-management/users/me ### Description Retrieves information about the authenticated user. ### Method GET ### Endpoint https://api.seranking.com/v1/project-management/users/me ### Parameters #### Headers - **Authorization** (string) - Required - Your API key in the format "Token YOUR_API_KEY" ### Request Example ```bash curl -X GET "https://api.seranking.com/v1/project-management/users/me" -H "Authorization: Token YOUR_API_KEY" ``` ### Response #### Success Response (200) - **currency** (string) - The currency used for the account. - **value** (number) - The account balance or value. #### Response Example ```json { "currency": "rur", "value": 2296380.85 } ``` ``` -------------------------------- ### GET Request Example for SERP100 Source: https://seranking.com/api/project/competitors This example demonstrates how to construct a GET request to retrieve the top 100 search engine results for a specific keyword within a project. Ensure all required parameters like site_id, date, site_engine_id, and keyword_id are provided. ```http GET https://api.seranking.com/v1/project-management/competitors/serp100?site_id=123&date=2018-01-01&site_engine_id=1&keyword_id=1&top=50 ``` -------------------------------- ### Get Domain Pages Request Example Source: https://seranking.com/api/data/domain-analysis Example of how to make a GET request to the domain pages endpoint. Ensure you replace YOUR_API_KEY with your actual API key and adjust the parameters as needed. ```bash curl -X GET 'https://api.example.com/v1/domain/pages?target=seranking.com&scope=base_domain&source=us&type=organic' \ -H 'Authorization: Token YOUR_API_KEY' ``` -------------------------------- ### Start n8n Service Source: https://seranking.com/api/integrations/n8n Launches the n8n application after installation. Access it via http://localhost:5678. ```bash n8n start ``` -------------------------------- ### GET Request for Multiple Targets Source: https://seranking.com/api/data/backlinks Use this example to send multiple targets in a single GET request. Ensure the 'apikey' and 'output' parameters are included as GET parameters. ```http GET: https://api.seranking.com/v1/backlinks/refdomains/count?apikey=XXX&target=https://www.seranking.com&target=https://www.seranking.com&mode=url&output=json ``` -------------------------------- ### GET Request Example for Indexed Pages Source: https://seranking.com/api/data/backlinks Use this GET request to retrieve indexed pages with backlinks. Ensure apikey and output are sent as GET parameters. ```http GET: https://api.seranking.com/v1/backlinks/indexed-pages?apikey=XXX&target=https://seranking.com&mode=domain&limit=100&order_by=backlinks&output=json ``` -------------------------------- ### GET Request Example for Backlinks History Source: https://seranking.com/api/data/backlinks Demonstrates how to fetch new backlinks using a GET request. Ensure all required parameters like apikey and target are included. ```http GET: https://api.seranking.com/v1/backlinks/history?apikey=XXX&target=https://www.seranking.com&mode=domain&new_lost_type=new&date_from=2023-01-15&date_to=2023-01-15&link_type=href&anchor_type=text&dofollow=dofollow&output=json ``` -------------------------------- ### POST Request Example for Indexed Pages Source: https://seranking.com/api/data/backlinks This POST request example shows how to send target, order_by, mode, and limit as JSON in the request body. The apikey and output parameters must still be included as GET parameters. ```http | POST: https://api.seranking.com/v1/backlinks/indexed-pages?apikey=XXX&output=json ---|--- | { | "target": "https://www.seranking.com/", | "order_by": "backlinks", | "mode": "domain", | "limit": 2 | } ``` -------------------------------- ### POST Request Example Source: https://seranking.com/api/data/backlinks Shows how to send a POST request with a JSON body to retrieve referring domain history. The apikey and output parameters are still sent as GET parameters. ```http POST: https://api.seranking.com/v1/backlinks/refdomains/history?apikey=XXX&output=json { "target": "https://www.seranking.com", "mode": "domain", "new_lost_type": "new", "date_from": "2023-01-15", "date_to": "2023-01-16" } ``` -------------------------------- ### Backlink Import Response Example Source: https://seranking.com/api/project/backlink-checker Example of a successful response when starting a backlink import. The response contains the import task status and a unique token for status checking. ```json { "status": "queued", "token": "1c84d0375d44725521647919c17f1cb9" } ``` -------------------------------- ### Get Related Keywords API Request Example Source: https://seranking.com/api/data/keyword-research This example demonstrates a full API request to the /v1/keywords/related endpoint, including various filtering and sorting parameters. Ensure you replace 'YOUR_API_KEY' with your actual API token. ```bash curl --location 'https://api.seranking.com/v1/keywords/related?source=us&keyword=avocado&limit=10&offset=0&sort=keyword&sort_order=asc&history_trend=true&filter[volume][from]=50&filter[volume][to]=5000&filter[difficulty][from]=18&filter[difficulty][to]=40&filter[cpc][from]=0.10&filter[cpc][to]=3.00&filter[competition][from]=0.2&filter[competition][to]=0.7&filter[keyword_count][from]=3&filter[keyword_count][to]=5&filter[characters_count][from]=20&filter[characters_count][to]=50&filter[serp_features]=featured_snippets,images&filter[intents]=I,C&filter[multi_keyword_included]=[[{"type":"contains","value":"oil"}],[{"type":"exact","value":"avocado recipes"}]]' \ --header 'Authorization: Token YOUR_API_KEY' ``` -------------------------------- ### Get Similar Keywords Request Example Source: https://seranking.com/api/data/keyword-research This example demonstrates how to make a request to the API to find similar keywords. It includes various parameters for filtering by volume, difficulty, CPC, competition, keyword length, character count, SERP features, intents, and inclusion/exclusion patterns. Ensure you replace 'YOUR_API_KEY' with your actual API key. ```curl curl --location 'https://api.seranking.com/v1/keywords/similar?source=us&keyword=avocado&limit=10&offset=0&sort=keyword&sort_order=asc&history_trend=true&filter[volume][from]=50&filter[volume][to]=5000&filter[difficulty][from]=18&filter[difficulty][to]=40&filter[cpc][from]=0.10&filter[cpc][to]=3.00&filter[competition][from]=0.2&filter[competition][to]=0.7&filter[keyword_count][from]=3&filter[keyword_count][to]=5&filter[characters_count][from]=20&filter[characters_count][to]=50&filter[serp_features]=featured_snippets,images&filter[intents]=I,C&filter[multi_keyword_included]=[[{"type":"contains","value":"oil"}],[{"type":"exact","value":"avocado recipes"}]]' \ --header 'Authorization: Token YOUR_API_KEY' ``` -------------------------------- ### Backlinks API Request Example Source: https://seranking.com/api/data/backlinks This example demonstrates how to construct a GET request to the raw backlinks endpoint. It includes essential parameters like API key, target domain, mode, limit, and output format. The 'next' parameter is used for pagination. ```http GET: https://api.seranking.com/v1/backlinks/raw?apiKey=XXX&target=seranking.com&mode=domain&limit=50000&output=json&next=YYY ``` -------------------------------- ### POST Request for Single Target Source: https://seranking.com/api/data/backlinks This example demonstrates how to send a single target using a POST request. The 'apikey' and 'output' parameters must still be included as GET parameters, while the target and mode are sent in the JSON body. ```http | POST: https://api.seranking.com/v1/backlinks/refdomains/count?apikey=XXX&output=json ---|--- | { | "target": [ | "https://www.seranking.com/" | ], | "mode": "domain" | } ``` -------------------------------- ### Get Total Ads Chart Request Example Source: https://seranking.com/api/project/project-management This example demonstrates how to make a GET request to the ads-stats endpoint. It includes parameters for site ID, date range, and filters for search engines and keywords. ```http GET https://api.seranking.com/v1/project-management/sites/ads-stats?site_id=123&date_from=2020-05-20&date_to=2020-05-21&site_engine_ids[]=1&site_engine_ids[]=2&keywords_ids[]=1&keywords_ids[]=1 ``` -------------------------------- ### Launch Standard Website Audit with cURL Source: https://seranking.com/api/data/website-audit Use this command to start a standard website audit. Ensure you replace 'YOUR_API_KEY' with your actual API key and 'example.com' with the target domain. The settings object allows for detailed configuration of the audit parameters. ```bash curl --location 'https://api.seranking.com/v1/site-audit/audits/standard' \ --header 'Content-Type: application/json' \ --header 'Authorization: Token YOUR_API_KEY' \ --data '{ "domain": "example.com", "title": "Full Audit - example.com", "settings": { "source_site": 1, "source_sitemap": 1, "source_subdomain": 1, "source_file": 0, "check_robots": 1, "ignore_noindex": 1, "ignore_nofollow": 1, "ignore_params": 2, "custom_params": "utm_source, utm_medium, utm_term, utm_content, utm_campaign, cid, PHPSESSID, fbclid, gclid", "user_agent": 0, "login": "", "password": "", "max_pages": 10000, "max_depth": 15, "max_req": 300, "max_redirects": 10, "max_size": 5000, "min_title_len": 30, "max_title_len": 60, "min_description_len": 50, "max_description_len": 160, "min_words": 300, "max_h1_len": 70, "max_h2_len": 80, "allow": "/blog\n/products", "disallow": "/admin\n/staging", "hide": "/cdn-cgi\n/wp-json", "send_report": 1, "report_emails": "seo-lead@example.com, devops@example.com" } }' ``` -------------------------------- ### Start SEOIntel Development Server Source: https://seranking.com/api/data/quickstarts/generate-seo-intelligence-reports-with-seointel Start the local development server for SEOIntel. Access the application at http://localhost:3003 after starting. ```bash npm run dev ``` -------------------------------- ### List Projects Response Example Source: https://seranking.com/api/project/project-management This is an example of the JSON response when listing projects. It includes details such as project ID, name, and configuration. ```json [ { "id": 1, "title": "zniqpf tfallp mykqeg", "name": "Cronin.info", "group_id": 0, "is_active": 1, "exact_url": 0, "subdomain_match": 0, "depth": 100, "check_freq": "check_daily", "check_day": null, "guest_link": "https://seranking.com/guest.html?site_id=1&hv=0&hash=432&tab=detailed" } ] ``` -------------------------------- ### Response Example for Owned Projects Source: https://seranking.com/api/project/sub-account-management Example response when successfully retrieving owned website IDs for a sub-account. ```JSON [ 39, 40 ] ``` -------------------------------- ### User Profile Response Example Source: https://seranking.com/api/project/account-management Example JSON response for the 'Get user profile' endpoint, detailing user information. ```JSON { "email": "john.doe@example.com", "email_verified": true, "first_name": "John", "last_name": "Doe", "lang": "en", "picture": "https://online.seranking.com/files/public/avatar/se.png" } ``` -------------------------------- ### Direct API Call Example Source: https://seranking.com/api/data/quickstarts/generate-seo-intelligence-reports-with-seointel Use this example to make a direct POST request to the SEORanking API for domain overview data. Replace 'YOUR_API_KEY' with your actual API key. ```bash curl -X POST https://api.seranking.com/v1/domain/overview/db \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"domain": "example.com", "source": "us"}' ``` -------------------------------- ### Clone and Install SEOIntel Project Source: https://seranking.com/api/data/quickstarts/generate-seo-intelligence-reports-with-seointel Clone the SEOIntel repository from GitHub and install its dependencies using npm. This is the first step to running the project locally. ```bash git clone https://github.com/seranking/seointel.git cd seointel npm install ``` -------------------------------- ### GET Request for Single Backlink Count Source: https://seranking.com/api/data/backlinks Use this example to retrieve the backlink count for a single target via a GET request. Ensure apikey and output are included as GET parameters. ```http GET: https://api.seranking.com/v1/backlinks/count?apikey=XXX&target=seranking.com&mode=host&output=json ``` -------------------------------- ### Response Example for Listing Keywords Source: https://seranking.com/api/project/project-management This is an example of the JSON array returned upon successful retrieval of project keywords. It includes details like keyword ID, name, group, assigned URL, and check dates. ```json | [ | { | "id": "1", | "name": "key1", | "group_id": "2", |     "link": null, |     "first_check_date": "2015-02-17" |   }, |   {        | "id": "2",       |    "name": "key2",     |     "group_id": "2",      |     "link": "http://mysite.com/",     |     "first_check_date": null,     |     "tags": [] |   }, |   ... | ] ``` -------------------------------- ### Get Backlink Summary (Single Target - GET) Source: https://seranking.com/api/data/backlinks Use this example to retrieve summary backlink metrics for a single target using a GET request. Ensure the 'Authorization' header is set with your API key. ```bash | curl -X GET 'https://api.seranking.com/v1/backlinks/summary?target=rubyonrails.org&mode=host&output=json' \ ---|--- | -H 'Authorization: Token YOUR_API_KEY' ``` -------------------------------- ### Response Example for Adding Keywords Source: https://seranking.com/api/project/project-management Example of a successful response after adding keywords to a project. It indicates the count of keywords added and provides their new IDs. ```JSON | { ---|--- | "added": 3, | "ids": [123, 456, 789] | } ``` -------------------------------- ### Get Domain Subdomains Response Example Source: https://seranking.com/api/data/domain-analysis This is an example of the JSON response structure for the domain subdomains endpoint. Each object details a subdomain's performance metrics. ```json [ { "traffic_sum": 73909, "traffic_percent": 99.52, "price_sum": 149497.18, "keywords_count": 116181, "url": "example.com" }, { "traffic_sum": 209, "traffic_percent": 0.28, "price_sum": 56.34, "keywords_count": 33, "url": "online.example.com" }, { "traffic_sum": 146, "traffic_percent": 0.2, "price_sum": 175.67, "keywords_count": 1590, "url": "help.example.com" }, { "traffic_sum": 0, "traffic_percent": 0, "price_sum": 0, "keywords_count": 1, "url": "academy.example.com" }, { "traffic_sum": 0, "traffic_percent": 0, "price_sum": 0, "keywords_count": 4, "url": "visible.example.com" } ] ``` -------------------------------- ### Response Example for Shared Projects Source: https://seranking.com/api/project/sub-account-management Example response when successfully retrieving shared website IDs for a sub-account. ```JSON [ 39, 44 ] ``` -------------------------------- ### Get Longtail Keywords Request Example Source: https://seranking.com/api/data/keyword-research Example of how to make a curl request to the longtail keywords endpoint. Ensure you replace 'YOUR_API_KEY' with your actual API token. ```bash curl --location --globoff 'https://api.seranking.com/v1/keywords/longtail?source=us&keyword=avocado&limit=10&offset=0' \ --header 'Authorization: Token YOUR_API_KEY' ``` -------------------------------- ### Create Sub-account Response Example Source: https://seranking.com/api/project/account-management Example of a successful response after creating a sub-account, returning the new sub-account's ID. ```json { "id": 36872 } ``` -------------------------------- ### Get Domain Authority History Request Source: https://seranking.com/api/data/backlinks Example of a GET request to retrieve historical Domain InLink Rank values. Specify target, date range, and granularity. ```http GET: https://api.seranking.com/v1/backlinks/authority/domain/history?apikey=XXX&output=json&target=seranking.com&date_from=2025-06-01&date_to=2025-09-01&granularity=by_month ``` -------------------------------- ### List Project Search Engines Response Example Source: https://seranking.com/api/project/project-management A successful response returns a JSON array of search engines associated with the project. Each object details the search engine configuration. ```JSON [ { "site_engine_id": 1, "search_engine_id": 339, "region_id": 0, "region_name": null, "lang_code": "ru", "merge_map": 0, "business_name": null, "phone": null, "paid_results": 0, "featured_snippet": 0, "keyword_count": 10 } ] ``` -------------------------------- ### Get Audit Status Request Example Source: https://seranking.com/api/project/audit Use this cURL command to get the real-time status of a specific audit. Ensure you replace YOUR_API_KEY and the audit_id with your actual values. ```bash curl --location 'https://api.seranking.com/v1/project-management/audits/status?audit_id=123' \ --header 'Authorization: Token YOUR_API_KEY' ``` -------------------------------- ### Run Tests with npm Source: https://seranking.com/api/data/quickstarts/generate-seo-intelligence-reports-with-seointel Execute the project's test suite using npm to understand expected behavior and verify customizations. Ensure you have the project dependencies installed. ```bash npm run test:run ``` -------------------------------- ### Get Page Authority Response Example Source: https://seranking.com/api/data/backlinks Example of the JSON response structure when requesting page authority. It includes a list of pages with their respective URLs and InLink Rank values. ```json | { ---|--- | "pages": [ | { | "url": "https://seranking.com", | "inlink_rank": 19 | }, | { | "url": "https://www.seranking.com", | "inlink_rank": 49 | } | ] | } ``` -------------------------------- ### Example POST Request to Backlinks Summary Source: https://seranking.com/api/data/getting-started Demonstrates a POST request to the /backlinks/summary endpoint, including necessary authentication and content type headers, and a JSON body. ```bash curl -X POST 'https://api.seranking.com/v1/backlinks/summary' \ -H 'Authorization: Token YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ \ "target": "seranking.com", \ "mode": "host" \ }' ``` -------------------------------- ### List Project Groups Response Example Source: https://seranking.com/api/project/project-groups Example response when listing project groups, showing a JSON array of group objects, each with an ID and name. ```JSON [ { "id": "123", "name": "Group1" }, { "id": "456", "name": "Group2" } ] ``` -------------------------------- ### Get LLM Engine Response Example Source: https://seranking.com/api/project/ai-result-tracker This is an example of a successful JSON response when retrieving LLM engine details. It includes the engine's ID, site ID, base name, and regional settings. ```json { "id": 151216, "site_id": 11270054, "base_name": "google_ai_overview", "country_code": "us", "region_name": "Washburn County, Wisconsin, United States", "lang_code": "en", "region_settings": { "lat": 45.965719, "lng": -91.814895, "uule": "", "radius": 25000 } } ``` -------------------------------- ### Get Prompts by Brand Request Example Source: https://seranking.com/api/data/ai-search Example of how to make a curl request to the AI Search API to retrieve prompts mentioning a specific brand. Ensure you replace 'YOUR_API_KEY' with your actual API key. ```bash | curl --location 'https://api.seranking.com/v1/ai-search/prompts-by-brand?brand=Netflix&source=us&engine=perplexity&sort=volume&sort_order=desc&offset=0&limit=10' \ --header 'Authorization: Token YOUR_API_KEY' ``` -------------------------------- ### Create Sub-account Request Example Source: https://seranking.com/api/project/account-management Example of a POST request to create a new sub-account with specified settings and access permissions. ```json | POST https://api.seranking.com/v1/project-management/users ---|--- | [ | { | "key": "data", | "value": [ | {"setting.account_email": "test10@gmail.com"}, | {"setting.account_first_name": "Test"}, | {"setting.account_last_name": "Test"}, | {"setting.account_password": "TestPassword"}, | {"setting.account_type": "user"}, | {"limit.balance.period": "day"}, | {"limit.balance.amount": 10}, | {"access": [ | "add_website", | "audit_settings", | "report_manual", | "report_scheduled", | "report_template" | ]} | ] | } | ] ``` -------------------------------- ### Add New Project Source: https://seranking.com/api/project/project-management Create a new project in your account by providing the website URL and a project title. You can also configure settings like ranking depth, subdomain tracking, and check frequency. ```http | POST https://api.seranking.com/v1/project-management/sites ---|--- | [{"url": "http://test.site/","title": "seo site"}] ``` -------------------------------- ### Configure Environment Variables for SEOIntel Source: https://seranking.com/api/data/quickstarts/generate-seo-intelligence-reports-with-seointel Copy the example environment file and edit it with your Redis connection details and application URL. This configures the local instance of SEOIntel. ```bash cp .env.example .env.local ``` ```dotenv # Redis connection (required for report storage) UPSTASH_REDIS_REST_URL=your-redis-url UPSTASH_REDIS_REST_TOKEN=your-redis-token # App URL for shareable report links (optional) NEXT_PUBLIC_APP_URL=http://localhost:3003 ``` -------------------------------- ### Get Total Ads Chart Response Example Source: https://seranking.com/api/project/project-management This is an example of a successful response from the ads-stats endpoint. It returns an array grouped by site engine ID, with nested keyword data and ad statistics (tads and bads) for each date. ```json | [ | { | "site_engine_id": 1, | "keywords": [ | { | "id": 1, | "ads": [ | { | "date": "2020-05-20", | "tads": 2, | "bads": 3 | }, | { | "date": "2020-05-21", | "tads": 3, | "bads": 2 | } | ] | }, | { | "id": 2, | "ads": [ | { | "date": "2020-05-20", | "tads": 0, | "bads": 0 | }, | { | "date": "2020-05-21", | "tads": 0, | "bads": 1 | } | ] | } | ] | }, | { | "site_engine_id": 2, | "keywords": [ | { | "id": 1, | "ads": [ | { | "date": "2020-05-20", | "tads": 1, | "bads": 1 | }, | { | "date": "2020-05-21", | "tads": 2, | "bads": 2 | } | ] | }, | { | "id": 2, | "ads": [ | { | "date": "2020-05-20", | "tads": 0, | "bads": 2 | }, | { | "date": "2020-05-21", | "tads": 5, | "bads": 1 | } | ] | } | ] | } | ] ``` -------------------------------- ### Get Backlink Summary (Multiple Targets - POST) Source: https://seranking.com/api/data/backlinks Use this example to retrieve summary backlink metrics for multiple targets via a POST request. Targets and mode are sent in the JSON body, while the API key is in the GET parameters and Authorization header. ```bash | curl -X POST \ ---|--- | 'https://api.seranking.com/v1/backlinks/summary?output=json' \ | -H 'Authorization: Token YOUR_API_KEY' \ | -d '{ | "target": [ | "https://www.seranking.com/", | "https://www.seranking.com/" | ], | "mode": "host" | }' ``` -------------------------------- ### LLM Status Response Example (No Prompts Configured) Source: https://seranking.com/api/project/ai-result-tracker Example JSON response when no prompts are configured for an LLM engine. ```json { "llm_id": 160000, "site_id": 11270054, "progress": 0, "prompts_count": 0, "prompts_checked": 0, "last_update_date": null } ```