Interface BlacklistOptions

Blacklist endpoint optional parameters.

Hierarchy

  • TypeOf<typeof blacklistOptionsSchema>
    • BlacklistOptions

Properties

confidenceMinimum?: number = ...

Minimum confidence percentage value. Accepted values between 25 and 100, defaults to 100 by the API. Requires a subscription to use this feature.

exceptCountries?: string[] = ...

Filters the reports based on a given array of ISO 3166-1 Alpha-2 countries, excluding only the given list. Requires a subscription to use this feature. onlyCountries and exceptCountries are mutually exclusive, only one can be defined at a time.

limit?: number = ...

Limits the amount of returned reports. Accepted values between 1 and 500000, defaults to 10000 by the API. The value is capped by your current subscription tier. (10k Standard, 100k Basic, 500k Premium).

onlyCountries?: string[] = ...

Filters the reports based on a given array of ISO 3166-1 Alpha-2 countries, including only the given list. Requires a subscription to use this feature. onlyCountries and exceptCountries are mutually exclusive, only one can be defined at a time.

plaintext?: boolean = ...

Returns the response as a text list, instead of JSON structure. Result is wrapped in a ClientResponse

Generated using TypeDoc