Location Snapshot

StableOffert en anglais seulementÉ.-U. 🇺🇸 et Canada 🇨🇦

Description

Requête pour obtenir un instantané de l'emplacement : une vue agrégée des données Local Logic autour d'un emplacement donné. Ce point de terminaison fournit quatre ensembles de renseignements Local Logic autour d'une latitude et d'une longitude données :

Les données Demographics autour de l'emplacement fourni
Le nombre de Points of Interest par catégorie autour de l'emplacement fourni
Les Location Scores de Local Logic autour de l'emplacement fourni
Les mesures Local Logic autour de l'emplacement fourni, qui comprennent des calculs d'accès, de distance, de bruit et de qualité. Par exemple :
- Proximité de l'épicerie générale la plus près
- Accès aux cafés
- Bruit de la circulation
- Désagrément de l'infrastructure pour les piétons

GET `/v3/data`

Les données démographiques, le nombre de POI, les scores de localisation et les mesures Local Logic demandés peuvent être récupérés pour un emplacement précis à l'aide de cette requête.

GET /v3/data

Cette API utilise l'authentification par jeton JWT. Ce jeton porteur (Bearer) JWT est ce qui est utilisé pour remplir l'en-tête Authorization ci-dessous.

Les instructions pour récupérer ce jeton se trouvent dans Premiers pas.

En-tête	Statut	Description
Authorization	requis	Votre jeton porteur récupéré depuis notre API d'autorisation, ex. `Bearer eyJhbGci...`
Accept	requis	Le type de données demandé; cette API retournera `application/json`.

Chaîne de requête

La région interrogée par le point de terminaison doit être définie en spécifiant une coordonnée lat/lng, avec des paramètres radius/radius_unit optionnels.

Les mesures et les cotes seront données pour l'emplacement exact fourni avec les coordonnées lat/lng. Lorsque les paramètres radius/radius_unit ne sont pas fournis, le point de terminaison retournera les données démographiques dans un rayon de 500 m et le nombre de points d'intérêt dans un rayon de 5 km.

Lorsque vous incluez les paramètres radius/radius_unit, la zone circulaire résultante autour de la coordonnée lat/lng sera interrogée. radius_unit peut être soit meter, soit mile.

Paramètre	Statut	Description
include	requis	Chaînes séparées par des virgules représentant les données à retourner. Les valeurs acceptées sont `demographics`, `measures_all`, `pois_count`, et `scores_all`.
lat	requis	Un nombre décimal entre `-90` et `90` (latitude)
lng	requis	Un nombre décimal entre `-180` et `180` (longitude)
radius	optionnel	Un nombre décimal positif (rayon du cercle)
radius_unit	optionnel	Le type d'unité du rayon. Disponible : `meter`, `mile`. Par défaut : `meter`

Exemples d'utilisation

NodeJS
Python

require('node-fetch')('https://api.locallogic.co/v3/data?' + new URLSearchParams({
    lat: 41.847206,
    lng: -87.668825,
    include: 'demographics,scores_all,measures_all,pois_count'
}), {
    method: 'GET',
    headers: {
        Accept: 'application/json',
        Authorization: 'Bearer eyJhbGciOiJ...'
    }
})
    .then(response => response.json())
    .then(body => {
        console.log(body)
    })
    .catch(error => {
        console.log(error)
    })

import requests

response = requests.get(
"https://api.locallogic.co/v3/data",
headers={
    "Accept": "application/json",
    "Authorization": "Bearer eyJhbGciOiJ..."},
params={
    "lat": 43.593611,
    "lng": -79.536194,
    "include": "demographics,scores_all,measures_all,pois_count"
}
)

print(response.json())
# Voir l'exemple de réponse ci-dessous

Exemple de réponse

