Unit Map

Unit Map™ Developer Hub

Welcome to the Unit Map developer hub. You'll find comprehensive guides and documentation to help you start working with the platform as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Unit Maps

 

List Unit Maps

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.unitmap.com/v1/maps
curl --request GET \
  --url https://api.unitmap.com/v1/maps
var request = require("request");

var options = { method: 'GET', url: 'https://api.unitmap.com/v1/maps' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.unitmap.com/v1/maps")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.unitmap.com/v1/maps");

xhr.send(data);
import requests

url = "https://api.unitmap.com/v1/maps"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "paging": {
    "per_page": 3,
    "current_page": 1,
    "prev_url": null,
    "next_url": "https://api.unitmap.com/v1/maps?per-page=3&page=2"
  },
  "data": [
    {
      "id": "2630",
      "name": "1600 Glenarm Place - Unit Map Style A",
      "created_at": "2016-11-18T22:36:25+00:00",
      "updated_at": "2017-01-30T23:04:33+00:00",
      "url": "https://cdn.unitmap.com/assets/99/0p/990p79ev7ng/9c/c6/9cc610ae4bc30776b015b217ef706e12.umap"
    },
    {
      "id": "2631",
      "name": "Camden Flatirons - Unit Map Style A",
      "created_at": "2016-11-21T15:00:31+00:00",
      "updated_at": "2017-01-30T23:16:46+00:00",
      "url": "https://cdn.unitmap.com/assets/rl/zv/rlzvgd7vln7/ff/f8/fff8f35a3f92629dd7deb4ba78aba999.umap"
    },
    {
      "id": "2632",
      "name": "Brittany - Unit Map Style B",
      "created_at": "2016-11-23T16:07:07+00:00",
      "updated_at": "2017-01-31T21:21:59+00:00",
      "url": "https://cdn.unitmap.com/assets/rm/1p/rm1p881pd6e/15/0c/150c39fdd756c9e7001d0dde2afd148d.umap"
    }
  ]
}
{
  "message": "Access denied"
}

Query Params

page
int32

Request a specific page of resources

per-page
int32

Limit the number of returned resources

 

Get Unit Map

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.unitmap.com/v1/maps/map
curl --request GET \
  --url https://api.unitmap.com/v1/maps/map
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.unitmap.com/v1/maps/map' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.unitmap.com/v1/maps/map")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.unitmap.com/v1/maps/map");

xhr.send(data);
import requests

url = "https://api.unitmap.com/v1/maps/map"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "2630",
  "name": "Legacy - Unit Map Style A",
  "created_at": "2016-12-09T23:26:56+00:00",
  "updated_at": "2016-12-16T16:16:59+00:00",
  "url": "https://cdn.unitmap.com/assets/d0/ow/d0ow3xqw2mn/9d/df/9ddf269b5d609220653fcaa88dbb4907.umap"
},
{
  "message": "Access denied"
}

Path Params

map
string
required

Unit Map ID

 

List Units

List Units for a Unit Map

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.unitmap.com/v1/maps/map/units
curl --request GET \
  --url https://api.unitmap.com/v1/maps/map/units
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.unitmap.com/v1/maps/map/units' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.unitmap.com/v1/maps/map/units")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.unitmap.com/v1/maps/map/units");

xhr.send(data);
import requests

url = "https://api.unitmap.com/v1/maps/map/units"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "paging": {
    "per_page": 3,
    "current_page": 1,
    "prev_url": null,
    "next_url": "https://api.unitmap.com/v1/maps/2630/units?per-page=3&page=2"
  },
  "data": [
    {
      "id": "112686",
      "name": "1101",
      "created_at": "2016-11-30T23:52:28+00:00",
      "updated_at": "2016-11-30T23:52:28+00:00"
    },
    {
      "id": "112687",
      "name": "1102",
      "created_at": "2016-11-30T23:52:28+00:00",
      "updated_at": "2016-11-30T23:52:28+00:00",
    },
    {
      "id": "112688",
      "name": "1103",
      "created_at": "2016-11-30T23:52:28+00:00",
      "updated_at": "2016-11-30T23:52:28+00:00"
    }
  ]
}
{
  "message": "Access denied"
}

Path Params

map
string
required

Unit Map ID

Query Params

page
int32

Request a specific page of resources

per-page
int32

Limit the number of returned resources

 

Get Unit

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.unitmap.com/v1/maps/map/units/unit
curl --request GET \
  --url https://api.unitmap.com/v1/maps/map/units/unit
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.unitmap.com/v1/maps/map/units/unit' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.unitmap.com/v1/maps/map/units/unit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.unitmap.com/v1/maps/map/units/unit");

xhr.send(data);
import requests

url = "https://api.unitmap.com/v1/maps/map/units/unit"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "112686",
  "name": "1101",
  "created_at": "2016-11-30T23:52:28+00:00",
  "updated_at": "2016-11-30T23:52:28+00:00"
}
{
  "message": "Access denied"
}

Path Params

map
string
required

Unit Map ID

unit
string
required

Unit ID

 

List Level Tags

List Level Tags for a Unit Map

 

Header Auth

 Authentication is required for this endpoint.
gethttps://api.unitmap.com/v1/maps/map/levels/tags
curl --request GET \
  --url https://api.unitmap.com/v1/maps/map/levels/tags
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.unitmap.com/v1/maps/map/levels/tags' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.unitmap.com/v1/maps/map/levels/tags")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.unitmap.com/v1/maps/map/levels/tags");

xhr.send(data);
import requests

url = "https://api.unitmap.com/v1/maps/map/levels/tags"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "name": "Building",
      "key": "building",
      "created_at": "2016-11-14T23:11:11+00:00",
      "updated_at": "2016-11-14T23:11:11+00:00",
      "values": [
        {
          "name": "1",
          "value": "48",
          "created_at": "2016-11-14T23:13:52+00:00",
          "updated_at": "2016-11-14T23:13:52+00:00"
        }
      ]
    },
    {
      "name": "Floor",
      "key": "floor",
      "created_at": "2016-11-14T23:11:11+00:00",
      "updated_at": "2016-11-14T23:11:11+00:00",
      "values": [
        {
          "name": "4",
          "value": "42",
          "created_at": "2016-11-14T23:13:52+00:00",
          "updated_at": "2016-11-21T15:13:04+00:00"
        },
        {
          "name": "3",
          "value": "43",
          "created_at": "2016-11-14T23:13:52+00:00",
          "updated_at": "2016-11-21T15:13:00+00:00"
        },
        {
          "name": "2",
          "value": "44",
          "created_at": "2016-11-14T23:13:52+00:00",
          "updated_at": "2016-11-21T15:13:00+00:00"
        },
        {
          "name": "5",
          "value": "45",
          "created_at": "2016-11-14T23:13:52+00:00",
          "updated_at": "2016-11-21T15:13:04+00:00"
        }
      ]
    }
  ]
}
{
  "message": "Access denied"
}

Path Params

map
string
required

Unit Map ID

Query Params

page
int32

Request a specific page of resources

per-page
int32

Limit the number of returned resources