Developer reference
Domain Score
DomScan API: Calculate an overall domain quality score based on multiple factors.
Domain Score
Calculate an overall domain quality score based on multiple factors.
GET
/v1/score
Query parameters
| Parameter | Type | Description |
|---|---|---|
| name required | string | Domain to calculate score for |
| domain optional | string | Alias for name. The name parameter wins when both are supplied. Pass the label only, without a TLD. |
Example response
{
"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"
}
}
Response fields
| Field | Type |
|---|---|
name |
string |
input |
string |
scored_label |
string |
tld |
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 |
analysis |
object |
analysis.syllable_count |
integer |
analysis.character_count |
integer |
analysis.has_vowels |
boolean |
analysis.has_numbers |
boolean |
analysis.has_hyphens |
boolean |
analysis.is_dictionary_word |
boolean |
analysis.is_premium_word |
boolean |
analysis.is_too_generic |
boolean |
analysis.starts_with_vowel |
boolean |
analysis.ends_with_vowel |
boolean |
analysis.has_repeated_letters |
boolean |
analysis.vowel_ratio |
number |
recommendations[] |
string[] |
available_tlds[] |
string[] |
feedback[] |
string[] |
meta |
object |
meta.methodology |
string |
meta.disclaimer |
string |
POST
/v1/score/compare
Credits: 2
Query parameters
| Parameter | Type | required |
|---|---|---|
| dry_run |
string
Allowed values
true
|
optional |
Body parameters
| Parameter | Type | required |
|---|---|---|
| names | string[] | required |
Response fields
| Field | Type |
|---|---|
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 |
meta.duplicates_removed |
integer |
Example request
curl -X POST "https://domscan.net/v1/score/compare" \
-H "Content-Type: application/json" \
-H "X-API-Key: $DOMSCAN_API_KEY" \
-d '{
"names": [
"brandpilot",
"launchly",
"nimbus"
]
}'const response = await fetch("https://domscan.net/v1/score/compare", {
method: "POST",
headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
body: JSON.stringify({
"names": [
"brandpilot",
"launchly",
"nimbus"
]
}),
});
const data = await response.json();
console.log(data);import os
import requests
response = requests.post(
"https://domscan.net/v1/score/compare",
headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
json={
"names": [
"brandpilot",
"launchly",
"nimbus",
],
},
)
print(response.json())package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"names": [
"brandpilot",
"launchly",
"nimbus"
]
}`)
req, err := http.NewRequest(http.MethodPost, "https://domscan.net/v1/score/compare", 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/score/compare")
request = Net::HTTP::Post.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
"names" => [
"brandpilot",
"launchly",
"nimbus"
]
})
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))Example response
{
"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
}
}
HTTP status codes
200OK400Bad Request401Unauthorized402Payment Required409HTTP 409422HTTP 422429Too Many Requests
GET
/v1/score/info
Credits: 0
Response fields
| Field | Type |
|---|---|
scoring_dimensions |
object |
grade_scale |
object |
endpoints |
object |
Example request
curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/score/info"const response = await fetch("https://domscan.net/v1/score/info", {
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/score/info",
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/score/info", 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/score/info")
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))Example response
{
"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"
}
}
HTTP status codes
200OK401Unauthorized429Too Many Requests