https://api.nexscope.ai/seo/domainCompetitorsRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/seo/domainCompetitors |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
language | string | optional | Language value used by this API operation. Constant: en Default: en |
limit | integer | optional | Limit value used by this API operation. Default: 10 Minimum: 1 Maximum: 20 |
market | string | optional | Market value used by this API operation. Constant: US Default: US |
target | string | required | Target value used by this API operation. Minimum length: 1 Maximum length: 254 |
Code example
{
"language": "en",
"limit": 10,
"market": "US",
"target": "nexscope.ai"
}Response example
Example response envelope from the documented SEO API contract.
{
"code": 0,
"cost": "-1",
"data": {
"callId": "synthetic-call",
"completedAt": null,
"coverage": {
"missing": [
{
"field": "synthetic",
"reason": "UPSTREAM_FIELD_MISSING"
}
],
"status": "PARTIAL"
},
"requestedAt": "123",
"result": {
"inputTarget": "synthetic",
"items": [
{
"averagePosition": 1.25,
"domain": "synthetic",
"missing": [
{
"field": "synthetic",
"reason": "synthetic"
}
],
"sharedKeywordCount": 9007199254740992
}
],
"language": "synthetic",
"market": "synthetic",
"maximumRankGroup": 1,
"missing": [
{
"field": "synthetic",
"reason": "synthetic"
}
],
"ordering": "synthetic",
"requestedLimit": 1,
"returnedCount": 1,
"searchType": "synthetic",
"target": "synthetic"
},
"schemaVersion": "synthetic",
"source": "synthetic",
"status": "PARTIAL",
"usage": {
"billingStatus": "UNAPPROVED",
"chargedCredits": "0"
}
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": "synthetic-trace",
"ts": "9007199254740993"
}Response fields
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 is a successful envelope; inspect data.status separately. Allowed: 0, 42008, 42009 |
cost | string | required | Elapsed processing milliseconds; not price. -1 for non-web context. |
data | object | required | Data value used by this API operation. |
data.callId | string | null | optional | Call id value used by this API operation. |
data.completedAt | string | integer | null | optional | Completed at value used by this API operation. |
data.coverage | object | optional | Coverage value used by this API operation. |
data.coverage.missing | array | optional | Missing value used by this API operation. |
data.coverage.missing[] | object | required | Item in data coverage missing. |
data.coverage.missing[].field | string | optional | Field value used by this API operation. |
data.coverage.missing[].reason | string | optional | Reason value used by this API operation. |
data.coverage.status | string | optional | Status value used by this API operation. |
data.requestedAt | string | integer | null | optional | Requested at value used by this API operation. |
data.result | object | null | required | Result value used by this API operation. |
data.result.inputTarget | string | required | Input target value used by this API operation. |
data.result.items | array | required | Items value used by this API operation. Minimum items: 0 Maximum items: 20 |
data.result.items[] | object | required | Item in data result items. |
data.result.items[].averagePosition | number | null | required | Average position value used by this API operation. Minimum: 0 |
data.result.items[].domain | string | required | Domain value used by this API operation. Minimum length: 1 |
data.result.items[].missing | array | required | Missing value used by this API operation. Minimum items: 0 |
data.result.items[].missing[] | object | required | Item in data result items[] missing. |
data.result.items[].missing[].field | string | required | Field value used by this API operation. |
data.result.items[].missing[].reason | string | required | Reason value used by this API operation. Allowed: UPSTREAM_FIELD_MISSING, UPSTREAM_FIELD_INVALID, DUPLICATE_UPSTREAM_ITEM |
data.result.items[].sharedKeywordCount | integer | null | required | Shared keyword count value used by this API operation. Minimum: 0 |
data.result.language | string | required | Language value used by this API operation. Constant: en |
data.result.market | string | required | Market value used by this API operation. Constant: US |
data.result.maximumRankGroup | integer | required | Maximum rank group value used by this API operation. Constant: 100 |
data.result.missing | array | required | Missing value used by this API operation. Minimum items: 0 |
data.result.missing[] | object | required | Item in data result missing. |
data.result.missing[].field | string | required | Field value used by this API operation. |
data.result.missing[].reason | string | required | Reason value used by this API operation. Allowed: UPSTREAM_FIELD_MISSING, UPSTREAM_FIELD_INVALID, DUPLICATE_UPSTREAM_ITEM |
data.result.ordering | string | required | Ordering value used by this API operation. Constant: target_intersection_organic_count_desc |
data.result.requestedLimit | integer | required | Requested limit value used by this API operation. Minimum: 1 Maximum: 20 |
data.result.returnedCount | integer | required | Returned count value used by this API operation. Minimum: 0 Maximum: 20 |
data.result.searchType | string | required | Search type value used by this API operation. Constant: organic |
data.result.target | string | required | Target value used by this API operation. |
data.schemaVersion | string | null | optional | Schema version value used by this API operation. |
data.source | string | null | optional | Source value used by this API operation. |
data.status | string | optional | Status value used by this API operation. Allowed: SUCCESS, PARTIAL, EMPTY, PROCESSING, UNKNOWN, FAILED |
data.usage | object | null | optional | Usage value used by this API operation. |
data.usage.billingStatus | string | null | optional | Billing status value used by this API operation. |
data.usage.chargedCredits | string | integer | null | optional | Charged credits value used by this API operation. |
msg | string | null | required | Available upstream msg/errmsg/message is preferred for success and failure; Chinese is translated to English. Missing successful message is null. Platform-only errors and task states use platform English. Message text never determines success or retry. |
time | string | required | yyyy-MM-dd HH:mm:ss |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds; global long serializer. |
Accepted processing response
code 0 confirms acceptance. Use data.callId to query the same request; processing is not completion.
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 is a successful envelope; inspect data.status separately. Constant: 0 |
cost | string | required | Elapsed processing milliseconds; not price. -1 for non-web context. |
data | object | required | Data value used by this API operation. |
data.callId | string | null | required | Call id value used by this API operation. |
data.reason | string | required | Reason value used by this API operation. Constant: IN_PROGRESS |
data.retryable | boolean | optional | Retryable value used by this API operation. |
data.status | string | required | Status value used by this API operation. Constant: PROCESSING |
data.taskId | string | null | optional | Task id value used by this API operation. |
msg | string | null | required | Available upstream msg/errmsg/message is preferred for success and failure; Chinese is translated to English. Missing successful message is null. Platform-only errors and task states use platform English. Message text never determines success or retry. |
time | string | required | yyyy-MM-dd HH:mm:ss |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds; global long serializer. |
Error response
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 is a successful envelope; inspect data.status separately. |
cost | string | required | Elapsed processing milliseconds; not price. -1 for non-web context. |
data | object | required | Data value used by this API operation. |
data.callId | string | null | required | Call id value used by this API operation. |
data.reason | string | null | required | Reason value used by this API operation. |
data.retryable | boolean | optional | Retryable value used by this API operation. |
data.status | string | null | required | Status value used by this API operation. |
data.taskId | string | null | optional | Task id value used by this API operation. |
msg | string | null | required | Available upstream msg/errmsg/message is preferred for success and failure; Chinese is translated to English. Missing successful message is null. Platform-only errors and task states use platform English. Message text never determines success or retry. |
time | string | required | yyyy-MM-dd HH:mm:ss |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds; global long serializer. |
Retrieve a processing result
A response with PROCESSING and a callId means the result is still being prepared. Use the result query below with the returned identifier. This lookup reads the stored result and does not spend credits.
curl -X GET https://api.nexscope.ai/seo/domainCompetitors/calls/{callId} \
-H "Authorization: Bearer nk-xxxxxxxxxxxxxxxxx"Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.