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.
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.
Header | Status | Description |
---|---|---|
Authorization | required | Your bearer token retrieved from our authorization API, ex. Bearer eyJhbGci... |
Accept | required | The datatype to request, this API will return application/json . |
geog_id
GET v3/profiles/{geog_id}
Parameter | Status | Description |
---|---|---|
geog_id | required* | An identifier that we provide for you to request a specific profile (see the Specifying neighbourhoods section) |
lat
and lng
GET v3/profiles?lat={lat}&lng={lng}
Parameter | Status | Description |
---|---|---|
lat | required* | A decimal number between -90 and 90 , representing the latitude. |
lng | required* | A decimal number between -180 and 180 , representing the longitude. |
locale | optional | String value representing the language to return the profiles in. Available:en (English), fr (French) Default: en |
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)})
{"data": {"profiles": {"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","intro": "Ville-Marie is a neighbourhood within Montréal, Quebec.","name": "Ville-Marie"},"meta": {"sections": {"transport": "Transportation","services": "Services","character": "Character","housing": "Housing"}}}
Important: Make sure to display information under data.attributes.*
as HTML
.
Use this endpoint to retrieve the Local Profiles of a specific location using an identifier.
GET /profiles/{geog_id}
Parameter | Status | Description |
---|---|---|
geog_id | required | An identifier that we provide for you to request a specific profile (see the Specifying neighbourhoods section) |
Parameter | Status | Description |
---|---|---|
key | required | The ApiKey provided for you |
locale | optional | String value representing the language to return the profiles in. Available:en (English), fr (French) Default: en |
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})
{"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
.