مرجع API

API الخاص بـ قائمة مراقبة المجالات

إدارة قائمة مراقبة المجالات الخاصة بك. احصل على إشعارات عند توفر المجالات أو تغير الحالة. استخدم هذا المرجع لاختيار عملية ودمج عقد الاستجابة الموثق.

العمليات

GET /v1/watchlist عرض مرجع API
POST /v1/watchlist عرض مرجع API
DELETE /v1/watchlist عرض مرجع API
GET /v1/watchlist/expiring عرض مرجع API
GET /v1/watchlist/available عرض مرجع API

GET /v1/watchlist

العملية: getWatchlist الوحدات والمصادقة: 1 المصادقة مطلوبة
GET /v1/watchlist

حقول الرد

الحقل النوع
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

طلب مثال

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

مثال الرد

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

العملية: addToWatchlist الوحدات والمصادقة: 1 المصادقة مطلوبة
POST /v1/watchlist

معاملات الجسم

المعامل النوع مطلوب
domain string مطلوب
notify_email string اختياري

حقول الرد

الحقل النوع
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

طلب مثال

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

مثال الرد

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

العملية: removeFromWatchlist الوحدات والمصادقة: مجانًا المصادقة مطلوبة
DELETE /v1/watchlist

معاملات الاستعلام

المعامل النوع مطلوب
domain string مطلوب

حقول الرد

الحقل النوع
success boolean
message string
domain string

طلب مثال

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

مثال الرد

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

GET /v1/watchlist/expiring

العملية: getExpiringWatchlist الوحدات والمصادقة: 1 المصادقة مطلوبة
GET /v1/watchlist/expiring

معاملات الاستعلام

المعامل النوع مطلوب
days integer
الافتراضي 90
اختياري

حقول الرد

الحقل النوع
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

طلب مثال

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

مثال الرد

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

العملية: getAvailableWatchlist الوحدات والمصادقة: 1 المصادقة مطلوبة
GET /v1/watchlist/available

حقول الرد

الحقل النوع
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

طلب مثال

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

مثال الرد

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

موارد المرجع