Map Features API

Overview

Hivemapper automatically detects objects such as speed limit signs, traffic light signals, turn restriction signs, etc. When detected objects are properly and successfully geo-located, they become map features that are accessible via the Map Features API.

Supported Map Features

The list of supported Map Features will constantly expand. Below are the currently supported Map Features by country.

Map Features	Countries
Turn Restriction Signs	US
Stop Signs	US
Highway Signs	US
Speed Limit Signs	US
Intersection Traffic Lights	US

API Endpoint Docs and Tools

• Developer documentation for Map Data APIs can be accessed here.

• You will need an API Key, see here for instructions.

Map Feature Data Schema

Below is an example of the data schema for a map feature.

/**
 * GET features
 * position always in NE reference
 */

{
  "id": "SLS299345",,
  "objectClass": "speed-limit",
  "properties": {
    "speedLimit": 35,
    "unit": "mph",
    "regulatory": "enforced",
  },
  "position": {
      "lon": -108.123,
      "lat": 34.234,
      "azimuth": 90,
      "height": 0.5,
      "width": 0.3
  },
  "observed": {
      "confidence": 0.9,
      "frameId": 1922121212933
      "firstSeen": "2023-05-05T00:00:00.000Z",
      "lastSeen": "2023-05-05T00:00:00.000Z",
  },
}

Description:

• id – Unique ID for each map feature.

• objectClass – The name of the object class, e.g., speed limit or stop sign.

• properties – These provide the context and details for the map feature.

• lat/lon – The coordinates for the object.

• height – The height of the object.

• width – The width of the object.

• azimuth – The direction in which the object is facing, e.g., the sign is facing northbound traffic.

• confidence – The confidence that this object has been successfully identified and geo-located to create or update a map feature.

• frameId – The associated image frame(s) that were used to generate this map feature.

• firstSeen – The first time Hivemapper has seen and detected this object.

• lastSeen – The last time Hivemapper has seen and detected this object.

Map Feature History

For a given map feature ID, you can request its history to review changes. Below is an example of a history for a given map feature.

/**
 * GET features/:feature
 * position always in NE reference
 */
{
  "id": "SLP001",
  "status": "void",
  "class": "speed-limit",
  "position": {
    "lon": -108.123,
    "lat": 34.234,
    "azimuth": 90,
    "height": 0.5,
    "width": 0.3
  },
  "history": [
    {
      "date": "2023-02-05T22:43:28.067Z",
      "changeType": "created"
    },
    {
      "date": "2023-03-06T22:43:28.067Z",
      "changeType": "updated",
      "speedLimit": 30
    },
    {
      "date": "2023-04-07T22:43:28.067Z",
      "changeType": "updated",
      "position": {
        "lon": -108.124,
        "lat": 34.235,
        "azimuth": 89,
        "height": 0.5,
        "width": 0.3      
      }
    },
    {
      "date": "2023-05-07T22:43:28.067Z",
      "changeType": "inactive",
    },
    {
      "date": "2023-06-07T22:43:28.067Z",
      "changeType": "active",
    },
    {
      "date": "2023-07-07T22:43:28.067Z",
      "changeType": "void",
    }
  ]
}