Skip to main content
All CollectionsSoftware tutorials API
Getting a list of regions
Getting a list of regions
Kate avatar
Written by Kate
Updated over a year ago

To get a list of available regions, paste the following link into the address bar, replacing all <variables> (don't forget to delete the following symbols: "< ", ">") 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, which you can find on the Profile page in your Dashboard;

  • <package-key> - the key (login) of the package being used;

  • <country_iso> is the ISO code of your target country. Please note that
    ISO country codes should be in lowercase.
    For example, if you want to get a list of the available regions of the USA, you need to substitute it with us;

  • <conn_type> is the connection type you're using and must equal mobile/wifi.

    • If your package provides Wi-Fi (residential) IPs, <conn_type> can only be wifi.

    • If your package provides mobile IPs, <conn_type> can only be mobile;

  • <provider_name> is optional.

If you have any questions, feel free to contact us via chat or email at [email protected] 👩‍💻👨‍💻

Did this answer your question?