Skip to content

PlacesNearbyAPI

Method HTTP request
getCoordLonLatPlacesNearby GET /coord/{lon};{lat}/places_nearby
getCoordsLonLatPlacesNearby GET /coords/{lon};{lat}/places_nearby
getCoverageLonLatPlacesNearby GET /coverage/{lon};{lat}/places_nearby
getCoverageLonLatUriPlacesNearby GET /coverage/{lon};{lat}/{uri}/places_nearby
getCoverageRegionPlacesNearby GET /coverage/{region}/places_nearby
getCoverageRegionUriPlacesNearby GET /coverage/{region}/{uri}/places_nearby

getCoordLonLatPlacesNearby

Parameters

Name Type Note
lat Double The latitude of where the coord you want to query
lon Double The longitude of where the coord you want to query
type [String] Type of the objects to return [optional] [default to [u'stop_area', u'stop_point', u'poi']] [enum: stop_point, poi, administrative_region, stop_area, address]
filter String Filter your objects [optional]
distance Int Distance range of the query in meters [optional] [default to 500]
count Int Elements per page [optional] [default to 10]
depth Int Maximum depth on objects [optional] [default to 1]
startPage Int The page number of the ptref result [optional]
bssStands Bool DEPRECATED, Use add_poi_infos[]=bss_stands [optional]
addPoiInfos [String] Show more information about the poi if it's available, for instance, show BSS/car park availability in the pois(BSS/car park) of the response [optional] [default to [u'bss_stands', u'car_park']] [enum: bss_stands, car_park, , none]
disableGeojson Bool remove geojson from the response [optional]
disableDisruption Bool remove disruptions from the response [optional]

Return

PlacesNearby

Example

