Lotes asíncronos de API
Pon en cola varias solicitudes compatibles de la API y recopila sus resultados sin mantener abierta una conexión del cliente.
Lotes asíncronos de API
Pon en cola varias solicitudes compatibles de la API y recopila sus resultados sin mantener abierta una conexión del cliente.
Cómo funciona el procesamiento por lotes
- Cada lote admite hasta 100 solicitudes GET públicas compatibles.
- Cada elemento mantiene el precio habitual de su endpoint, y los fallos definitivos se reembolsan de forma independiente.
- El estado y los resultados del trabajo permanecen disponibles para todos los miembros de la cuenta durante 24 horas.
- Un webhook HTTPS opcional puede avisar a tu sistema cuando el procesamiento alcanza un estado definitivo.
Solicitud de ejemplo
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"}}
]
}'
Campos de respuesta
| Campo | Tipo |
|---|---|
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 |
Respuesta de ejemplo
{
"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"
}
}
Consulta de estado y cancelación
Consulta el endpoint de estado, recupera los resultados ordenados o cancela el trabajo que aún no ha comenzado.
GET /v1/batches/{job_id}
GET /v1/batches/{job_id}/results
GET /v1/batches/{job_id}/results?format=csv
DELETE /v1/batches/{job_id}
Webhooks de finalización firmados
Las firmas de webhook usan HMAC-SHA256 sobre la marca de tiempo, un punto y el cuerpo exacto de la solicitud. Verifica la marca de tiempo antes de aceptar una entrega.
X-DomScan-Event: batch.completed
X-DomScan-Timestamp: 1785231000
X-DomScan-Signature: sha256=...
API unificada de trabajos
Consulta, pagina y cancela todos los trabajos asíncronos en un solo lugar: lotes de API, descubrimiento de dominios, análisis de tecnologías y trabajos de scraping. Los trabajos se siguen creando en sus propios endpoints, que continúan funcionando sin cambios. Todas las operaciones de /v1/jobs son gratuitas.
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
Estructura del trabajo
Todos los trabajos tienen los mismos campos: id, kind, status, marcas de tiempo, progress (total, done, succeeded, failed, cancelled), credits (charged, refunded) y enlaces al trabajo, a sus resultados y, mientras todavía se pueda cancelar, a su acción de cancelación. native_status conserva el estado informado por el endpoint que creó el trabajo.
{
"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"
}
}
}
Estados
queued y running indican que el trabajo está en curso. Un trabajo que se está cancelando muestra running hasta que la cancelación se completa. completed significa que todos los elementos llegaron a un estado final, failed significa que el trabajo terminó sin ningún elemento correcto y cancelled significa que el trabajo se canceló. Los elementos fallidos se cuentan en progress.failed y aparecen en los resultados.
batch domain_discovery tech_scan scrape · queued running completed failed cancelled
Paginación
Tanto el listado de trabajos como la lectura de resultados aceptan limit (de 1 a 100, 25 por defecto) y cursor. Pasa el next_cursor de la página anterior como cursor. Es null en la última página. Los cursores están firmados y vinculados a tu cuenta y al trabajo, por lo que un cursor modificado o ajeno devuelve 400.
Cancelación
Al cancelar un trabajo de lotes de API, descubrimiento de dominios o análisis de tecnologías se detienen los elementos sin iniciar y se reembolsan sus créditos. Un elemento que ya se está ejecutando puede terminar. Cancelar un trabajo ya cancelado devuelve 200. Los trabajos de scraping no se pueden cancelar, y un trabajo que ya terminó devuelve 409 con JOB_NOT_CANCELLABLE.
Webhook de finalización
Añade notify_webhook: true a cualquier solicitud de creación de trabajo para recibir un evento firmado job.completed, job.failed o job.cancelled cuando el trabajo termine. El evento llega a todos los endpoints de webhook firmados activos que estén suscritos a él o a todos los eventos. Pasa el id de un endpoint en lugar de true para enviarlo solo a ese endpoint. Las entregas usan las mismas firmas, reintentos y registro de entregas que las alertas de monitorización, y son gratuitas.
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
Parámetros del cuerpo
| Parámetro | Tipo | obligatorio |
|---|---|---|
| notify_webhook | unknown | opcional |
| tlds | string[] | obligatorio |
| limit | integer | opcional |
| cursor | string | opcional |
| min_length |
integer
Predeterminado
3
|
opcional |
| max_length |
integer
Predeterminado
16
|
opcional |
| singular_only |
boolean
Predeterminado
false
|
opcional |
Campos de respuesta
| Campo | Tipo |
|---|---|
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 |
Solicitud de ejemplo
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))Respuesta de ejemplo
{
"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"
}
}
Códigos de estado HTTP
200OK202Aceptado400Solicitud incorrecta401No autorizado402Pago requerido409HTTP 409429Demasiadas solicitudes
Parámetros de consulta
| Parámetro | Tipo | obligatorio |
|---|---|---|
| limit |
integer
Predeterminado
25
|
opcional |
Campos de respuesta
| Campo | Tipo |
|---|---|
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 |
Solicitud de ejemplo
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))Respuesta de ejemplo
{
"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
}
Códigos de estado HTTP
200OK400Solicitud incorrecta401No autorizado429Demasiadas solicitudes
Parámetros de consulta
| Parámetro | Tipo | obligatorio |
|---|---|---|
| job_id | string | obligatorio |
Campos de respuesta
| Campo | Tipo |
|---|---|
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 |
Solicitud de ejemplo
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))Respuesta de ejemplo
{
"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"
}
}
Códigos de estado HTTP
200OK401No autorizado404No encontrado429Demasiadas solicitudes
Parámetros de consulta
| Parámetro | Tipo | obligatorio |
|---|---|---|
| job_id | string | obligatorio |
| after |
integer
Predeterminado
-1
|
opcional |
| limit |
integer
Predeterminado
100
|
opcional |
| format |
string
Valores permitidos
jsoncsv
Predeterminado
json
|
opcional |
Campos de respuesta
| Campo | Tipo |
|---|---|
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 |
Solicitud de ejemplo
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))Respuesta de ejemplo
{
"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
}
Códigos de estado HTTP
200OK400Solicitud incorrecta401No autorizado404No encontrado429Demasiadas solicitudes
Parámetros de consulta
| Parámetro | Tipo | obligatorio |
|---|---|---|
| job_id | string | obligatorio |
Campos de respuesta
| Campo | Tipo |
|---|---|
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 |
Solicitud de ejemplo
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))Respuesta de ejemplo
{
"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"
}
}
Códigos de estado HTTP
202Aceptado401No autorizado404No encontrado409HTTP 409429Demasiadas solicitudes
Parámetros de consulta
| Parámetro | Tipo | obligatorio |
|---|---|---|
| limit |
integer
Predeterminado
25
|
opcional |
| cursor | string | opcional |
| kind |
string
Valores permitidos
batchtech_scanscrapedomain_discoverycrawl
|
opcional |
Campos de respuesta
| Campo | Tipo |
|---|---|
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 |
Solicitud de ejemplo
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))Respuesta de ejemplo
{
"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"
}
Códigos de estado HTTP
200OK400Solicitud incorrecta401No autorizado429Demasiadas solicitudes
Parámetros de consulta
| Parámetro | Tipo | obligatorio |
|---|---|---|
| job_id | string | obligatorio |
Campos de respuesta
| Campo | Tipo |
|---|---|
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 |
Solicitud de ejemplo
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))Respuesta de ejemplo
{
"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"
}
}
}
Códigos de estado HTTP
200OK401No autorizado404No encontrado429Demasiadas solicitudes
Parámetros de consulta
| Parámetro | Tipo | obligatorio |
|---|---|---|
| job_id | string | obligatorio |
| limit |
integer
Predeterminado
25
|
opcional |
| cursor | string | opcional |
Campos de respuesta
| Campo | Tipo |
|---|---|
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 |
Solicitud de ejemplo
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))Respuesta de ejemplo
{
"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"
}
Códigos de estado HTTP
200OK400Solicitud incorrecta401No autorizado404No encontrado410HTTP 410429Demasiadas solicitudes
Parámetros de consulta
| Parámetro | Tipo | obligatorio |
|---|---|---|
| job_id | string | obligatorio |
Campos de respuesta
| Campo | Tipo |
|---|---|
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 |
Solicitud de ejemplo
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))Respuesta de ejemplo
{
"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"
}
Códigos de estado HTTP
200OK202Aceptado401No autorizado404No encontrado409HTTP 409429Demasiadas solicitudes