Referência para desenvolvedores

Consulta de empresa

Esta API está em beta. Os resultados podem variar em precisão e completude. Os dados são agregados a partir de fontes públicas.

Consulta de empresa

Esta API está em beta. Os resultados podem variar em precisão e completude. Os dados são agregados a partir de fontes públicas.

GET /v1/company

Parâmetros de consulta

ParâmetroTipoDescrição
domain obrigatório string Domínio da empresa que você deseja consultar (por exemplo, "stripe.com")

Campos da resposta

CampoDescrição
company.nameNome oficial da empresa
company.descriptionDescrição da atividade
socialLinks do LinkedIn, Twitter, Facebook

Casos de uso

  • Inteligência competitiva
  • Pesquisa de fornecedores e parceiros

Exemplo de requisição

curl -H "X-API-Key: your-api-key" "https://domscan.net/v1/company?domain=stripe.com"

Exemplo de resposta

{
                "domain": "stripe.com",
                "company": {
                "name": "Stripe",
                "legal_name": null,
                "description": "Financial infrastructure for the internet.",
                "founded_year": null,
                "industry": null,
                "employee_count_range": null,
                "type": null
                },
                "location": {
                "headquarters": null
                },
                "social": {
                "linkedin": "https://linkedin.com/company/stripe",
                "twitter": "https://twitter.com/stripe",
                "facebook": null,
                "github": null
                },
                "tech": {
                "email_provider": "Google Workspace",
                "website_technologies": []
                },
                "confidence": 0.65
                }
GET /v1/company/resolve Créditos: 1

Parâmetros de consulta

Parâmetro Tipo obrigatório
ticker string opcional
exchange string opcional
isin string opcional
name string opcional
match string
Valores permitidos fullprefix
Padrão full
opcional
limit integer
Padrão 5
opcional

Campos da resposta

Campo Tipo
query object
query.type string
query.value string
query.exchange string | null
query.match string | null
query.limit integer | null
status string
reason string
domain string | null
website string | null
company object
company.id string
company.name string
company.domain string | null
company.website string | null
company.domains[] string[]
company.identifiers object
company.identifiers.wikidata string | null
company.identifiers.cik string | null
company.identifiers.isins[] string[]
company.identifiers.listings[] object[]
company.identifiers.listings[] object
company.identifiers.listings[].ticker string
company.identifiers.listings[].exchange object
company.identifiers.listings[].exchange.name string | null
company.identifiers.listings[].exchange.mic string | null
company.identifiers.listings[].exchange.wikidata string | null
company.identifiers.listings[].source string
company.confidence string
company.score number
company.match object
company.match.field string
company.match.value string
company.match.kind string
company.sources[] string[]
company.evidence[] object[]
company.evidence[] object
company.evidence[].source string
company.evidence[].field string
company.evidence[].value string
company.evidence[].url string
candidates[] object[]
candidates[] object
candidates[].id string
candidates[].name string
candidates[].domain string | null
candidates[].website string | null
candidates[].domains[] string[]
candidates[].identifiers object
candidates[].identifiers.wikidata string | null
candidates[].identifiers.cik string | null
candidates[].identifiers.isins[] string[]
candidates[].identifiers.listings[] object[]
candidates[].identifiers.listings[] object
candidates[].identifiers.listings[].ticker string
candidates[].identifiers.listings[].exchange object
candidates[].identifiers.listings[].exchange.name string | null
candidates[].identifiers.listings[].exchange.mic string | null
candidates[].identifiers.listings[].exchange.wikidata string | null
candidates[].identifiers.listings[].source string
candidates[].confidence string
candidates[].score number
candidates[].match object
candidates[].match.field string
candidates[].match.value string
candidates[].match.kind string
candidates[].sources[] string[]
candidates[].evidence[] object[]
candidates[].evidence[] object
candidates[].evidence[].source string
candidates[].evidence[].field string
candidates[].evidence[].value string
candidates[].evidence[].url string
classification object
classification.status string
classification.reason string
classification.evidence object
classification.evidence.source string
classification.evidence.method string
classification.evidence.observed_at string
classification.evidence.detail string
classification.checked_at string
checked_at string
meta object
meta.sources[] object[]
meta.sources[] object
meta.sources[].source string
meta.sources[].snapshot_at string | null
meta.sources[].records integer
meta.sources[].stale boolean
meta.sources[].licence string
meta.candidates_total integer

