Interface DataForSeoApiConfig

DataForSeoApiConfig

Description

Represents the configuration object used to set up a DataForSeoAPISearch instance.

interface DataForSeoApiConfig {
    apiLogin?: string;
    apiPassword?: string;
    jsonResultFields?: string[];
    jsonResultTypes?: string[];
    params?: Record<string, string | number | boolean>;
    topCount?: number;
    useJsonOutput?: boolean;
}

Properties

apiLogin? apiPassword? jsonResultFields? jsonResultTypes? params? topCount? useJsonOutput?

Properties

Optional apiLogin

apiLogin?: string

Description

The API login credential for DataForSEO. If not provided, it will be fetched from environment variables.

Optional apiPassword

apiPassword?: string

Description

The API password credential for DataForSEO. If not provided, it will be fetched from environment variables.

Optional jsonResultFields

jsonResultFields?: string[]

Description

Specifies the fields to include in each result object.

Optional jsonResultTypes

jsonResultTypes?: string[]

Description

Specifies the types of results to include in the output.

Optional params

params?: Record<string, string | number | boolean>

Description

Additional parameters to customize the API request.

Optional topCount

topCount?: number

Description

Specifies the maximum number of results to return.

Optional useJsonOutput

useJsonOutput?: boolean

Description

Determines if the output should be in JSON format.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc