Skip to content

Local Profiles

Stable
Available in the US and Canada

GET v3/profiles

Use this endpoint to retrieve the Local Profiles of a specific location using an identifier. Local Profiles can be retrieved by supplying the specific geog_id, or by supplying a lat and lng coordinate pair as arguments. See below for examples.

V3 Header Request Parameters

This API uses JWT token based authentication. This JWT Bearer token is what is used to populate the Authorization header below.

Instructions on how to retrieve this token can be found at Accessing the API → V3 API Authorization.

HeaderStatusDescription
AuthorizationrequiredYour bearer token retrieved from our authorization API, ex. Bearer eyJhbGci...
AcceptrequiredThe datatype to request, this API will return application/json.

V3 Calling with a geog_id

GET v3/profiles/{geog_id}
ParameterStatusDescription
geog_idrequired*An identifier that we provide for you to request a specific profile (see the Specifying neighbourhoods section). Accepted values are g10_*, g20_* and g30_*. Other values will result with a 404 (not found) status code.

V3 Calling with lat and lng

GET v3/profiles?lat={lat}&lng={lng}
ParameterStatusDescription
latrequired*A decimal number between -90 and 90, representing the latitude.
lngrequired*A decimal number between -180 and 180, representing the longitude.
localeoptionalString value representing the language to return the profiles in.
Available:en (English), fr (French)
Default: en
* If a geog_id path parameter is provided, the lat and lng arguments are optional, and vice versa.

V3 NodeJS example

require('node-fetch')('https://api.locallogic.co/v3/profiles/g20_f25dyhf3?' + new URLSearchParams({
locale: 'en',
}), {
method: 'GET',
headers: {
Accept: 'application/json',
Authorization: 'Bearer eyJhbGciOiJ...'
}
})
.then(response => response.json())
.then(body => {
console.log(body)
})
.catch(error => {
console.log(error)
})

V3 200 - Response example

{
"data": {
"bounding_box": {
"east": -73.51738361127795,
"north": 45.53938230417042,
"south": 45.48710983364872,
"west": -73.60695342963047
},
"centroid": {
"lat": 45.5097221239011,
"lng": -73.56099384933795
},
"id": "g20_f25dyhf3",
"intro": "The borough of Ville-Marie can be found in the city of Montréal, Quebec, which is situated in the Greater Montreal metropolitan area.",
"name": "Ville-Marie",
"profiles": {
"character": "Ville-Marie is a great part of Montréal for home buyers who enjoy both indoor and outdoor activities. Finding things to do is very easy in this area. There is a broad selection of entertainment venues, the streets are very often busy with people, and with its over 100 nightlife venues, there are options for nighttime activities. Rue Saint-Paul is among the most lively streets in this area. There is a good amount of greenery in this part of Montréal; it is very easy to get to green spaces in the borough since there are over 50 of them close by for residents to visit. In addition, residents will find that the majority of streets have reasonably good tree coverage.",
"housing": "In Ville-Marie, most dwellings are large apartment buildings, while small apartment buildings are also present in the housing stock. Around 30% of homes in this borough were constructed pre-1960, while many of the remaining buildings were built in the 1960s and the 1980s. This part of Montréal offers mainly two bedroom and one bedroom homes. Renters occupy roughly 70% of the dwellings in Ville-Marie and owners occupy the remainder.",
"services": "Both general and specialty grocery stores are usually accessible within a short walk from anywhere in this part of the city. There are over 100 supermarkets in Ville-Marie, and the best selection can be found on streets such as Avenue du Parc. Moreover, thanks to 1000-odd restaurants and cafes in Ville-Marie, there is typically a place to get a meal or beverage just around the corner. Residents benefit from a very large number of nearby clothing stores. With respect to education, in Ville-Marie, parents and their kids will usually be able to access schools and daycares by walking.",
"summary": "Ville-Marie in Montréal, Quebec is a vibrant neighborhood that offers easy access to public transportation, a plethora of diverse dining options, and convenient grocery and shopping locations. The area is also known for its bike-friendly infrastructure and plenty of green spaces for outdoor activities. With a bustling nightlife and a variety of entertainment venues, residents can easily find things to do. The housing stock primarily consists of large apartment buildings, offering a range of options for renters and owners. Ville-Marie is perfect for those seeking a lively and accessible neighborhood with a rich urban atmosphere.",
"transport": "Regardless of the means of transportation, it is very simple to move around in Ville-Marie. The great public transit access makes transit a viable option for many due to plenty of nearby rapid transit stations with access to the Orange Line, Green Line and Yellow Line, and over 50 nearby bus lines. Physically active home buyers will also be pleased with the very walk-friendly nature of this area; running common errands is very convenient, and various businesses are reasonably nearby. Ville-Marie is bicycling-friendly since the bicycling network is quite extensive, and bike-share stations are hardly ever more than a short walk away."
},
"type": "profiles"
},
"meta": {
"geometry": [],
"sections": {
"character": "Character",
"housing": "Housing",
"services": "Services",
"summary": "Summary",
"transport": "Transportation"
}
}
}

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

GET v1/profiles/{geog_id}

⚠️ The v1/profiles API is deprecated.

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

GET /profiles/{geog_id}

V1 Path Request Parameters

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

V1 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

V1 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
})

V1 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"
}
}
}

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

© Local Logic 2024