Справочник API

API API изображений логотипов

Получайте логотип компании для любого домена в виде PNG-изображения, которое можно встраивать, кэшировать и сохранять. Используйте этот справочник, чтобы выбрать нужный эндпоинт и точно увидеть, что он возвращает.

Операции

GET /v1/logo/:domain

Операция: getLogoImage Кредиты и аутентификация: 1 Требуется аутентификация
GET /v1/logo/:domain Кредиты: 1

Параметры запроса

Параметр Тип обязателен
domain string обязателен
size integer
По умолчанию 128
опционально
retina boolean
По умолчанию false
опционально
greyscale boolean
По умолчанию false
опционально
theme string
Допустимые значения lightdark
опционально
fallback string
Допустимые значения 404monogram
По умолчанию 404
опционально
format string
Допустимые значения png
По умолчанию png
опционально
variant string
Допустимые значения squarewide
По умолчанию square
опционально
v string опционально
token string опционально

Поля ответа

Поле Тип
body image/png
X-Credits-Charged string
X-Credits-Remaining string
X-RateLimit-Limit string
X-RateLimit-Remaining string
X-RateLimit-Reset string
Cache-Control string
ETag string
Last-Modified string
X-Logo-Status string
X-Logo-Source string
X-Logo-Verification string
X-Logo-Source-Format string
X-Logo-Native-Size string
X-Logo-Theme-Adjusted string
X-Logo-Variant string
X-Logo-Lookup string
X-Cache string
Cloudflare-CDN-Cache-Control string
X-Cache-Age string

Пример запроса

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/logo/example.com?size=128&retina=false&greyscale=false&theme=light&fallback=404&format=png&variant=square&v=example&token=example"
const response = await fetch("https://domscan.net/v1/logo/example.com?size=128&retina=false&greyscale=false&theme=light&fallback=404&format=png&variant=square&v=example&token=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/logo/example.com?size=128&retina=false&greyscale=false&theme=light&fallback=404&format=png&variant=square&v=example&token=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/logo/example.com?size=128&retina=false&greyscale=false&theme=light&fallback=404&format=png&variant=square&v=example&token=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/logo/example.com?size=128&retina=false&greyscale=false&theme=light&fallback=404&format=png&variant=square&v=example&token=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))

Пример ответа

HTTP/2 200
content-type: image/png
x-credits-charged: ...
x-credits-remaining: ...
x-ratelimit-limit: ...
x-ratelimit-remaining: ...
x-ratelimit-reset: ...
cache-control: ...
etag: ...
last-modified: ...
x-logo-status: found
x-logo-source: bimi
x-logo-verification: decoded
x-logo-source-format: ...
x-logo-native-size: ...
x-logo-theme-adjusted: tile
x-logo-variant: wide
x-logo-lookup: ...
x-cache: HIT
cloudflare-cdn-cache-control: ...
x-cache-age: ...

Коды состояния HTTP

  • 200 OK
  • 304 HTTP 304
  • 400 Неверный запрос
  • 401 Не авторизован
  • 402 Требуется оплата
  • 403 Доступ запрещен
  • 404 Не найдено
  • 429 Слишком много запросов

Справочные материалы