​
What Is the Toolip API?

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.

​
Common Headers

  • 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.
ParameterTypeDescription
zoneIdstringIdentifier of the zone.
typeOfZonestringType of the subscription.
startDateSubscription start date.
untilDateSubscription end date.

​
2. Get Usage Info

Retrieve usage information for a specific zone.

​
Endpoint:

GET https://toolip.io/api/v1/getUsageInfo

​
Request Parameters:

ParameterTypeDescription
zoneIdstringIdentifier of the zone.

​
Response:

A JSON object containing usage details.
ParameterTypeDescription
usednumberAmount of traffic used.
limitnumberBandwidth limit.

​
3. Get Proxies

Retrieve proxy details for a specific zone.

​
Endpoint:

GET https://toolip.io/api/v1/getProxies

​
Request Parameters:

ParameterTypeDescription
zoneIdstringIdentifier of the zone.

​
Response:

A JSON array containing proxy details.
ParameterTypeDescription
hoststringProxy hostname.
portstringProxy port.
loginstringProxy login credentials.
passwordstringProxy password.
countrystringProxy’s assigned country.
ipstringIP of the proxy (if applicable).

​
4. Configure Proxies

Generate new proxies for a specific zone.

​
Endpoint:

POST https://toolip.io/api/v1/configureProxies

​
Request Parameters:

ParameterTypeDescription
zoneIdstringIdentifier of the zone.
countrystringDesired country for proxies.
quantitystringNumber of proxies required.

​
Response:

A JSON array with the new proxy details.
ParameterTypeDescription
hoststringHostname of the proxy.
portstringPort number for the proxy.
loginstringLogin credential for the proxy.
passwordstringPassword credential for the proxy.
countrystringCountry of the proxy.
ipstringIP address (if applicable).

​
5. Rotate IPs

Refresh IPs for specific proxies.

​
Endpoint:

PUT https://toolip.io/api/v1/rotateIP

​
Request Parameters:

ParameterTypeDescription
zoneIdstringIdentifier of the zone.
countrystringCountry for the new proxies.
ipsArray<string>List of IPs to rotate.

​
Response:

A JSON array with the new IPs.
ParameterTypeDescription
ipsstringList of IPs to rotate.
By following these steps, you’ll have full control over your Toolip proxy configurations and operations through the API. Happy scraping!