In case you need to automate some of your processes and get specific information without accessing your dashboard interface, we have a couple of API methods for you to use.
NEW: You may now whitelist your IP via API. You can read more about it here.
Getting a list of regions
To get a list of available regions paste the following link into the address bar, replacing all <variables> with those corresponding to your package, and then follow this link:
https://api.soax.com/api/get-country-regions?api_key=<api_key>&package_key=<package_key>&country_iso=<country_iso>&conn_type=<conn_type>[&provider=<provider>]
<api_key> - your unique API-key, you can find it on the "Profile" page in your Dashboard.
<package-key> - the key (login) of the package being used.
<conn_type> is the connection type you’re using and must equal mix / mobile / wifi. If your package provides Wi-Fi (residential) IPs, <conn_type> can only be wifi. Or, if your package provides both Wi-Fi and mobile IPs, <conn_type> can be either any of these two or mix, if needed;
<country_iso> is the ISO code of your target country. For example, if you want to get a list of the available regions of Russia, you need to substitute it with ru;
<provider> is the provider you need (this filter is optional).
Getting a list of cities
Get a list of all cities paste the following link into the address bar, replacing all <variables> with those corresponding to your package, and then follow this link:
https://api.soax.com/api/get-country-cities?api_key=<api_key>&package_key=<package_key>&country_iso=<country_iso>&conn_type=<conn_type>[&provider=<provider_name>[®ion=<region_name>]]
where <provider_name> and <region_name> are optional.
Below are the two methods you can use to get a list of Internet service providers or mobile carriers available in a specific location.
Getting a list of carriers
Get a list of all carriers paste the following link into the address bar, replacing all <variables> with those corresponding to your package, and then follow this link:
https://api.soax.com/api/get-country-operators?api_key=<api_key>&package_key=<package_key>&country_iso=<country_iso>[®ion=<region_name>[&city=<city_name>]]
Where <region_name> and <city_name> are optional.
Please note that this method is available only for packages with connection type "mobile".
Getting a list of ISPs
Get a list all ISPs paste the following link into the address bar, replacing all <variables> with those corresponding to your package, and then follow this link:
https://api.soax.com/api/get-country-isp?api_key=<api_key>&package_key=<package_key>&country_iso=<country_iso>[®ion=<region_name>[&city=<city_name>]]
Please note that this method is available only for packages with connection type "wifi".
API method for IP whitelisting
We have devoted a separate article to this method since this API block includes several methods at once.
Should you have any questions, feel free to contact us via chat or email at [email protected].