2b2t Atlas

2b2tAtlas Public API

Use the 2b2tAtlas catalog in your own map, mod or research tool. It includes historical locations, groups, highways, Archive warps, world downloads, dated renders, Find, saved inventories, artwork and NoCom observations. This repository contains the HTTP API reference, request examples and an archived application snapshot.

Live contract rechecked October 19, 2026: 57 public GET routes and 38 read-only MCP tools. Recorded response examples are dated October 17; values and counts can change. Use the live website reference or the complete route catalog for exact parameters.

Base URL: https://api.blackportal.cloud. Public reads require no API key. You can make requests from a browser, a command line, or your own code.

• API reference
• Live OpenAPI schema
• Coordinates and render tiles
• BlueMap 3D views
• Unified Find, inventories and saved objects
• Nocom data
• MCP setup and tools
• Current facts and canonical links for integrations
• Changelog
• Source versions and the current application stack
• Application source snapshot - September 26, 2026 source and setup instructions.

Try it

Open the location list in a browser, or run one of these commands. On Windows PowerShell 5.1, use curl.exe.

curl --fail "https://api.blackportal.cloud/api/locations"
curl --fail "https://api.blackportal.cloud/api/groups"
curl --fail "https://api.blackportal.cloud/api/renders?limit=10"
curl --fail "https://api.blackportal.cloud/api/nocom/highways?dimension=nether&direction=northeast"

List responses are JSON arrays. Warps, renders, and attachments accept limit and offset; the default limit is 500 and the maximum is 1,000. Locations return the complete catalog.

For a location picker or directory, use /api/locations/directory. It returns compact rows with names, groups, counts and preferred actions. Fetch /api/locations/{id} when someone opens a record for its full history and media.

Request examples

examples/requests.http contains ordinary HTTP requests for catalog records, Find, inventories and historical observations. Use the API from whatever language or HTTP tool you already use. No Atlas client package is required.

The application snapshot is separate from the current API reference. Its setup guides describe the September 26, 2026 source; they do not describe later production features or runtime changes.

Endpoints

All routes below use GET. See the reference for response fields, filters, caching, and errors.

Client behavior

• Cache catalog responses and honor HTTP cache headers. In Minecraft clients, perform HTTP requests and image decoding outside the render/tick thread.
• Use interactiveUrl for a location page, apiUrl for JSON, and worldDownloadUrl for a saved world. For a Find object's 3D destination, prefer savedObject.locationLink, resolved against https://2b2tatlas.com. blueMapUrl opens the standalone viewer and is optional and render-specific.
• Handle null fields and ignore unknown JSON properties.
• Coordinates use the record's native dimension: 0 Overworld, 1 Nether, 2 End. Tile-template {y} is a tile row, not Minecraft elevation.
• WDLs are partial historical Java saves. Their metadata includes scope, provenance, size, and SHA-256; ZIP downloads support HTTP ranges.
• Historical coordinates and renders do not describe the current server state. Nocom observation counts are not unique-player counts.
• Retain source URLs, captions, attribution, and evidence fields when copying records so the original material can be checked.

MCP

Endpoint: https://api.blackportal.cloud/mcp. Transport: Streamable HTTP. The server is stateless and read-only, with no authentication required.

The MCP guide includes client configuration, the current tools, and resource URIs. The registry name is io.github.bobymicjohn/2b2t-atlas; its manifest is server.json.

Bulk data

Static exports are hosted on 2b2tatlas.com:

Use these exports for bulk imports. Keep entity IDs and canonical URLs with imported records. The WDL catalog also has an HTML view.

Existing integration

XaeroTools supports an optional Atlas location overlay with source links and local copies of Atlas map imagery.

Contributing

See CONTRIBUTING.md for local checks and pull requests. Report documentation errors and incorrect request examples through issues.

License

Atlas-authored code, documentation and the full stack are released under the Unlicense. Use, modify and share them however you like; no permission or Atlas attribution is required. The same goes for Atlas's factual catalog. ATTRIBUTION.md has optional credit formats; NOTICE.md covers third-party media and source terms.

2b2tAtlas is not affiliated with Mojang Studios, Microsoft, or the operators of 2b2t.