Getting Started

Use this page as a quick starting point for the STOPBOT api/v2, with links to the setup details, authentication guide, account check, endpoint references, and error handling pages.

STOPBOT provides public API services for bot detection, SmartURLs, IP lookup, email validation, phone number identification, and account status checks.

Quick Start Links

What You Need	Go To	Purpose
Understand the request flow	Workflow Overview	See how STOPBOT receives visitor context and returns a decision
Prepare your API key	Authentication	Learn how to send and protect your API key
Test your API key	Account	Check package, quota, usage, and expiration
Choose a service	Available Services	Pick the endpoint that matches your use case
Handle failed requests	Error Codes	Understand common error responses
Move from the old API	Migration From V1	Compare legacy and current endpoint behavior

Quick Start Path

For a new integration, follow this order:

1. Read Authentication.

2. Test your API key with Account.

3. Choose a service from Available Services.

4. Open the selected endpoint page and follow its request example.

5. Review Error Codes before using the integration in production.

Before You Start

Before making your first request, make sure you have:

• an active STOPBOT account

• an API key from the STOPBOT panel

• available quota on the API key

• a backend server or server-side application for sending API requests

Your API key should stay on the server side. For API key format and security recommendations, see Authentication.

Base URL

Use this base URL for current STOPBOT API integrations:

https://api.stopbot.net/services

If you are migrating from the legacy API at https://stopbot.net/api, see Migration From V1.

Request Method

All public STOPBOT service endpoints use GET.

GET https://api.stopbot.net/services/{endpoint}

Parameters are sent as query parameters. Authentication uses the apikey query parameter, which is explained in Authentication.

Basic Request Pattern

Most requests follow this pattern:

https://api.stopbot.net/services/{endpoint}?apikey={API_KEY}&parameter=value

Your first request should usually be the Account endpoint.

curl "https://api.stopbot.net/services/account?apikey={API_KEY}"

If this request succeeds, continue to the service endpoint that matches your use case.

Available Services

Service	Endpoint	Documentation
Account	/account	Account
Blocker	/blocker	Blocker
Blocker V2	/blockerv2	Blocker V2
SmartURLs	/shorterlink	SmartURLs
IP Lookup	/iplookup	IP Lookup
Email Validation	/email-validation	Email Validation
Phone Number Identify	/phonenumber	Phone Number Identify

Response Format

STOPBOT returns JSON responses. Each endpoint page explains the exact success and failed response shape for that service.

Most successful responses include:

{
  "status": "success",
  "executionTime": "1.23ms",
  "timeResponse": "2026-07-07 12:00:00"
}

Some services also include endpoint-specific decision fields. For example, Blocker V2 uses blockAccess, detectActivity, pageResponseType, and pageResponseContents.

For failed responses, see Error Codes.

Next Steps

If You Want To	Read
Learn how the full protection flow works	Workflow Overview
Understand API key usage	Authentication
Check quota and expiration	Account
Add standard visitor protection	Blocker
Protect shortlink traffic	SmartURLs
Use advanced page responses	Blocker V2
Handle errors correctly	Error Codes