Referencja API

API Check Dostępność domeny

Sprawdź dostępność nazwy domeny na jednej lub większej liczbie TLD. Użyj tej referencji, aby wybrać operację i zintegrować jej udokumentowany kontrakt odpowiedzi.

Operacje

GET /v1/status Otwórz referencję API
POST /v1/status/bulk Otwórz referencję API

GET /v1/status

Operacja: checkDomainAvailability Kredyty i uwierzytelnianie: 1 Wymagane uwierzytelnianie
GET /v1/status

Parametry zapytania

Parametr Typ wymagane
name string opcjonalne
tlds string opcjonalne
domain string opcjonalne
prefer_cache boolean
Domyślnie false
opcjonalne

Odpowiedź Fields

Pole Typ
name string
results[] object[]
results[] object
results[].domain string
results[].tld string
results[].available boolean | null
results[].source string
results[].confidence string
results[].checked_at string
results[].latency_ms integer
results[].error string
confidence_summary object
confidence_summary.scope string
confidence_summary.requested_count integer
confidence_summary.result_count integer
confidence_summary.invalid_count integer
confidence_summary.available_count integer
confidence_summary.registered_count integer
confidence_summary.authoritative_count integer
confidence_summary.heuristic_count integer
confidence_summary.cached_count integer
confidence_summary.error_count integer
confidence_summary.ambiguous_count integer
confidence_summary.source_counts object
confidence_summary.primary_source string | null
confidence_summary.cache_status string
confidence_summary.rdap_calls integer
confidence_summary.refreshes integer
confidence_summary.cache_preference_misses integer
confidence_summary.fallback_chain[] string[]
confidence_summary.confidence_level string
confidence_summary.determinacy_rate number
confidence_summary.ambiguity_reason string | null
meta object
meta.total_checked integer
meta.available_count integer
meta.duration_ms integer

Przykład Request

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/status?name=mycompany&tlds=com%2Cnet%2Corg%2Cio&domain=mycompany.com&prefer_cache=example.com"

Example Odpowiedź

{
  "name": "mycompany",
  "results": [
    {
      "domain": "mycompany.com",
      "tld": "com",
      "available": false,
      "source": "rdap",
      "latency_ms": 45
    },
    {
      "domain": "mycompany.io",
      "tld": "io",
      "available": true,
      "source": "rdap",
      "latency_ms": 67
    }
  ],
  "meta": {
    "total_checked": 2,
    "available_count": 1,
    "duration_ms": 120
  }
}

POST /v1/status/bulk

Operacja: bulkCheckDomains Kredyty i uwierzytelnianie: 1 Wymagane uwierzytelnianie
POST /v1/status/bulk

Parametry treści

Parametr Typ wymagane
domains string[] wymagane
prefer_cache boolean
Domyślnie false
opcjonalne

Odpowiedź Fields

Pole Typ
results[] object[]
results[] object
results[].domain string
results[].tld string
results[].available boolean | null
results[].source string
results[].confidence string
results[].checked_at string
results[].latency_ms integer
results[].error string
confidence_summary object
confidence_summary.scope string
confidence_summary.requested_count integer
confidence_summary.result_count integer
confidence_summary.invalid_count integer
confidence_summary.available_count integer
confidence_summary.registered_count integer
confidence_summary.authoritative_count integer
confidence_summary.heuristic_count integer
confidence_summary.cached_count integer
confidence_summary.error_count integer
confidence_summary.ambiguous_count integer
confidence_summary.source_counts object
confidence_summary.primary_source string | null
confidence_summary.cache_status string
confidence_summary.rdap_calls integer
confidence_summary.refreshes integer
confidence_summary.cache_preference_misses integer
confidence_summary.fallback_chain[] string[]
confidence_summary.confidence_level string
confidence_summary.determinacy_rate number
confidence_summary.ambiguity_reason string | null
meta object
meta.total_checked integer
meta.available_count integer
meta.duration_ms integer

Przykład Request

curl -X POST "https://domscan.net/v1/status/bulk" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "domains": [
    "example.com",
    "startup.io",
    "brand.ai"
  ],
  "prefer_cache": false
}'

Example Odpowiedź

{
  "results": [
    {
      "domain": "example.com",
      "tld": "com",
      "available": false,
      "source": "rdap",
      "latency_ms": 45
    },
    {
      "domain": "startup.io",
      "tld": "io",
      "available": true,
      "source": "rdap",
      "latency_ms": 67
    },
    {
      "domain": "brand.ai",
      "tld": "ai",
      "available": true,
      "source": "cache",
      "latency_ms": 2
    }
  ],
  "meta": {
    "total_checked": 3,
    "available_count": 2,
    "duration_ms": 120
  }
}

Materiały referencyjne