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 and Nocom observations. This repository has small API
examples and the full Atlas application.
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.
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.
Examples
To run your own Atlas, see examples/atlas-stack.
That folder is an Unlicense application snapshot. The smaller API clients below
remain standalone examples for consuming the public service.
Run from the repository root:
dotnet run --project examples/csharp -- "Mu Megabase"
node examples/javascript/atlas-examples.mjs "Mu Megabase"
python examples/python/atlas_examples.py "Mu Megabase"
python examples/python/nocom_activity.py --dimension nether --direction northeast
python examples/python/location_media.py 1254
The C# example uses .NET 10. The JavaScript and Python examples use their standard
libraries. Each defaults to the public API; set ATLAS_API_BASE_URL to use a
local fixture or development server.
examples/requests.http contains REST Client requests.
examples/fabric contains an asynchronous Java HTTP client and
Minecraft client-thread handoff example; it is not a complete mod.
Endpoints
All routes below use GET. See the reference for response
fields, filters, caching, and errors.
| Resource | Routes |
|---|
| Locations | /api/locations, /api/locations/{id} |
| Groups | /api/groups, /api/groups/{id} |
| Highways | /api/highways, /api/highways/{id} |
| Archive warps | /api/warps, /api/warps/{id} |
| Warp WDL metadata and ZIP | /api/warps/{id}/world-download, /api/warps/{id}/world-download.zip |
| Renders | /api/renders, /api/renders/{id}, /api/locations/{id}/renders |
| Preserved render-source WDL metadata and ZIP | /api/renders/{id}/world-download, /api/renders/{id}/world-download.zip |
| Historical media | /api/attachments, /api/attachments/{id} |
| Map layers | /api/maprenders, /api/maprenders/catalog |
| Nocom | /api/nocom, /api/nocom/periods, /api/nocom/highways |
Client behavior
- Cache catalog responses and honor HTTP cache headers. In Minecraft clients,
perform HTTP requests and image decoding outside the render/tick thread.
- Follow returned links such as
apiUrl, canonicalUrl, worldDownloadUrl,
and blueMapUrl. BlueMap links are optional and belong to a specific render.
- 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 example checks and pull requests.
Report documentation errors and broken 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.