{
    "data": {
        "demographics": {
            "commute_mode": {
                "type": "percent",
                "variables": [
                    {
                        "variable": "cmtr_transt",
                        "value": 0,
                        "label": "Transit"
                    },
                    ...
                ],
                "label": "Commute mode"
            },
            "population_total": {
                ...
            },
            ...
        },
        "scores": {
            "high_schools": "0.06532",
            "primary_schools": "3.75381",
            ...
        },
        "pois": {
            "counts": {
                "total_count": 1927,
                "total_by_category": {
                    "libraries": 4,
                    "alcohol": 33,
                    "shops_and_services": 1740,
                    "home_improvement": 18,
                    ...
                }
            }
        },
        "measures": {
            "nearest_general_grocery_store_proximity": 4.68047,
            "nearest_fitness_establishment_proximity": 4.89759,
            "nearest_clothing_and_accessory_store_proximity": 4.89759,
            "coffee_shop_access": 2.12512,
            ...
        }
    },
    "meta": {
        "message": "Successfully called v3/data API.",
        "type": "LocalLogic.API.Success",
        "statusCode": 200
    }
}

Dans l'exemple de données retournées ci-dessus, chacune des quatre composantes de la réponse Data est fournie :

Les données Demographics dépendent des attributs disponibles par pays. Consultez cette page de documentation pour plus d'information sur les réponses.
Les Location Scores de Local Logic autour de l'emplacement fourni. Tous les scores disponibles pour l'emplacement sont fournies sur une échelle de 0 à 5, sans arrondissement.
Le nombre de Points of Interest par catégorie autour de l'emplacement fourni, incluant le nombre total de POI. Si plus de détails sur les POI sont requis, les utilisateurs devront appeler directement l'un de nos points de terminaison POI avec un accès approprié.
Les mesures Local Logic autour de l'emplacement fourni

Mesures Local Logic

Les mesures Local Logic sont utilisées pour quantifier les caractéristiques d'un emplacement à un niveau plus granulaire que les scores de localisation. Voici une liste de toutes les mesures qui peuvent être retournées par le point de terminaison Data :

Mesure	Description
`bus_service_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux arrêts d'autobus urbains depuis cet emplacement, pondérée par la fréquence de passage des autobus. Des valeurs plus élevées indiquent qu'il y a plus d'arrêts d'autobus accessibles, qu'ils sont plus près, et que la fréquence des autobus est plus élevée.
`shops_and_services_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux commerces et services depuis cet emplacement. Des valeurs plus élevées indiquent qu'il y a plus de commerces et services accessibles, et qu'ils sont plus près.
`coffee_shop_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux cafés depuis cet emplacement. Des valeurs plus élevées indiquent qu'il y a plus de cafés accessibles, et qu'ils sont plus près.
`casino_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux casinos depuis cet emplacement. Des valeurs plus élevées indiquent qu'il y a plus de casinos accessibles, et qu'ils sont plus près.
`clothing_and_accessory_store_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux magasins de vêtements et d'accessoires depuis cet emplacement. Des valeurs plus élevées indiquent qu'il y a plus de magasins de vêtements et d'accessoires accessibles, et qu'ils sont plus près.
`common_needs_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux besoins courants depuis cet emplacement. Des valeurs plus élevées indiquent qu'il y a plus de besoins courants accessibles, et qu'ils sont plus près. Les besoins courants comprennent les salons de coiffure, les quincailleries, les magasins d'alcool, les banques, les bureaux de poste, les dépanneurs et les services de buanderie. Les épiceries et les pharmacies font l'objet de mesures distinctes.
`department_store_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux grands magasins depuis cet emplacement. Des valeurs plus élevées indiquent qu'il y a plus de grands magasins accessibles, et qu'ils sont plus près.
`entertainment_venue_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux lieux de divertissement depuis cet emplacement. Des valeurs plus élevées indiquent qu'il y a plus de lieux de divertissement accessibles, et qu'ils sont plus près. Les lieux de divertissement comprennent les salles de spectacle, les théâtres, les cinémas et les salles d'arts de la scène.
`fitness_establishment_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux établissements de conditionnement physique depuis cet emplacement. Des valeurs plus élevées indiquent qu'il y a plus d'établissements de conditionnement physique accessibles, et qu'ils sont plus près. Les établissements de conditionnement physique comprennent les gyms, les studios de yoga et les piscines.
`healthy_restaurant_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux restaurants santé depuis cet emplacement. Des valeurs plus élevées indiquent qu'il y a plus de restaurants santé accessibles, et qu'ils sont plus près.
`nightlife_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès à la vie nocturne depuis cet emplacement. Des valeurs plus élevées indiquent qu'il y a plus d'établissements de vie nocturne accessibles, et qu'ils sont plus près. La vie nocturne comprend les bars, les pubs, les clubs d'humour et les boîtes de nuit.
`park_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux parcs depuis cet emplacement. Des valeurs plus élevées indiquent qu'il y a plus de parcs accessibles, et qu'ils sont plus près.
`park_access_weighted_by_area`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux parcs depuis cet emplacement, pondérée par leur superficie. Des valeurs plus élevées indiquent qu'il y a plus de parcs accessibles, qu'ils sont plus près, et qu'ils sont plus grands en superficie.
`pedestrian_oriented_street_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux rues commerciales orientées vers les piétons depuis cet emplacement. Des valeurs plus élevées indiquent qu'il y a plus de rues commerciales accessibles, qu'elles sont plus près, et qu'elles comptent plus de commerces et de services.
`rapid_transit_service_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux stations de transport rapide depuis cet emplacement, pondérée par la fréquence de leur service. Des valeurs plus élevées indiquent qu'il y a plus de stations accessibles, qu'elles sont plus près, et que la fréquence de service est plus élevée.
`restaurant_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux restaurants depuis cet emplacement. Des valeurs plus élevées indiquent qu'il y a plus de restaurants accessibles, et qu'ils sont plus près.
`specialty_grocery_store_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux épiceries spécialisées depuis cet emplacement. Des valeurs plus élevées indiquent qu'il y a plus d'épiceries spécialisées accessibles, et qu'elles sont plus près.
`sports_facility_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux installations sportives depuis cet emplacement. Des valeurs plus élevées indiquent qu'il y a plus d'installations sportives accessibles, et qu'elles sont plus près. Les installations sportives comprennent les terrains de soccer, les pistes de course, les terrains de baseball, les patinoires, et ainsi de suite.
`train_service_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux gares depuis cet emplacement, pondérée par la fréquence de leur service. Des valeurs plus élevées indiquent qu'il y a plus de gares accessibles, qu'elles sont plus près, et que la fréquence de service est plus élevée.
`unhealthy_restaurant_access`	Une mesure, sur une échelle de 0 à 5, de la facilité d'accès aux restaurants malsains depuis cet emplacement. Des valeurs plus élevées indiquent qu'il y a plus de restaurants malsains accessibles, et qu'ils sont plus près.
`nearest_bus_stop_proximity`	Une mesure, sur une échelle de 0 à 5, de la proximité de l'arrêt d'autobus le plus près. Des valeurs plus élevées indiquent qu'il est plus près.
`nearest_coffee_shop_proximity`	Une mesure, sur une échelle de 0 à 5, de la proximité du café le plus près. Des valeurs plus élevées indiquent qu'il est plus près.
`nearest_clothing_and_accessory_store_proximity`	Une mesure, sur une échelle de 0 à 5, de la proximité du magasin de vêtements et d'accessoires le plus près. Des valeurs plus élevées indiquent qu'il est plus près.
`nearest_fitness_establishment_proximity`	Une mesure, sur une échelle de 0 à 5, de la proximité de l'établissement de conditionnement physique le plus près. Des valeurs plus élevées indiquent qu'il est plus près.
`nearest_general_grocery_store_proximity`	Une mesure, sur une échelle de 0 à 5, de la proximité de l'épicerie générale la plus près. Des valeurs plus élevées indiquent qu'elle est plus près. Les épiceries générales comprennent les supermarchés et les autres magasins qui vendent un large éventail d'aliments.
`nearest_healthy_restaurant_proximity`	Une mesure, sur une échelle de 0 à 5, de la proximité du restaurant santé le plus près. Des valeurs plus élevées indiquent qu'il est plus près.
`nearest_highway_proximity`	Une mesure, sur une échelle de 0 à 5, de la proximité de l'entrée d'autoroute la plus près. Des valeurs plus élevées indiquent qu'elle est plus près.
`nearest_nightlife_proximity`	Une mesure, sur une échelle de 0 à 5, de la proximité de l'établissement de vie nocturne le plus près. Des valeurs plus élevées indiquent qu'il est plus près.
`nearest_park_proximity`	Une mesure, sur une échelle de 0 à 5, de la proximité du parc le plus près. Des valeurs plus élevées indiquent qu'il est plus près.
`nearest_pharmacy_proximity`	Une mesure, sur une échelle de 0 à 5, de la proximité de la pharmacie la plus près. Des valeurs plus élevées indiquent qu'elle est plus près.
`nearest_rapid_transit_station_proximity`	Une mesure, sur une échelle de 0 à 5, de la proximité de la station de transport rapide la plus près. Des valeurs plus élevées indiquent qu'elle est plus près.
`nearest_restaurant_proximity`	Une mesure, sur une échelle de 0 à 5, de la proximité du restaurant le plus près. Des valeurs plus élevées indiquent qu'il est plus près.
`nearest_sports_facility_proximity`	Une mesure, sur une échelle de 0 à 5, de la proximité de l'installation sportive la plus près. Des valeurs plus élevées indiquent qu'elle est plus près.
`nearest_train_station_proximity`	Une mesure, sur une échelle de 0 à 5, de la proximité de la gare la plus près. Des valeurs plus élevées indiquent qu'elle est plus près.
`nearest_unhealthy_restaurant_proximity`	Une mesure, sur une échelle de 0 à 5, de la proximité du restaurant malsain le plus près. Des valeurs plus élevées indiquent qu'il est plus près.
`nearest_bicycle_share_station_proximity`	Une mesure, sur une échelle de 0 à 5, de la proximité de la station de vélopartage la plus près. Des valeurs plus élevées indiquent qu'elle est plus près.
`airport_noise`	Une mesure, sur une échelle de 0 à 5, du bruit provenant des aéroports à cet emplacement.
`interchange_noise`	Une mesure, sur une échelle de 0 à 5, du bruit provenant des échangeurs autoroutiers à cet emplacement.
`railway_noise`	Une mesure, sur une échelle de 0 à 5, du bruit provenant des chemins de fer à cet emplacement.
`traffic_noise`	Une mesure, sur une échelle de 0 à 5, du bruit provenant de la circulation à cet emplacement.
`terrain_steepness`	Une mesure, sur une échelle de 0 à 5, de l'inclinaison du terrain dans un rayon de 1 km.
`street_steepness`	Une mesure, sur une échelle de 0 à 5, de l'inclinaison de la rue à cet emplacement.
`intersection_density`	Une mesure, sur une échelle de 0 à 5, du nombre d'intersections de rues par unité de superficie. Des valeurs plus élevées indiquent une densité d'intersections plus élevée et, inversement, des pâtés de maisons plus petits.
`local_street_proportion`	Une mesure, sur une échelle de 0 à 5, de la proportion de rues dans un rayon de 1 km qui sont locales, par opposition aux autoroutes ou aux artères.
`infrastructure_unpleasant_for_pedestrians`	Une mesure, sur une échelle de 0 à 5, de la quantité d'infrastructures à proximité qui sont désagréables pour les piétons. Cela comprend les autoroutes et les chemins de fer.

Codes de réponse

Lorsque vous appelez l'API de Local Logic, vous pouvez recevoir un code de réponse HTTP indiquant une erreur ou une absence de données. Ces erreurs sont expliquées ci-dessous.

En général, les codes d'erreur commençant par « 4 » sont dus à un appel d'API invalide et peuvent être corrigés de votre côté, alors que les codes d'erreur commençant par « 5 » sont dus à des erreurs de serveur (c'est-à-dire des problèmes de notre côté). Si vous recevez quelque chose qui n'est pas décrit ici, veuillez communiquer avec nous à support@locallogic.co.

204 - No Content

Ce « code d'erreur » n'en est pas un et se produit lorsque nous n'avons pas les données requises pour un emplacement précis. Par exemple, si vous envoyez une paire lat/lng pour obtenir des scores dans des régions inhabitées du nord du Canada, nous pouvons retourner une réponse 204 vide, car nous reconnaissons l'emplacement, mais nous ne calculons pas de scores dans des endroits aussi éloignés, donc il n'y a rien à retourner.

400 - BadRequest

Ce code d'erreur se produit lorsque les données saisies dans la requête sont incorrectes. Utilisez le champ detail de la réponse pour obtenir des précisions. Exemple :

{
  "code": "LocalLogic.API.BadRequest",
  "detail": "ValidationErrors: AroundEndpoint is invalid:\n\tinclude is invalid: \"bad_input\" is not an acceptable value: \"groceries\", \"restaurants\", \"nightlife\", \"cafes\", \"shopping\", \"daycares\", \"primary_schools\", \"high_schools\""
}

