STOPBOT.NET Documentation
  • MAIN
    • Introduction
    • Workflow Overview
  • API DOCUMENTATION
    • Getting Started
    • Account
    • Blocker
    • Blocker V2
    • Smart URLs
    • IP Lookup
    • Email Validation
    • Email Verifier
    • Phone Number Identify
  • SERVICE GUIDES
    • STOPBOT
      • Blocker
      • Smart URLs
      • Blocker V2
  • PANEL GUIDES
    • Panel Overview
    • Dashboard
    • Account
      • My Account
      • Recent Logs
      • Payments
      • Redeem Coupons
    • Plans & Pricing
      • Payment
    • Services
      • STOPBOT
        • BLOCKER
        • Smart URLs
        • Optional
          • BOT Redirect
          • Blacklist IP
          • Whitelist IP
    • Apikey
  • INFORMATION
    • Affiliate
    • Status
      • Server
    • Update Logs
    • FAQ
    • Privacy Policy
    • Terms of Services
Powered by GitBook
On this page
  • REQUEST
  • Endpoint
  • HTTP Method
  • Description
  • Parameter(s)
  • Example Request
  • Example Response
  • Success Response
  • Description on successful response
  • Failed Response
  • Description on failed response:
  • Notes
  1. API DOCUMENTATION

Account

Here is an example API documentation for the endpoint used for checking account's package status.

REQUEST

Endpoint

https://stopbot.net/api/account?apikey={APIKEY}

HTTP Method

GET

Description

This endpoint is used to check the status of a package account using the provided API key. The request should be made using the GET method and include the API key as a parameter.

Parameter(s)

  • apikey (string, required): The API key provided to the user.

Example Request

CURL "https://stopbot.net/api/account?apikey=9ca6f45b2e9821b3a964c0f79cb67dc3"

Example Response

Success Response

If the HTTP response is 200 (success response), it will generate the following response:

{
  "status": "success",
  "Apikey": "9ca6f45b2e9821b3a964c0f79cb67dc3",
  "Packages": "Silver Plan",
  "Quota": "65000",
  "Usage": "100",
  "ExpiredDate": "[UTC-0] 2023-06-23 03:51:32",
  "timeResponse": "2023-06-8 23:00"
}

Description on successful response

  • status: Response Status: The value is "success" if the request is successful.

  • token: Account token sent in the response.

  • Packages: Name of the active account package.

  • Quota: Amount of available quota in the account package.

  • Usage: Current usage amount.

  • ExpiredDate: Date and time when the package will expire.

  • 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.

Notes

  • Please make sure to replace apikey with a valid API key.

  • Check the value of the HTTP response to determine the appropriate response.

  • Please note the date and time format used in the response.

PreviousGetting StartedNextBlocker

Last updated 1 year ago