API 参考

品牌数据 API API 参考

根据公司的域名、股票代码、ISIN 或名称,获取其名称、徽标、品牌颜色和社交媒体主页。 通过本参考选择合适的端点,并准确了解它返回的内容。

操作

GET /v1/brand 查看 API 参考

GET /v1/brand

操作: getBrand 积分和身份验证: 3 需要身份验证
GET /v1/brand 积分: 3

查询参数

参数 类型 必需
domain string 可选
ticker string 可选
exchange string 可选
isin string 可选
name string 可选

响应字段

字段 类型
cache_age_s integer
query object
query.type string
query.value string
query.exchange string | null
status string
reason string | null
domain string | null
website object
website.url string
website.fetch_state string
resolution object
resolution.status string
resolution.reason string
resolution.company object
resolution.company.id string
resolution.company.name string
resolution.company.domain string | null
resolution.company.confidence string
resolution.candidates[] object[]
resolution.candidates[] object
resolution.candidates[].id string
resolution.candidates[].name string
resolution.candidates[].domain string | null
resolution.candidates[].confidence string
name object
name.status string
name.value string | null
name.reason string | null
name.provenance object
name.provenance.source string
name.provenance.method string
name.provenance.url string | null
name.checked_at string | null
description object
description.status string
description.value string | null
description.reason string | null
description.provenance object
description.provenance.source string
description.provenance.method string
description.provenance.url string | null
description.checked_at string | null
socials object
socials.status string
socials.value[] object[]
socials.value[] object
socials.value[].platform string
socials.value[].type string
socials.value[].handle string | null
socials.value[].url string
socials.value[].declared_by string
socials.value[].confidence string
socials.reason string | null
socials.provenance object
socials.provenance.source string
socials.provenance.method string
socials.provenance.url string | null
socials.checked_at string | null
logo object
logo.status string
logo.value object
logo.value.url string
logo.value.source string
logo.value.source_url string | null
logo.value.verification string
logo.value.format string | null
logo.value.native_width integer | null
logo.value.native_height integer | null
logo.value.width integer | null
logo.value.height integer | null
logo.value.aspect_ratio number | null
logo.value.digest string | null
logo.reason string | null
logo.provenance object
logo.provenance.source string
logo.provenance.method string
logo.provenance.url string | null
logo.checked_at string | null
wide_logo object
wide_logo.status string
wide_logo.value object
wide_logo.value.url string
wide_logo.value.source string
wide_logo.value.source_url string | null
wide_logo.value.verification string
wide_logo.value.format string | null
wide_logo.value.native_width integer | null
wide_logo.value.native_height integer | null
wide_logo.value.width integer | null
wide_logo.value.height integer | null
wide_logo.value.aspect_ratio number | null
wide_logo.value.digest string | null
wide_logo.reason string | null
wide_logo.provenance object
wide_logo.provenance.source string
wide_logo.provenance.method string
wide_logo.provenance.url string | null
wide_logo.checked_at string | null
colors object
colors.status string
colors.value object
colors.value.from string
colors.value.palette[] object[]
colors.value.palette[] object
colors.value.palette[].hex string
colors.value.palette[].rgb object
colors.value.palette[].rgb.r integer
colors.value.palette[].rgb.g integer
colors.value.palette[].rgb.b integer
colors.value.palette[].oklch object
colors.value.palette[].oklch.l number
colors.value.palette[].oklch.c number
colors.value.palette[].oklch.h number
colors.value.palette[].oklch.css string
colors.value.palette[].share number
colors.value.palette[].neutral boolean
colors.value.dominant object
colors.value.dominant.hex string
colors.value.dominant.rgb object
colors.value.dominant.rgb.r integer
colors.value.dominant.rgb.g integer
colors.value.dominant.rgb.b integer
colors.value.dominant.oklch object
colors.value.dominant.oklch.l number
colors.value.dominant.oklch.c number
colors.value.dominant.oklch.h number
colors.value.dominant.oklch.css string
colors.value.dominant.share number
colors.value.dominant.neutral boolean
colors.value.background object
colors.value.background.hex string
colors.value.background.rgb object
colors.value.background.rgb.r integer
colors.value.background.rgb.g integer
colors.value.background.rgb.b integer
colors.value.background.oklch object
colors.value.background.oklch.l number
colors.value.background.oklch.c number
colors.value.background.oklch.h number
colors.value.background.oklch.css string
colors.reason string | null
colors.provenance object
colors.provenance.source string
colors.provenance.method string
colors.provenance.url string | null
colors.checked_at string | null
theme_color object
theme_color.status string
theme_color.value object
theme_color.value.declared string
theme_color.value.color object
theme_color.value.color.hex string
theme_color.value.color.rgb object
theme_color.value.color.rgb.r integer
theme_color.value.color.rgb.g integer
theme_color.value.color.rgb.b integer
theme_color.value.color.oklch object
theme_color.value.color.oklch.l number
theme_color.value.color.oklch.c number
theme_color.value.color.oklch.h number
theme_color.value.color.oklch.css string
theme_color.reason string | null
theme_color.provenance object
theme_color.provenance.source string
theme_color.provenance.method string
theme_color.provenance.url string | null
theme_color.checked_at string | null
checked_at string

