Blocker
Here is an example API documentation for the endpoint used for checking visitors status.
REQUEST
Endpoint
https://stopbot.net/api/blocker?apikey={APIKEY}&ip={IP}&ua={url-encode-useragent}&url={url-encode-url}
Method
GET
Parameters
apikey
(string, required): The API key provided to the user.ip
(string, required): The IP address of the visitor.ua
(string, required): The useragent used by the visitor.url
(string, required): The URL opened by the visitor, REQUEST_URI from your website or APP).
Example Request
curl "https://stopbot.net/api/blocker?apikey=9ca6f45b2e9821b3a964c0f79cb67dc3&ip=1.1.1.1&ua=Mozilla%2F5.0%20%28Windows%20NT%2010.0%3B%20Win64%3B%20x64%29%20AppleWebKit%2F537.36%20%28KHTML%2C%20like%20Gecko%29%20Chrome%2F113.0.0.0%20Safari%2F537.36&url=some_script.php%3Fid%3D1"
Example Response
Success Response
If the HTTP response is 200 (success response), it will generate the following response:
{
"IP": "1.1.1.1",
"IPInfo": {
"hostname": "",
"asn": 13335,
"company": "Cloudflare, Inc.",
"isp": "Cloudflare, Inc.",
"city": "Marble Bar",
"district": "East Pilbara",
"region": "Western Australia",
"postcode": "",
"country": "AU",
"latitude": -20.5,
"longitude": 120.15,
"timezone": "Australia\/Perth"
},
"IPStatus": {
"isBot": 1,
"BlockAccess": 1,
"ThreatURL": 0,
"DetectActivity": "BLOCKED BY IP DATABASE."
},
"UA": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/113.0.0.0 Safari\/537.36",
"status": "success",
"timeResponse": "2023-07-21 03:59:24"
}
Description on successful response
IP
: The visitor's IP address.IPInfo
: Information about the visitor's IP.hostname
: The visitor's hostname.asn
: The Autonomous System Number (ASN) that identifies the internet service provider.company
: The company associated with the visitor's IP.isp
: The Internet Service Provider (ISP) name.city
: The city where the visitor is located.district
: The district or area associated with the IP address.region
: The region where the visitor is located.postcode
: The postal code associated with the IP address.country
: The country where the visitor is located.latitude
: The latitude coordinate of the IP address location.longitude
: The longitude coordinate of the IP address location.timezone
: The timezone of the IP address location.
IPStatus
: Information about the visitor's IP status.isBot
: Indicates whether the visitor is a bot (1) or not (0).BlockAccess
: Indicates whether access is blocked (1) or not (0).ThreatURL
: Indicating whether the visitor is performing suspicious actions on your URL, result true (1) or false (0).DetectActivity
: Describes the visitor's status. There are 13 possible statuses:BLOCK BY IP DATABASE
BLOCK BY MALICIOUS ACTIVITY
BLOCK BY HOSTNAME DATABASE
BLOCK BY PROXY/VPN/TOR
BLOCK BY COUNTRY
BLOCK BY IP NON-ISP
BLOCK BY SPIDER CRAWLER
BLOCK BY THREAT URL
BLOCK BY DEVICE DESKTOP
BLOCK BY DEVICE MOBILE
BLOCK BY BLACKLIST IP (USER)
ALLOW BY WHITELIST IP (USER)
VISITOR
UA
: The useragent used by the visitor.status
: Indicates the success or failure of the request.timeResponse
: Date and time when the response was sent.
Failed Response
If the HTTP response is 400 or 401 (failed response), it will generate the following response:
{
"status": "failed",
"timeResponse": "2023-06-8 23:00"
}
Description on failed response:
status
: Response Status: The value is "failed" if the request fails.timeResponse
: Date and time when the response was sent.
Last updated