Exemplo de requisição

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

Exemplo de resposta

{
  "query": {
    "type": "ticker",
    "value": "example",
    "exchange": "example",
    "match": "full",
    "limit": 1
  },
  "status": "present",
  "reason": "resolved",
  "domain": "example.com",
  "website": "example",
  "company": {
    "id": "example-id",
    "name": "example",
    "domain": "example.com",
    "website": "example",
    "domains": [
      "example.com",
      "example.org"
    ],
    "identifiers": {
      "wikidata": "example",
      "cik": "example",
      "isins": [
        "example"
      ],
      "listings": [
        {
          "ticker": "example",
          "exchange": {
            "name": "example",
            "mic": "example",
            "wikidata": "example"
          },
          "source": "sec"
        }
      ]
    },
    "confidence": "high",
    "score": 0.85,
    "match": {
      "field": "ticker",
      "value": "example",
      "kind": "exact"
    },
    "sources": [
      "sec"
    ],
    "evidence": [
      {
        "source": "sec",
        "field": "example",
        "value": "example",
        "url": "https://example.com"
      }
    ]
  },
  "candidates": [
    {
      "id": "example-id",
      "name": "example",
      "domain": "example.com",
      "website": "example",
      "domains": [
        "example.com",
        "example.org"
      ],
      "identifiers": {
        "wikidata": "example",
        "cik": "example",
        "isins": [
          "example"
        ],
        "listings": [
          {
            "ticker": "example",
            "exchange": {
              "name": "example",
              "mic": "example",
              "wikidata": "example"
            },
            "source": "sec"
          }
        ]
      },
      "confidence": "high",
      "score": 0.85,
      "match": {
        "field": "ticker",
        "value": "example",
        "kind": "exact"
      },
      "sources": [
        "sec"
      ],
      "evidence": [
        {
          "source": "sec",
          "field": "example",
          "value": "example",
          "url": "https://example.com"
        }
      ]
    }
  ],
  "classification": {
    "status": "present",
    "evidence": {
      "source": "rdap",
      "method": "rdap_lookup",
      "observed_at": "2026-08-27T12:00:00Z",
      "detail": "example"
    },
    "checked_at": "2026-08-27T12:00:00Z",
    "reason": "blocked"
  },
  "checked_at": "2026-08-27T12:00:00Z",
  "meta": {
    "sources": [
      {
        "source": "sec",
        "snapshot_at": "2026-08-27T12:00:00Z",
        "records": 1,
        "stale": false,
        "licence": "example"
      }
    ],
    "candidates_total": 1
  }
}

Códigos de status HTTP

  • 200 OK
  • 400 Pedido inválido
  • 401 Não autorizado
  • 402 Pagamento necessário
  • 429 Demasiados pedidos
GET /v1/brand Créditos: 3

Parâmetros de consulta

Parâmetro Tipo obrigatório
domain string opcional
ticker string opcional
exchange string opcional
isin string opcional
name string opcional

Campos da resposta

Campo Tipo
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

Exemplo de requisição

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

Exemplo de resposta

{
  "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
}

Códigos de status HTTP

  • 200 OK
  • 304 HTTP 304
  • 400 Pedido inválido
  • 401 Não autorizado
  • 402 Pagamento necessário
  • 429 Demasiados pedidos
GET /v1/identity-assets Créditos: 2

Parâmetros de consulta

Parâmetro Tipo obrigatório
domain string obrigatório
skip_cache string
Valores permitidos 1
opcional

Campos da resposta

Campo Tipo
cache_age_s integer
domain string
website_url string
fetch_state string
organization_name string | null
assets object
assets.logo_url string | null
assets.logo_kind string | null
assets.logo_source string | null
assets.logo_verification string | null
assets.favicon_url string | null
assets.touch_icon_url string | null
assets.preview_image_url string | null
assets.manifest_url string | null
assets.theme_color string | null
assets.candidates[] object[]
assets.candidates[] object
assets.candidates[].url string
assets.candidates[].kind string
assets.candidates[].source string
assets.candidates[].type string | null
assets.candidates[].sizes string | null
assets.candidates[].score integer
assets.candidates[].confidence string
social_profiles[] object[]
social_profiles[] object
social_profiles[].platform string
social_profiles[].type string
social_profiles[].handle string | null
social_profiles[].url string
social_profiles[].source string
social_profiles[].confidence string
confidence number
evidence[] string[]
meta object
meta.checked_at string
meta.cached boolean
meta.fetch_transport string
meta.fetch_error string

Exemplo de requisição

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

Exemplo de resposta

{
  "domain": "www.example.com",
  "website_url": "https://www.example.com/",
  "fetch_state": "ok",
  "organization_name": "Example Co",
  "assets": {
    "logo_url": "https://www.example.com/logo.png",
    "logo_kind": "logo",
    "logo_source": "json_ld:logo",
    "logo_verification": "verified",
    "favicon_url": "https://www.example.com/favicon.ico",
    "touch_icon_url": "https://www.example.com/apple-touch-icon.png",
    "preview_image_url": "https://www.example.com/og.png",
    "manifest_url": "https://www.example.com/site.webmanifest",
    "theme_color": "#0b5fff",
    "candidates": [
      {
        "url": "https://www.example.com/logo.png",
        "kind": "logo",
        "source": "json_ld:logo",
        "type": null,
        "sizes": null,
        "score": 100,
        "confidence": "high"
      },
      {
        "url": "https://www.example.com/apple-touch-icon.png",
        "kind": "touch_icon",
        "source": "link:apple-touch-icon",
        "type": null,
        "sizes": "180x180",
        "score": 80,
        "confidence": "high"
      },
      {
        "url": "https://www.example.com/icons/icon-512.png",
        "kind": "manifest_icon",
        "source": "manifest:icons",
        "type": "image/png",
        "sizes": "512x512",
        "score": 78,
        "confidence": "medium"
      },
      {
        "url": "https://www.example.com/favicon.ico",
        "kind": "favicon",
        "source": "link:icon",
        "type": null,
        "sizes": "48x48",
        "score": 60,
        "confidence": "medium"
      },
      {
        "url": "https://www.example.com/og.png",
        "kind": "preview_image",
        "source": "open_graph:image",
        "type": null,
        "sizes": null,
        "score": 30,
        "confidence": "low"
      }
    ]
  },
  "social_profiles": [
    {
      "platform": "linkedin",
      "type": "social",
      "handle": "example-co",
      "url": "https://www.linkedin.com/company/example-co",
      "source": "same_as",
      "confidence": "high"
    },
    {
      "platform": "github",
      "type": "developer",
      "handle": "example-co",
      "url": "https://github.com/example-co",
      "source": "same_as",
      "confidence": "high"
    }
  ],
  "confidence": 1,
  "evidence": [
    "organization_name",
    "structured_logo",
    "asset_verified",
    "declared_icon",
    "declared_social_profiles"
  ],
  "meta": {
    "checked_at": "2026-10-09T10:15:30.000Z",
    "cached": false,
    "fetch_transport": "edge_relay"
  }
}

Códigos de status HTTP

  • 200 OK
  • 400 Pedido inválido
  • 401 Não autorizado
  • 402 Pagamento necessário
  • 429 Demasiados pedidos
  • 502 Erro de gateway
GET /v1/logo/:domain Créditos: 1

Parâmetros de consulta

