Add an uploaded raster tileset in Mapbox GL JS

Overview

This guide shows how to add an uploaded raster tileset in Mapbox GL JS through TileJSON.

If your tileset starts as an MBTiles or PMTiles file, upload it through the console first. See Upload Data for the full upload workflow, then return with the tileset Id and API key from API Keys & Access.

The example uses mappinest.countries-raster as the sample uploaded raster tileset. It loads the TileJSON URL as a raster source so Mapbox GL JS can discover the tile URL and zoom metadata from one endpoint.

For production, replace mappinest.countries-raster with your own tileset Id from the console. Use the Raster Tiles API page for the direct XYZ tile URL and raster endpoint details.

Tiles API raster tiles in Mapbox GL JS

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1" />
  <title>Mappinest raster TileJSON with Mapbox GL JS</title>
  <link href="https://api.mapbox.com/mapbox-gl-js/v3.16.0/mapbox-gl.css" rel="stylesheet" />
  <style>
    body { margin: 0; }
    #map { height: 100vh; width: 100vw; }
  </style>
</head>
<body>
  <div id="map"></div>
  <script src="https://api.mapbox.com/mapbox-gl-js/v3.16.0/mapbox-gl.js"></script>
  <script>

    // Mapbox GL JS needs its own runtime token. Mappinest API requests use apiKey.
    mapboxgl.accessToken = 'YOUR_MAPBOX_ACCESS_TOKEN';

    const apiKey = 'YOUR_MAPPINEST_KEY';

    const map = new mapboxgl.Map({
      container: 'map',
      style: `https://api.mappinest.com/v1/styles/light/style.json?key=${apiKey}`,
      center: [0, 0],
      zoom: 1
    });

    map.addControl(new mapboxgl.NavigationControl(), 'top-right');

    map.on('load', () => {
      // TileJSON lets Mapbox GL JS discover the raster tile URL and zoom range.
      map.addSource('countries-raster', {
        type: 'raster',
        url: `https://api.mappinest.com/v1/tiles/mappinest.countries-raster.json?key=${apiKey}`,
        tileSize: 256
      });

      map.addLayer({
        id: 'countries-raster-layer',
        type: 'raster',
        source: 'countries-raster',
        paint: {
          'raster-opacity': 0.9
        }
      });
    });
  </script>
</body>
</html>

import { useEffect, useRef } from 'react';
import mapboxgl from 'mapbox-gl';
import 'mapbox-gl/dist/mapbox-gl.css';

// Mapbox GL JS needs its own runtime token. Mappinest API requests use apiKey.
mapboxgl.accessToken = 'YOUR_MAPBOX_ACCESS_TOKEN';

const apiKey = 'YOUR_MAPPINEST_KEY';

export default function MappinestMapboxRasterTilesMap() {
  const containerRef = useRef<HTMLDivElement | null>(null);
  const mapRef = useRef<mapboxgl.Map | null>(null);

  useEffect(() => {
    if (!containerRef.current || mapRef.current) return;

    const map = new mapboxgl.Map({
      container: containerRef.current,
      style: `https://api.mappinest.com/v1/styles/light/style.json?key=${apiKey}`,
      center: [0, 0],
      zoom: 1
    });

    mapRef.current = map;

    map.on('load', () => {
      // TileJSON lets Mapbox GL JS discover the raster tile URL and zoom range.
      map.addSource('countries-raster', {
        type: 'raster',
        url: `https://api.mappinest.com/v1/tiles/mappinest.countries-raster.json?key=${apiKey}`,
        tileSize: 256
      });

      map.addLayer({
        id: 'countries-raster-layer',
        type: 'raster',
        source: 'countries-raster',
        paint: {
          'raster-opacity': 0.9
        }
      });
    });

    return () => {
      map.remove();
      mapRef.current = null;
    };
  }, []);

  return <div ref={containerRef} style={{ height: 420, width: '100%' }} />;
}

URL patterns used in this example

The bold parameters are the values you replace. Prefer TileJSON as the integration request so the raster tile template and zoom metadata stay behind one URL.

Use case	URL pattern	Docs
Tileset TileJSON	`https://api.mappinest.com/v1/tiles/{tilesetId}.json?key=YOUR_KEY`	TileJSON
Direct raster tile URL	`https://api.mappinest.com/v1/tiles/{tilesetId}/{z}/{x}/{y}.{format}?key=YOUR_KEY`	Raster Tiles API
Map style	`https://api.mappinest.com/v1/styles/{styleId}/style.json?key=YOUR_KEY`	StyleJSON

Get your free API key in API Keys & Access, then replace YOUR_KEY in the example.

Common errors

Symptom	What to check
Raster layer is blank	Open the TileJSON URL and confirm the `tiles` array contains a raster tile template.
Tiles appear at the wrong zoom	Check `minzoom`, `maxzoom`, and tile bounds in the TileJSON response.
Requests return 403	Check API key restrictions and allowed domains in API Keys & Access.

Overview

URL patterns used in this example

Common errors

What to read next