On this page
Brasil Terras Raras
English

Proprietary API overview

The proprietary API assembles the layers and indicators used by the public map experience into a versioned snapshot.

How the map consumes the API

The public client requests the map API bootstrap endpoint and receives a JSON document. The request asks for current content and explicitly declares the accepted format.

Before mounting any layer, the application validates the schema version, snapshot version, and vector tile path. An incompatible contract stops loading instead of displaying ambiguous data.

OperationCurrent contract
Map bootstrapGET https://api.brasilterrasraras.com.br/v1/map/bootstrap?client=ownership-color-v1
Formatapplication/json
Client cacheno-store

Snapshot contract

The response identifies the version and validity of the published dataset. It also reports operational counts so the interface can verify the delivered volume.

v1
expected schema version
JSON
response format
3
possible states per source
  • schemaVersion: expected format version.
  • snapshotVersion: identifier of the loaded publication.
  • generatedAt and expiresAt: snapshot generation and validity.
  • counts: totals for detail hexagons, overview hexagons, scored areas, linked areas, and features.

Delivered layers and sources

The snapshot separates vector data, feature collections, and raster overlays. Each source reports pending, ready, or error, allowing the map to disable only the affected layer.

  • States and mineral records.
  • GeoSGB resources.
  • Environmental and seismic events.
  • Raster overlays with their tile addresses.
  • The vector tile path used by opportunity areas.

Documented scope

This page describes the contract consumed by the public Mineral Map experience. It does not announce a general-purpose open API or grant access to internal operations.