SE Ranking API

https://seranking.com/api
Admin
SE Ranking API is a scalable SEO data integration platform that enables automated reporting, bulk...
Tokens:325,550
Snippets:1,766
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install and start n8n

Source: https://seranking.com/api/integrations/n8n

Install n8n globally using npm and then start the n8n server. Requires Node.js 18.x or higher.

```bash
npm install n8n -g 
```

```bash
n8n start 
```

--------------------------------

### GET reviews overview request example

Source: https://seranking.com/api/local-marketing-api/reviews

Example request to retrieve review overview for location 15 for May 2026.

```http
GET https://api.seranking.com/v1/local-marketing/locations/15/reviews/overview?from=2026-05-01&to=2026-05-31
```

--------------------------------

### Get prompt details response example

Source: https://seranking.com/api/se-visible/prompts

Example response for the Get prompt details endpoint. Shows the structure of a prompt object, including read-only text_hash and always-null deleted_at.

```json
{  
  "id": 1,  
  "text": "What are the best ground coffee brands for a rich and smooth flavor?",  
  "topic_id": 10,  
  "report_id": "550e8400-e29b-41d4-a716-446655440000",  
  "created_at": "2023-12-15T10:30:00.000000Z",  
  "text_hash": 2751880790,  
  "deleted_at": null,  
  "is_parsed": true  
}
```

--------------------------------

### GET reviews overview response example

Source: https://seranking.com/api/local-marketing-api/reviews

Example JSON response showing aggregated review statistics for location 15.

```json
{  

  "location_id": 15,  

  "total_reviews": 60,  

  "average_rating": 3.8,  

  "answered_reviews": 52,  

  "unanswered_reviews": 8,  

  "rating_distribution": {  

    "1_star": 4,  

    "2_star": 5,  

    "3_star": 10,  

    "4_star": 21,  

    "5_star": 20  

  },  

  "items_by_source": [  

    {  

      "source": "google",  

      "reviews_count": 55,  

      "average_rating": 3.9,  

      "answered_reviews": 50,  

      "unanswered_reviews": 5  

    },  

    {  

      "source": "facebook",  

      "reviews_count": 5,  

      "average_rating": 3.4,  

      "answered_reviews": 2,  

      "unanswered_reviews": 3  

    }  

  ]  

}
```

--------------------------------

### Get prompt answer response example

Source: https://seranking.com/api/project/ai-result-tracker

Example response from the Get prompt answer endpoint. Shows the full answer text, cited sources, brand mentions, and organic URLs for Google AI Overview engines. The organic_urls field is omitted for other engines.

```json
{
  "prompt_llm_id": 6739,
  "prompt": "What are the top fashion trends for Fall/Winter 2025?",
  "site_llm_id": 630,
  "site_id": 72193,
  "date": "2026-04-01",
  "text": "Fall/Winter 2025 fashion trends embrace dramatic, oversized silhouettes and textured luxury, featuring long coats, rich suede, leather blazers, and strong \"collegiate\" preppy styles...",
  "sources": [
    { "url": "https://www.whowhatwear.com/fashion/fall/fashion-week-trends-fall-winter-2025", "position": 1 },
    { "url": "https://facesmag.com/fashion-en/faces-trend-report-the-top-13-trends-for-fall-winter-2025-26/", "position": 2 },
    { "url": "https://www.vogue.com/article/fall-winter-2025-fashion-trends", "position": 3 }
  ],
  "brands": [
    { "name": "Vogue", "position": 1 },
    { "name": "Who What Wear", "position": 2 },
    { "name": "Glamour", "position": 3 }
  ],
  "organic_urls": [
    { "url": "https://www.vogue.com/article/fall-winter-2025-fashion-trends", "position": 1 },
    { "url": "https://www.whowhatwear.com/fashion/trends/elegant-fall-winter-trends-2025", "position": 2 },
    { "url": "https://www.pinterest.com/ideas/fall-2025-fashion-trends/923550151023/", "position": 3 }
  ]
}
```

--------------------------------

### Get user profile - Response example

Source: https://seranking.com/api/project/account-management

Example response for the user profile endpoint. Returns fields like email, email_verified, first_name, last_name, lang, and picture.

```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"  

}
```

--------------------------------

### Start the development server

Source: https://seranking.com/api/data/quickstarts/generate-seo-intelligence-reports-with-seointel

Starts the development server. After running, open http://localhost:3003 to access the app.

```bash
npm run dev
```

--------------------------------

### Get site brand - response example

Source: https://seranking.com/api/project/ai-result-tracker

Example JSON response for the get site brand endpoint. The response includes the site_id and the configured brand, which is null if not set.

```json
{
  "site_id": 11270054,
  "brand": "SE Ranking"
}
```

--------------------------------

### Copy environment file

Source: https://seranking.com/api/data/quickstarts/generate-seo-intelligence-reports-with-seointel

Copies the example environment file to create a local configuration file.

```bash
cp .env.example .env.local
```

--------------------------------

### Create project with POST /v1/se-visible/projects

Source: https://seranking.com/api/se-visible/getting-started

Example POST request to create a project. Requires the Content-Type: application/json header and an Authorization header with your API key. The payload includes domain, country_code, lang_code, brand_names, and topics.

```bash
curl -X POST 'https://api.seranking.com/v1/se-visible/projects' \
  -H 'Authorization: Token YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "domain": "https://lavazza.com",
    "country_code": "US",
    "lang_code": "en",
    "brand_names": ["Lavazza"],
    "topics": ["Ground Coffee", "Espresso Machines"]
  }'
```

--------------------------------

### GET LLM engine response example

Source: https://seranking.com/api/project/ai-result-tracker

Example response for the GET LLM engine request. Shows a geo-targeted engine with region_settings containing lat, lng, uule, and radius.

```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 /v1/domain/keywords

Source: https://seranking.com/api/data/domain-analysis

Documentation for the GET /v1/domain/keywords endpoint, including parameters, response examples, and notes.

```APIDOC
## GET /v1/domain/keywords

### Description
Returns the keywords a domain (or a specific URL) ranks for in a regional database, organic or paid. Supports historical month-by-month snapshots, advanced filtering across keyword properties, SERP-feature presence, search intent, and traffic share.

### Method
GET

### Endpoint
https://api.seranking.com/v1/domain/keywords

### Parameters
#### Required Fields
- **source** (String) - Required - Country code of the regional keyword database (e.g., `us`, `uk`, `de`). See Regional database codes.
- **domain** (String) - Optional - Domain to retrieve rankings for (e.g., `booking.com`). Mutually exclusive with `url`.
- **url** (String) - Optional - Exact URL to retrieve rankings for (e.g., `https://seranking.com/api.html`). When supplied, the `with_subdomains` flag has no effect — only this exact URL is considered.

#### Search Type, Pagination, Ordering
- **type** (`organic` | `adv`) - Optional - Default: `organic` - Search-traffic type. `adv` returns paid-search keywords with snippet fields populated.
- **with_subdomains** (Boolean) - Optional - Default: `true` - When `true`, include keywords ranking for any subdomain of `domain`. When `false`, restrict to the exact `domain`. Ignored when `url` is used. Also accepts `1`/`0`.
- **page** (Integer ≥ 1) - Optional - Default: `1` - Page number for paginated results.
- **limit** (Integer 1–1000) - Optional - Default: `100` - Page size. Values > 1000 are silently capped at 1000.
- **order_field** (enum) - Optional - Default: `traffic` - Sort key. Valid values: `traffic`, `volume`, `position`, `cpc`, `competition`, `kei`, `difficulty`, `traffic_percent`, `price`.
- **order_type** (`asc` | `desc`) - Optional - Default: `desc` - Sort direction.
- **cols** (String) - Optional - Comma-separated list of fields to return. See Default response columns. Invalid column names are silently dropped.

#### Historical Snapshots (year / month)
- **year** (Integer) - Optional - Year of the historical snapshot to retrieve. Must be supplied together with `month`.
- **month** (Integer 1–12) - Optional - Month of the historical snapshot. Must be supplied together with `year`. Out-of-range values return HTTP 400 `invalid month`.

### Response
#### Success Response (200)
- **keywords_count** (Integer) - Total number of keywords.
- **traffic_sum** (Number) - Sum of traffic.
- **top1_5** (Integer) - Number of keywords in top 1-5 positions (organic type).
- **top6_10** (Integer) - Number of keywords in top 6-10 positions (organic type).
- **top11_20** (Integer) - Number of keywords in top 11-20 positions (organic type).
- **top21_50** (Integer) - Number of keywords in top 21-50 positions (organic type).
- **top51_100** (Integer) - Number of keywords in top 51-100 positions (organic type).
- **top1_2** (Integer) - Number of keywords in top 1-2 positions (adv type).
- **top3_5** (Integer) - Number of keywords in top 3-5 positions (adv type).
- **top6_8** (Integer) - Number of keywords in top 6-8 positions (adv type).
- **top9_11** (Integer) - Number of keywords in top 9-11 positions (adv type).
- **year** (Integer) - Year of the snapshot.
- **month** (Integer) - Month of the snapshot.
- **price_sum** (Number) - Sum of prices.

#### Response Example (organic)
```json
[
  {
    "keywords_count": 104199,
    "traffic_sum": 35838,
    "top1_5": 12629,
    "top6_10": 11401,
    "top11_20": 19134,
    "top21_50": 39725,
    "top51_100": 46089,
    "year": 2025,
    "month": 4,
    "price_sum": 85424.78
  },
  {
    "keywords_count": 103538,
    "traffic_sum": 34402,
    "top1_5": 9107,
    "top6_10": 11517,
    "top11_20": 19029,
    "top21_50": 39617,
    "top51_100": 45963,
    "year": 2025,
    "month": 5,
    "price_sum": 85721.73
  }
]
```

#### Response Example (adv)
```json
[
  {
    "keywords_count": 7,
    "traffic_sum": 0,
    "top1_2": 7,
    "top3_5": 0,
    "top6_8": 0,
    "top9_11": 0,
    "year": 2025,
    "month": 4,
    "price_sum": 0
  },
  {
    "keywords_count": 8,
    "traffic_sum": 0,
    "top1_2": 8,
    "top3_5": 0,
    "top6_8": 0,
    "top9_11": 0,
    "year": 2025,
    "month": 5,
    "price_sum": 0
  }
]
```

### Notes
- **Cost:** 100 credits per request.
- **Historical responses use a different schema than current responses.** See Response shape — historical below. Clients that consume both must branch on whether `year`/`month` were sent.
- `topX_Y` fields reflect total result occurrences, not unique keywords. This is why their sum can exceed `keywords_count`.
```

--------------------------------

### Create project response example

Source: https://seranking.com/api/se-visible/projects

Example JSON response returned after successfully creating a project. Contains the UUID of the newly created project.

```json
{
  "id": "550e8400-e29b-41d4-a716-446655440000"
}
```

--------------------------------

### Add project response example

Source: https://seranking.com/api/project/project-management

Response example for the add project request. Returns the ID of the newly created project.

```json
{ "site_id": 507052 }
```

--------------------------------

### Response example for Get TOP 10 results

Source: https://seranking.com/api/project/competitors

Example response body for the Get TOP 10 results endpoint. Shows an array of objects with position, url, keyword_id, backlinks, and domains fields.

```json
[  

    {  

        "position": 1,  

        "url": "https://anandaioga.com/ca/inici",  

        "keyword_id": 4843813,  

        "backlinks": "216",  

        "domains": "57"  

    },  

  ...  

]
```

--------------------------------

### POST /projects

Source: https://seranking.com/api/se-visible/getting-started

Example of creating a new SE Visible project via POST request.

```APIDOC
## POST /projects

### Description
Creates a new SE Visible project. The project is processed asynchronously; track progress via Get project details.

### Method
POST

### Endpoint
https://api.seranking.com/v1/se-visible/projects

### Parameters
#### Request Body
- **domain** (string) - Required - The primary brand's domain.
- **country_code** (string) - Required - Country code for the project.
- **lang_code** (string) - Required - Language code for the project.
- **brand_names** (array of strings) - Required - List of brand names to track.
- **topics** (array of strings) - Required - List of topics for the project.

### Request Example
{
  "domain": "https://lavazza.com",
  "country_code": "US",
  "lang_code": "en",
  "brand_names": ["Lavazza"],
  "topics": ["Ground Coffee", "Espresso Machines"]
}

### Response
#### Success Response (200)
- **project** (object) - The created project resource.

#### Response Example
{
  "project": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "queued"
  }
}
```

--------------------------------

### GET /v1/project-management/users/me

Source: https://seranking.com/api/project/getting-started

Example of a GET request to the SE Ranking API to retrieve current user information.

```APIDOC
## [GET] /v1/project-management/users/me

### Description
Retrieves information about the current user, including currency and value.

### Method
GET

### Endpoint
/v1/project-management/users/me

### Parameters
#### Headers
- **Authorization** (string) - Required - The API key in the format `Token YOUR_API_KEY`.

### Request Example
```
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 code.
- **value** (number) - The value associated with the user.

#### Response Example
```
{
  "currency": "rur",
  "value": 2296380.85
}
```
```

