API-referentie

Merkbewaking API-referentie

Controleer domeinen op merkenverlies en typosquatting-bedreigingen. Gebruik deze referentie om het juiste endpoint te kiezen en precies te zien wat het teruggeeft.

Bewerkingen

GET /v1/brand-monitor API-referentie bekijken
POST /v1/brand-monitor API-referentie bekijken
DELETE /v1/brand-monitor API-referentie bekijken
POST /v1/brand-monitor/scan API-referentie bekijken
GET /v1/brand-monitor/status API-referentie bekijken
POST /v1/brand-monitor/reset-baseline API-referentie bekijken
PUT /v1/brand-monitor/alerts API-referentie bekijken

GET /v1/brand-monitor

Bewerking: getBrandMonitors Credits en authenticatie: 1 Authenticatie vereist
GET /v1/brand-monitor Tegoeden: 1

Queryparameters

Parameter Type vereist
limit integer optioneel
cursor string optioneel

Antwoordvelden

Veld Type
has_more boolean
next_cursor string | null
brands[] object[]
brands[] object
brands[].domain string
brands[].added_at string
brands[].last_scan_at string | null
brands[].scan_count integer
brands[].registered_typos integer
brands[].new_threats_since_baseline integer
brands[].has_alerts boolean
brands[].scan_status string
total integer
updated_at string

Voorbeeldverzoek

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/brand-monitor"
const response = await fetch("https://domscan.net/v1/brand-monitor", {
  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-monitor",
    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-monitor", 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-monitor")
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))

Voorbeeldantwoord

{
  "brands": [
    {
      "domain": "example.com",
      "scan_count": 1,
      "registered_typos": 1,
      "new_threats_since_baseline": 1,
      "has_alerts": false,
      "added_at": "2026-08-27T12:00:00Z",
      "last_scan_at": "2026-08-27T12:00:00Z",
      "scan_status": "pending"
    }
  ],
  "total": 1,
  "updated_at": "2026-08-27T12:00:00Z",
  "has_more": false,
  "next_cursor": "example"
}

HTTP-statuscodes

  • 200 OK
  • 400 Ongeldig verzoek
  • 401 Niet geautoriseerd
  • 402 Betaling vereist
  • 429 Te veel verzoeken

POST /v1/brand-monitor

Bewerking: createBrandMonitor Credits en authenticatie: 3 Authenticatie vereist
POST /v1/brand-monitor Tegoeden: 3

Body-parameters

Parameter Type vereist
domain string vereist
alert_email string optioneel
alert_webhook string optioneel

Antwoordvelden

Veld Type
success boolean
message string
brand object
brand.domain string
brand.baseline_threats integer
brand.scan_status string
initial_scan object | null

Voorbeeldverzoek

curl -X POST "https://domscan.net/v1/brand-monitor" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "domain": "example.com",
  "alert_email": "[email protected]",
  "alert_webhook": "https://hooks.example.com/domscan"
}'
const response = await fetch("https://domscan.net/v1/brand-monitor", {
  method: "POST",
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "domain": "example.com",
    "alert_email": "[email protected]",
    "alert_webhook": "https://hooks.example.com/domscan"
  }),
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.post(
    "https://domscan.net/v1/brand-monitor",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
    json={
        "domain": "example.com",
        "alert_email": "[email protected]",
        "alert_webhook": "https://hooks.example.com/domscan",
    },
)
print(response.json())
package main

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

