Skip to content

Neighborhood Profiles

Stable
Available in the US and Canada

GET /profiles/{geog_id}

Use this endpoint to retrieve the Local Profiles of a specific location using an identifier.

GET /profiles/{geog_id}

Path Request Parameters

ParameterStatusDescription
geog_idrequiredAn identifier that we provide for you to request a specific profile (see the Specifying neighbourhoods section)

QueryString Request Parameters

ParameterStatusDescription
keyrequiredThe ApiKey provided for you
localeoptionalString value representing the language to return the profiles in.
Available:en (English), fr (French)
Default: en

NodeJS example

require('request')({
method: 'GET',
url: 'https://api.locallogic.co/v1/profiles/g20_f25dyhf3',
qs: {
key: 'YOUR_API_KEY',
locale: 'en',
}
}, function (err, response, body) {
// See response example
})

200 - Response example

{
"data": {
"attributes": {
"transport": "This part of the city is a very pleasant part of Montréal for cyclists and pedestrians. Cycling is convenient in Ville-Marie because there...",
"services": "In Ville-Marie, families will typically be able to reach daycares and schools on foot. In addition to public schools, there are private elementary and...",
"character": "Ville-Marie offers a variety of experiences for home buyers who enjoy a vibrant atmosphere and spending time in green spaces. There are a large number of vibrant spots in this area to explore..."
},
"id": "g20_f25dyhf3"
},
"meta": {
"name": "Ville-Marie",
"intro": "Ville-Marie is a neighbourhood within Montréal, Quebec.",
"sections": {
"transport": "Transportation",
"services": "Services",
"character": "Character",
"housing": "Housing"
},
"geometry": [[45.51579,-73.59027],[45.51629,-73.58981],[45.51678,-73.58938],[45.51629,-73.58825],[45.51556,-73.58662],[45.51556,-73.58662],[45.51361,-73.58243],[45.51247,-73.58019],[45.51216,-73.57961],[45.51182,-73.57921],[45.51135,-73.57857],[45.51086,-73.57815],[45.5103,-73.5785],[45.50989,-73.57899],[45.50931,-73.57954],[45.5082,-73.58013]]
}
}

Important: Make sure to display information under data.attributes.* as HTML.

GET /geographies

Use this endpoint to retrieve the names and IDs of geographies (e.g. neighbourhoods, cities) associated with a specific location (lat/lng). The geography IDs (e.g. g10_f25dyhcn) in the returned dictionary can be used to query the Local Profiles by geog_id.

GET /geographies

QueryString Request Parameters

ParameterStatusDescription
latrequiredA decimal number between -90 and 90 (Latitude)
lngrequiredA decimal number between -180 and 180 (Longitude)
keyrequiredThe API Key provided for you

NodeJS example

require('request')({
method: 'GET',
url: 'https://api.locallogic.co/v1/geographies',
qs: {
lat: 45.5017,
lng: -73.5656,
key: 'YOUR_API_KEY'
}
}, function (err, response, body) {
// See response example
})

200 - Response example

{
"data": {
"attributes": {
"g10_f25dyhcn": {
"name": {
"fr": "Le Faubourg Saint-Laurent",
"en": "Le Faubourg Saint-Laurent"
},
"level_type": {
"fr": "quartier",
"en": "neighbourhood"
},
"level": 10
},
"g20_f25dyhf3": {
"name": {
"en": "Ville-Marie",
"fr": "Ville-Marie"
},
"level_type": {
"en": "borough",
"fr": "arrondissement"
},
"level": 20
},
"g30_f25dfkes": {
"name": {
"en": "Montréal",
"fr": "Montréal"
},
"level_type": {
"en": "city",
"fr": "ville"
},
"level": 30
}
}
},
"meta": {
"order": [
"g10_f25dyhcn",
"g20_f25dyhf3",
"g30_f25dfkes"
]
}
}