Parâmetro Tipo obrigatório
domain string obrigatório
size integer
Padrão 128
opcional
retina boolean
Padrão false
opcional
greyscale boolean
Padrão false
opcional
theme string
Valores permitidos lightdark
opcional
fallback string
Valores permitidos 404monogram
Padrão 404
opcional
format string
Valores permitidos png
Padrão png
opcional
variant string
Valores permitidos squarewide
Padrão square
opcional
v string opcional
token string opcional

Campos da resposta

Campo Tipo
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

Exemplo de requisição

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

Exemplo de resposta

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: ...

Códigos de status HTTP

  • 200 OK
  • 304 HTTP 304
  • 400 Pedido inválido
  • 401 Não autorizado
  • 402 Pagamento necessário
  • 403 Proibido
  • 404 Não encontrado
  • 429 Demasiados pedidos
POST /v1/identity-assets/bulk Créditos: 2/item

Parâmetros de consulta

Parâmetro Tipo obrigatório
dry_run string
Valores permitidos true
opcional

Parâmetros do corpo

Parâmetro Tipo obrigatório
domains string[] obrigatório

Campos da resposta

Campo Tipo
results[] object[]
results[] object
results[].input string
results[].data object
results[].error object
results[].error.error object
results[].error.error.code string
results[].error.error.type string
results[].error.error.message string
results[].error.error.status integer
results[].error.error.retryable boolean
results[].error.error.request_id string
results[].error.error.suggestion string
results[].error.error.details object
results[].error.error.retry_after integer
results[].error.error.docs_url string
meta object
meta.total integer
meta.succeeded integer
meta.failed integer
meta.unknown integer
meta.max_items integer
meta.credits_per_item integer
meta.duration_ms integer

Exemplo de requisição

curl -X POST "https://domscan.net/v1/identity-assets/bulk" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "domains": [
    "stripe.com",
    "github.com"
  ]
}'
const response = await fetch("https://domscan.net/v1/identity-assets/bulk", {
  method: "POST",
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "domains": [
      "stripe.com",
      "github.com"
    ]
  }),
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.post(
    "https://domscan.net/v1/identity-assets/bulk",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
    json={
        "domains": [
            "stripe.com",
            "github.com",
        ],
    },
)
print(response.json())
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
	  "domains": [
	    "stripe.com",
	    "github.com"
	  ]
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://domscan.net/v1/identity-assets/bulk", 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/identity-assets/bulk")
request = Net::HTTP::Post.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "domains" => [
    "stripe.com",
    "github.com"
  ]
})

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

Exemplo de resposta

{
  "results": [
    {
      "input": "example",
      "data": {},
      "error": {
        "error": {
          "code": "INVALID_DOMAIN",
          "type": "authentication_error",
          "message": "Invalid domain format",
          "status": 400,
          "retryable": false,
          "request_id": "request-id",
          "docs_url": "https://domscan.net/docs/check-availability",
          "suggestion": "example",
          "details": {},
          "retry_after": 300
        }
      }
    }
  ],
  "meta": {
    "total": 1,
    "succeeded": 1,
    "failed": 1,
    "unknown": 1,
    "max_items": 10,
    "credits_per_item": 2,
    "duration_ms": 1
  }
}

Códigos de status HTTP

  • 200 OK
  • 400 Pedido inválido
  • 401 Não autorizado
  • 402 Pagamento necessário
  • 409 HTTP 409
  • 422 HTTP 422
  • 429 Demasiados pedidos
GET /v1/identity-resolution Créditos: 2

Parâmetros de consulta

Parâmetro Tipo obrigatório
domain string obrigatório
skip_cache string
Valores permitidos 1
opcional

Campos da resposta

