7 operations. Call each with POST https://app.chirply.io/api/v1/actions/<name> and a bearer token; the response is { "data": { "action", "summary", "result" } }. A read badge means the operation changes nothing; write requires the credential’s write scope.
Export Domain Leads CSV
domain_leads.export_csvread
Search Domain Leads and return the matching registration records as CSV text for download or downstream processing. Read-only and costs nothing. One machine call returns at most 5,000 rows; use offset to page through larger result sets. Requires the Domain Leads app (a one-time purchase from the App Marketplace) to be installed in this account; without it the call returns 403 app_required and no data.
Parameters
Field
Type
Required
Description
keyword
string
required
Word to find inside the domain name. 'plumbing' matches denverplumbingpros.com. Matched against whole words by default.
mode
"word" | "contains"
optional
'word' (default) matches whole words via the token index and is fast. 'contains' matches any substring anywhere in the name — thorough but scans the whole table and takes seconds.
tld
string
optional
Only domains with this ending, e.g. 'com' or 'co.uk'. Leading dot optional.
country
string
optional
Only registrants in this country, spelled as WHOIS records it, e.g. 'United States'.
registered_from
string
optional
Only domains registered on or after this date (YYYY-MM-DD).
registered_to
string
optional
Only domains registered on or before this date (YYYY-MM-DD).
max_domains
integer
optional
Only registrants holding at most this many domains. Use a low number (1-5) to exclude domain speculators holding hundreds of names, who are rarely real prospects.
require_phone
boolean
optional
Only registrants with a phone number on record. Defaults to true.
sort
"newest" | "oldest" | "domain"
optional
Result order. Defaults to newest registration first.
limit
integer
optional
Rows to include in this CSV page. Default 500, maximum 5,000.
offset
integer
optional
Matching rows to skip before this CSV page. Default 0.
Over MCP the same operation is the tool domain_leads_export_csv at https://app.chirply.io/api/mcp, same bearer token, same input.
Get a domain's registrant
domain_leads.getread
Look up one specific domain and return everything known about who registered it — name, company, phone, email, full postal address, registrar, and registration/expiry dates. Returns null when the domain isn't in the database or was registered behind a privacy proxy. Requires the Domain Leads app (a one-time purchase from the App Marketplace) to be installed in this account; without it the call returns 403 app_required and no data.
Parameters
Field
Type
Required
Description
domain
string
required
The full domain name including its ending, e.g. 'example.com'.
Over MCP the same operation is the tool domain_leads_get at https://app.chirply.io/api/mcp, same bearer token, same input.
View Domain Leads inventory
domain_leads.get_inventoryread
Return the exact number of records currently available in the shared Domain Leads dataset, plus its earliest and latest valid registration dates. Read-only and costs nothing. Requires the Domain Leads app (a one-time purchase from the App Marketplace) to be installed in this account; without it the call returns 403 app_required and no data.
Over MCP the same operation is the tool domain_leads_get_inventory at https://app.chirply.io/api/mcp, same bearer token, same input.
Import domain leads into contacts
domain_leads.import_to_contactswriteconfirm
Run a domain-leads search and copy the matching registrants into this organization's CRM as contacts, with their name, company, email, phone and website. Creates up to 500 contact records in one call — these are real people's contact details and will appear in the org's contact list, where they can then be called, texted or emailed. Does not send anything by itself and spends no money, but bulk-importing thousands of contacts is tedious to undo, so it asks for confirmation. Requires the Domain Leads app (a one-time purchase from the App Marketplace) to be installed in this account; without it the call returns 403 app_required and no data.
Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.
Parameters
Field
Type
Required
Description
keyword
string
required
Word to find inside the domain name. 'plumbing' matches denverplumbingpros.com. Matched against whole words by default.
mode
"word" | "contains"
optional
'word' (default) matches whole words via the token index and is fast. 'contains' matches any substring anywhere in the name — thorough but scans the whole table and takes seconds.
tld
string
optional
Only domains with this ending, e.g. 'com' or 'co.uk'. Leading dot optional.
country
string
optional
Only registrants in this country, spelled as WHOIS records it, e.g. 'United States'.
registered_from
string
optional
Only domains registered on or after this date (YYYY-MM-DD).
registered_to
string
optional
Only domains registered on or before this date (YYYY-MM-DD).
max_domains
integer
optional
Only registrants holding at most this many domains. Use a low number (1-5) to exclude domain speculators holding hundreds of names, who are rarely real prospects.
require_phone
boolean
optional
Only registrants with a phone number on record. Defaults to true.
sort
"newest" | "oldest" | "domain"
optional
Result order. Defaults to newest registration first.
limit
integer
optional
How many contacts to import. Default 50, max 500.
source_label
string
optional
Value to record in each contact's Source field. Defaults to 'domain_leads'.
Over MCP the same operation is the tool domain_leads_import_to_contacts at https://app.chirply.io/api/mcp, same bearer token, same input.
List domain endings and countries
domain_leads.list_filtersread
List the domain endings (TLDs) and registrant countries available as search filters, each with how many domains carry it, most common first. Use this to discover valid values for the tld and country arguments of domain_leads.search. Requires the Domain Leads app (a one-time purchase from the App Marketplace) to be installed in this account; without it the call returns 403 app_required and no data.
Over MCP the same operation is the tool domain_leads_list_filters at https://app.chirply.io/api/mcp, same bearer token, same input.
List a registrant's other domains
domain_leads.registrant_portfolioread
Given a registrant's email address, list the other domains that same person or business registered. Useful for gauging whether a lead is a real business (a handful of domains) or a domain speculator (hundreds). Requires the Domain Leads app (a one-time purchase from the App Marketplace) to be installed in this account; without it the call returns 403 app_required and no data.
Parameters
Field
Type
Required
Description
email
string
required
The registrant email address, as returned by domain_leads.search.
Over MCP the same operation is the tool domain_leads_registrant_portfolio at https://app.chirply.io/api/mcp, same bearer token, same input.
Search domain leads
domain_leads.searchread
Search the 26,086,322-record historical domain-registration dataset by a keyword in the domain name and return the person or business who registered each one, with their name, company, phone, email and postal address. Registration dates span 1985 through 2024; this is a historical dataset, not live WHOIS. Domains registered behind privacy/proxy services may not carry reachable contact details. Costs nothing to run. Requires the Domain Leads app (a one-time purchase from the App Marketplace) to be installed in this account; without it the call returns 403 app_required and no data.
Parameters
Field
Type
Required
Description
keyword
string
required
Word to find inside the domain name. 'plumbing' matches denverplumbingpros.com. Matched against whole words by default.
mode
"word" | "contains"
optional
'word' (default) matches whole words via the token index and is fast. 'contains' matches any substring anywhere in the name — thorough but scans the whole table and takes seconds.
tld
string
optional
Only domains with this ending, e.g. 'com' or 'co.uk'. Leading dot optional.
country
string
optional
Only registrants in this country, spelled as WHOIS records it, e.g. 'United States'.
registered_from
string
optional
Only domains registered on or after this date (YYYY-MM-DD).
registered_to
string
optional
Only domains registered on or before this date (YYYY-MM-DD).
max_domains
integer
optional
Only registrants holding at most this many domains. Use a low number (1-5) to exclude domain speculators holding hundreds of names, who are rarely real prospects.
require_phone
boolean
optional
Only registrants with a phone number on record. Defaults to true.
sort
"newest" | "oldest" | "domain"
optional
Result order. Defaults to newest registration first.