Skip to main content

Value Drivers

StableOnly available in EnglishUS 🇺🇸 and Canada 🇨🇦

Description​

Query for the top features that make locations within a neighborhood valuable based on Local Logic measures and scores. The value drivers are calculated derived from Local Logic's valuation engine as applied across different asset classes across entire neighborhoods.

The results from the endpoint include an ordered list of the following values:

  • Local Local Measures, as the name of the value driver
  • Values, representing the numeric value of the measure
  • Value Qualifiers (Low, Med, High) representing which tertile the measure's value falls into within the surrounding area ("Is the coffee shop access for this neighborhood low, medium, or high compared to other nearby neighborhoods?")
  • Weight, a measure of the impact of each measure in that neighborhood on property values. A higher absolute value of weight means a higher impact, and a negative weight means the measure tends to lower property values in the neighborhood.

GET v3/value-drivers/{geog_id}​

Accepted values for geog_id are g10_*, g20_*, g30_*, g32_*, g35_*, and g37_*. Other values will result with a 404 (not found) status code. Some geographies will not have value drivers due to significantly low population density.

GET v3/value-drivers/{geog_id}

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 Getting Started.

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

QueryString​

ParameterStatusDescription
limitoptionalThe limit of value drivers to fetch. -1 means no limit.

Usage examples​

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

Response example​

{
  "data": {
    "meta": {
      "message": "This is a Beta endpoint. Its interface can change without notice."
    },
    "value_drivers": [
      {
        "name": "FITNESS_ESTABLISHMENT_ACCESS",
        "value": 4.401399,
        "value_qualifier": "HIGH",
        "weight": 0.000741
      },
      {
        "name": "COFFEE_SHOP_ACCESS",
        "value": 3.179949,
        "value_qualifier": "HIGH",
        "weight": 0.000689
      },
      {
        "name": "NIGHTLIFE_ACCESS",
        "value": 3.12326,
        "value_qualifier": "HIGH",
        "weight": 0.000631
      },
      {
        "name": "PEDESTRIAN_ORIENTED_STREET_ACCESS",
        "value": 3.805161,
        "value_qualifier": "HIGH",
        "weight": 0.000531
      },
      {
        "name": "RAPID_TRANSIT_SERVICE_ACCESS",
        "value": 3.558977,
        "value_qualifier": "HIGH",
        "weight": 0.000515
      },
      {
        "name": "BUS_SERVICE_ACCESS",
        "value": 3.91037,
        "value_qualifier": "HIGH",
        "weight": 0.000426
      },
      {
        "name": "PARKS",
        "value": 4.820454,
        "value_qualifier": "HIGH",
        "weight": 0.000308
      },
      {
        "name": "CLOTHING_AND_ACCESSORY_STORE_ACCESS",
        "value": 3.218212,
        "value_qualifier": "HIGH",
        "weight": 0.000306
      },
      {
        "name": "ENTERTAINMENT_VENUE_ACCESS",
        "value": 2.691957,
        "value_qualifier": "HIGH",
        "weight": 0.000209
      },
      {
        "name": "NEAREST_PHARMACY_PROXIMITY",
        "value": 3.319748,
        "value_qualifier": "LOW",
        "weight": 0.000195
      },
      {
        "name": "SPORTS_FACILITY_ACCESS",
        "value": 3.690975,
        "value_qualifier": "HIGH",
        "weight": 0.000146
      },
      {
        "name": "RESTAURANT_ACCESS",
        "value": 3.94121,
        "value_qualifier": "HIGH",
        "weight": 0.000112
      },
      {
        "name": "DEPARTMENT_STORE_ACCESS",
        "value": 3.311129,
        "value_qualifier": "MED",
        "weight": 5.1e-05
      },
      {
        "name": "SHOPS_AND_SERVICES_ACCESS",
        "value": 3.355069,
        "value_qualifier": "HIGH",
        "weight": 4.3e-05
      },
      {
        "name": "NEAREST_HIGHWAY_PROXIMITY",
        "value": 1.035646,
        "value_qualifier": "MED",
        "weight": -1.2e-05
      },
      {
        "name": "SPECIALTY_GROCERY_STORE_ACCESS",
        "value": 3.344644,
        "value_qualifier": "HIGH",
        "weight": -0.000119
      },
      {
        "name": "COMMON_NEEDS_ACCESS",
        "value": 4.045221,
        "value_qualifier": "HIGH",
        "weight": -0.000143
      },
      {
        "name": "TRAIN_SERVICE_ACCESS",
        "value": 1.610418,
        "value_qualifier": "HIGH",
        "weight": -0.000343
      }
    ]
  },
  "meta": {
    "message": "Successfully called v3/value-drivers API.",
    "statusCode": 200,
    "type": "LocalLogic.API.Success"
  }
}

Local Logic Measures​

