API de Receita de Localizador de Domínio

Q: Quais endpoints estão incluídos?

Este guia cobre 4 endpoints públicos: POST /v1/domain-discovery/jobs , GET /v1/batches/:job_id , GET /v1/batches/:job_id/results , DELETE /v1/batches/:job_id .

curl -X POST "https://domscan.net/v1/domain-discovery/jobs" \ -H "X-API-Key: $DOMSCAN_API_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: discovery-com-io-1" \ -d '{"tlds":["com","io"],"limit":25,"min_length":4,"max_length":12,"singular_only":true}'

{ "job": { "id": "bat_...", "status": "queued", "total": 50, "status_url": "https://domscan.net/v1/batches/bat_...", "results_url": "https://domscan.net/v1/batches/bat_.../results" }, "discovery": { "page_words": 25, "tlds": ["com", "io"], "domain_checks": 50, "credits_per_domain": 1, "next_cursor": "..." } }

Categoria Pesquisa e preços de domínios

Pontos finais 4

Créditos 0-1/item

Autenticação Autenticação necessária

Usado por pessoas em empresas incríveis

Sinais de confiança antes da integração

Documentação transparente, solicitações autenticadas e detalhes visíveis de confiabilidade facilitam avaliar o DomScan antes de publicar.

Ao vivo Status do serviço

Consulte o estado do serviço ao vivo e as respostas de falha documentadas antes de fazer a integração.

OpenAPI Artefatos da API

OpenAPI, Swagger, Postman, CLI, SDK e links MCP ficam a um clique.

Chaves API Acesso protegido

Endpoints autenticados usam chaves API com custos de créditos claros antes da chamada.

10,000 Cota gratuita

Comece com 10.000 créditos mensais e faça upgrade só quando o uso crescer.

O que esta API ajuda você a lançar

Use esta página como briefing de produção: endpoints, exemplos, formato da resposta e peças de workflow para conectar o DomScan ao seu produto.

Workflows de produto

Incorpore checagens de domínio, inteligência DNS, sinais de risco ou enriquecimento em onboarding, busca e ferramentas internas.

Automação de analistas

Substitua consultas manuais repetidas por jobs agendados, alertas e etapas de investigação reproduzíveis.

Dados JSON limpos

Use campos previsíveis, códigos de status documentados e custos em créditos em vez de raspar páginas de fornecedores.

IA e operações

Alimente agentes, dashboards, playbooks SOAR e CRMs via OpenAPI, SDK, Postman ou MCP.

Fluxo de integração

Um caminho simples da primeira requisição ao uso repetível em produção.

Autentique uma vez

Envie sua chave API com o cabeçalho documentado e mantenha requisições consistentes entre serviços.

Consulte com exemplos

Comece pelos exemplos curl e HTTP, depois mapeie os parâmetros no código da sua aplicação.

Opere e monitore

Use códigos de status, custos em créditos e campos de resposta para criar retentativas, logs e alertas.

Kit de desenvolvedor

Saia desta página para docs legíveis por máquina, coleções de requisições, SDKs ou ferramentas para agentes.

Esquema OpenAPI

Gere clientes ou inspecione cada formato de requisição e resposta.

Coleção Postman

Importe requisições prontas para testes manuais e repasse ao time.

SDKs e CLI

Use pacotes mantidos e fluxos de linha de comando em vez de escrever boilerplate.

Integração MCP

Exponha inteligência de domínios para agentes de IA e assistentes internos.

Mapa de parâmetros e resposta

Revise entradas, campos de saída e códigos de status antes de ligar o endpoint ao seu cliente.

Parâmetros da requisição

Parâmetro

tldslimitcursormin_lengthmax_lengthsingular_onlyjob_idafterformat

Campos da resposta

Resposta de Exemplo

jobjob.idjob.statusjob.totaljob.status_urljob.results_urldiscoverydiscovery.page_wordsdiscovery.tldsdiscovery.domain_checksdiscovery.credits_per_domaindiscovery.next_cursor

Cobertura de status

Códigos de Estado HTTP

200202400401402409429

Pontos finais

POST /v1/domain-discovery/jobs

