Loading
Loading
Search for registered domains that read like typo variants of a brand keyword, or that match a wildcard pattern, across the full TLD set. Each match returns what is available of its registration date, expiry date, last-seen date, and drop status, paginated at 100 domains per page.
Provide either a keyword (tight fuzzy match on one label) or a pattern (up to three * wildcards, slower, wider). Walk large result sets with the pageToken returned as nextPageToken.
Authorize every request with your API key, passed either as a header or as a query parameter:
X-apiKeyapiKeyThis is version v1.0 of the API.
The following parameters can be used in your API requests. All parameters are passed as query string parameters.
keywordoptionalStringdefault: paypalBrand or label to find typo variants for. 3-63 characters, letters, digits, or hyphens, a single label with no dots. Case-insensitive. Use either keyword or pattern, never both.
patternoptionalStringWildcard search string that combines fuzzy matching with * wildcards. 3-63 characters total, * is the only supported wildcard and each one matches zero or more characters, maximum 3 asterisks per request. Use either keyword or pattern, never both.
pageTokenoptionalStringToken from nextPageToken in the previous response. Required to retrieve page 2 and onward. The original keyword or pattern must be passed alongside the token on every page request. Results page at 100 domains per page.
A successful request returns a 200 OK response with a JSON object containing paginated look-alike domain data. See the response preview on the right for the full JSON structure.
statusIndicates if the request was successful.
totalRecordsTotal number of domains found.
currentPagePage number of the current response. Starts at 1.
hasNextPagetrue if at least one additional page is available.
totalPagesTotal number of pages available.
nextPageTokenOpaque token to pass as pageToken on the next request. Present only when hasNextPage is true.
domainName (String), createDate (String), expiryDate (String), lastSeen (String), isDropped (Boolean)
Besides the response body, every response carries custom headers you can use to track credit usage, and concurrency usage on endpoints that enforce a concurrency limit. See the Custom Response Headers documentation and the endpoints with concurrency limits for more details.
X-Concurrent-Threadsheaderconcurrency-limited endpointsSpecifies the maximum number of concurrent requests allowed.
X-Concurrent-Threads-Activeheaderconcurrency-limited endpointsIndicates the number of active concurrent requests being processed.
X-AF-Credits-Costheaderall responsesSpecifies the number of credits consumed by the current request.
See the HTTP Status Codes documentation for a complete reference of common API errors and HTTP status codes.
The pattern must contain at least 5 non-wildcard characters and no more than 3 wildcards.
Use either the "keyword" or the "pattern" parameter, never both.
Please provide either a "keyword" or a "pattern" parameter.