dataforseo-mcp-server/build/main/core/modules/domain-analytics/tools/whois/whois-overview.tool.js

A Model Context Protocol (MCP) server for the DataForSEO API, enabling modular and extensible integration of DataForSEO endpoints with support for both HTTP and SSE transports.

import { z } from 'zod';
import { BaseTool } from '../../../base.tool.js';
export class WhoisOverviewTool extends BaseTool {
    client;
    constructor(client) {
        super(client);
        this.client = client;
    }
    getName() {
        return 'domain_analytics_whois_overview';
    }
    getDescription() {
        return `This endpoint will provide you with Whois data enriched with backlink stats, and ranking and traffic info from organic and paid search results. Using this endpoint you will be able to get all these data for the domains matching the parameters you specify in the request`;
    }
    getParams() {
        return {
            limit: z.number().min(1).max(1000).default(10).optional().describe("the maximum number of returned domains"),
            offset: z.number().min(0).optional().describe(`offset in the results array of returned businesses
optional field
default value: 0
if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities`),
            filters: this.getFilterExpression().optional().describe(`array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:
regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, match, not_match
you can use the % operator with like and not_like to match any string of zero or more characters
example:
["rating.value",">",3]`),
            order_by: z.array(z.string()).optional().describe(`results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:
asc – results will be sorted in the ascending order
desc – results will be sorted in the descending order
you should use a comma to set up a sorting parameter
example:
["rating.value,desc"]note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:
["rating.value,desc","rating.votes_count,desc"]`),
            is_claimed: z.boolean().optional().describe(`indicates whether the business is verified by its owner on Google Maps`).default(true)
        };
    }
    async handle(params) {
        try {
            const response = await this.client.makeRequest('/v3/domain_analytics/whois/overview/live', 'POST', [{
                    limit: params.limit,
                    offset: params.offset,
                    filters: this.formatFilters(params.filters),
                    order_by: this.formatOrderBy(params.order_by),
                }]);
            return this.validateAndFormatResponse(response);
        }
        catch (error) {
            return this.formatErrorResponse(error);
        }
    }
}
//# sourceMappingURL=whois-overview.tool.js.map