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=scientific-view-v1
Formatapplication/json
Client cache60 seconds, with revalidation

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 layer
  • schemaVersion: expected format version.
  • snapshotVersion: identifier of the loaded publication.
  • generatedAt and expiresAt: snapshot generation and validity.
  • counts: totals for detailed scientific cells, overview cells, and published features.

Delivered Brasil Terras Raras layers

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

  • States and mineral records.
  • Brasil Terras Raras resource records.
  • Environmental and seismic events.
  • Raster overlays with their tile addresses.
  • The vector tile path used by opportunity areas.

Dynamic scientific catalog

The panel also requests a versioned, localized manifest containing analysis modes, data domains, rare earths, indicator elements, geochemical profiles, and publishable layers. This catalog is independent from the legacy map and does not turn historical data into an approved scientific result.

OperationCurrent contract
Public manifestGET https://mineral-api.brasilterrasraras.com.br/v1/manifest
Contractbtr-manifest-v1
Current statusunavailable · zero approved layers

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.