Campo Tipo
cache_age_s integer
query string
canonical_domain string
website_url string
fetch_state string
organization object
organization.name string | null
organization.description string | null
identities[] object[]
identities[] object
identities[].platform string
identities[].type string
identities[].handle string | null
identities[].url string
identities[].source string
identities[].confidence string
contacts object
contacts.emails[] string[]
contacts.phones[] string[]
confidence number
evidence object
evidence.declared_identity_count integer
evidence.high_confidence_count integer
evidence.medium_confidence_count integer
evidence.sources[] string[]
meta object
meta.checked_at string
meta.cached boolean
meta.fetch_transport string
meta.fetch_error string

Exemplo de requisição

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

Exemplo de resposta

{
  "query": "example",
  "canonical_domain": "example.com",
  "website_url": "https://example.com",
  "fetch_state": "ok",
  "organization": {
    "name": "example",
    "description": "example"
  },
  "identities": [
    {
      "platform": "github",
      "type": "social",
      "url": "https://example.com",
      "source": "same_as",
      "confidence": "high",
      "handle": "example"
    }
  ],
  "contacts": {
    "emails": [
      "[email protected]",
      "[email protected]"
    ],
    "phones": [
      "example"
    ]
  },
  "confidence": 0.85,
  "evidence": {
    "declared_identity_count": 1,
    "high_confidence_count": 1,
    "medium_confidence_count": 1,
    "sources": [
      "example"
    ]
  },
  "meta": {
    "checked_at": "2026-08-27T12:00:00Z",
    "cached": false,
    "fetch_transport": "worker",
    "fetch_error": "timeout"
  },
  "cache_age_s": 1
}

Códigos de status HTTP

  • 200 OK
  • 400 Pedido inválido
  • 401 Não autorizado
  • 402 Pagamento necessário
  • 429 Demasiados pedidos
  • 502 Erro de gateway
POST /v1/identity-resolution/bulk Créditos: 2/item

Parâmetros de consulta

Parâmetro Tipo obrigatório
dry_run string
Valores permitidos true
opcional

Parâmetros do corpo

Parâmetro Tipo obrigatório
domains string[] obrigatório

Campos da resposta

Campo Tipo
results[] object[]
results[] object
results[].input string
results[].data object
results[].error object
results[].error.error object
results[].error.error.code string
results[].error.error.type string
results[].error.error.message string
results[].error.error.status integer
results[].error.error.retryable boolean
results[].error.error.request_id string
results[].error.error.suggestion string
results[].error.error.details object
results[].error.error.retry_after integer
results[].error.error.docs_url string
meta object
meta.total integer
meta.succeeded integer
meta.failed integer
meta.unknown integer
meta.max_items integer
meta.credits_per_item integer
meta.duration_ms integer

Exemplo de requisição

curl -X POST "https://domscan.net/v1/identity-resolution/bulk" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "domains": [
    "stripe.com",
    "github.com"
  ]
}'
const response = await fetch("https://domscan.net/v1/identity-resolution/bulk", {
  method: "POST",
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "domains": [
      "stripe.com",
      "github.com"
    ]
  }),
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.post(
    "https://domscan.net/v1/identity-resolution/bulk",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
    json={
        "domains": [
            "stripe.com",
            "github.com",
        ],
    },
)
print(response.json())
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
	  "domains": [
	    "stripe.com",
	    "github.com"
	  ]
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://domscan.net/v1/identity-resolution/bulk", 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/identity-resolution/bulk")
request = Net::HTTP::Post.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "domains" => [
    "stripe.com",
    "github.com"
  ]
})

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

Exemplo de resposta

{
  "results": [
    {
      "input": "example",
      "data": {},
      "error": {
        "error": {
          "code": "INVALID_DOMAIN",
          "type": "authentication_error",
          "message": "Invalid domain format",
          "status": 400,
          "retryable": false,
          "request_id": "request-id",
          "docs_url": "https://domscan.net/docs/check-availability",
          "suggestion": "example",
          "details": {},
          "retry_after": 300
        }
      }
    }
  ],
  "meta": {
    "total": 1,
    "succeeded": 1,
    "failed": 1,
    "unknown": 1,
    "max_items": 10,
    "credits_per_item": 2,
    "duration_ms": 1
  }
}

