View as Markdown
WhoisFreaks icon

WhoisFreaks ACTION

Domain Availability Lookup

Check if a domain name is available for registration. For example you can check whoisfreaks.com. This action supports responses in both JSON and XML format. Always use sug=false to get the response. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's WhoisFreaks account once, then configure and run Domain Availability Lookup from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "whoisfreaks-domain-availability-lookup",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    whoisfreaks: { authProvisionId: "apn_xxxxxxx" },
    domainName: "Domain Name",
    format: "Format",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Domain Availability Lookup inputs
Property Type Description
domainName Domain Name string
The domain name to lookup (e.g. example.com)
Required
format Format string
Two formats are available JSON, XML. If you don't specify the 'format' parameter, the default format will be JSON.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
whoisfreaks-domain-availability-lookup
Version
0.0.2
App
WhoisFreaks
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes