Wynik domeny | Dokumentacja API DomScan

GET /v1/score

Parametry zapytania

Parametr	Typ	Opis
name wymagane	string	Domena do obliczenia wyniku
domain opcjonalne	string	Alias dla name. Parametr name wygrywa, gdy dostarczone są oba. Przekaż tylko label, bez TLD.

Example Odpowiedź

{
                "success": true,
                "data": {
                "name": "startup",
                "overall_score": 82,
                "grade": "B+",
                "scores": {
                "length": 86,
                "pronounceability": 78,
                "memorability": 80,
                "spelling": 84,
                "uniqueness": 75,
                "brandability": 88
                },
                "analysis": {
                "length": 7,
                "syllable_count": 2,
                "has_vowels": true,
                "has_numbers": false,
                "has_hyphens": false
                }
                },
                "meta": {
                "requestId": "req_demo"
                }
                }

Odpowiedź Fields

Pole	Typ
`name`	string
`overall_score`	integer
`grade`	string
`scores`	object
`scores.length`	integer
`scores.pronounceability`	number
`scores.memorability`	integer
`scores.spelling`	integer
`scores.uniqueness`	integer
`scores.brandability`	integer
`score_explanation`	object
`score_explanation.score_band`	string
`score_explanation.top_strengths[]`	object[]
`score_explanation.top_strengths[]`	object
`score_explanation.top_strengths[].dimension`	string
`score_explanation.top_strengths[].score`	number
`score_explanation.top_strengths[].weight`	number
`score_explanation.top_blockers[]`	object[]
`score_explanation.top_blockers[]`	object
`score_explanation.top_blockers[].dimension`	string
`score_explanation.top_blockers[].score`	number
`score_explanation.top_blockers[].weight`	number
`score_explanation.weighted_dimensions`	object
`score_explanation.most_sensitive_dimension`	string
`score_explanation.points_to_next_grade`	integer \| null
`feedback[]`	string[]

POST /v1/score/compare

Parametry treści

Parametr	Typ	wymagane
names	string[]	wymagane

Odpowiedź Fields

Pole	Typ
`names[]`	object[]
`names[]`	object
`best`	string \| null
`ranking[]`	object[]
`ranking[]`	object
`ranking[].name`	string
`ranking[].score`	number
`ranking[].rank`	integer
`decision_summary`	object
`decision_summary.compared_count`	integer
`decision_summary.best`	string \| null
`decision_summary.runner_up`	string \| null
`decision_summary.score_margin`	integer \| null
`decision_summary.score_spread`	integer
`decision_summary.tie_breaker`	string \| null
`decision_summary.winning_dimension`	string \| null
`meta`	object
`meta.total_compared`	integer
`meta.valid_scores`	integer

Przykład Request

curl -X POST "https://domscan.net/v1/score/compare" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "names": [
    "brandify",
    "brandpilot",
    "brandmint"
  ]
}'

Example Odpowiedź

{
  "names": [
    {
      "name": "brandify",
      "score": 88,
      "grade": "A",
      "verdict": "Strong"
    },
    {
      "name": "brandpilot",
      "score": 82,
      "grade": "B+",
      "verdict": "Promising"
    }
  ],
  "best": "brandify",
  "ranking": [
    {
      "name": "brandify",
      "score": 88,
      "rank": 1
    },
    {
      "name": "brandpilot",
      "score": 82,
      "rank": 2
    }
  ],
  "decision_summary": {
    "compared_count": 2,
    "best": "brandify",
    "runner_up": "brandpilot",
    "score_margin": 6,
    "score_spread": 6,
    "tie_breaker": "higher_brandability",
    "winning_dimension": "brandability"
  },
  "meta": {
    "total_compared": 2,
    "valid_scores": 2
  }
}

GET /v1/score/info

Odpowiedź Fields

Pole	Typ
`scoring_dimensions`	object
`grade_scale`	object
`endpoints`	object

Przykład Request

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

Example Odpowiedź

{
  "scoring_dimensions": {
    "length": {
      "weight": 0.12,
      "description": "Rewards concise names"
    },
    "pronounceability": {
      "weight": 0.18,
      "description": "Rewards names that are easy to say"
    }
  },
  "grade_scale": {
    "A+": "Exceptional",
    "A": "Excellent",
    "B": "Good",
    "C": "Average",
    "D": "Weak",
    "F": "Poor"
  },
  "endpoints": {
    "GET /v1/score?name=<name>": "Score a single name",
    "POST /v1/score/compare": "Compare multiple names",
    "GET /v1/score/info": "Get scoring methodology"
  }
}