Códigos de status HTTP

  • 200 OK
  • 400 Pedido inválido
  • 401 Não autorizado
  • 402 Pagamento necessário
  • 409 HTTP 409
  • 422 HTTP 422
  • 429 Demasiados pedidos
GET /v1/url-intelligence Créditos: 2

Parâmetros de consulta

Parâmetro Tipo obrigatório
url string obrigatório
skip_cache string
Valores permitidos 1
opcional

Campos da resposta

Campo Tipo
cache_age_s integer
requested_url string
final_url string
status integer
fetch_state string
content_type string | null
redirects integer
title string | null
description string | null
canonical_url string | null
language string | null
favicon_url string | null
preview_image_url string | null
manifest_url string | null
theme_color string | null
author string | null
publisher string | null
published_at string | null
modified_at string | null
feeds[] object[]
feeds[] object
feeds[].url string
feeds[].type string
feeds[].title string | null
oembed_url string | null
video object
video.url string
video.type string | null
video.width integer | null
video.height integer | null
video.source string
audio object
audio.url string
audio.type string | null
audio.source string
open_graph object
twitter_card object
structured_data object
structured_data.types[] string[]
structured_data.items integer
structured_data.parse_errors integer
robots object
robots.meta[] string[]
robots.header[] string[]
robots.indexable boolean | null
security_headers object
links object
links.total integer
links.internal integer
links.external integer
social_profiles[] object[]
social_profiles[] object
social_profiles[].platform string
social_profiles[].type string
social_profiles[].handle string | null
social_profiles[].url string
social_profiles[].source string
social_profiles[].confidence string
contacts object
contacts.emails[] string[]
contacts.phones[] string[]
meta object
meta.checked_at string
meta.cached boolean
meta.fetch_transport string
meta.fetch_error string

Exemplo de requisição

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/url-intelligence?url=https%3A%2F%2Fexample.com&skip_cache=1"
const response = await fetch("https://domscan.net/v1/url-intelligence?url=https%3A%2F%2Fexample.com&skip_cache=1", {
  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/url-intelligence?url=https%3A%2F%2Fexample.com&skip_cache=1",
    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/url-intelligence?url=https%3A%2F%2Fexample.com&skip_cache=1", 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/url-intelligence?url=https%3A%2F%2Fexample.com&skip_cache=1")
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))

Exemplo de resposta

{
  "requested_url": "https://www.example.com/",
  "final_url": "https://www.example.com/",
  "status": 200,
  "fetch_state": "ok",
  "content_type": "text/html; charset=UTF-8",
  "redirects": 0,
  "title": "Example Co",
  "description": "Example Co builds simple tools for small teams.",
  "canonical_url": "https://www.example.com/",
  "language": "en",
  "favicon_url": "https://www.example.com/favicon.ico",
  "preview_image_url": "https://www.example.com/og.png",
  "manifest_url": "https://www.example.com/site.webmanifest",
  "theme_color": "#0b5fff",
  "author": null,
  "publisher": "Example Co",
  "published_at": null,
  "modified_at": "2026-10-01T08:00:00.000Z",
  "feeds": [
    {
      "url": "https://www.example.com/blog/feed.xml",
      "type": "application/rss+xml",
      "title": "Example Co blog"
    }
  ],
  "oembed_url": null,
  "video": null,
  "audio": null,
  "open_graph": {
    "title": "Example Co",
    "type": "website",
    "url": "https://www.example.com/",
    "image": "https://www.example.com/og.png"
  },
  "twitter_card": {
    "card": "summary_large_image",
    "title": "Example Co"
  },
  "structured_data": {
    "types": [
      "Organization"
    ],
    "items": 1,
    "parse_errors": 0
  },
  "robots": {
    "meta": [
      "index",
      "follow"
    ],
    "header": [],
    "indexable": true
  },
  "security_headers": {
    "content-security-policy": "default-src 'self'",
    "strict-transport-security": "max-age=63072000; includeSubDomains",
    "x-content-type-options": "nosniff",
    "x-frame-options": "SAMEORIGIN",
    "referrer-policy": "strict-origin-when-cross-origin",
    "permissions-policy": null,
    "cross-origin-opener-policy": null
  },
  "links": {
    "total": 3,
    "internal": 2,
    "external": 1
  },
  "social_profiles": [
    {
      "platform": "linkedin",
      "type": "social",
      "handle": "example-co",
      "url": "https://www.linkedin.com/company/example-co",
      "source": "same_as",
      "confidence": "high"
    },
    {
      "platform": "github",
      "type": "developer",
      "handle": "example-co",
      "url": "https://github.com/example-co",
      "source": "same_as",
      "confidence": "high"
    }
  ],
  "contacts": {
    "emails": [
      "[email protected]"
    ],
    "phones": []
  },
  "meta": {
    "checked_at": "2026-10-09T10:15:30.000Z",
    "cached": false,
    "fetch_transport": "edge_relay"
  }
}

