EN English ES Español DE Deutsch FR Français PT Português JP 日本語 CN 中文 AR العربية IT Italiano KR 한국어 RU Русский NL Nederlands TR Türkçe PL Polski SE Svenska
Referência da API

API de Lista de Observação de Domínios

Gerencie a sua lista de observação de domínios. Receba notificações quando domínios ficarem disponíveis ou mudem de estado. Use esta referência para escolher uma operação e integrar seu contrato de resposta documentado.

Ver página do produto

Operações

GET /v1/watchlist Ver referência da API
POST /v1/watchlist Ver referência da API
DELETE /v1/watchlist Ver referência da API
GET /v1/watchlist/expiring Ver referência da API
GET /v1/watchlist/available Ver referência da API

GET /v1/watchlist

Operação: getWatchlist Créditos e autenticação: 1 Autenticação obrigatória
GET /v1/watchlist

Campos de Resposta

Campo Tipo
watchlist[] object[]
watchlist[] object
watchlist[].domain string
watchlist[].added_at string
watchlist[].status string
watchlist[].last_checked string
watchlist[].expiry_date string
watchlist[].days_until_expiry integer
watchlist[].notify_email string
total integer
updated_at string

Pedido de Exemplo

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/watchlist"

Resposta de Exemplo

{
  "watchlist": [
    {
      "domain": "example.com",
      "added_at": "2024-01-01T00:00:00Z",
      "status": "registered",
      "last_checked": "2024-01-15T12:00:00Z"
    }
  ],
  "total": 1,
  "updated_at": "2024-01-15T12:00:00Z"
}

POST /v1/watchlist

Operação: addToWatchlist Créditos e autenticação: 1 Autenticação obrigatória
POST /v1/watchlist

Parâmetros do Corpo

Parâmetro Tipo obrigatório
domain string obrigatório
notify_email string opcional

Campos de Resposta

Campo Tipo
success boolean
message string
watchlist[] object[]
watchlist[] object
watchlist[].domain string
watchlist[].added_at string
watchlist[].status string
watchlist[].last_checked string
watchlist[].expiry_date string
watchlist[].days_until_expiry integer
watchlist[].notify_email string
total integer

Pedido de Exemplo

curl -X POST "https://domscan.net/v1/watchlist" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "domain": "example.com",
  "notify_email": "[email protected]"
}'

Resposta de Exemplo

{
  "success": true,
  "message": "string",
  "watchlist": [
    {
      "domain": "example.com",
      "added_at": "2026-04-15T12:00:00Z",
      "status": "registered",
      "last_checked": "2026-04-15T12:00:00Z",
      "expiry_date": "2026-04-15T12:00:00Z",
      "days_until_expiry": 1,
      "notify_email": "[email protected]"
    }
  ],
  "total": 1
}

DELETE /v1/watchlist

Operação: removeFromWatchlist Créditos e autenticação: Grátis Autenticação obrigatória
DELETE /v1/watchlist

Parâmetros de Consulta

Parâmetro Tipo obrigatório
domain string obrigatório

Campos de Resposta

Campo Tipo
success boolean
message string
domain string

Pedido de Exemplo

curl -X DELETE "https://domscan.net/v1/watchlist?domain=example.com" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{}'

Resposta de Exemplo

{
  "success": true,
  "message": "string",
  "domain": "example.com"
}

GET /v1/watchlist/expiring

Operação: getExpiringWatchlist Créditos e autenticação: 1 Autenticação obrigatória
GET /v1/watchlist/expiring

Parâmetros de Consulta

Parâmetro Tipo obrigatório
days integer
Padrão 90
opcional

Campos de Resposta

Campo Tipo
expiring_domains[] object[]
expiring_domains[] object
expiring_domains[].domain string
expiring_domains[].added_at string
expiring_domains[].status string
expiring_domains[].last_checked string
expiring_domains[].expiry_date string
expiring_domains[].days_until_expiry integer
expiring_domains[].notify_email string
total integer
threshold_days integer

Pedido de Exemplo

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/watchlist/expiring?days=example.com"

Resposta de Exemplo

{
  "expiring_domains": [
    {
      "domain": "example.com",
      "added_at": "2026-04-15T12:00:00Z",
      "status": "registered",
      "last_checked": "2026-04-15T12:00:00Z",
      "expiry_date": "2026-04-15T12:00:00Z",
      "days_until_expiry": 1,
      "notify_email": "[email protected]"
    }
  ],
  "total": 1,
  "threshold_days": 1
}

GET /v1/watchlist/available

Operação: getAvailableWatchlist Créditos e autenticação: 1 Autenticação obrigatória
GET /v1/watchlist/available

Campos de Resposta

Campo Tipo
available_domains[] object[]
available_domains[] object
available_domains[].domain string
available_domains[].added_at string
available_domains[].status string
available_domains[].last_checked string
available_domains[].expiry_date string
available_domains[].days_until_expiry integer
available_domains[].notify_email string
total integer
message string

Pedido de Exemplo

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/watchlist/available"

Resposta de Exemplo

{
  "available_domains": [
    {
      "domain": "example.com",
      "added_at": "2026-04-15T12:00:00Z",
      "status": "registered",
      "last_checked": "2026-04-15T12:00:00Z",
      "expiry_date": "2026-04-15T12:00:00Z",
      "days_until_expiry": 1,
      "notify_email": "[email protected]"
    }
  ],
  "total": 1,
  "message": "string"
}

Recursos de referência

OpenAPI 3.0 Postman MCP