Local Logic Measures are used to quantify location characteristics on a more granular level that Location Scores. Here's a list of all of the measures that can be returned by the Value Drivers endpoint, based on Local Logic's insight into which of these measures have the biggest impact on home prices:

MeasureDescription
bus_service_accessA measure, on a 0 to 5 scale, of how easy it is to get to city bus stops from this location, weighted by how frequently buses come to them. Higher values indicate that there are more reachable bus stops, that they are closer, and that bus frequency is higher.
shops_and_services_accessA measure, on a 0 to 5 scale, of how easy it is to get to shops and services from this location. Higher values indicate that there are more reachable shops and services, and that they are closer.
coffee_shop_accessA measure, on a 0 to 5 scale, of how easy it is to get to coffee shops from this location. Higher values indicate that there are more reachable coffee shops, and that they are closer.
casino_accessA measure, on a 0 to 5 scale, of how easy it is to get to casinos from this location. Higher values indicate that there are more reachable casinos, and that they are closer.
clothing_and_accessory_store_accessA measure, on a 0 to 5 scale, of how easy it is to get to clothing and accessory stores from this location. Higher values indicate that there are more reachable clothing and accessory stores, and that they are closer.
common_needs_accessA measure, on a 0 to 5 scale, of how easy it is to get to common needs from this location. Higher values indicate that there are more reachable common needs, and that they are closer. Common needs include hairdressers, hardware stores, liquor stores, banks, post offices, convenience stores, and laundry services. Groceries and pharmacies have separate measures.
department_store_accessA measure, on a 0 to 5 scale, of how easy it is to get to department stores from this location. Higher values indicate that there are more reachable department stores, and that they are closer.
entertainment_venue_accessA measure, on a 0 to 5 scale, of how easy it is to get to entertainment venues from this location. Higher values indicate that there are more reachable entertainment venues, and that they are closer. Entertainment venues include music venues, live theaters, cinemas, and performing arts venues.
fitness_establishment_accessA measure, on a 0 to 5 scale, of how easy it is to get to fitness establishments from this location. Higher values indicate that there are more reachable fitness establishments, and that they are closer. Fitness establishments include gyms, yoga studios, and pools.
healthy_restaurant_accessA measure, on a 0 to 5 scale, of how easy it is to get to healthy restaurants from this location. Higher values indicate that there are more reachable healthy restaurants, and that they are closer.
nightlife_accessA measure, on a 0 to 5 scale, of how easy it is to get to nightlife from this location. Higher values indicate that there are more reachable nightlife, and that they are closer. Nightlife includes bars, pubs, comedy clubs, and night clubs.
park_accessA measure, on a 0 to 5 scale, of how easy it is to get to parks from this location. Higher values indicate that there are more reachable parks, and that they are closer.
park_access_weighted_by_areaA measure, on a 0 to 5 scale, of how easy it is to get to parks from this location, weighted by their area. Higher values indicate that there are more reachable parks, that they are closer, and that they are larger in area.
pedestrian_oriented_street_accessA measure, on a 0 to 5 scale, of how easy it is to get to pedestrian-oriented commercial streets from this location. Higher values indicate that there are more reachable commercial streets, that they are closer, and that they have more shops and services on them.
rapid_transit_service_accessA measure, on a 0 to 5 scale, of how easy it is to get to rapid transit stations from this location, weighted by how frequent their service is. Higher values indicate that there are more reachable stations, that they are closer, and that service frequency is higher.
restaurant_accessA measure, on a 0 to 5 scale, of how easy it is to get to restaurants from this location. Higher values indicate that there are more reachable restaurants, and that they are closer.
specialty_grocery_store_accessA measure, on a 0 to 5 scale, of how easy it is to get to specialty grocery stores from this location. Higher values indicate that there are more reachable specialty grocery stores, and that they are closer.
sports_facility_accessA measure, on a 0 to 5 scale, of how easy it is to get to sports facilities from this location. Higher values indicate that there are more reachable sports facilities, and that they are closer. Sports facilities include soccer fields, running tracks, baseball diamonds, ice rinks, and so forth.
train_service_accessA measure, on a 0 to 5 scale, of how easy it is to get to train stations from this location, weighted by how frequent their service is. Higher values indicate that there are more reachable stations, that they are closer, and that service frequency is higher.
unhealthy_restaurant_accessA measure, on a 0 to 5 scale, of how easy it is to get to unhealthy restaurants from this location. Higher values indicate that there are more reachable unhealthy restaurants, and that they are closer.
nearest_bus_stop_proximityA measure, on a 0 to 5 scale, of how close the nearest bus stop is. Higher values indicate that it is closer.
nearest_coffee_shop_proximityA measure, on a 0 to 5 scale, of how close the nearest coffee shop is. Higher values indicate that it is closer.
nearest_clothing_and_accessory_store_proximityA measure, on a 0 to 5 scale, of how close the nearest clothing and accessory store is. Higher values indicate that it is closer.
nearest_fitness_establishment_proximityA measure, on a 0 to 5 scale, of how close the nearest fitness establishment is. Higher values indicate that it is closer.
nearest_general_grocery_store_proximityA measure, on a 0 to 5 scale, of how close the nearest general grocery store is. Higher values indicate that it is closer. General grocery stores include supermarkets and other stores that sell a wide range of foods.
nearest_healthy_restaurant_proximityA measure, on a 0 to 5 scale, of how close the nearest healthy restaurant is. Higher values indicate that it is closer.
nearest_highway_proximityA measure, on a 0 to 5 scale, of how close the nearest highway entrance is. Higher values indicate that it is closer.
nearest_nightlife_proximityA measure, on a 0 to 5 scale, of how close the nearest nightlife establishment is. Higher values indicate that it is closer.
nearest_park_proximityA measure, on a 0 to 5 scale, of how close the nearest park is. Higher values indicate that it is closer.
nearest_pharmacy_proximityA measure, on a 0 to 5 scale, of how close the nearest pharmacy is. Higher values indicate that it is closer.
nearest_rapid_transit_station_proximityA measure, on a 0 to 5 scale, of how close the nearest rapid transit station is. Higher values indicate that it is closer.
nearest_restaurant_proximityA measure, on a 0 to 5 scale, of how close the nearest restaurant is. Higher values indicate that it is closer.
nearest_sports_facility_proximityA measure, on a 0 to 5 scale, of how close the nearest sports facility is. Higher values indicate that it is closer.
nearest_train_station_proximityA measure, on a 0 to 5 scale, of how close the nearest train station is. Higher values indicate that it is closer.
nearest_unhealthy_restaurant_proximityA measure, on a 0 to 5 scale, of how close the nearest unhealthy restaurant is. Higher values indicate that it is closer.
nearest_bicycle_share_station_proximityA measure, on a 0 to 5 scale, of how close the nearest bicycle share station is. Higher values indicate that it is closer.
airport_noiseA measure, on a 0 to 5 scale, of how much noise there is from airports at this location.
interchange_noiseA measure, on a 0 to 5 scale, of how much noise there is from highway interchanges at this location.
railway_noiseA measure, on a 0 to 5 scale, of how much noise there is from railways at this location.
traffic_noiseA measure, on a 0 to 5 scale, of how much noise there is from traffic at this location.
terrain_steepnessA measure, on a 0 to 5 scale, of how steep the terrain is within a 1 km radius.
street_steepnessA measure, on a 0 to 5 scale, of how steep the street of this location is.
intersection_densityA measure, on a 0 to 5 scale, of how many street intersections there are per unit of area. Higher values indicate a higher density of intersections, and conversely, smaller blocks.
local_street_proportionA measure, on a 0 to 5 scale, of the proportion of streets within 1 km that are local, as opposed to being highways or arteries.
infrastructure_unpleasant_for_pedestriansA measure, on a 0 to 5 scale, of how much infrastructure there is nearby that is unpleasant for pedestrians. This includes highways and railways.