--------------------------------

### GET /v1/domain/keywords/comparison

Source: https://seranking.com/api/data/domain-analysis

Documentation for the GET /v1/domain/keywords/comparison endpoint, including query parameters, request examples, and response fields.

```APIDOC
## [GET] /v1/domain/keywords/comparison

### Description
Retrieves keyword comparison data between a primary domain and a compare domain. Returns a JSON array of keyword objects with metrics for both domains.

### Method
GET

### Endpoint
https://api.seranking.com/v1/domain/keywords/comparison

### Parameters
#### Query Parameters
- **source** (string) - Required - The search engine source (e.g., `us`).
- **domain** (string) - Required - The primary domain to analyze (e.g., `booking.com`).
- **compare** (string) - Required - The domain to compare against (e.g., `hotels.com`).
- **type** (string) - Required - The search type (e.g., `organic`).
- **diff** (integer) - Required - Comparison mode: `0` for domain comparison, `1` for URL comparison.
- **order_field** (string) - Optional - Field to order results by (e.g., `volume`).
- **order_type** (string) - Optional - Order direction: `asc` or `desc`.
- **url** (string) - Optional - The primary URL to analyze when `diff=1` (e.g., `https://www.booking.com`).
- **compare** (string) - Optional - The URL to compare against when `diff=1` (e.g., `https://www.hotels.com`).
- **filter[intents]** (string) - Optional - Filter by search intent codes (e.g., `T` for transactional).
- **filter[volume][from]** (integer) - Optional - Filter keywords by minimum volume (e.g., `1000`).
- **cols** (string) - Optional - Comma-separated list of columns to include in the response (e.g., `keyword,volume,intents,position,compare_position`).

### Request Example
```
curl -X GET 'https://api.seranking.com/v1/domain/keywords/comparison?source=us&domain=booking.com&compare=hotels.com&type=organic&diff=0&order_field=volume&order_type=desc' \
  -H 'Authorization: Token YOUR_API_KEY'
```

### Response
#### Success Response (200)
Returns a JSON array of keyword objects. Each object contains the following fields:
- **keyword** (string) - The analyzed keyword phrase.
- **volume** (integer) - Average monthly Google searches for the keyword.
- **cpc** (float) - Cost per click for the keyword.
- **competition** (float) - Keyword competition score from `0.00` to `1.00`.
- **difficulty** (integer) - Keyword difficulty from `0` to `100`.
- **total_sites** (integer) - Number of websites in search results for the query.
- **position** (integer) - Ranking position of the primary domain. Can be null if `diff=1` and the domain doesn't rank.
- **url** (string) - URL of the primary domain's ranking page. Can be null if `diff=1`.
- **price** (float) - Estimated traffic value for the primary domain. Can be null if `diff=1`.
- **traffic** (float) - Estimated traffic for the primary domain. Can be null if `diff=1`.
- **compare_position** (integer) - Ranking position of the compare domain.
- **compare_url** (string) - URL of the compare domain's ranking page.
- **compare_price** (float) - Estimated traffic value for the compare domain.
- **compare_traffic** (float) - Estimated traffic for the compare domain.
- **intents** (array) - Search intent codes: `I` (informational), `N` (navigational), `T` (transactional), `C` (commercial), `L` (local).
- **serp_features** (array) - SERP features present for the keyword (e.g., `sitelinks`, `hotel_pack`, `people_also_ask`).

#### Response Example
```json
[
  {
    "keyword": "haworth hotel holland mi",
    "volume": 10,
    "cpc": 3.01,
    "competition": 0.5,
    "difficulty": 20,
    "total_sites": 94,
    "position": 4,
    "url": "https://www.booking.com/hotel/us/haworth-inn-center.html",
    "price": 2.44,
    "traffic": 0.81,
    "compare_position": 5,
    "compare_url": "https://www.hotels.com/ho576868/haworth/",
    "compare_price": 1.84,
    "compare_traffic": 0.61,
    "intents": ["T"],
    "serp_features": ["sitelinks", "hotel_pack", "people_also_ask"]
  }
]
```
```

--------------------------------

### Add project request example

Source: https://seranking.com/api/project/project-management

Request example for adding a new project. The endpoint is POST https://api.seranking.com/v1/project-management/sites. The request body includes url and title. The response returns HTTP 201 and the project ID.

```http
POST https://api.seranking.com/v1/project-management/sites  

[{"url": "http://test.site/","title": "seo site"}]
```

--------------------------------

### JSON response for project details

Source: https://seranking.com/api/se-visible/projects

Example response showing project metadata, check progress, topics, check dates, next check date, tracked brands, and unparsed prompts flag.

```json
{
  "project": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "domain": "https://lavazza.com",
    "brand_names": ["Lavazza"],
    "created_at": "2023-12-15 10:30:00",
    "checked_at": "2023-12-15 11:45:00",
    "status": "success",
    "models": [
      { "model_type": "chatgpt", "country_code": "US" },
      { "model_type": "google_ai_mode", "country_code": "US" }
    ]
  },
  "check": {
    "processed_percent": 75
  },
  "topics": [
    { "id": 1, "title": "Default", "is_default": true, "prompts_count": 0 },
    { "id": 2, "title": "Ground Coffee", "is_default": false, "prompts_count": 10 },
    { "id": 3, "title": "Whole Bean Coffee", "is_default": false, "prompts_count": 8 }
  ],
  "check_dates": ["2023-12-15", "2023-12-14", "2023-12-13"],
  "next_check_date": "2023-12-22 10:00:00",
  "tracked_brands": [
    { "brand_id": 10, "brand_name": "Illy", "domain": "https://illy.com" },
    { "brand_id": 11, "brand_name": "Nespresso", "domain": null }
  ],
  "has_unparsed_prompts": false
}
```

--------------------------------

### GET /v1/project-management/airt/prompts/answer

Source: https://seranking.com/api/project/ai-result-tracker

Documentation for the GET /v1/project-management/airt/prompts/answer endpoint, including parameters, request example, response fields, and error handling.

```APIDOC
## GET /v1/project-management/airt/prompts/answer

### Description
Retrieves the full AI answer text, cited source URLs, detected brand mentions, and, for Google AI Overview engines, the top organic URLs for the tracked prompt on the requested date. Use this endpoint to retrieve the evidence behind the presence and position metrics from `/prompts/rankings`.

### Method
GET

### Endpoint
`https://api.seranking.com/v1/project-management/airt/prompts/answer`

### Parameters
#### Path Parameters
- **site_id** (Integer) - Required - Site ID.
- **llm_id** (Integer) - Required - LLM engine ID.
- **prompt_llm_id** (Integer) - Required - Prompt-LLM link ID from List prompts.

#### Query Parameters
- **date** (String) - Optional - Date of the cached answer, in `YYYY-MM-DD` format. Defaults to current date.

### Request Example
```
curl -X GET "https://api.seranking.com/v1/project-management/airt/prompts/answer?site_id=123&llm_id=456&prompt_llm_id=789&date=2026-04-01" \
  -H "Authorization: Token YOUR_API_TOKEN"
```

### Response
#### Success Response (200)
- **prompt_llm_id** (Integer) - Prompt ID. Same value as the prompt_llm_id path parameter.
- **prompt** (String) - Prompt text.
- **site_llm_id** (Integer) - Site LLM association ID.
- **site_id** (Integer) - Site ID.
- **date** (String) - Date of the cached answer, in `YYYY-MM-DD` format.
- **text** (String) - Full AI answer text cached on the requested date. Empty for dates older than 30 days.
- **sources** (Array of Object) - Source URLs cited in the answer, ordered by position.
  - **sources[].url** (String) - Cited source URL.
  - **sources[].position** (Integer) - Position of the source in the answer, starting at 1.
- **brands** (Array of Object) - Brands detected in the answer, including the tracked brand and competitors.
  - **brands[].name** (String) - Detected brand name.
  - **brands[].position** (Integer) - Position of the brand in the answer, starting at 1.
- **organic_urls** (Array of Object) - Top organic URLs alongside the AI answer. Returned for Google AI Overview engines, up to 20 items.
  - **organic_urls[].url** (String) - Organic result URL.
  - **organic_urls[].position** (Integer) - Organic result position, starting at 1.