401 - Unauthorized

Ce code d'erreur se produit lorsque votre clé API ne peut pas accéder à certaines ressources ou à certains emplacements. Par exemple, certaines clés API ne peuvent accéder qu'à certains pays, états ou provinces. N'hésitez pas à communiquer avec nous pour plus d'information.

{
  "code": "LocalLogic.API.Unauthorized",
  "detail": "Your API KEY doesn't support this region"
}

403 - Forbidden

Ce code d'erreur se produit lorsque vous avez oublié d'inclure les identifiants de sécurité dans votre requête ou lorsque vous demandez un paramètre auquel vous n'avez pas accès.

{
  "message": "Forbidden"
}

404 - NotFound

Ce code d'erreur se produit lorsque nous n'avons pas de données pour l'emplacement demandé. Par exemple, si vous envoyez une paire lat/lng pour un emplacement en Antarctique, nous retournerons cette erreur, car nous n'avons pas (encore!) de données pour l'Antarctique.

{
  "code": "LocalLogic.API.NotFound",
  "detail": "No Location Scores found for this location."
}

422 - Unprocessable Entity

Ce code d'erreur est retourné lorsque les bons paramètres ont été envoyés, mais que les données qu'ils contiennent ne sont pas valides. Par exemple, si vous envoyez une paire lat/lng et que la latitude est invalide (c.-à-d. hors de la plage [-90, 90]) ou que la longitude est invalide (c.-à-d. hors de la plage [-180, 180]). Le message retourné expliquera le problème précis avec vos paramètres qui les rend invalides.

{
  "message": "Latitude must be within [-90, 90], Longitude must be within [-180, 180], Requires at least lat/lng pair, or geography_ids. None supplied.",
  "code": "LocalLogic.API.BadRequest",
  "statusCode": 422
}

429 - Too Many Requests

Ce code d'erreur peut être retourné lorsque vous devez limiter le débit de vos requêtes. À l'interne, nous établissons des limites qui dépassent toutes les limites contractuelles pouvant entraîner le retour de ce code d'erreur. Si vous avez des questions ou si vous voyez cette erreur, veuillez communiquer avec nous à support@locallogic.co.

500 - ServerError

Ce code d'erreur signifie qu'une erreur s'est produite de notre côté. N'hésitez pas à réessayer la même requête pour voir si le problème persiste. Si vous recevez beaucoup de ces erreurs, veuillez communiquer avec nous à support@locallogic.co.

{
  "code": "LocalLogic.API.ServerError",
  "detail": "No Location Scores found for this location."
}

502 - BadGateway

Ce code d'erreur signifie qu'une erreur provient de notre fournisseur infonuagique. N'hésitez pas à réessayer la même requête pour voir si le problème persiste.

{
  "message": "Internal server error"
}

Description​

GET /v3/data​

En-tête​

Chaîne de requête​

Exemples d'utilisation​

Exemple de réponse​

Mesures Local Logic​

Codes de réponse​