API documentation

Citymirror dataset search API

Use Citymirror to locate dataset source domains by place, topic and use case. The endpoint accepts natural-language intent and returns a structured data-availability map. Built for AI agents, MCP clients and developers.

Endpoint

`POST https://citymirror.io/api/search`

Also available as GET https://citymirror.io/api/search?place=Birmingham&country=UK&topic=traffic

Request

POST https://citymirror.io/api/search
Content-Type: application/json

{
  "query": "Find traffic datasets for Birmingham for congestion modelling",
  "place": "Birmingham",
  "country": "United Kingdom",
  "topic": "traffic",
  "use_case": "digital twin",
  "agent": true
}

Response

{
  "query_id": "cm_q_20260614_001",
  "interpreted_intent": {
    "place": "Birmingham",
    "country": "United Kingdom",
    "topic": "traffic",
    "use_case": "digital twin modelling"
  },
  "data_map": {
    "coverage": "partial",
    "source_domains": [
      {
        "domain": "data.gov.uk",
        "source_type": "national_open_data_portal",
        "confidence": 0.86
      },
      {
        "domain": "tfwm.org.uk",
        "source_type": "transport_authority",
        "confidence": 0.74
      }
    ],
    "missing_or_uncertain": [
      "real-time traffic sensor feeds",
      "historic SCOOT/RTEM feeds"
    ]
  },
  "next_actions": [
    "Check Transport for West Midlands transport datasets",
    "Check national transport statistics on data.gov.uk"
  ],
  "citation_policy": "Citymirror provides source-location intelligence, not ownership of external datasets."
}

Parameters

query
Natural-language dataset requeststring · required

place
City or place namestring · optional

country
Country name or ISO codestring · optional

topic
traffic, air-quality, population, geospatial, housing, planning, energy, transport, weather, environmentstring · optional

use_case
e.g. digital twin, urban planningstring · optional

Discovery

OPENAPI
/openapi.json MCP
/.well-known/mcp.json LLMS
/llms.txt PAGES
/datasets

Note: the live endpoint runs on https://citymirror.io. Until it is deployed, every dataset page also ships a static .json sibling (append .json to any /datasets URL) carrying the same source-domain map.

Source map last reviewed: 2026-06-14. Citymirror provides dataset source-location intelligence, not ownership of external datasets.