SDK Implementations​

Value Drivers is used by one Local Logic SDK:

SDKDescription
Property Value Drivers SDKRetrieve the top drivers of property value within the neighborhood.

Error codes​

When calling Local Logic’s API, you may receive an HTTP error code. These errors are explained below. In general, error codes starting with “4” are due to an invalid API call and can be fixed on your end, whereas error codes starting with “5” are due to server errors (that is, problems on our end). If you receive something not described here, please contact us at support@locallogic.co.

400 - BadRequest

This error code happens when the request inputs are incorrect. Use the detail field of the response for clarification. Example:

{
  "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

This error code happens when your API key cannot access specific resources or locations. For example, some API keys can only access certain countries / states / provinces. Feel free to contact us for more information. Example:

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

403 - Forbidden

This error code happens when you forgot to include security credentials with your request or you are requesting a parameter that you do not have access to. Example:

{
  "message": "Forbidden"
}

404 - NotFound

This error code happens when we don’t have data for the requested location. For example, if you send a lat/lng pair for a location in Antarctica, we will return this error as we don’t have data for Antarctica (yet!). Example:

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

422 - Unprocessable Entity

This error code is returned when the correct parameters have been sent however, the data they contain is not valid. For example, if you send a lat/lng pair and the latitude is invalid (ie. not in the range [-90, 90]) and/or the longitude is invalid (ie. not in the range [-180, 180]).

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

500 - ServerError

This error code means that an error occurred on our end. Feel free to retry the same request to see if the problem persists. If you received a lot of these errors, please contact us at support@locallogic.co Example:

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

502 - BadGateway

This error code means that an error came from our cloud provider. Feel free to retry the same request to see if the problem persists. Example:

{
  "message": "Internal server error"
}