请求示例

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

响应示例

{
  "query": {
    "type": "domain",
    "value": "example",
    "exchange": "example"
  },
  "status": "present",
  "reason": "blocked",
  "domain": "example.com",
  "website": {
    "url": "https://example.com",
    "fetch_state": "ok"
  },
  "resolution": {
    "status": "present",
    "reason": "resolved",
    "company": {
      "id": "example-id",
      "name": "example",
      "domain": "example.com",
      "confidence": "high"
    },
    "candidates": [
      {
        "id": "example-id",
        "name": "example",
        "domain": "example.com",
        "confidence": "high"
      }
    ]
  },
  "name": {
    "status": "present",
    "value": "example",
    "reason": "blocked",
    "provenance": {
      "source": "website",
      "method": "rdap",
      "url": "https://example.com"
    },
    "checked_at": "2026-08-27T12:00:00Z"
  },
  "description": {
    "status": "present",
    "value": "example",
    "reason": "blocked",
    "provenance": {
      "source": "website",
      "method": "rdap",
      "url": "https://example.com"
    },
    "checked_at": "2026-08-27T12:00:00Z"
  },
  "socials": {
    "status": "present",
    "value": [
      {
        "platform": "example",
        "type": "social",
        "handle": "example",
        "url": "https://example.com",
        "declared_by": "same_as",
        "confidence": "high"
      }
    ],
    "reason": "blocked",
    "provenance": {
      "source": "website",
      "method": "rdap",
      "url": "https://example.com"
    },
    "checked_at": "2026-08-27T12:00:00Z"
  },
  "logo": {
    "status": "present",
    "value": {
      "url": "https://example.com",
      "source": "bimi",
      "source_url": "https://example.com",
      "verification": "decoded",
      "format": "example",
      "native_width": 1,
      "native_height": 1,
      "width": 1,
      "height": 1,
      "aspect_ratio": 0.5,
      "digest": "example"
    },
    "reason": "blocked",
    "provenance": {
      "source": "website",
      "method": "rdap",
      "url": "https://example.com"
    },
    "checked_at": "2026-08-27T12:00:00Z"
  },
  "wide_logo": {
    "status": "present",
    "value": {
      "url": "https://example.com",
      "source": "bimi",
      "source_url": "https://example.com",
      "verification": "decoded",
      "format": "example",
      "native_width": 1,
      "native_height": 1,
      "width": 1,
      "height": 1,
      "aspect_ratio": 0.5,
      "digest": "example"
    },
    "reason": "blocked",
    "provenance": {
      "source": "website",
      "method": "rdap",
      "url": "https://example.com"
    },
    "checked_at": "2026-08-27T12:00:00Z"
  },
  "colors": {
    "status": "present",
    "value": {
      "from": "logo",
      "palette": [
        {
          "hex": "#635bff",
          "rgb": {
            "r": 1,
            "g": 1,
            "b": 1
          },
          "oklch": {
            "l": 0.5,
            "c": 0.5,
            "h": 0.5,
            "css": "oklch(57.84% 0.2346 278.29)"
          },
          "share": 0.5,
          "neutral": false
        }
      ],
      "dominant": {
        "hex": "#635bff",
        "rgb": {
          "r": 1,
          "g": 1,
          "b": 1
        },
        "oklch": {
          "l": 0.5,
          "c": 0.5,
          "h": 0.5,
          "css": "oklch(57.84% 0.2346 278.29)"
        },
        "share": 0.5,
        "neutral": false
      },
      "background": {
        "hex": "#635bff",
        "rgb": {
          "r": 1,
          "g": 1,
          "b": 1
        },
        "oklch": {
          "l": 0.5,
          "c": 0.5,
          "h": 0.5,
          "css": "oklch(57.84% 0.2346 278.29)"
        }
      }
    },
    "reason": "blocked",
    "provenance": {
      "source": "website",
      "method": "rdap",
      "url": "https://example.com"
    },
    "checked_at": "2026-08-27T12:00:00Z"
  },
  "theme_color": {
    "status": "present",
    "value": {
      "declared": "example",
      "color": {
        "hex": "#635bff",
        "rgb": {
          "r": 1,
          "g": 1,
          "b": 1
        },
        "oklch": {
          "l": 0.5,
          "c": 0.5,
          "h": 0.5,
          "css": "oklch(57.84% 0.2346 278.29)"
        }
      }
    },
    "reason": "blocked",
    "provenance": {
      "source": "website",
      "method": "rdap",
      "url": "https://example.com"
    },
    "checked_at": "2026-08-27T12:00:00Z"
  },
  "checked_at": "2026-08-27T12:00:00Z",
  "cache_age_s": 1
}

HTTP 状态码

  • 200 成功
  • 304 HTTP 304
  • 400 请求错误
  • 401 未授权
  • 402 需要付款
  • 429 请求过多

参考资源