Developers

API Documentation

The MIMU Data Portal exposes a read-only HTTP API for programmatic access to repositories, datasets and resources. Catalog endpoints live under /api/v1. Each request acts on behalf of the key's owner, so it returns everything that account is allowed to see — public content plus any repositories and datasets they are a member of. All responses are JSON.

Authentication

Every API request must be authenticated with a personal API key.

Sign in and open API keys, then choose New API key. Your key looks like mimu_xxxxxxxxxxxxxxxxxxxxxxxx.
Send it on every request in the Authorization header as a bearer token (an x-api-key header is also accepted).
Keep the key secret. You can disable or delete a key at any time from the same page; requests using a disabled or deleted key are rejected.

Authorization: Bearer mimu_xxxxxxxxxxxxxxxxxxxxxxxx

Requests without a valid, active key return 401 Unauthorized. Requesting content you are not allowed to access returns 403 Forbidden, and unknown records return 404 Not Found.

Base URL & conventions

Catalog endpoints are served under /api/v1on this portal's origin. File downloads use unversioned /api/files/…. Legacy paths such as /api/datasets permanently redirect to their /api/v1 equivalents. In the examples below, replace $BASE and $KEY with your values:

BASE="https://data.themimu.info"
KEY="mimu_xxxxxxxxxxxxxxxxxxxxxxxx"

Results are scoped to the key owner's permissions: public, published content is always included, plus draft or member-only repositories and datasets they belong to. Content the owner cannot access is never exposed, and a dataset is hidden whenever its parent repository is not visible to them.
List endpoints are paginated. Use ?page= (default 1) and optional ?pageSize= (default 24, maximum 100). Responses include meta: { apiVersion, page, pageSize, total, totalPage }. All v1 JSON responses include the X-API-Version: 1 header.

Endpoints

Dataset search uses short query-parameter names aligned with dataset fields: q (full-text search), k(keyword filter — matches your dataset keyword tags), and qtype (how multiple k values combine — and or or).

get/api/v1

API discovery

Returns the current API version, query-parameter conventions, and endpoint paths. No authentication required.

curl "$BASE/api/v1"

get/api/v1/repositories

List repositories you can access

Parameter	Description
page	Page number (default 1).
pageSize	Items per page (default 24, max 100).

curl -H "Authorization: Bearer $KEY" \
  "$BASE/api/v1/repositories?page=1&pageSize=50"

{
  "data": [
    {
      "uuid": "…",
      "name": "Myanmar Information Management Unit",
      "slug": "mimu",
      "description": "…",
      "logo": "https://…/api/files/logos/…",
      "updatedAt": "2026-06-30T…Z"
    }
  ],
  "meta": { "apiVersion": 1, "page": 1, "pageSize": 20, "total": 1, "totalPage": 1 }
}

get/api/v1/repository/{uuid}

Get one repository with the datasets you can see

Parameter	Description
uuid *	Repository UUID (path).

curl -H "Authorization: Bearer $KEY" \
  "$BASE/api/v1/repository/11efab27-0bb1-4c2f-abaf-bf8bc65841ac"

{
  "uuid": "…",
  "name": "…",
  "slug": "…",
  "description": "…",
  "logo": "…",
  "updatedAt": "…",
  "datasets": [ { "uuid": "…", "name": "…", "slug": "…", "…": "…" } ]
}

get/api/v1/datasets

Search datasets you can access

Parameter	Description
q	Full-text search over name, description and keywords.
k	Filter by keyword tag. Repeat for multiple values (e.g. k=health&k=survey).
qtype	Query type for multiple k values: and (default, all must match) or or (any may match).
sector	Filter by sector slug.
location	Filter by state/region pcode. Repeat for multiple (e.g. location=MMR001&location=MMR002).
repo	Restrict to a repository UUID.
page	Page number (default 1).
pageSize	Items per page (default 24, max 100).

curl -H "Authorization: Bearer $KEY" \
  "$BASE/api/v1/datasets?k=health&k=survey&qtype=and&sector=admin&page=1&pageSize=50"

{
  "data": [
    {
      "uuid": "…",
      "name": "Myanmar Boundaries",
      "slug": "myanmar-boundaries",
      "description": "…",
      "keywords": ["admin", "boundaries"],
      "updatefrequency": "annually",
      "downloadrights": "public",
      "repository": "…",
      "sectors": [ { "uuid": "…", "name": "…", "slug": "…" } ],
      "stateregion": [ { "pcode": "MMR001", "name": "…" } ],
      "updatedAt": "…"
    }
  ],
  "meta": { "apiVersion": 1, "page": 1, "pageSize": 20, "total": 1, "totalPage": 1 }
}

get/api/v1/dataset/{uuid}

Get one dataset with its resources

Parameter	Description
uuid *	Dataset UUID (path).

curl -H "Authorization: Bearer $KEY" \
  "$BASE/api/v1/dataset/c1b8de83-6b48-4542-bb78-ad3e6e506e17"

{
  "uuid": "…",
  "name": "Myanmar Boundaries",
  "slug": "myanmar-boundaries",
  "downloadrights": "public",
  "resources": [
    {
      "uuid": "…",
      "displayname": "States and regions",
      "fileextension": "geojson",
      "filesize": 148523,
      "dataset": "…",
      "notes": "Administrative boundaries as of 2024.",
      "fileformat": "geojson",
      "sort": 10,
      "thumbnailUrl": "https://…/api/files/thumbnails/….webp",
      "downloadUrl": "https://…/api/files/resources/….geojson"
    }
  ]
}

Lists downloadable files for a dataset. Use this endpoint (not a separate global file search) to discover resources programmatically. downloadUrlis only populated when the key owner is allowed to download the file — for example when download rights are public or registereduseronly and the key owner has a portal account, when they are a member of the parent repository with sufficient access, or when a download request has been approved. thumbnailUrl is a small preview image (generated for images/PDFs, or uploaded manually) and is null when no thumbnail exists. notes is markdown curator text; fileformat is the declared data format; sort is the curator display order (lower first).

get/api/v1/resource/{uuid}

Get resource metadata

Parameter	Description
uuid *	Resource UUID (path).

curl -H "Authorization: Bearer $KEY" \
  "$BASE/api/v1/resource/…"

get/api/files/{path}

Download a resource file

Use the downloadUrl returned by the dataset/resource endpoints. URLs use the form /api/files/resources/<resource-uuid>/<seo-name>.<ext>; the SEO filename segment is cosmetic and links keep working when a resource is renamed. Legacy /api/files/resources/<storage-uuid>.<ext> paths still work. A file can be fetched whenever the key owner is allowed to download it (public or registereduseronly with a portal account, repository membership, or an approved download request); otherwise the request returns 403 Forbidden. The response sets Content-Disposition with the display filename, so curl -OJ saves it under its real name.

curl -L -OJ -H "Authorization: Bearer $KEY" \
  "$BASE/api/files/resources/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/states-and-regions.geojson"

Need help?

For access issues or higher-volume needs, contact [email protected].