Códigos de status HTTP

  • 200 OK
  • 400 Pedido inválido
  • 401 Não autorizado
  • 402 Pagamento necessário
  • 429 Demasiados pedidos
  • 502 Erro de gateway
POST /v1/url-intelligence/bulk Créditos: 2/item

Parâmetros de consulta

Parâmetro Tipo obrigatório
dry_run string
Valores permitidos true
opcional

Parâmetros do corpo

Parâmetro Tipo obrigatório
urls string[] obrigatório

Campos da resposta

Campo Tipo
results[] object[]
results[] object
results[].input string
results[].data object
results[].error object
results[].error.error object
results[].error.error.code string
results[].error.error.type string
results[].error.error.message string
results[].error.error.status integer
results[].error.error.retryable boolean
results[].error.error.request_id string
results[].error.error.suggestion string
results[].error.error.details object
results[].error.error.retry_after integer
results[].error.error.docs_url string
meta object
meta.total integer
meta.succeeded integer
meta.failed integer
meta.unknown integer
meta.max_items integer
meta.credits_per_item integer
meta.duration_ms integer

Exemplo de requisição

curl -X POST "https://domscan.net/v1/url-intelligence/bulk" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "urls": [
    "https://example.com",
    "https://github.com/about"
  ]
}'
const response = await fetch("https://domscan.net/v1/url-intelligence/bulk", {
  method: "POST",
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "urls": [
      "https://example.com",
      "https://github.com/about"
    ]
  }),
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.post(
    "https://domscan.net/v1/url-intelligence/bulk",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
    json={
        "urls": [
            "https://example.com",
            "https://github.com/about",
        ],
    },
)
print(response.json())
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
	  "urls": [
	    "https://example.com",
	    "https://github.com/about"
	  ]
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://domscan.net/v1/url-intelligence/bulk", 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/url-intelligence/bulk")
request = Net::HTTP::Post.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "urls" => [
    "https://example.com",
    "https://github.com/about"
  ]
})

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

Exemplo de resposta

{
  "results": [
    {
      "input": "example",
      "data": {},
      "error": {
        "error": {
          "code": "INVALID_DOMAIN",
          "type": "authentication_error",
          "message": "Invalid domain format",
          "status": 400,
          "retryable": false,
          "request_id": "request-id",
          "docs_url": "https://domscan.net/docs/check-availability",
          "suggestion": "example",
          "details": {},
          "retry_after": 300
        }
      }
    }
  ],
  "meta": {
    "total": 1,
    "succeeded": 1,
    "failed": 1,
    "unknown": 1,
    "max_items": 10,
    "credits_per_item": 2,
    "duration_ms": 1
  }
}

Códigos de status HTTP

  • 200 OK
  • 400 Pedido inválido
  • 401 Não autorizado
  • 402 Pagamento necessário
  • 409 HTTP 409
  • 422 HTTP 422
  • 429 Demasiados pedidos