API Documentation

Full Check (Flagship)

The all-in-one endpoint. Checks domains, social media, brand score, and trademark in a single call. Every field except name is optional.

{
  "name": "coolbrand",
  "platforms": ["github", "twitter", "youtube"],
  "domains": ["com", "io", "dev"],
  "brandScore": true,
  "trademark": true
}

{
  "success": true,
  "data": {
    "name": "coolbrand",
    "domains": {
      "results": [ ... ],
      "summary": { "available": 15, "taken": 4 }
    },
    "social": {
      "results": [ ... ],
      "summary": { "available": 10, "taken": 4 }
    },
    "brandScore": { "overall": 82, "band": "wide-open", "provisional": false, ... },
    "trademark": { "summary": { "overallRisk": "low", ... }, ... }
  },
  "meta": {
    "plan": "pro",
    "duration": 3200,
    "timestamp": "2026-02-11T12:00:00Z"
  }
}

Domain Check

Check domain availability across specific TLDs using the 3-tier verification system. Set details: true to attach a registration record to each taken TLD (registrar, registered/expires dates, status, drop stage) read from the registry - registrant identity is usually redacted.

{
  "name": "coolbrand",
  "tlds": ["com", "io", "dev"],
  "details": true
}

Social Media Check

Check username availability across specific social platforms with parallel processing.

{
  "name": "coolbrand",
  "platforms": ["github", "twitter", "youtube"]
}

Brand Score

Score how ownable a brand name is (0-100) based on weighted availability across .com, premium domains, priority social handles, and USPTO trademark risk. Higher scores mean more channels are open to claim.

{
  "name": "coolbrand"
}

Trademark Check

Screen for USPTO trademark conflicts with risk assessment and legal guidance.

{
  "name": "coolbrand",
  "includeVariations": true
}

Smart Alternatives

Generate professional brand name variations using prefixes, suffixes, and creative patterns.

{
  "name": "coolbrand",
  "count": 8
}

AI Name Generation

Generate creative brand names from a business description using AI.

{
  "description": "productivity tool for remote teams",
  "count": 10,
  "style": "modern"
}

Usage Stats

Returns your current plan, rate limits, and API usage statistics. No request body required.

Create Watch

Start monitoring a username across one or more platforms. Get notified when it becomes available. skipped lists pairs already being watched; skippedInvalid lists those that fail the platform's username rules.

{
  "username": "coolbrand",
  "platforms": ["github", "twitter", "instagram"]
}

{
  "success": true,
  "data": {
    "created": [
      { "id": "clx...", "username": "coolbrand", "platform": "github", "status": "watching", "createdAt": "..." }
    ],
    "skipped": ["twitter"],
    "skippedInvalid": []
  },
  "meta": { "slots": { "used": 4, "limit": 20 } }
}

List Watches

List all monitored handles with status, last check time, and slot usage.

Pause / Resume Watch

Pause or resume monitoring for a specific watch. status is either paused or watching.

{
  "status": "paused"
}

Remove Watch

Stop monitoring and delete a watch. Frees up a slot.

List Notifications

Retrieve in-app notifications with pagination. Use ?unread=true to filter.

Query params: unread (bool), limit (max 100), offset

Mark Notification Read

Mark a single notification as read.

Mark All Read

Mark all unread in-app notifications as read.

Register Webhook

Create a webhook endpoint for alert delivery (https URLs on public hosts only). The signing secret is returned only on creation.

{
  "url": "https://example.com/hook",
  "events": ["handle_available", "handle_change"]
}

{
  "success": true,
  "data": {
    "id": "clx...",
    "url": "https://example.com/hook",
    "secret": "abc123...",
    "events": ["handle_available", "handle_change"],
    "active": true
  }
}

List Webhooks

List all registered webhook endpoints with status and failure info.

Update Webhook

Update a webhook endpoint. Send active: true to re-enable one that was auto-disabled after repeated delivery failures.

{
  "active": true
}

Remove Webhook

Delete a webhook endpoint.