func main() {
	body := strings.NewReader(`{
	  "domain": "example.com",
	  "alert_email": "[email protected]",
	  "alert_webhook": "https://hooks.example.com/domscan"
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://domscan.net/v1/brand-monitor", 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/brand-monitor")
request = Net::HTTP::Post.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "domain" => "example.com",
  "alert_email" => "[email protected]",
  "alert_webhook" => "https://hooks.example.com/domscan"
})

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

Voorbeeldantwoord

{
  "success": true,
  "message": "Request completed",
  "brand": {
    "domain": "example.com",
    "baseline_threats": 1,
    "scan_status": "pending"
  },
  "initial_scan": {}
}

HTTP-statuscodes

  • 201 Aangemaakt
  • 400 Ongeldig verzoek
  • 401 Niet geautoriseerd
  • 402 Betaling vereist
  • 409 HTTP 409
  • 422 HTTP 422
  • 429 Te veel verzoeken

DELETE /v1/brand-monitor

Bewerking: deleteBrandMonitor Credits en authenticatie: 1 Authenticatie vereist
DELETE /v1/brand-monitor Tegoeden: 1

Queryparameters

Parameter Type vereist
domain string vereist

Antwoordvelden

Veld Type
success boolean
message string

Voorbeeldverzoek

curl -X DELETE "https://domscan.net/v1/brand-monitor?domain=example.com" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{}'
const response = await fetch("https://domscan.net/v1/brand-monitor?domain=example.com", {
  method: "DELETE",
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.delete(
    "https://domscan.net/v1/brand-monitor?domain=example.com",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
    json={},
)
print(response.json())
package main

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

func main() {
	body := strings.NewReader(`{}`)
	req, err := http.NewRequest(http.MethodDelete, "https://domscan.net/v1/brand-monitor?domain=example.com", 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/brand-monitor?domain=example.com")
request = Net::HTTP::Delete.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({})

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

Voorbeeldantwoord

{
  "success": true,
  "message": "Request completed"
}

HTTP-statuscodes

  • 200 OK
  • 400 Ongeldig verzoek
  • 401 Niet geautoriseerd
  • 402 Betaling vereist
  • 429 Te veel verzoeken

POST /v1/brand-monitor/scan

Bewerking: triggerBrandScan Credits en authenticatie: 6 Authenticatie vereist
POST /v1/brand-monitor/scan Tegoeden: 6

Queryparameters

Parameter Type vereist
domain string vereist

Antwoordvelden

Veld Type
success boolean
scan object | null
alert object
alert.level string
alert.message string

Voorbeeldverzoek

curl -X POST "https://domscan.net/v1/brand-monitor/scan?domain=example.com" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{}'
const response = await fetch("https://domscan.net/v1/brand-monitor/scan?domain=example.com", {
  method: "POST",
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.post(
    "https://domscan.net/v1/brand-monitor/scan?domain=example.com",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
    json={},
)
print(response.json())
package main

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

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

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

Voorbeeldantwoord

{
  "success": true,
  "scan": {},
  "alert": {
    "level": "medium",
    "message": "Request completed"
  }
}

HTTP-statuscodes

  • 200 OK
  • 400 Ongeldig verzoek
  • 401 Niet geautoriseerd
  • 402 Betaling vereist
  • 409 HTTP 409
  • 422 HTTP 422
  • 429 Te veel verzoeken

GET /v1/brand-monitor/status

Bewerking: getBrandMonitorStatus Credits en authenticatie: 1 Authenticatie vereist
GET /v1/brand-monitor/status Tegoeden: 1

Queryparameters

Parameter Type vereist
domain string vereist

Antwoordvelden

Veld Type
brand object
brand.domain string
brand.name string
brand.tld string
brand.added_at string
brand.last_scan_at string | null
brand.scan_count integer
threats object
threats.baseline_count integer
threats.current_count integer
threats.new_since_baseline integer
threats.new_threat_domains[] string[]
threats.all_registered[] string[]
alerts object
alerts.email string | null
alerts.webhook string | null

Voorbeeldverzoek

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/brand-monitor/status?domain=example.com"
const response = await fetch("https://domscan.net/v1/brand-monitor/status?domain=example.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/brand-monitor/status?domain=example.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/brand-monitor/status?domain=example.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/brand-monitor/status?domain=example.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))

Voorbeeldantwoord

{
  "brand": {
    "domain": "example.com",
    "name": "example",
    "tld": "com",
    "added_at": "2026-08-27T12:00:00Z",
    "last_scan_at": "2026-08-27T12:00:00Z",
    "scan_count": 1
  },
  "threats": {
    "baseline_count": 1,
    "current_count": 1,
    "new_since_baseline": 1,
    "new_threat_domains": [
      "example.com"
    ],
    "all_registered": [
      "example"
    ]
  },
  "alerts": {
    "email": "[email protected]",
    "webhook": "example"
  }
}

HTTP-statuscodes

  • 200 OK
  • 400 Ongeldig verzoek
  • 401 Niet geautoriseerd
  • 402 Betaling vereist
  • 404 Niet gevonden
  • 429 Te veel verzoeken

POST /v1/brand-monitor/reset-baseline

Bewerking: resetBrandMonitorBaseline Credits en authenticatie: 1 Authenticatie vereist
POST /v1/brand-monitor/reset-baseline Tegoeden: 1

Queryparameters

Parameter Type vereist
domain string vereist

Antwoordvelden

Veld Type
success boolean
message string

Voorbeeldverzoek

curl -X POST "https://domscan.net/v1/brand-monitor/reset-baseline?domain=example.com" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{}'
const response = await fetch("https://domscan.net/v1/brand-monitor/reset-baseline?domain=example.com", {
  method: "POST",
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.post(
    "https://domscan.net/v1/brand-monitor/reset-baseline?domain=example.com",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
    json={},
)
print(response.json())
package main

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

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

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

Voorbeeldantwoord

{
  "success": true,
  "message": "Request completed"
}

HTTP-statuscodes

  • 200 OK
  • 400 Ongeldig verzoek
  • 401 Niet geautoriseerd
  • 402 Betaling vereist
  • 409 HTTP 409
  • 422 HTTP 422
  • 429 Te veel verzoeken

PUT /v1/brand-monitor/alerts

Bewerking: updateBrandMonitorAlerts Credits en authenticatie: 1 Authenticatie vereist
PUT /v1/brand-monitor/alerts Tegoeden: 1

Body-parameters

Parameter Type vereist
domain string vereist
alert_email string | null optioneel
alert_webhook string | null optioneel

Antwoordvelden

Veld Type
success boolean
message string

Voorbeeldverzoek

curl -X PUT "https://domscan.net/v1/brand-monitor/alerts" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "domain": "example.com",
  "alert_email": "[email protected]",
  "alert_webhook": "https://hooks.example.com/domscan"
}'
const response = await fetch("https://domscan.net/v1/brand-monitor/alerts", {
  method: "PUT",
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "domain": "example.com",
    "alert_email": "[email protected]",
    "alert_webhook": "https://hooks.example.com/domscan"
  }),
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.put(
    "https://domscan.net/v1/brand-monitor/alerts",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
    json={
        "domain": "example.com",
        "alert_email": "[email protected]",
        "alert_webhook": "https://hooks.example.com/domscan",
    },
)
print(response.json())
package main

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

func main() {
	body := strings.NewReader(`{
	  "domain": "example.com",
	  "alert_email": "[email protected]",
	  "alert_webhook": "https://hooks.example.com/domscan"
	}`)
	req, err := http.NewRequest(http.MethodPut, "https://domscan.net/v1/brand-monitor/alerts", 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/brand-monitor/alerts")
request = Net::HTTP::Put.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "domain" => "example.com",
  "alert_email" => "[email protected]",
  "alert_webhook" => "https://hooks.example.com/domscan"
})

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

Voorbeeldantwoord

{
  "success": true,
  "message": "Request completed"
}

HTTP-statuscodes

  • 200 OK
  • 400 Ongeldig verzoek
  • 401 Niet geautoriseerd
  • 402 Betaling vereist
  • 429 Te veel verzoeken

Referentiebronnen