SOsoax
Packages
Locations

Get available cities for a region in a country for a package

List cities available in a country (optionally narrowed to a region) for this package. Use code values as the city parameter of the connection-string endpoint.

Requires the proxy:packages:read scope.

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

Request

Path parameters

package_idstring required

The package ID

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.

regionstring nullable

Narrow results to one region (use a code from the regions endpoint).

Response

Successful Response

Example response

{
  "data": [
    {
      "code": "NY",
      "name": "New York",
      "rank": 1,
      "volume_level": 3
    },
    {
      "code": "LA",
      "name": "Los Angeles",
      "rank": 2,
      "volume_level": 2
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.