# TileJSON Tileset Metadata Extractor (`datamule/tilejson-tileset-extractor`) Actor

Point at ANY TileJSON 3.0 tileset metadata URL (OpenFreeMap, VersaTiles, MapTiler, Stadia, tileserver-gl, Tippecanoe, PMTiles) and extract structured metadata: one row per vector layer (id, fields, zoom) plus bounds, center, attribution, scheme, tile URLs. Raster tilesets emit a summary row.

- **URL**: https://apify.com/datamule/tilejson-tileset-extractor.md
- **Developed by:** [Datamule](https://apify.com/datamule) (community)
- **Categories:** Developer tools, Other
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.35 / 1,000 records

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## TileJSON Tileset Metadata Extractor

Point at **any TileJSON 3.0 tileset metadata URL** and get its structure as clean, structured rows — one row per vector layer, or a single tileset summary. Works with every conforming map-tile server: OpenFreeMap, VersaTiles, MapTiler, Stadia Maps, tileserver-gl, Tippecanoe output, PMTiles gateways, planetiler builds, and any custom `tiles.json`.

No per-host scraper, no map rendering — just the metadata document, parsed and normalized.

### What it does

Every map-tile server publishes a [TileJSON 3.0](https://github.com/mapbox/tilejson-spec) document (a `tiles.json` / tileset-metadata endpoint) describing its tileset: the `tiles[]` URL templates, the `vector_layers[]` and their field schemas, geographic `bounds`, `center`, `minzoom`/`maxzoom`, `attribution`, `scheme`, and more. This Actor fetches that document and flattens it.

### Input

| Field | Required | Description |
|-------|----------|-------------|
| `tilesetUrl` | ✅ | Any TileJSON 3.0 metadata URL. Redirects are followed; relative tile-URL templates are resolved to absolute. |
| `mode` | | `layers` (default) — one row per vector layer; `summary` — one tileset-summary row. |
| `userAgent` | | Optional User-Agent override. |
| `timeoutSecs` | | Per-request timeout (default 60). |

#### Example

```json
{
  "tilesetUrl": "https://tiles.openfreemap.org/planet",
  "mode": "layers"
}
```

### Modes

- **`layers`** (default) — emits one row per `vector_layers[]` entry: its `layerId`, `layerFields` schema (+ `layerFieldNames` / `layerFieldCount`), and per-layer `layerMinzoom`/`layerMaxzoom`, with the tileset-level metadata joined onto every row.
- **`summary`** — emits exactly one tileset-summary row (name, spec version, bounds, center, zoom envelope, tile URL template, layer count) with no per-layer fan-out.

### Raster tilesets

A **raster** tileset (imagery, hillshade, a raster OpenMapTiles variant) is a valid TileJSON document that simply has no `vector_layers`. Running such a URL in `layers` mode automatically falls back to a **single tileset summary row** (recorded in the row's `_note`) rather than returning zero rows — so a raster tileset is a real, honest result, never a failure or an empty.

### Output

One record per vector layer (or one summary row). Key fields:

- **Tileset:** `name`, `description`, `version`, `tilejsonVersion`, `attribution`, `scheme`, `format`, `minzoom`, `maxzoom`, `isVector`, `tilesetLayerCount`
- **Extent:** `bounds` (+ `boundsWest/South/East/North`), `center` (+ `centerLon/Lat/Zoom`)
- **Tiles:** `tileUrlTemplate` (first template, resolved absolute), `tileUrls`
- **Layer** (in `layers` mode): `layerId`, `layerDescription`, `layerMinzoom`, `layerMaxzoom`, `layerFields`, `layerFieldNames`, `layerFieldCount`
- **Provenance:** `_tilesetUrl`, `_mode`, `_rowIndex`, `_note`, and the lossless `_raw` original document

A URL that cannot be fetched, is not JSON, or is not a TileJSON document fails loudly — this Actor never fabricates rows.

### Pricing

Pay-per-event: **$0.0005 per record** (one vector layer or one tileset summary).

# Actor input Schema

## `tilesetUrl` (type: `string`):

Any TileJSON 3.0 tileset metadata URL (a 'tiles.json' or tileset-metadata document). Examples: https://tiles.openfreemap.org/planet (OpenFreeMap, 16 vector layers) · https://tiles.versatiles.org/tiles/osm/tiles.json (VersaTiles, 26 vector layers) · https://tiles.stadiamaps.com/data/openmaptiles.json (a raster tileset → summary row). Redirects are followed; relative tile URL templates are resolved against this URL.

## `mode` (type: `string`):

'layers' (default) emits one row per vector layer (its id, fields schema, per-layer zoom) with the tileset metadata joined on. 'summary' emits exactly one tileset-summary row (no per-layer fan-out). A RASTER / layer-less tileset run in 'layers' mode automatically falls back to a single summary row instead of zero rows.

## `userAgent` (type: `string`):

Override the default User-Agent header sent to the tile server. Some hosts gate a bare/default agent.

## `timeoutSecs` (type: `integer`):

Per-request timeout in seconds for fetching the TileJSON document.

## Actor input object example

```json
{
  "tilesetUrl": "https://tiles.openfreemap.org/planet",
  "mode": "layers",
  "timeoutSecs": 60
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "tilesetUrl": "https://tiles.openfreemap.org/planet"
};

// Run the Actor and wait for it to finish
const run = await client.actor("datamule/tilejson-tileset-extractor").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "tilesetUrl": "https://tiles.openfreemap.org/planet" }

# Run the Actor and wait for it to finish
run = client.actor("datamule/tilejson-tileset-extractor").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "tilesetUrl": "https://tiles.openfreemap.org/planet"
}' |
apify call datamule/tilejson-tileset-extractor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,datamule/tilejson-tileset-extractor"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/9YtdKmFrJbOC8w0ov/builds/n9TaEhk7r0Ee1ydZd/openapi.json