#### Response Example
```
{
  "prompt_llm_id": 6739,
  "prompt": "What are the top fashion trends for Fall/Winter 2025?",
  "site_llm_id": 630,
  "site_id": 72193,
  "date": "2026-04-01",
  "text": "Fall/Winter 2025 fashion trends embrace dramatic, oversized silhouettes and textured luxury, featuring long coats, rich suede, leather blazers, and strong \"collegiate\" preppy styles...",
  "sources": [
    { "url": "https://www.whowhatwear.com/fashion/fall/fashion-week-trends-fall-winter-2025", "position": 1 },
    { "url": "https://facesmag.com/fashion-en/faces-trend-report-the-top-13-trends-for-fall-winter-2025-26/", "position": 2 },
    { "url": "https://www.vogue.com/article/fall-winter-2025-fashion-trends", "position": 3 }
  ],
  "brands": [
    { "name": "Vogue", "position": 1 },
    { "name": "Who What Wear", "position": 2 },
    { "name": "Glamour", "position": 3 }
  ],
  "organic_urls": [
    { "url": "https://www.vogue.com/article/fall-winter-2025-fashion-trends", "position": 1 },
    { "url": "https://www.whowhatwear.com/fashion/trends/elegant-fall-winter-trends-2025", "position": 2 },
    { "url": "https://www.pinterest.com/ideas/fall-2025-fashion-trends/923550151023/", "position": 3 }
  ]
}
```

### Error Handling
- **404** - Prompt not found for this LLM engine. Occurs when using the `prompt_id` field instead of `prompt_llm_id`.
- **400** - Dates older than one year return HTTP 400.

### Notes
- Answer data is stored per day. To follow answer drift over time, call the endpoint once per date.
- Available dates come from the `/prompts/rankings` endpoint.
- The `organic_urls` field is returned only for Google AI Overview engines. For other engines (ChatGPT, Perplexity, Gemini), the field is omitted from the response.
- The full `text` field is retained for 30 days.
- Presence metrics (`sources`, `brands`, `organic_urls`) are retained for one year.
- For dates between 30 days and one year old, the endpoint returns the presence metrics with `text` as an empty string.
- Dates older than one year return HTTP `400`.
```

--------------------------------

### Create topics response example

Source: https://seranking.com/api/se-visible/topics

Example JSON response for a successful create topics request, showing the created topics with their IDs and default flags.

```json
[
  { "id": 123, "title": "Artificial Intelligence", "is_default": false },
  { "id": 124, "title": "Machine Learning", "is_default": false }
]
```

--------------------------------

### Get domain authority

Source: https://seranking.com/api/data/backlinks

Documentation for the Get domain authority endpoint, including request parameters, examples, and response format.

```APIDOC
## GET/POST /v1/backlinks/authority/domain

### Description
Returns the Domain InLink Rank value of the target page's root domain. Supports GET and POST requests and allows batching of up to 100 targets per request.

### Method
GET or POST

### Endpoint
https://api.seranking.com/v1/backlinks/authority/domain

### Parameters
#### Query Parameters
- **apikey** (String) - Required - API key for authentication. Must always be sent as a GET parameter.
- **target** (String) - Required - Target to analyze: root domain, host (subdomain), or specific URL (e.g., `seranking.com`). Can be repeated for multiple targets.
- **output** (String) - Optional - Response format (`json` or `xml`). Default: `json`. Must always be sent as a GET parameter.

#### Request Body (POST only)
- **target** (Array of String) - Required - List of targets to analyze. Must be in JSON format.

### Request Example
#### GET (multiple targets)
```
GET: https://api.seranking.com/v1/backlinks/authority/domain?apikey=XXX&target=https://seranking.com&target=https://www.seranking.com&output=json
```

#### POST (multiple targets)
```
POST: https://api.seranking.com/v1/backlinks/authority/domain?apikey=XXX&output=json
{
  "target": [
    "https://seranking.com/",
    "https://www.seranking.com/rank-tracker/"
  ]
}
```

### Response
#### Success Response (200)
- **pages** (Array) - List of objects containing the URL and its domain inlink rank.
  - **url** (String) - The target URL.
  - **domain_inlink_rank** (Integer) - The Domain InLink Rank value.

