Documentation Index
Fetch the complete documentation index at: https://docs.toolip.io/llms.txt
Use this file to discover all available pages before exploring further.
The Toolip API offers a streamlined way to configure and manage your proxies programmatically. With its simple design and powerful functionality, you can access your proxy details, monitor usage, generate proxies, and rotate IPs all from a single endpoint.
To get started, you’ll need an API token, which can be generated directly from your Toolip dashboard. The token is required for authentication in both the authorization header and the authtoken parameter.
Getting Started with the API
Authentication
Include your API token in every request to authenticate:
-
authorization: Use the format Basic <API_TOKEN> in the header.
-
authtoken: Add your API token as a query parameter in the request.
-
authorization: Pass your API token.
-
Content-Type: Set to application/json.
API Methods
1. Get Subscriptions
Retrieve all active subscriptions associated with your account.
Endpoint:
GET https://toolip.io/api/v1/getSubscription
Response:
A JSON array containing details about your subscriptions.
| Parameter | Type | Description |
|---|
zoneId | string | Identifier of the zone. |
typeOfZone | string | Type of the subscription. |
start | Date | Subscription start date. |
until | Date | Subscription end date. |
2. Get Usage Info
Retrieve usage information for a specific zone.
Endpoint:
GET https://toolip.io/api/v1/getUsageInfo
Request Parameters:
| Parameter | Type | Description |
|---|
zoneId | string | Identifier of the zone. |
Response:
A JSON object containing usage details.
| Parameter | Type | Description |
|---|
used | number | Amount of traffic used. |
limit | number | Bandwidth limit. |
3. Get Proxies
Retrieve proxy details for a specific zone.
Endpoint:
GET https://toolip.io/api/v1/getProxies
Request Parameters:
| Parameter | Type | Description |
|---|
zoneId | string | Identifier of the zone. |
Response:
A JSON array containing proxy details.
| Parameter | Type | Description |
|---|
host | string | Proxy hostname. |
port | string | Proxy port. |
login | string | Proxy login credentials. |
password | string | Proxy password. |
country | string | Proxy’s assigned country. |
ip | string | IP of the proxy (if applicable). |
Endpoint:
POST https://toolip.io/api/v1/configureProxies
Request Parameters:
| Parameter | Type | Description |
|---|
zoneId | string | Identifier of the zone. |
country | string | Desired country for proxies. |
quantity | string | Number of proxies required. |
Response:
A JSON array with the new proxy details.
| Parameter | Type | Description |
|---|
host | string | Hostname of the proxy. |
port | string | Port number for the proxy. |
login | string | Login credential for the proxy. |
password | string | Password credential for the proxy. |
country | string | Country of the proxy. |
ip | string | IP address (if applicable). |
5. Rotate IPs
Refresh IPs for specific proxies.
Endpoint:
PUT https://toolip.io/api/v1/rotateIP
Request Parameters:
| Parameter | Type | Description |
|---|
zoneId | string | Identifier of the zone. |
country | string | Country for the new proxies. |
ips | Array<string> | List of IPs to rotate. |
Response:
A JSON array with the new IPs.
| Parameter | Type | Description |
|---|
ips | string | List of IPs to rotate. |
