Geography

Zone by ID

Returns the details of a specific zone (neighborhood or sub-area) identified by its internal numeric ID.

get/zones/{id}

Request

  • Base URL
    https://api-dev.despegar.com/v3
  • URL
    https://api-dev.despegar.com/v3/zones/{id}
  • Auth
    API key in header x-apikey

Path parameters

idstring required

Internal numeric identifier of the zone. E.g.: 183179.

Query parameters

productstring required

Product type used to filter configurations. E.g.: HOTELS, FLIGHTS.

languagestring required

Comma-separated list of language codes for the descriptions field. E.g.: ES,PT,EN.

ratiostring

Aspect ratio for pictures, if available. E.g.: 4:3, 16:9.

Response

OK

idstring

Internal numeric identifier of the zone.

gidstring

Global identifier combining type and id. E.g.: ZON_183179.

typestring

Zone classification type. E.g.: NEIGHBOURHOOD.

descriptionsobject

Localized zone names keyed by language code.

aliasesstring[]

List of alternative names for the zone. Not always present.

city_idstring

Internal numeric identifier of the city this zone belongs to.

city_gidstring

Global identifier of the city. E.g.: CIT_982.

relevanceinteger

Relevance score used to rank zones.

providerstring

Source of the zone data. E.g.: DESPEGAR. Not always present.

configurationsstring[]

List of product and platform configurations in which this zone is available.

picturesobject[]

List of pictures associated with the zone. Always empty.

last_update_datestring date-time

Date and time of the last update to this record.

Changes

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