Créditos: 1/itemAutenticação: Autenticação necessária

tldslimitcursormin_lengthmax_lengthsingular_only

GET /v1/batches/:job_id

Créditos: 0Autenticação: Autenticação necessária

job_id

GET /v1/batches/:job_id/results

Créditos: 0Autenticação: Autenticação necessária

job_idafterlimitformat

DELETE /v1/batches/:job_id

Créditos: 0Autenticação: Autenticação necessária

job_id

Sinais de confiança antes da integração

Documentação transparente, solicitações autenticadas e detalhes visíveis de confiabilidade facilitam avaliar o DomScan antes de publicar.

Status do serviço Artefatos da API

OpenAPI, Swagger, Postman, CLI, SDK e links MCP ficam a um clique.

Chaves API Acesso protegido

Endpoints autenticados usam chaves API com custos de créditos claros antes da chamada.

Cota gratuita Cadastre-se Gratuitamente

Comece com 10.000 créditos mensais e faça upgrade só quando o uso crescer.

Ativo Pedido de Exemplo

Comece pelos exemplos curl e HTTP, depois mapeie os parâmetros no código da sua aplicação.

Principais Recursos

Pontos finais

POST /v1/domain-discovery/jobs • GET /v1/batches/:job_id • GET /v1/batches/:job_id/results • DELETE /v1/batches/:job_id

Parâmetro

tlds, limit, cursor, min_length, max_length, singular_only, job_id, after, format

Códigos de Estado HTTP

200, 202, 400, 401, 402, 409, 429

Créditos / Autenticação

0-1/item / Autenticação necessária

Pedido de Exemplo

POST /v1/domain-discovery/jobs bash

curl -X POST "https://domscan.net/v1/domain-discovery/jobs" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: discovery-com-io-1" \
  -d '{"tlds":["com","io"],"limit":25,"min_length":4,"max_length":12,"singular_only":true}'

Resposta de Exemplo

202 Accepted json

{
  "job": {
    "id": "bat_...",
    "status": "queued",
    "total": 50,
    "status_url": "https://domscan.net/v1/batches/bat_...",
    "results_url": "https://domscan.net/v1/batches/bat_.../results"
  },
  "discovery": {
    "page_words": 25,
    "tlds": ["com", "io"],
    "domain_checks": 50,
    "credits_per_domain": 1,
    "next_cursor": "..."
  }
}

Perguntas frequentes

Quais endpoints estão incluídos?

Este guia cobre 4 endpoints públicos: POST /v1/domain-discovery/jobs, GET /v1/batches/:job_id, GET /v1/batches/:job_id/results, DELETE /v1/batches/:job_id.

Esta API exige autenticação?

Sim. Envie sua chave de API com o cabeçalho `X-API-Key` ou `Authorization: Bearer` ao chamar Receita de Localizador de Domínio.

Quantos créditos ela usa?

As solicitações destes guias usam 0-1/item créditos, dependendo do endpoint. Para endpoints em lote, os créditos usam a taxa padrão por item.

Onde posso ver os parâmetros completos e os endpoints relacionados?

Use a documentação completa de Receita de Localizador de Domínio para revisar detalhes dos parâmetros, observações de autenticação e endpoints relacionados da mesma família de API.

Ferramentas e Recursos Relacionados

Códigos de Estado HTTP

Documentamos os códigos de estado HTTP que deves tratar para distinguir respostas bem-sucedidas, problemas de autenticação, créditos, limites de taxa, dados em falta e falhas do serviço a montante.

OK 200

Pedido bem-sucedido

Aceito 202

Falha de cache de subdomínios em modo somente cache aceita para atualização em segundo plano. Nenhum crédito é cobrado; tente novamente após o intervalo Retry-After.

Pedido inválido 400

Parâmetros inválidos

Não autorizado 401

Chave de API ou sessão em falta ou inválida.

Pagamento necessário 402

Não tens créditos suficientes para executar este pedido.

HTTP 409 409

Demasiados pedidos 429

Limite de taxa excedido

Comece grátis com 10.000 créditos por mês. Use qualquer API pública e adicione créditos somente quando precisar.

Começar Gratuitamente Ver documentação