API v1 reference

tinymap API

A read-only REST API to fetch any public tinymap by its ID. Manage your API keys.

Authentication

Send your API key as a Bearer token or a custom header:

header

Authorization: Bearer tm_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx
# or
X-API-Key: tm_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

Keys are scoped to your account. Revoking a key takes effect immediately.

Get a tinymap by ID

Returns the full map — pins, buildings, events, contacts — for a given tinymap ID.

GEThttps://app.tinymap.in/api/v1/maps/{id}

Examples

cURL

curl -H "Authorization: Bearer tm_live_xxx" \
  https://app.tinymap.in/api/v1/maps/aarav-home

JavaScript

const r = await fetch(`https://app.tinymap.in/api/v1/maps/${id}`, {
  headers: { Authorization: `Bearer ${process.env.TINYMAP_KEY}` },
});
const map = await r.json();
console.log(map.title, map.pins.length, "pins");

Python

import os, requests
r = requests.get(
    f"https://app.tinymap.in/api/v1/maps/{tinymap_id}",
    headers={"Authorization": f"Bearer {os.environ['TINYMAP_KEY']}"},
)
r.raise_for_status()
m = r.json()
print(m["title"], len(m["pins"]), "pins")

Response

JSON

{
  "id": "cluxyz...",
  "slug": "aarav-home",
  "url": "https://tinymap.in/aarav-home",
  "title": "Aarav's home",
  "description": "Take left at the security cabin",
  "creatorName": "Aarav Kumar",
  "contacts": [
    { "label": "Owner", "phone": "+919876543210", "whatsapp": true, "call": true }
  ],
  "centerLat": 12.9716,
  "centerLng": 77.5946,
  "zoom": 18,
  "audioLang": "en",
  "hasNarration": true,
  "pins": [ { /* Pin objects */ } ],
  "events": [ { /* Event objects */ } ],
  "activeEvents": [ /* events whose end date+time is in the future */ ],
  "viewCount": 42,
  "createdAt": "2026-05-15T10:23:00.000Z",
  "updatedAt": "2026-05-29T08:11:00.000Z"
}

Errors

401 — Missing/invalid/revoked API key.
404 — No map with that ID.