Expert.shared.placesNearbyApi.getCoordLonLatPlacesNearby(
    lat: 3.4, 
    lon: 3.4, 
    type: ["[u'stop_area', u'stop_point', u'poi']"], 
    filter: "filter_example", 
    distance: 500, 
    count: 10, 
    depth: 1, 
    startPage: 56, 
    bssStands: true, 
    addPoiInfos: ["[u'bss_stands', u'car_park']"], 
    disableGeojson: true, 
    disableDisruption: true
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoordsLonLatPlacesNearby

Parameters

Name Type Note
lat Double The latitude of where the coord you want to query
lon Double The longitude of where the coord you want to query
type [String] Type of the objects to return [optional] [default to [u'stop_area', u'stop_point', u'poi']] [enum: stop_point, poi, administrative_region, stop_area, address]
filter String Filter your objects [optional]
distance Int Distance range of the query in meters [optional] [default to 500]
count Int Elements per page [optional] [default to 10]
depth Int Maximum depth on objects [optional] [default to 1]
startPage Int The page number of the ptref result [optional]
bssStands Bool DEPRECATED, Use add_poi_infos[]=bss_stands [optional]
addPoiInfos [String] Show more information about the poi if it's available, for instance, show BSS/car park availability in the pois(BSS/car park) of the response [optional] [default to [u'bss_stands', u'car_park']] [enum: bss_stands, car_park, , none]
disableGeojson Bool remove geojson from the response [optional]
disableDisruption Bool remove disruptions from the response [optional]

Return

PlacesNearby

Example

Expert.shared.placesNearbyApi.getCoordsLonLatPlacesNearby(
    lat: 3.4, 
    lon: 3.4, 
    type: ["[u'stop_area', u'stop_point', u'poi']"], 
    filter: "filter_example", 
    distance: 500, 
    count: 10, 
    depth: 1, 
    startPage: 56, 
    bssStands: true, 
    addPoiInfos: ["[u'bss_stands', u'car_park']"], 
    disableGeojson: true, 
    disableDisruption: true
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageLonLatPlacesNearby

Parameters

Name Type Note
lat Double The latitude of where the coord you want to query
lon Double The longitude of where the coord you want to query
type [String] Type of the objects to return [optional] [default to [u'stop_area', u'stop_point', u'poi']] [enum: stop_point, poi, administrative_region, stop_area, address]
filter String Filter your objects [optional]
distance Int Distance range of the query in meters [optional] [default to 500]
count Int Elements per page [optional] [default to 10]
depth Int Maximum depth on objects [optional] [default to 1]
startPage Int The page number of the ptref result [optional]
bssStands Bool DEPRECATED, Use add_poi_infos[]=bss_stands [optional]
addPoiInfos [String] Show more information about the poi if it's available, for instance, show BSS/car park availability in the pois(BSS/car park) of the response [optional] [default to [u'bss_stands', u'car_park']] [enum: bss_stands, car_park, , none]
disableGeojson Bool remove geojson from the response [optional]
disableDisruption Bool remove disruptions from the response [optional]

Return

PlacesNearby

Example

Expert.shared.placesNearbyApi.getCoverageLonLatPlacesNearby(
    lat: 3.4, 
    lon: 3.4, 
    type: ["[u'stop_area', u'stop_point', u'poi']"], 
    filter: "filter_example", 
    distance: 500, 
    count: 10, 
    depth: 1, 
    startPage: 56, 
    bssStands: true, 
    addPoiInfos: ["[u'bss_stands', u'car_park']"], 
    disableGeojson: true, 
    disableDisruption: true
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageLonLatUriPlacesNearby

Parameters

Name Type Note
lat Double The latitude of where the coord you want to query
lon Double The longitude of where the coord you want to query
uri String First part of the uri
type [String] Type of the objects to return [optional] [default to [u'stop_area', u'stop_point', u'poi']] [enum: stop_point, poi, administrative_region, stop_area, address]
filter String Filter your objects [optional]
distance Int Distance range of the query in meters [optional] [default to 500]
count Int Elements per page [optional] [default to 10]
depth Int Maximum depth on objects [optional] [default to 1]
startPage Int The page number of the ptref result [optional]
bssStands Bool DEPRECATED, Use add_poi_infos[]=bss_stands [optional]
addPoiInfos [String] Show more information about the poi if it's available, for instance, show BSS/car park availability in the pois(BSS/car park) of the response [optional] [default to [u'bss_stands', u'car_park']] [enum: bss_stands, car_park, , none]
disableGeojson Bool remove geojson from the response [optional]
disableDisruption Bool remove disruptions from the response [optional]

Return

PlacesNearby

Example

Expert.shared.placesNearbyApi.getCoverageLonLatUriPlacesNearby(
    lat: 3.4, 
    lon: 3.4, 
    uri: "uri_example", 
    type: ["[u'stop_area', u'stop_point', u'poi']"], 
    filter: "filter_example", 
    distance: 500, 
    count: 10, 
    depth: 1, 
    startPage: 56, 
    bssStands: true, 
    addPoiInfos: ["[u'bss_stands', u'car_park']"], 
    disableGeojson: true, 
    disableDisruption: true
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageRegionPlacesNearby

Parameters

Name Type Note
region String The region you want to query
type [String] Type of the objects to return [optional] [default to [u'stop_area', u'stop_point', u'poi']] [enum: stop_point, poi, administrative_region, stop_area, address]
filter String Filter your objects [optional]
distance Int Distance range of the query in meters [optional] [default to 500]
count Int Elements per page [optional] [default to 10]
depth Int Maximum depth on objects [optional] [default to 1]
startPage Int The page number of the ptref result [optional]
bssStands Bool DEPRECATED, Use add_poi_infos[]=bss_stands [optional]
addPoiInfos [String] Show more information about the poi if it's available, for instance, show BSS/car park availability in the pois(BSS/car park) of the response [optional] [default to [u'bss_stands', u'car_park']] [enum: bss_stands, car_park, , none]
disableGeojson Bool remove geojson from the response [optional]
disableDisruption Bool remove disruptions from the response [optional]

Return

PlacesNearby

Example

Expert.shared.placesNearbyApi.getCoverageRegionPlacesNearby(
    region: "region_example", 
    type: ["[u'stop_area', u'stop_point', u'poi']"], 
    filter: "filter_example", 
    distance: 500, 
    count: 10, 
    depth: 1, 
    startPage: 56, 
    bssStands: true, 
    addPoiInfos: ["[u'bss_stands', u'car_park']"], 
    disableGeojson: true, 
    disableDisruption: true
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageRegionUriPlacesNearby

Parameters

Name Type Note
region String The region you want to query
uri String First part of the uri
type [String] Type of the objects to return [optional] [default to [u'stop_area', u'stop_point', u'poi']] [enum: stop_point, poi, administrative_region, stop_area, address]
filter String Filter your objects [optional]
distance Int Distance range of the query in meters [optional] [default to 500]
count Int Elements per page [optional] [default to 10]
depth Int Maximum depth on objects [optional] [default to 1]
startPage Int The page number of the ptref result [optional]
bssStands Bool DEPRECATED, Use add_poi_infos[]=bss_stands [optional]
addPoiInfos [String] Show more information about the poi if it's available, for instance, show BSS/car park availability in the pois(BSS/car park) of the response [optional] [default to [u'bss_stands', u'car_park']] [enum: bss_stands, car_park, , none]
disableGeojson Bool remove geojson from the response [optional]
disableDisruption Bool remove disruptions from the response [optional]

Return

PlacesNearby

Example

Expert.shared.placesNearbyApi.getCoverageRegionUriPlacesNearby(
    region: "region_example", 
    uri: "uri_example", 
    type: ["[u'stop_area', u'stop_point', u'poi']"], 
    filter: "filter_example", 
    distance: 500, 
    count: 10, 
    depth: 1, 
    startPage: 56, 
    bssStands: true, 
    addPoiInfos: ["[u'bss_stands', u'car_park']"], 
    disableGeojson: true, 
    disableDisruption: true
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }