API documentation

Add an asset to the watchlist

Adds the asset to the watchlist; if the value already exists no new record is created (`deduped: true`).

POST/v1/watch/assets
POSTAdd an asset to the watchlist
curl -X POST "https://api.darkradar.com/api/public/v1/watch/assets" \
  -H "x-api-key: $DARKRADAR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"email","value":"[email protected]","label":"Finans direktörü"}'
Response

Created

{
  "success": true,
  "data": {
    "assetId": "64b1f0c2a9e4d21f8c3b9a20",
    "deduped": false
  }
}

Access

Scopewatch:write
Plan entitlementintel_watch

Request body

FieldsValues
type · string · requiredAsset type · Values: email, phone, username, tc, taxid, domain
value · string · requiredValue to watch (max 512 chars)
label · string · optionalDisplay label (max 120 chars)

Responses

201Created
400Invalid request (malformed id, missing or invalid field)
401Key missing, invalid, expired or revoked
403Insufficient scope, no API access in plan, or product not enabled
404Record not found or not owned by this key’s firm
408The request exceeded its maximum response time
429Rate limit exceeded; retry after a minute

Response limits

Rate limit500 requests per 15 min · per IP

Was this page helpful?