#### Response Example
```
{
  "pages": [
    {
      "url": "https://seranking.com",
      "domain_inlink_rank": 68
    },
    {
      "url": "https://www.seranking.com",
      "domain_inlink_rank": 87
    }
  ]
}
```
```

--------------------------------

### Response example for listing business listings

Source: https://seranking.com/api/local-marketing-api/business-listings

Example response for listing business listings. Returns HTTP 200 with an array of citations in 'items' and a 'pagination' object. Shows fields like 'nap_match_status' and 'field_statuses' for each citation.

```json
{  

  "items": [  

    {  

      "id": 301,  

      "location_id": 15,  

      "directory_code": "yelp",  

      "directory_name": "Yelp",  

      "status": "active",  

      "url": "https://yelp.com/biz/folk-osteria",  

      "is_synced": true,  

      "updated_at": "2026-08-01 10:00:00",  

      "last_synced_at": "2026-08-01 10:00:00",  

      "sync_error": null,  

      "nap_match_status": "matched",  

      "field_statuses": {  

        "name": "matched",  

        "address": "matched",  

        "phone": "matched",  

        "website": "matched"  

      }  

    },  

    {  

      "id": 302,  

      "location_id": 15,  

      "directory_code": "foursquare",  

      "directory_name": "Foursquare",  

      "status": "mismatched",  

      "url": "https://foursquare.com/v/folk-osteria",  

      "is_synced": false,  

      "updated_at": "2026-07-28 14:30:00",  

      "last_synced_at": "2026-07-20 09:00:00",  

      "sync_error": null,  

      "nap_match_status": "mismatched",  

      "field_statuses": {  

        "name": "matched",  

        "address": "mismatched",  

        "phone": "matched",  

        "website": null  

      }  

    }  

  ],  

  "pagination": {  

    "total": 66,  

    "limit": 100,  

    "offset": 0  

  }  

}
```

--------------------------------

### Get question keywords

Source: https://seranking.com/api/data/keyword-research

API documentation for the GET /v1/keywords/questions endpoint, including parameters, request example, and response information.

```APIDOC
## [GET] /v1/keywords/questions

### Description
Retrieves keywords phrased as common user questions related to a specified seed keyword within a regional database. Returns metrics such as search volume, CPC, competition, keyword difficulty, search intent, and optional historical search volume trends.

### Method
GET

### Endpoint
https://api.seranking.com/v1/keywords/questions

### Parameters
#### Query Parameters
- **source** (String) - Required - Country code of the regional keyword database (e.g., `us`). For acceptable values, see Regional database codes.
- **keyword** (String) - Required - Seed keyword to retrieve question-style keywords (e.g., `avocado`).
- **limit** (Integer) - Optional (default: `100`) - Maximum number of keywords to return per page (e.g., `10`). Positive integer.
- **offset** (Integer) - Optional (default: `0`) - Starting offset for pagination (e.g., `0`). Non-negative integer.
- **sort** (String) - Optional - Field by which keywords are sorted: `keyword`, `volume`, `cpc`, `difficulty`, `competition`.
- **sort_order** (String) - Optional (default: `desc`) - Sorting order: `asc` (ascending) or `desc` (descending).
- **history_trend** (Boolean) - Optional (default: `FALSE`) - Indicates whether to include historical search volume trend data in the response: `true` or `false`.
- **filter[volume][from]** (Integer) - Optional - Minimum monthly search volume (e.g., `50`). Non-negative integer.
- **filter[volume][to]** (Integer) - Optional - Maximum monthly search volume (e.g., `5000`). Non-negative integer.
- **filter[difficulty][from]** (Integer) - Optional - Minimum keyword difficulty score. Integers from 0 to 100.
- **filter[difficulty][to]** (Integer) - Optional - Maximum keyword difficulty score. Integers from 0 to 100.
- **filter[cpc][from]** (Float) - Optional - Minimum Cost Per Click (e.g., `0.1`). Non-negative float.
- **filter[cpc][to]** (Float) - Optional - Maximum Cost Per Click (e.g., `3`). Non-negative float.
- **filter[competition][from]** (Float) - Optional - Minimum competition score (e.g., `0.2`). Floats from 0.0 to 1.0.
- **filter[competition][to]** (Float) - Optional - Maximum competition score (e.g., `0.7`). Floats from 0.0 to 1.0.
- **filter[keyword_count][from]** (Integer) - Optional - Minimum number of words in the keyword (e.g., `3`). Positive integer.
- **filter[keyword_count][to]** (Integer) - Optional - Maximum number of words in the keyword (e.g., `5`). Positive integer.
- **filter[characters_count][from]** (Integer) - Optional - Minimum character length of the keyword (e.g., `20`). Positive integer.
- **filter[characters_count][to]** (Integer) - Optional - Maximum character length of the keyword (e.g., `50`). Positive integer.
- **filter[serp_features]** (String) - Optional - Comma-separated list of SERP features to filter results (e.g., `sge`, `images`, `top_stories`). For acceptable values, see SERP features.
- **filter[intents]** (String) - Optional - Comma-separated list of intent codes: `I` (informational), `N` (navigational), `T` (transactional), `C` (commercial), `L` (local).
- **filter[multi_keyword_included]** (Array) - Optional - Keywords to include based on specific patterns. Each element is an array of objects with `type` (begins, contains, ends, exact) and `value` (string to match).
- **filter[multi_keyword_excluded]** (Array) - Optional - Keywords to exclude based on specific patterns. Each element is an array of objects with `type` (begins, contains, ends, exact) and `value` (string to match).

