Get available regions for a country in a package

List regions available in a country for this package. rank orders locations by available pool size (1 = largest) and volume_level is a coarse 1–3 indicator of relative IP volume (3 = highest, 1 = lowest). Use code values as the region parameter of the connection-string endpoint.

Requires the proxy:packages:read scope.

get/v1/proxy/packages/{package_id}/locations/countries/{cc}/regions

Request

Base URL
https://api.platform.soax.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/soax/apis/soax-api/docs/v1/proxy/packages/:package_id/locations/countries/:cc/regions/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

package_idstring required

The package's ID. To find it, open the package in Packages and expand the header, or call List packages.

ccstring required

The country code

Query parameters

network'wifi' | 'mobile' | 'mix' nullable

Filter by network type. Valid values are the package's own types (wifi, mobile, or mix); anything else returns 400 listing the networks available on the package.

Response

Successful Response

Example response

{
  "data": [
    {
      "code": "ca",
      "name": "California",
      "rank": 1,
      "volume_level": 3
    },
    {
      "code": "tx",
      "name": "Texas",
      "rank": 2,
      "volume_level": 2
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.