Référence API

API Liste de Surveillance de Domaine

Gérez votre liste de surveillance de domaines. Recevez une notification lorsque les domaines deviennent disponibles ou changent de statut. Utilisez cette référence pour choisir une opération et intégrer son contrat de réponse documenté.

Opérations

GET /v1/watchlist Voir la référence API
POST /v1/watchlist Voir la référence API
DELETE /v1/watchlist Voir la référence API
GET /v1/watchlist/expiring Voir la référence API
GET /v1/watchlist/available Voir la référence API

GET /v1/watchlist

Opération: getWatchlist Crédits et authentification: 1 Authentification requise
GET /v1/watchlist

Champs de Réponse

Champ Type
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

Exemple de Requête

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

Exemple de Réponse

{
  "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

Opération: addToWatchlist Crédits et authentification: 1 Authentification requise
POST /v1/watchlist

Paramètres du Corps

Paramètre Type requis
domain string requis
notify_email string optionnel

Champs de Réponse

Champ Type
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

Exemple de Requête

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]"
}'

Exemple de Réponse

{
  "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

Opération: removeFromWatchlist Crédits et authentification: Gratuit Authentification requise
DELETE /v1/watchlist

Paramètres de Requête

Paramètre Type requis
domain string requis

Champs de Réponse

Champ Type
success boolean
message string
domain string

Exemple de Requête

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

Exemple de Réponse

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

GET /v1/watchlist/expiring

Opération: getExpiringWatchlist Crédits et authentification: 1 Authentification requise
GET /v1/watchlist/expiring

Paramètres de Requête

Paramètre Type requis
days integer
Défaut 90
optionnel

Champs de Réponse

Champ Type
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

Exemple de Requête

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

Exemple de Réponse

{
  "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

Opération: getAvailableWatchlist Crédits et authentification: 1 Authentification requise
GET /v1/watchlist/available

Champs de Réponse

Champ Type
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

Exemple de Requête

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

Exemple de Réponse

{
  "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"
}

Ressources de référence