### Request Example
```
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'
```

### Response
#### Success Response (200)
The response contains the retrieved question keywords with their metrics. Specific response fields are not detailed in the source documentation.

#### Response Example
Not provided in the source documentation.
```

--------------------------------

### List projects - JSON response

Source: https://seranking.com/api/se-visible/projects

Example response showing a project object with id, domain, brand_names, timestamps, status, and models array.

```json
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "domain": "https://lavazza.com",
    "brand_names": ["Lavazza"],
    "created_at": "2023-12-15 10:30:00",
    "checked_at": "2023-12-15 11:45:00",
    "status": "success",
    "models": [
      { "model_type": "chatgpt", "country_code": "US" }
    ]
  }
]
```

--------------------------------

### Response example for Get all crawled pages

Source: https://seranking.com/api/data/website-audit

Example JSON response from the Get all crawled pages endpoint. It includes the total count and an items array with detailed page data such as URL, status, load time, title, and issue counts.

```json
{
    "total": 1009,
    "items": [
        {
            "id": "50958380",
            "url": "[https://www.vitality.co.uk/](https://www.vitality.co.uk/)",
            "url_len": "27",
            "type": "doc",
            "url_protocol": "https",
            "sitemap": "0",
            "status": "200",
            "size": "156676",
            "depth": "1",
            "noindex": "0",
            "first_ms": "35",
            "load_ms": "1373",
            "robots": "index, follow",
            "nofollow": "0",
            "xrobots": null,
            "title_len": "53",
            "description_len": "139",
            "chars": "153843",
            "h1_len": "35",
            "h2_len": "16",
            "html_ratio": "40",
            "blocked_robots": "0",
            "img": "21",
            "hreflang": null,
            "hreflang_link": null,
            "refresh_time": null,
            "meta_refresh": "0",
            "redirect_url": null,
            "canonical_url": "[https://www.vitality.co.uk/](https://www.vitality.co.uk/)",
            "single_h1": "1",
            "single_h2": "0",
            "h3_count": "9",
            "h4_count": "33",
            "h5_count": "0",
            "h6_count": "0",
            "words_count": "1621",
            "total_links": "230",
            "mixed_count": null,
            "mixed": null,
            "last_modified": null,
            "content_hash": "9d657683ebd385ba700d4301f1ef854f",
            "title": "Vitality Insurance | Award-Winning Insurance Provider",
            "description": "Vitality is a leading UK insurer offering health and life insurance. Get your quote today and unlock discounts and rewards from top brands.",
            "h1": "Live longer with Vitality insurance",
            "h2": "Health insurance",
            "issues": "2",
            "errors": "0",
            "warnings": "0",
            "notices": "2",
            "refpages": "921"
        }
    ]
}
```

--------------------------------

### Get user profile - Request example

Source: https://seranking.com/api/project/account-management

Sends a GET request to retrieve the authenticated user's profile. No parameters are required.

```http
GET https://api.seranking.com/v1/project-management/users/me
```

--------------------------------

### List plan items - Response example

Source: https://seranking.com/api/project/marketing-plan

Example response showing the structure of a marketing plan section with items, including fields like title, items, id, items_count, and items_checked.

```json
[
  {
    "title": "Step 1. Semantic core and keyword research",
    "items": [
      {
        "id": "analyze_competitors",
        "title": "Analyze competitors’ keywords",
        "checked": true
      },
      {
        "id": "makeup_final_list",
        "title": "Collect core keywords",
        "checked": true
      },
      ...
    ],
    "id": "keywords_research",
    "items_count": 3,
    "items_checked": 3
  },
  ...
]
```

--------------------------------

### Response example for adding prompts

Source: https://seranking.com/api/project/ai-result-tracker

Example JSON response returned with HTTP status 201. Contains site_llm_id, site_id, added count (excluding duplicates), and an array of prompt_llm_id values.

```json
{
  "site_llm_id": 151294,
  "site_id": 11270054,
  "added": 3,
  "prompts": [1411621, 1411624, 1411627]
}
```
Tokens:
Raw