Referencja API

API Check Dostępność domeny

Sprawdź dostępność nazwy domeny na jednej lub większej liczbie TLD. Skorzystaj z tej dokumentacji, aby wybrać odpowiedni endpoint i dokładnie zobaczyć, co zwraca.

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 Kredyty: 1

Parametry zapytania

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

Pola odpowiedzi

Pole Typ
cache_age_s integer
name string
results[] object[]
results[] object
results[].classification object
results[].classification.status string
results[].classification.reason string
results[].classification.evidence object
results[].classification.evidence.source string
results[].classification.evidence.method string
results[].classification.evidence.observed_at string
results[].classification.evidence.detail string
results[].classification.checked_at string
results[].domain string
results[].tld string
results[].available boolean | null
results[].availability_reason string
results[].registry_message string
results[].source string
results[].confidence string
results[].checked_at string
results[].latency_ms integer
results[].cache_age_s integer
results[].registry_status[] string[]
results[].rdap_events[] object[]
results[].rdap_events[] object
results[].rdap_events[].eventAction string
results[].rdap_events[].eventDate string
results[].proof object
results[].dns_status object
results[].dns_status.has_nameservers boolean
results[].dns_status.resolvable boolean
results[].dns_status.checked boolean
results[].timing object
results[].timing.cache_lookup_ms integer
results[].timing.rdap_query_ms integer
results[].timing.dns_check_ms integer
results[].timing.total_ms integer
results[].status_flags[] string[]
results[].status string
results[].lifecycle_phase string
results[].is_public_suffix boolean
results[].error object
results[].error.code string
results[].error.message string
results[].error.suggestion string
results[].error.cause string
scope 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.restricted_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
meta.served_by string
meta.scope_description string

Przykładowe żądanie

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=false"
const response = await fetch("https://domscan.net/v1/status?name=mycompany&tlds=com%2Cnet%2Corg%2Cio&domain=mycompany.com&prefer_cache=false", {
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY },
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.get(
    "https://domscan.net/v1/status?name=mycompany&tlds=com%2Cnet%2Corg%2Cio&domain=mycompany.com&prefer_cache=false",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
)
print(response.json())
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://domscan.net/v1/status?name=mycompany&tlds=com%2Cnet%2Corg%2Cio&domain=mycompany.com&prefer_cache=false", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	data, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(resp.Status, string(data))
}
require "json"
require "net/http"

uri = URI("https://domscan.net/v1/status?name=mycompany&tlds=com%2Cnet%2Corg%2Cio&domain=mycompany.com&prefer_cache=false")
request = Net::HTTP::Get.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))

Przykładowa 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
  }
}

Kody statusu HTTP

  • 200 OK
  • 400 Nieprawidłowe żądanie
  • 401 Nieautoryzowany
  • 402 Wymagana płatność
  • 429 Zbyt wiele żądań

POST /v1/status/bulk

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

Parametry zapytania

Parametr Typ wymagane
dry_run string
Dozwolone wartości true
opcjonalne

Parametry treści

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

Pola odpowiedzi

Pole Typ
cache_age_s integer
results[] object[]
results[] object
results[].classification object
results[].classification.status string
results[].classification.reason string
results[].classification.evidence object
results[].classification.evidence.source string
results[].classification.evidence.method string
results[].classification.evidence.observed_at string
results[].classification.evidence.detail string
results[].classification.checked_at string
results[].domain string
results[].tld string
results[].available boolean | null
results[].availability_reason string
results[].registry_message string
results[].source string
results[].confidence string
results[].checked_at string
results[].latency_ms integer
results[].cache_age_s integer
results[].registry_status[] string[]
results[].rdap_events[] object[]
results[].rdap_events[] object
results[].rdap_events[].eventAction string
results[].rdap_events[].eventDate string
results[].proof object
results[].dns_status object
results[].dns_status.has_nameservers boolean
results[].dns_status.resolvable boolean
results[].dns_status.checked boolean
results[].timing object
results[].timing.cache_lookup_ms integer
results[].timing.rdap_query_ms integer
results[].timing.dns_check_ms integer
results[].timing.total_ms integer
results[].status_flags[] string[]
results[].status string
results[].lifecycle_phase string
results[].is_public_suffix boolean
results[].error object
results[].error.code string
results[].error.message string
results[].error.suggestion string
results[].error.cause 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.restricted_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ładowe żądanie

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"
  ]
}'
const response = await fetch("https://domscan.net/v1/status/bulk", {
  method: "POST",
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "domains": [
      "example.com",
      "startup.io",
      "brand.ai"
    ]
  }),
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.post(
    "https://domscan.net/v1/status/bulk",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
    json={
        "domains": [
            "example.com",
            "startup.io",
            "brand.ai",
        ],
    },
)
print(response.json())
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
	  "domains": [
	    "example.com",
	    "startup.io",
	    "brand.ai"
	  ]
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://domscan.net/v1/status/bulk", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	data, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(resp.Status, string(data))
}
require "json"
require "net/http"

uri = URI("https://domscan.net/v1/status/bulk")
request = Net::HTTP::Post.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "domains" => [
    "example.com",
    "startup.io",
    "brand.ai"
  ]
})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))

Przykładowa 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
  }
}

Kody statusu HTTP

  • 200 OK
  • 400 Nieprawidłowe żądanie
  • 401 Nieautoryzowany
  • 402 Wymagana płatność
  • 409 HTTP 409
  • 422 HTTP 422
  • 429 Zbyt wiele żądań

Materiały referencyjne