Botrisks

Address botrisk check

The botrisk check evaluates the risk that the address in question represents an automated bot, not a real person.

Syntax /svc/2.0/address/botrisk/<address>
Example /svc/2.0/address/botrisk/foo@bar.com
Parameter An ASCII email address as last part of the URL

Result

<botriskStatus> 
<infoIds>
  <infoId>2</infoId>
  <infoId>3</infoId> 
</infoIds> 
<result>1</result> 
</botriskStatus>

or

{"infoIds": [2, 3], "result": 1}

The service looks for typical naming patterns in different parts of the address and returns the sum. The result document contains:

  • result: the evaluation result
    • 0: normal risk, nothing found
    • 10: slightly increased risk, a part of the address is suspiciuos
    • 20: medium risk, some parts of the address are suspicious
    • 30: high risk, the complete address is suspicious
  • infoIds: if the result is > 0, this contains IDs for looking up more information about a botrisk resource.

Functionality

The service tests the requested address and parts of it against different types of entries stored in da database:

  1. the complete address against address entries
  2. the domain only against domain entries
  3. the local part only against local part entries
  4. the complete address against regex entries

If a match is found a risk result (>0) is returned. In case of multiple matches the risk increases. The IDs of the matching entries are also returned for further lookup.

Information about a botrisk resource

The botrisk info API call returns information about botrisk resources. Bots can be identified by their naming patterns, which are documented here.

Syntax /svc/2.0/info/botrisk/<id>
Example /svc/2.0/info/botrisk/1
Parameter An ID (number) as the last part of the URL

Result

<botRiskInfo> 
<botriskType>1</botriskType> 
<id>1</id> 
<owner>A botrisk provider name</owner> 
<remarks>Details about the bot, its maintainer</remarks> 
<url>http://bot-maintainer.com</url> 
</botRiskInfo>

or


"botRiskType": 1, 
"id": 1, 
"owner": "A botrisk provider name", 
"remarks": "Details about the bot, its maintainer", 
"url": "http://bot-maintainer.com" 
}

The structure of the result document is:

  • botRiskType: the part of the address or pattern that lead to the risk estimation
    • 1: domain name
    • 2: local part
    • 3: complete mail address
    • 4: regular expression
  • id: resource ID
  • owner: the name of the maintaining entity, if known
  • remarks: details about the resource
  • url: a URL with more informtion about the bot, its maintainer

Functionality

If no data is available for an ID the server will signal this with HTTP response code 204 (No Content) and return no result (null).