APIリファレンス

ドメインスコア APIリファレンス

複数の要因に基づいて、ドメインの包括的な品質スコアを取得します。 このリファレンスで、最適なエンドポイントを選び、返される内容を正確に確認できます。

操作

POST /v1/score/compare APIリファレンスを見る
GET /v1/score/info APIリファレンスを見る

GET /v1/score

操作: getDomainScore クレジットと認証: 1 認証が必要
GET /v1/score クレジット: 1

クエリパラメータ

パラメータ タイプ 必須
name string オプション
domain string オプション

レスポンスフィールド

フィールド タイプ
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

リクエスト例

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/score?name=brandify&domain=brandify.com"
const response = await fetch("https://domscan.net/v1/score?name=brandify&domain=brandify.com", {
  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?name=brandify&domain=brandify.com",
    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?name=brandify&domain=brandify.com", 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?name=brandify&domain=brandify.com")
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))

レスポンス例

{
  "name": "brandpilot",
  "input": "brandpilot.io",
  "scored_label": "brandpilot",
  "tld": "io",
  "overall_score": 73,
  "grade": "B",
  "scores": {
    "length": 60,
    "pronounceability": 68.33,
    "memorability": 65,
    "spelling": 80,
    "uniqueness": 65,
    "brandability": 95
  },
  "score_explanation": {
    "score_band": "strong",
    "top_strengths": [
      {
        "dimension": "brandability",
        "score": 95,
        "weight": 0.2
      },
      {
        "dimension": "memorability",
        "score": 65,
        "weight": 0.2
      },
      {
        "dimension": "pronounceability",
        "score": 68.33,
        "weight": 0.18
      }
    ],
    "top_blockers": [
      {
        "dimension": "length",
        "score": 60,
        "weight": 0.12
      },
      {
        "dimension": "memorability",
        "score": 65,
        "weight": 0.2
      },
      {
        "dimension": "uniqueness",
        "score": 65,
        "weight": 0.15
      }
    ],
    "weighted_dimensions": {
      "length": {
        "score": 60,
        "weight": 0.12,
        "weighted_points": 7
      },
      "pronounceability": {
        "score": 68.33,
        "weight": 0.18,
        "weighted_points": 12
      },
      "memorability": {
        "score": 65,
        "weight": 0.2,
        "weighted_points": 13
      },
      "spelling": {
        "score": 80,
        "weight": 0.15,
        "weighted_points": 12
      },
      "uniqueness": {
        "score": 65,
        "weight": 0.15,
        "weighted_points": 10
      },
      "brandability": {
        "score": 95,
        "weight": 0.2,
        "weighted_points": 19
      }
    },
    "most_sensitive_dimension": "memorability",
    "points_to_next_grade": 7
  }
}

HTTP ステータスコード

  • 200 成功
  • 400 不正なリクエスト
  • 401 未認証
  • 402 支払いが必要
  • 429 リクエスト過多

POST /v1/score/compare

操作: compareBrandNames クレジットと認証: 2 認証が必要
POST /v1/score/compare クレジット: 2

クエリパラメータ

パラメータ タイプ 必須
dry_run string
許可された値 true
オプション

ボディパラメータ

パラメータ タイプ 必須
names string[] 必須

レスポンスフィールド

フィールド タイプ
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

リクエスト例

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))

レスポンス例

{
  "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 ステータスコード

  • 200 成功
  • 400 不正なリクエスト
  • 401 未認証
  • 402 支払いが必要
  • 409 HTTP 409
  • 422 HTTP 422
  • 429 リクエスト過多

GET /v1/score/info

操作: getScoreInfo クレジットと認証: 無料 認証が必要
GET /v1/score/info クレジット: 0

レスポンスフィールド

フィールド タイプ
scoring_dimensions object
grade_scale object
endpoints object

リクエスト例

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))

レスポンス例

{
  "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 ステータスコード

  • 200 成功
  • 401 未認証
  • 429 リクエスト過多

リファレンスリソース