Асинхронные пакетные запросы API
Ставьте в очередь множество поддерживаемых запросов API и получайте результаты, не удерживая клиентское соединение открытым.
Асинхронные пакетные запросы API
Ставьте в очередь множество поддерживаемых запросов API и получайте результаты, не удерживая клиентское соединение открытым.
Как работает пакетная обработка
- Каждый пакет может содержать до 100 поддерживаемых общедоступных GET-запросов.
- Каждый элемент оплачивается по обычному тарифу своей конечной точки, а при окончательной ошибке кредиты возвращаются за него отдельно.
- Статус задания и результаты доступны всем участникам аккаунта в течение 24 часов.
- Необязательный HTTPS-вебхук может уведомить вашу систему, когда обработка перейдёт в конечное состояние.
Пример запроса
curl -X POST "https://domscan.net/v1/batches" \
-H "X-API-Key: $DOMSCAN_API_KEY" \
-H "Idempotency-Key: customer-import-42" \
-H "Content-Type: application/json" \
-d '{
"requests": [
{"path": "/v1/status", "query": {"domain": "example.com"}},
{"path": "/v1/dns", "query": {"domain": "example.org", "type": "MX"}}
]
}'
Поля ответа
| Поле | Тип |
|---|---|
job |
object |
job.id |
string |
job.status |
string |
job.total |
integer |
job.counts |
object |
job.counts.pending |
integer |
job.counts.processing |
integer |
job.counts.succeeded |
integer |
job.counts.failed |
integer |
job.counts.cancelled |
integer |
job.billing |
object |
job.billing.credits_charged |
integer |
job.billing.credits_refunded |
integer |
job.billing.credits_net |
integer |
job.webhook |
object |
job.webhook.configured |
boolean |
job.webhook.status |
string |
job.webhook.attempts |
integer |
job.status_url |
string |
job.results_url |
string |
job.results_csv_url |
string |
job.poll_after_ms |
integer | null |
job.created_at |
string |
job.started_at |
string | null |
job.completed_at |
string | null |
job.cancelled_at |
string | null |
job.updated_at |
string |
job.processing_deadline_at |
string |
job.results_expires_at |
string |
Пример ответа
{
"job": {
"id": "example-id",
"status": "queued",
"total": 1,
"counts": {
"pending": 1,
"processing": 1,
"succeeded": 1,
"failed": 1,
"cancelled": 1
},
"billing": {
"credits_charged": 1,
"credits_refunded": 1,
"credits_net": 1
},
"webhook": {
"configured": false,
"status": "not_configured",
"attempts": 1
},
"status_url": "https://example.com",
"results_url": "https://example.com",
"results_csv_url": "https://example.com",
"created_at": "2026-08-27T12:00:00Z",
"updated_at": "2026-08-27T12:00:00Z",
"processing_deadline_at": "2026-08-27T12:00:00Z",
"results_expires_at": "2026-08-27T12:00:00Z",
"poll_after_ms": 1,
"started_at": "2026-08-27T12:00:00Z",
"completed_at": "2026-08-27T12:00:00Z",
"cancelled_at": "2026-08-27T12:00:00Z"
}
}
Опрос состояния и отмена
Опрашивайте конечную точку состояния, получайте результаты в исходном порядке или отменяйте ещё не начатые задания.
GET /v1/batches/{job_id}
GET /v1/batches/{job_id}/results
GET /v1/batches/{job_id}/results?format=csv
DELETE /v1/batches/{job_id}
Подписанные вебхуки о завершении
Подписи вебхуков используют HMAC-SHA256 для строки из временной метки, точки и точного тела запроса. Перед принятием доставки проверяйте временную метку.
X-DomScan-Event: batch.completed
X-DomScan-Timestamp: 1785231000
X-DomScan-Signature: sha256=...
Единый API задач
Читайте, листайте и отменяйте любые асинхронные задачи в одном месте: пакетные запросы API, поиск доменов, сканирование технологий и задачи скрейпинга. Задачи по-прежнему создаются на собственных конечных точках, которые продолжают работать без изменений. Все операции /v1/jobs бесплатны.
GET /v1/jobs?limit=25&kind=tech_scan
GET /v1/jobs/{job_id}
GET /v1/jobs/{job_id}/results?limit=25&cursor=...
POST /v1/jobs/{job_id}/cancel
Структура задачи
У каждой задачи одни и те же поля: id, kind, status, временные метки, progress (total, done, succeeded, failed, cancelled), credits (charged, refunded) и ссылки на саму задачу, её результаты и, пока её можно отменить, на действие отмены. native_status сохраняет статус, сообщённый конечной точкой, которая создала задачу.
{
"job": {
"id": "tsj_4f2a9c1e7b3d4a5f8e6c2b1a0d9f8e7c",
"kind": "tech_scan",
"status": "running",
"native_status": "running",
"created_at": "2026-10-10T12:00:00Z",
"updated_at": "2026-10-10T12:00:20Z",
"started_at": "2026-10-10T12:00:05Z",
"completed_at": null,
"results_expires_at": "2026-10-12T12:00:00Z",
"progress": { "total": 2, "done": 1, "succeeded": 1, "failed": 0, "cancelled": 0 },
"credits": { "charged": 6, "refunded": 0 },
"notify_webhook": { "endpoint_id": null, "status": "waiting", "event_type": null, "deliveries": 0 },
"links": {
"self": "https://domscan.net/v1/jobs/tsj_4f2a9c1e7b3d4a5f8e6c2b1a0d9f8e7c",
"results": "https://domscan.net/v1/jobs/tsj_4f2a9c1e7b3d4a5f8e6c2b1a0d9f8e7c/results",
"cancel": "https://domscan.net/v1/jobs/tsj_4f2a9c1e7b3d4a5f8e6c2b1a0d9f8e7c/cancel"
}
}
}
Статусы
queued и running означают, что задача выполняется. Задача, которую отменяют, сообщает running, пока отмена не завершится. completed означает, что каждый элемент достиг конечного состояния, failed означает, что задача завершилась без единого успешного элемента, а cancelled означает, что задача была отменена. Неудачные элементы учитываются в progress.failed и перечислены в результатах.
batch domain_discovery tech_scan scrape · queued running completed failed cancelled
Постраничная навигация
И список задач, и чтение результатов принимают limit (от 1 до 100, по умолчанию 25) и cursor. Передайте next_cursor с предыдущей страницы как cursor. На последней странице он равен null. Курсоры подписаны и привязаны к вашему аккаунту и к задаче, поэтому изменённый или чужой курсор вернёт 400.
Отмена
Отмена пакетного запроса API, поиска доменов или сканирования технологий останавливает не начатые элементы и возвращает их кредиты. Элемент, который уже выполняется, может завершиться. Отмена уже отменённой задачи возвращает 200. Задачи скрейпинга отменить нельзя, а уже завершённая задача возвращает 409 с JOB_NOT_CANCELLABLE.
Вебхук о завершении
Добавьте notify_webhook: true в любой запрос на создание задачи, чтобы по её завершении получить одно подписанное событие job.completed, job.failed или job.cancelled. Событие уходит на каждую активную подписанную конечную точку вебхука, которая подписана на него или на все события. Передайте идентификатор конечной точки вместо true, чтобы отправить событие только на неё. Доставка использует те же подписи, повторные попытки и журнал доставок, что и оповещения мониторинга, и бесплатна.
curl -X POST "https://domscan.net/v1/tech/jobs" \
-H "X-API-Key: $DOMSCAN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"targets": ["example.com"], "notify_webhook": true}'
X-DomScan-Event: job.completed
X-DomScan-Event-Id: evt_job_tsj_4f2a9c1e7b3d4a5f8e6c2b1a0d9f8e7c
Параметры тела запроса
| Параметр | Тип | обязателен |
|---|---|---|
| notify_webhook | unknown | опционально |
| tlds | string[] | обязателен |
| limit | integer | опционально |
| cursor | string | опционально |
| min_length |
integer
По умолчанию
3
|
опционально |
| max_length |
integer
По умолчанию
16
|
опционально |
| singular_only |
boolean
По умолчанию
false
|
опционально |
Поля ответа
| Поле | Тип |
|---|---|
job |
object |
job.id |
string |
job.status |
string |
job.total |
integer |
job.counts |
object |
job.counts.pending |
integer |
job.counts.processing |
integer |
job.counts.succeeded |
integer |
job.counts.failed |
integer |
job.counts.cancelled |
integer |
job.billing |
object |
job.billing.credits_charged |
integer |
job.billing.credits_refunded |
integer |
job.billing.credits_net |
integer |
job.webhook |
object |
job.webhook.configured |
boolean |
job.webhook.status |
string |
job.webhook.attempts |
integer |
job.status_url |
string |
job.results_url |
string |
job.results_csv_url |
string |
job.poll_after_ms |
integer | null |
job.created_at |
string |
job.started_at |
string | null |
job.completed_at |
string | null |
job.cancelled_at |
string | null |
job.updated_at |
string |
job.processing_deadline_at |
string |
job.results_expires_at |
string |
discovery |
object |
discovery.corpus |
string |
discovery.corpus_version |
string |
discovery.total_matching_words |
integer |
discovery.page_offset |
integer |
discovery.page_words |
integer |
discovery.domain_checks |
integer |
discovery.tlds[] |
string[] |
discovery.filters |
object |
discovery.filters.min_length |
integer |
discovery.filters.max_length |
integer |
discovery.filters.singular_only |
boolean |
discovery.credits_per_domain |
integer |
discovery.next_cursor |
string | null |
Пример запроса
curl -X POST "https://domscan.net/v1/domain-discovery/jobs" \
-H "Content-Type: application/json" \
-H "X-API-Key: $DOMSCAN_API_KEY" \
-d '{
"tlds": [
"io",
"ai"
],
"limit": 50,
"min_length": 4,
"max_length": 8,
"singular_only": true
}'const response = await fetch("https://domscan.net/v1/domain-discovery/jobs", {
method: "POST",
headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
body: JSON.stringify({
"tlds": [
"io",
"ai"
],
"limit": 50,
"min_length": 4,
"max_length": 8,
"singular_only": true
}),
});
const data = await response.json();
console.log(data);import os
import requests
response = requests.post(
"https://domscan.net/v1/domain-discovery/jobs",
headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
json={
"tlds": [
"io",
"ai",
],
"limit": 50,
"min_length": 4,
"max_length": 8,
"singular_only": True,
},
)
print(response.json())package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"tlds": [
"io",
"ai"
],
"limit": 50,
"min_length": 4,
"max_length": 8,
"singular_only": true
}`)
req, err := http.NewRequest(http.MethodPost, "https://domscan.net/v1/domain-discovery/jobs", body)
if err != nil {
panic(err)
}
req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
data, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(resp.Status, string(data))
}require "json"
require "net/http"
uri = URI("https://domscan.net/v1/domain-discovery/jobs")
request = Net::HTTP::Post.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
"tlds" => [
"io",
"ai"
],
"limit" => 50,
"min_length" => 4,
"max_length" => 8,
"singular_only" => true
})
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))Пример ответа
{
"job": {
"id": "example-id",
"status": "queued",
"total": 1,
"counts": {
"pending": 1,
"processing": 1,
"succeeded": 1,
"failed": 1,
"cancelled": 1
},
"billing": {
"credits_charged": 1,
"credits_refunded": 1,
"credits_net": 1
},
"webhook": {
"configured": false,
"status": "not_configured",
"attempts": 1
},
"status_url": "https://example.com",
"results_url": "https://example.com",
"results_csv_url": "https://example.com",
"created_at": "2026-08-27T12:00:00Z",
"updated_at": "2026-08-27T12:00:00Z",
"processing_deadline_at": "2026-08-27T12:00:00Z",
"results_expires_at": "2026-08-27T12:00:00Z",
"poll_after_ms": 1,
"started_at": "2026-08-27T12:00:00Z",
"completed_at": "2026-08-27T12:00:00Z",
"cancelled_at": "2026-08-27T12:00:00Z"
},
"discovery": {
"corpus": "iannuttall/unclaimed",
"corpus_version": "example",
"total_matching_words": 1,
"page_offset": 1,
"page_words": 1,
"domain_checks": 1,
"tlds": [
"com",
"net",
"org"
],
"filters": {
"min_length": 1,
"max_length": 1,
"singular_only": false
},
"credits_per_domain": 1,
"next_cursor": "example"
}
}
Коды состояния HTTP
200OK202Принято400Неверный запрос401Не авторизован402Требуется оплата409HTTP 409429Слишком много запросов
Параметры запроса
| Параметр | Тип | обязателен |
|---|---|---|
| limit |
integer
По умолчанию
25
|
опционально |
Поля ответа
| Поле | Тип |
|---|---|
jobs[] |
object[] |
jobs[] |
object |
jobs[].id |
string |
jobs[].status |
string |
jobs[].total |
integer |
jobs[].counts |
object |
jobs[].counts.pending |
integer |
jobs[].counts.processing |
integer |
jobs[].counts.succeeded |
integer |
jobs[].counts.failed |
integer |
jobs[].counts.cancelled |
integer |
jobs[].billing |
object |
jobs[].billing.credits_charged |
integer |
jobs[].billing.credits_refunded |
integer |
jobs[].billing.credits_net |
integer |
jobs[].webhook |
object |
jobs[].webhook.configured |
boolean |
jobs[].webhook.status |
string |
jobs[].webhook.attempts |
integer |
jobs[].status_url |
string |
jobs[].results_url |
string |
jobs[].results_csv_url |
string |
jobs[].poll_after_ms |
integer | null |
jobs[].created_at |
string |
jobs[].started_at |
string | null |
jobs[].completed_at |
string | null |
jobs[].cancelled_at |
string | null |
jobs[].updated_at |
string |
jobs[].processing_deadline_at |
string |
jobs[].results_expires_at |
string |
retention_hours |
integer |
Пример запроса
curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/batches?limit=25"const response = await fetch("https://domscan.net/v1/batches?limit=25", {
headers: { "X-API-Key": process.env.DOMSCAN_API_KEY },
});
const data = await response.json();
console.log(data);import os
import requests
response = requests.get(
"https://domscan.net/v1/batches?limit=25",
headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
)
print(response.json())package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest(http.MethodGet, "https://domscan.net/v1/batches?limit=25", nil)
if err != nil {
panic(err)
}
req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
data, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(resp.Status, string(data))
}require "json"
require "net/http"
uri = URI("https://domscan.net/v1/batches?limit=25")
request = Net::HTTP::Get.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))Пример ответа
{
"jobs": [
{
"id": "example-id",
"status": "queued",
"total": 1,
"counts": {
"pending": 1,
"processing": 1,
"succeeded": 1,
"failed": 1,
"cancelled": 1
},
"billing": {
"credits_charged": 1,
"credits_refunded": 1,
"credits_net": 1
},
"webhook": {
"configured": false,
"status": "not_configured",
"attempts": 1
},
"status_url": "https://example.com",
"results_url": "https://example.com",
"results_csv_url": "https://example.com",
"created_at": "2026-08-27T12:00:00Z",
"updated_at": "2026-08-27T12:00:00Z",
"processing_deadline_at": "2026-08-27T12:00:00Z",
"results_expires_at": "2026-08-27T12:00:00Z",
"poll_after_ms": 1,
"started_at": "2026-08-27T12:00:00Z",
"completed_at": "2026-08-27T12:00:00Z",
"cancelled_at": "2026-08-27T12:00:00Z"
}
],
"retention_hours": 24
}
Коды состояния HTTP
200OK400Неверный запрос401Не авторизован429Слишком много запросов
Параметры запроса
| Параметр | Тип | обязателен |
|---|---|---|
| job_id | string | обязателен |
Поля ответа
| Поле | Тип |
|---|---|
job |
object |
job.id |
string |
job.status |
string |
job.total |
integer |
job.counts |
object |
job.counts.pending |
integer |
job.counts.processing |
integer |
job.counts.succeeded |
integer |
job.counts.failed |
integer |
job.counts.cancelled |
integer |
job.billing |
object |
job.billing.credits_charged |
integer |
job.billing.credits_refunded |
integer |
job.billing.credits_net |
integer |
job.webhook |
object |
job.webhook.configured |
boolean |
job.webhook.status |
string |
job.webhook.attempts |
integer |
job.status_url |
string |
job.results_url |
string |
job.results_csv_url |
string |
job.poll_after_ms |
integer | null |
job.created_at |
string |
job.started_at |
string | null |
job.completed_at |
string | null |
job.cancelled_at |
string | null |
job.updated_at |
string |
job.processing_deadline_at |
string |
job.results_expires_at |
string |
Пример запроса
curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/batches/string"const response = await fetch("https://domscan.net/v1/batches/string", {
headers: { "X-API-Key": process.env.DOMSCAN_API_KEY },
});
const data = await response.json();
console.log(data);import os
import requests
response = requests.get(
"https://domscan.net/v1/batches/string",
headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
)
print(response.json())package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest(http.MethodGet, "https://domscan.net/v1/batches/string", nil)
if err != nil {
panic(err)
}
req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
data, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(resp.Status, string(data))
}require "json"
require "net/http"
uri = URI("https://domscan.net/v1/batches/string")
request = Net::HTTP::Get.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))Пример ответа
{
"job": {
"id": "example-id",
"status": "queued",
"total": 1,
"counts": {
"pending": 1,
"processing": 1,
"succeeded": 1,
"failed": 1,
"cancelled": 1
},
"billing": {
"credits_charged": 1,
"credits_refunded": 1,
"credits_net": 1
},
"webhook": {
"configured": false,
"status": "not_configured",
"attempts": 1
},
"status_url": "https://example.com",
"results_url": "https://example.com",
"results_csv_url": "https://example.com",
"created_at": "2026-08-27T12:00:00Z",
"updated_at": "2026-08-27T12:00:00Z",
"processing_deadline_at": "2026-08-27T12:00:00Z",
"results_expires_at": "2026-08-27T12:00:00Z",
"poll_after_ms": 1,
"started_at": "2026-08-27T12:00:00Z",
"completed_at": "2026-08-27T12:00:00Z",
"cancelled_at": "2026-08-27T12:00:00Z"
}
}
Коды состояния HTTP
200OK401Не авторизован404Не найдено429Слишком много запросов
Параметры запроса
| Параметр | Тип | обязателен |
|---|---|---|
| job_id | string | обязателен |
| after |
integer
По умолчанию
-1
|
опционально |
| limit |
integer
По умолчанию
100
|
опционально |
| format |
string
Допустимые значения
jsoncsv
По умолчанию
json
|
опционально |
Поля ответа
| Поле | Тип |
|---|---|
job |
object |
job.id |
string |
job.status |
string |
job.total |
integer |
job.counts |
object |
job.counts.pending |
integer |
job.counts.processing |
integer |
job.counts.succeeded |
integer |
job.counts.failed |
integer |
job.counts.cancelled |
integer |
job.billing |
object |
job.billing.credits_charged |
integer |
job.billing.credits_refunded |
integer |
job.billing.credits_net |
integer |
job.webhook |
object |
job.webhook.configured |
boolean |
job.webhook.status |
string |
job.webhook.attempts |
integer |
job.status_url |
string |
job.results_url |
string |
job.results_csv_url |
string |
job.poll_after_ms |
integer | null |
job.created_at |
string |
job.started_at |
string | null |
job.completed_at |
string | null |
job.cancelled_at |
string | null |
job.updated_at |
string |
job.processing_deadline_at |
string |
job.results_expires_at |
string |
results[] |
object[] |
results[] |
object |
results[].position |
integer |
results[].reference |
string | null |
results[].request |
object |
results[].request.method |
string |
results[].request.path |
string |
results[].request.query |
object |
results[].status |
string |
results[].attempts |
integer |
results[].http_status |
integer | null |
results[].result |
object | null |
results[].error |
object | null |
results[].billing |
object |
results[].started_at |
string | null |
results[].completed_at |
string | null |
next_after |
integer | null |
Пример запроса
curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/batches/example/results?after=-1&limit=25&format=json"const response = await fetch("https://domscan.net/v1/batches/example/results?after=-1&limit=25&format=json", {
headers: { "X-API-Key": process.env.DOMSCAN_API_KEY },
});
const data = await response.json();
console.log(data);import os
import requests
response = requests.get(
"https://domscan.net/v1/batches/example/results?after=-1&limit=25&format=json",
headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
)
print(response.json())package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest(http.MethodGet, "https://domscan.net/v1/batches/example/results?after=-1&limit=25&format=json", nil)
if err != nil {
panic(err)
}
req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
data, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(resp.Status, string(data))
}require "json"
require "net/http"
uri = URI("https://domscan.net/v1/batches/example/results?after=-1&limit=25&format=json")
request = Net::HTTP::Get.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))Пример ответа
{
"job": {
"id": "example-id",
"status": "queued",
"total": 1,
"counts": {
"pending": 1,
"processing": 1,
"succeeded": 1,
"failed": 1,
"cancelled": 1
},
"billing": {
"credits_charged": 1,
"credits_refunded": 1,
"credits_net": 1
},
"webhook": {
"configured": false,
"status": "not_configured",
"attempts": 1
},
"status_url": "https://example.com",
"results_url": "https://example.com",
"results_csv_url": "https://example.com",
"created_at": "2026-08-27T12:00:00Z",
"updated_at": "2026-08-27T12:00:00Z",
"processing_deadline_at": "2026-08-27T12:00:00Z",
"results_expires_at": "2026-08-27T12:00:00Z",
"poll_after_ms": 1,
"started_at": "2026-08-27T12:00:00Z",
"completed_at": "2026-08-27T12:00:00Z",
"cancelled_at": "2026-08-27T12:00:00Z"
},
"results": [
{
"position": 1,
"request": {
"method": "GET",
"path": "example",
"query": {}
},
"status": "pending",
"attempts": 1,
"http_status": 1,
"result": {},
"error": {},
"billing": {},
"reference": "example",
"started_at": "2026-08-27T12:00:00Z",
"completed_at": "2026-08-27T12:00:00Z"
}
],
"next_after": 1
}
Коды состояния HTTP
200OK400Неверный запрос401Не авторизован404Не найдено429Слишком много запросов
Параметры запроса
| Параметр | Тип | обязателен |
|---|---|---|
| job_id | string | обязателен |
Поля ответа
| Поле | Тип |
|---|---|
job |
object |
job.id |
string |
job.status |
string |
job.total |
integer |
job.counts |
object |
job.counts.pending |
integer |
job.counts.processing |
integer |
job.counts.succeeded |
integer |
job.counts.failed |
integer |
job.counts.cancelled |
integer |
job.billing |
object |
job.billing.credits_charged |
integer |
job.billing.credits_refunded |
integer |
job.billing.credits_net |
integer |
job.webhook |
object |
job.webhook.configured |
boolean |
job.webhook.status |
string |
job.webhook.attempts |
integer |
job.status_url |
string |
job.results_url |
string |
job.results_csv_url |
string |
job.poll_after_ms |
integer | null |
job.created_at |
string |
job.started_at |
string | null |
job.completed_at |
string | null |
job.cancelled_at |
string | null |
job.updated_at |
string |
job.processing_deadline_at |
string |
job.results_expires_at |
string |
Пример запроса
curl -X DELETE "https://domscan.net/v1/batches/string" \
-H "Content-Type: application/json" \
-H "X-API-Key: $DOMSCAN_API_KEY" \
-d '{}'const response = await fetch("https://domscan.net/v1/batches/string", {
method: "DELETE",
headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
body: JSON.stringify({}),
});
const data = await response.json();
console.log(data);import os
import requests
response = requests.delete(
"https://domscan.net/v1/batches/string",
headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
json={},
)
print(response.json())package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{}`)
req, err := http.NewRequest(http.MethodDelete, "https://domscan.net/v1/batches/string", body)
if err != nil {
panic(err)
}
req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
data, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(resp.Status, string(data))
}require "json"
require "net/http"
uri = URI("https://domscan.net/v1/batches/string")
request = Net::HTTP::Delete.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({})
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))Пример ответа
{
"job": {
"id": "example-id",
"status": "queued",
"total": 1,
"counts": {
"pending": 1,
"processing": 1,
"succeeded": 1,
"failed": 1,
"cancelled": 1
},
"billing": {
"credits_charged": 1,
"credits_refunded": 1,
"credits_net": 1
},
"webhook": {
"configured": false,
"status": "not_configured",
"attempts": 1
},
"status_url": "https://example.com",
"results_url": "https://example.com",
"results_csv_url": "https://example.com",
"created_at": "2026-08-27T12:00:00Z",
"updated_at": "2026-08-27T12:00:00Z",
"processing_deadline_at": "2026-08-27T12:00:00Z",
"results_expires_at": "2026-08-27T12:00:00Z",
"poll_after_ms": 1,
"started_at": "2026-08-27T12:00:00Z",
"completed_at": "2026-08-27T12:00:00Z",
"cancelled_at": "2026-08-27T12:00:00Z"
}
}
Коды состояния HTTP
202Принято401Не авторизован404Не найдено409HTTP 409429Слишком много запросов
Параметры запроса
| Параметр | Тип | обязателен |
|---|---|---|
| limit |
integer
По умолчанию
25
|
опционально |
| cursor | string | опционально |
| kind |
string
Допустимые значения
batchtech_scanscrapedomain_discoverycrawl
|
опционально |
Поля ответа
| Поле | Тип |
|---|---|
jobs[] |
object[] |
jobs[] |
object |
jobs[].id |
string |
jobs[].kind |
string |
jobs[].status |
string |
jobs[].native_status |
string |
jobs[].created_at |
string | null |
jobs[].updated_at |
string | null |
jobs[].started_at |
string | null |
jobs[].completed_at |
string | null |
jobs[].results_expires_at |
string | null |
jobs[].progress |
object |
jobs[].progress.total |
integer |
jobs[].progress.done |
integer |
jobs[].progress.succeeded |
integer |
jobs[].progress.failed |
integer |
jobs[].progress.cancelled |
integer |
jobs[].credits |
object |
jobs[].credits.charged |
integer |
jobs[].credits.refunded |
integer |
jobs[].notify_webhook |
object |
jobs[].notify_webhook.endpoint_id |
string | null |
jobs[].notify_webhook.status |
string |
jobs[].notify_webhook.event_type |
string | null |
jobs[].notify_webhook.deliveries |
integer |
jobs[].links |
object |
jobs[].links.self |
string |
jobs[].links.results |
string |
jobs[].links.cancel |
string | null |
limit |
integer |
has_more |
boolean |
next_cursor |
string | null |
Пример запроса
curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/jobs?limit=25&cursor=example&kind=batch"const response = await fetch("https://domscan.net/v1/jobs?limit=25&cursor=example&kind=batch", {
headers: { "X-API-Key": process.env.DOMSCAN_API_KEY },
});
const data = await response.json();
console.log(data);import os
import requests
response = requests.get(
"https://domscan.net/v1/jobs?limit=25&cursor=example&kind=batch",
headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
)
print(response.json())package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest(http.MethodGet, "https://domscan.net/v1/jobs?limit=25&cursor=example&kind=batch", nil)
if err != nil {
panic(err)
}
req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
data, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(resp.Status, string(data))
}require "json"
require "net/http"
uri = URI("https://domscan.net/v1/jobs?limit=25&cursor=example&kind=batch")
request = Net::HTTP::Get.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))Пример ответа
{
"jobs": [
{
"id": "example-id",
"kind": "batch",
"status": "queued",
"native_status": "queued",
"created_at": "2026-08-27T12:00:00Z",
"updated_at": "2026-08-27T12:00:00Z",
"started_at": "2026-08-27T12:00:00Z",
"completed_at": "2026-08-27T12:00:00Z",
"results_expires_at": "2026-08-27T12:00:00Z",
"progress": {
"total": 1,
"done": 1,
"succeeded": 1,
"failed": 1,
"cancelled": 1
},
"credits": {
"charged": 1,
"refunded": 1
},
"notify_webhook": {
"endpoint_id": "example",
"status": "waiting",
"event_type": "job.completed",
"deliveries": 1
},
"links": {
"self": "https://example.com",
"results": "https://example.com",
"cancel": "https://example.com"
}
}
],
"limit": 1,
"has_more": false,
"next_cursor": "example"
}
Коды состояния HTTP
200OK400Неверный запрос401Не авторизован429Слишком много запросов
Параметры запроса
| Параметр | Тип | обязателен |
|---|---|---|
| job_id | string | обязателен |
Поля ответа
| Поле | Тип |
|---|---|
job |
object |
job.id |
string |
job.kind |
string |
job.status |
string |
job.native_status |
string |
job.created_at |
string | null |
job.updated_at |
string | null |
job.started_at |
string | null |
job.completed_at |
string | null |
job.results_expires_at |
string | null |
job.progress |
object |
job.progress.total |
integer |
job.progress.done |
integer |
job.progress.succeeded |
integer |
job.progress.failed |
integer |
job.progress.cancelled |
integer |
job.credits |
object |
job.credits.charged |
integer |
job.credits.refunded |
integer |
job.notify_webhook |
object |
job.notify_webhook.endpoint_id |
string | null |
job.notify_webhook.status |
string |
job.notify_webhook.event_type |
string | null |
job.notify_webhook.deliveries |
integer |
job.links |
object |
job.links.self |
string |
job.links.results |
string |
job.links.cancel |
string | null |
Пример запроса
curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/jobs/string"const response = await fetch("https://domscan.net/v1/jobs/string", {
headers: { "X-API-Key": process.env.DOMSCAN_API_KEY },
});
const data = await response.json();
console.log(data);import os
import requests
response = requests.get(
"https://domscan.net/v1/jobs/string",
headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
)
print(response.json())package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest(http.MethodGet, "https://domscan.net/v1/jobs/string", nil)
if err != nil {
panic(err)
}
req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
data, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(resp.Status, string(data))
}require "json"
require "net/http"
uri = URI("https://domscan.net/v1/jobs/string")
request = Net::HTTP::Get.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))Пример ответа
{
"job": {
"id": "example-id",
"kind": "batch",
"status": "queued",
"native_status": "queued",
"created_at": "2026-08-27T12:00:00Z",
"updated_at": "2026-08-27T12:00:00Z",
"started_at": "2026-08-27T12:00:00Z",
"completed_at": "2026-08-27T12:00:00Z",
"results_expires_at": "2026-08-27T12:00:00Z",
"progress": {
"total": 1,
"done": 1,
"succeeded": 1,
"failed": 1,
"cancelled": 1
},
"credits": {
"charged": 1,
"refunded": 1
},
"notify_webhook": {
"endpoint_id": "example",
"status": "waiting",
"event_type": "job.completed",
"deliveries": 1
},
"links": {
"self": "https://example.com",
"results": "https://example.com",
"cancel": "https://example.com"
}
}
}
Коды состояния HTTP
200OK401Не авторизован404Не найдено429Слишком много запросов
Параметры запроса
| Параметр | Тип | обязателен |
|---|---|---|
| job_id | string | обязателен |
| limit |
integer
По умолчанию
25
|
опционально |
| cursor | string | опционально |
Поля ответа
| Поле | Тип |
|---|---|
job |
object |
job.id |
string |
job.kind |
string |
job.status |
string |
job.native_status |
string |
job.created_at |
string | null |
job.updated_at |
string | null |
job.started_at |
string | null |
job.completed_at |
string | null |
job.results_expires_at |
string | null |
job.progress |
object |
job.progress.total |
integer |
job.progress.done |
integer |
job.progress.succeeded |
integer |
job.progress.failed |
integer |
job.progress.cancelled |
integer |
job.credits |
object |
job.credits.charged |
integer |
job.credits.refunded |
integer |
job.notify_webhook |
object |
job.notify_webhook.endpoint_id |
string | null |
job.notify_webhook.status |
string |
job.notify_webhook.event_type |
string | null |
job.notify_webhook.deliveries |
integer |
job.links |
object |
job.links.self |
string |
job.links.results |
string |
job.links.cancel |
string | null |
results[] |
object[] |
results[] |
object |
results[].index |
integer |
results[].status |
string |
results[].reference |
string | null |
results[].input |
unknown |
results[].data |
object | null |
results[].error |
object |
results[].error.code |
string |
results[].error.message |
string |
results[].error.retryable |
boolean |
results[].credits |
object |
results[].credits.charged |
integer |
results[].credits.refunded |
integer |
limit |
integer |
has_more |
boolean |
next_cursor |
string | null |
Пример запроса
curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/jobs/string/results?limit=25&cursor=example"const response = await fetch("https://domscan.net/v1/jobs/string/results?limit=25&cursor=example", {
headers: { "X-API-Key": process.env.DOMSCAN_API_KEY },
});
const data = await response.json();
console.log(data);import os
import requests
response = requests.get(
"https://domscan.net/v1/jobs/string/results?limit=25&cursor=example",
headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
)
print(response.json())package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest(http.MethodGet, "https://domscan.net/v1/jobs/string/results?limit=25&cursor=example", nil)
if err != nil {
panic(err)
}
req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
data, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(resp.Status, string(data))
}require "json"
require "net/http"
uri = URI("https://domscan.net/v1/jobs/string/results?limit=25&cursor=example")
request = Net::HTTP::Get.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))Пример ответа
{
"job": {
"id": "example-id",
"kind": "batch",
"status": "queued",
"native_status": "queued",
"created_at": "2026-08-27T12:00:00Z",
"updated_at": "2026-08-27T12:00:00Z",
"started_at": "2026-08-27T12:00:00Z",
"completed_at": "2026-08-27T12:00:00Z",
"results_expires_at": "2026-08-27T12:00:00Z",
"progress": {
"total": 1,
"done": 1,
"succeeded": 1,
"failed": 1,
"cancelled": 1
},
"credits": {
"charged": 1,
"refunded": 1
},
"notify_webhook": {
"endpoint_id": "example",
"status": "waiting",
"event_type": "job.completed",
"deliveries": 1
},
"links": {
"self": "https://example.com",
"results": "https://example.com",
"cancel": "https://example.com"
}
},
"results": [
{
"index": 1,
"status": "pending",
"reference": "example",
"input": "example",
"data": {},
"error": {
"code": "example",
"message": "Request completed",
"retryable": false
},
"credits": {
"charged": 1,
"refunded": 1
}
}
],
"limit": 1,
"has_more": false,
"next_cursor": "example"
}
Коды состояния HTTP
200OK400Неверный запрос401Не авторизован404Не найдено410HTTP 410429Слишком много запросов
Параметры запроса
| Параметр | Тип | обязателен |
|---|---|---|
| job_id | string | обязателен |
Поля ответа
| Поле | Тип |
|---|---|
job |
object |
job.id |
string |
job.kind |
string |
job.status |
string |
job.native_status |
string |
job.created_at |
string | null |
job.updated_at |
string | null |
job.started_at |
string | null |
job.completed_at |
string | null |
job.results_expires_at |
string | null |
job.progress |
object |
job.progress.total |
integer |
job.progress.done |
integer |
job.progress.succeeded |
integer |
job.progress.failed |
integer |
job.progress.cancelled |
integer |
job.credits |
object |
job.credits.charged |
integer |
job.credits.refunded |
integer |
job.notify_webhook |
object |
job.notify_webhook.endpoint_id |
string | null |
job.notify_webhook.status |
string |
job.notify_webhook.event_type |
string | null |
job.notify_webhook.deliveries |
integer |
job.links |
object |
job.links.self |
string |
job.links.results |
string |
job.links.cancel |
string | null |
cancellation |
string |
Пример запроса
curl -X POST "https://domscan.net/v1/jobs/string/cancel" \
-H "Content-Type: application/json" \
-H "X-API-Key: $DOMSCAN_API_KEY" \
-d '{}'const response = await fetch("https://domscan.net/v1/jobs/string/cancel", {
method: "POST",
headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
body: JSON.stringify({}),
});
const data = await response.json();
console.log(data);import os
import requests
response = requests.post(
"https://domscan.net/v1/jobs/string/cancel",
headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
json={},
)
print(response.json())package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{}`)
req, err := http.NewRequest(http.MethodPost, "https://domscan.net/v1/jobs/string/cancel", body)
if err != nil {
panic(err)
}
req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
data, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(resp.Status, string(data))
}require "json"
require "net/http"
uri = URI("https://domscan.net/v1/jobs/string/cancel")
request = Net::HTTP::Post.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({})
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))Пример ответа
{
"job": {
"id": "example-id",
"kind": "batch",
"status": "queued",
"native_status": "queued",
"created_at": "2026-08-27T12:00:00Z",
"updated_at": "2026-08-27T12:00:00Z",
"started_at": "2026-08-27T12:00:00Z",
"completed_at": "2026-08-27T12:00:00Z",
"results_expires_at": "2026-08-27T12:00:00Z",
"progress": {
"total": 1,
"done": 1,
"succeeded": 1,
"failed": 1,
"cancelled": 1
},
"credits": {
"charged": 1,
"refunded": 1
},
"notify_webhook": {
"endpoint_id": "example",
"status": "waiting",
"event_type": "job.completed",
"deliveries": 1
},
"links": {
"self": "https://example.com",
"results": "https://example.com",
"cancel": "https://example.com"
}
},
"cancellation": "accepted"
}
Коды состояния HTTP
200OK202Принято401Не авторизован404Не найдено409HTTP 409429Слишком много запросов