Skip to content
AlterEstate

Locations

Returns the countries’ cities and sectors (neighborhoods) available in AlterEstate. Use them in dynamic forms, search filters and when you create listings.

List cities

GEThttps://secure.alterestate.com/api/v1/cities/

Authentication

No authentication required.

Query parameters

countrynumberrequired
Country ID. See Supported countries below.Example: 149

Example request

GET
curl --request GET \
  --url 'https://secure.alterestate.com/api/v1/cities/?country=149' \
  --header 'Accept: application/json'

Example response

200 OK
[
  {
    "name": "Santo Domingo D.N.",
    "id": 156,
    "province": {
      "name": "Santo Domingo de Guzmán",
      "id": 31
    }
  },
  {
    "name": "Punta Cana",
    "id": 60,
    "province": {
      "name": "La Altagracia",
      "id": 13
    }
  },
  {
    "name": "Bávaro",
    "id": 59,
    "province": {
      "name": "La Altagracia",
      "id": 13
    }
  }
]

List sectors

GEThttps://secure.alterestate.com/api/v1/sectors/

Authentication

No authentication required.

Query parameters

citynumberrequired
City ID returned by List cities.Example: 156

Example request

GET
curl --request GET \
  --url 'https://secure.alterestate.com/api/v1/sectors/?city=156' \
  --header 'Accept: application/json'

Example response

200 OK
[
  {
    "name": "24 De Abril",
    "id": 2350,
    "city": "Santo Domingo D.N.",
    "province": {
      "name": "Santo Domingo de Guzmán",
      "id": 31
    }
  },
  {
    "name": "Altos De Arroyo Hondo",
    "id": 1669,
    "city": "Santo Domingo D.N.",
    "province": {
      "name": "Santo Domingo de Guzmán",
      "id": 31
    }
  },
  {
    "name": "Altos De Arroyo Hondo II",
    "id": 87530,
    "city": "Santo Domingo D.N.",
    "province": {
      "name": "Santo Domingo de Guzmán",
      "id": 31
    }
  }
]

Supported countries

CountryID
Dominican Republic149
Panama60
Colombia198
Guatemala199
Chile201
Ecuador202
Mexico203
Peru208
United States209
Puerto Rico212

Notes

  • Locations is read-only and does not require authentication.
  • Cities and sectors change rarely. Cache them and refresh periodically, or load them on demand.
  • Use the city and sector IDs in List properties filters and when you create a property.

Frequently asked questions

Does the AlterEstate Locations API require authentication?

No. GET /api/v1/cities/ and GET /api/v1/sectors/ are public and read-only.

What is the country ID for the Dominican Republic?

149. Mexico is 203, Colombia is 198 and Panama is 60.

Last updated . Questions? Emailengineering@alterestate.com.