Referencja API

API Lista obserwacyjna domen

Zarządzaj listą obserwowanych domen. Otrzymuj powiadomienia, gdy domeny stają się dostępne lub zmieniają status. Użyj tej referencji, aby wybrać operację i zintegrować jej udokumentowany kontrakt odpowiedzi.

Operacje

GET /v1/watchlist Otwórz referencję API
POST /v1/watchlist Otwórz referencję API
DELETE /v1/watchlist Otwórz referencję API
GET /v1/watchlist/expiring Otwórz referencję API
GET /v1/watchlist/available Otwórz referencję API

GET /v1/watchlist

Operacja: getWatchlist Kredyty i uwierzytelnianie: 1 Wymagane uwierzytelnianie
GET /v1/watchlist

Odpowiedź Fields

Pole Typ
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

Przykład Request

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

Example Odpowiedź

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

Operacja: addToWatchlist Kredyty i uwierzytelnianie: 1 Wymagane uwierzytelnianie
POST /v1/watchlist

Parametry treści

Parametr Typ wymagane
domain string wymagane
notify_email string opcjonalne

Odpowiedź Fields

Pole Typ
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

Przykład Request

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

Example Odpowiedź

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

Operacja: removeFromWatchlist Kredyty i uwierzytelnianie: Bezpłatnie Wymagane uwierzytelnianie
DELETE /v1/watchlist

Parametry zapytania

Parametr Typ wymagane
domain string wymagane

Odpowiedź Fields

Pole Typ
success boolean
message string
domain string

Przykład Request

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

Example Odpowiedź

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

GET /v1/watchlist/expiring

Operacja: getExpiringWatchlist Kredyty i uwierzytelnianie: 1 Wymagane uwierzytelnianie
GET /v1/watchlist/expiring

Parametry zapytania

Parametr Typ wymagane
days integer
Domyślnie 90
opcjonalne

Odpowiedź Fields

Pole Typ
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

Przykład Request

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

Example Odpowiedź

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

Operacja: getAvailableWatchlist Kredyty i uwierzytelnianie: 1 Wymagane uwierzytelnianie
GET /v1/watchlist/available

Odpowiedź Fields

Pole Typ
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

Przykład Request

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

Example Odpowiedź

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

Materiały referencyjne