Skip to main content
This API is specifically designed for users who need to automate and batch-manage proxies. It can replace manual dashboard operations to implement functions such as proxy configuration, session control, and data query. Suitable for scenarios like web crawling, multi-account operation, and business system integration, it improves operational efficiency.

​
1. Permission Requirements

  • Only users who have purchased a residential proxy plan (Traffic Plan / Unlimited Plan) can use this API. Interface permissions are bound to the plan type (e.g., the Traffic Plan supports the region filtering interface, while the Unlimited Plan does not have this permission).
  • The account status must be normal, with no arrears, bans, or expiration. Otherwise, interface calls will return permission errors.

​
2. API Key Acquisition and Management (Core Step)

The API key is the sole credential for calling interfaces. You need to generate it yourself and keep it properly. Follow these steps:
  1. Log in to the dashboard, enter the Proxy Plan page, and find the API Key Management module.
  2. Click Generate New Key. The system will prompt you to set a key remark (optional, used to distinguish keys for multiple scenarios, e.g., “Web Crawling Business Key”).
  3. Confirm to generate the key, and copy and save it immediately (visible only at generation; cannot be viewed again later).
Key Management: Supports resetting and deleting keys. If you suspect a key has been leaked, click Reset Key immediately. The original key will become invalid, and a new key will be generated simultaneously. You can manually delete unused keys to avoid redundant permissions.

​
3. Basic Call Specifications

  • All interfaces support the HTTP/HTTPS protocols. HTTPS is recommended to ensure data security.
  • Request Methods:
    • GET (for query-type interfaces)
    • POST (for operation-type interfaces, e.g., adding whitelists, switching sessions)
  • Mandatory Request Header Parameter: Authorization: Bearer [Your API Key] (replace with the actual generated key for identity authentication).
  • Response Format: Uniformly in JSON, including status codes, prompt messages, and returned data (clear prompts are provided for both successful and failed calls).
  • Encoding Format: UTF-8 to avoid garbled characters in Chinese parameters.