Miataru API

by miataru.com

Overview

The Miataru API is very simple and straight forward. Generally you're posting (HTTP POST) a JSON formatted request to a service method locations and you get back a JSON formatted answer. Please take into consideration that this has the request-for-comment status and that it can change while there's work done on client and server applications. Versioning therefore is done by prepending the version number - /v1/ for version 1 - to the method call.

Miataru is a geocoding API from miataru.com. It needs no API key. It is served over plain HTTP. Its OpenAPI description documents 5 endpoints.

At a glance

Authentication: No auth
HTTPS: No
CORS: Unknown
Category: Geocoding
Base URL: http://service.miataru.com/v1
Version: 1.0.0
Endpoints: 5
OpenAPI: Specification ↗
Spec updated: 2021-06-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "http://service.miataru.com/v1/GetLocationGeoJSON/DEVICEID" \
  -H "Accept: application/json"

JavaScript

const response = await fetch("http://service.miataru.com/v1/GetLocationGeoJSON/DEVICEID", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "http://service.miataru.com/v1/GetLocationGeoJSON/DEVICEID",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
POST	`/GetLocation`	To retrieve a specific devices latest known location the /GetLocation method is used. Please note that the MiataruConfig portion is optional. RequestMiataruDevi
GET	`/GetLocationGeoJSON/{deviceID}`	Retrieves a devices Location in GeoJSON format.
POST	`/GetLocationHistory`	Location History is stored on the server only if the client told the server to do so using the “EnableLocationHistory” setting in the Location Update requests.
POST	`/GetVisitorHistory`	Visitor History is stored on the server with every request to the location or location history information of a device. There is a server-side setting that cont
POST	`/UpdateLocation`	This method is used to update the location of a device. The device does not need to be known already to the Miataru server but it rather creates a unique identi