Skip to main content

Getting Started with MVF v2

Mappedin Venue Format (MVF) v2 is currently in an alpha state while Mappedin perfects a new design. Breaking changes may occur and this page will be updated to reflect this.

Mappedin Venue Format (MVF) is a GeoJSON based format containing geometry data associated with an indoor map.

Mappedin's exports take highly accurate indoor map data and format it as per GeoJSON specs, for a variety of use cases. These GeoJSON based exports provide complete flexibility to build any indoor mapping experience. Read the MVF Data Model for a full breakdown of the MVF bundle.

Downloading an MVF Using the Mappedin Editor​

MVF export is a feature of Mappedin Pro and Enterprise Tiers. To export an MVF using the Mappedin Editor, follow the steps below.

  1. Open the Mappedin editor and navigate to the desired map.
  2. From the the editor screen, select the download button.
  3. Select "Download as MVF (GeoJSON)".

Download as MVF

This will download a zip file titled the name of the map. Within the directory are a number of GeoJSON and JSON files describing the geometry and styling extensions of the map. These files are explained in further detail in the MVF Data Model.

Downloading an MVF Using the Mappedin REST API​

MVF export is a feature of Mappedin Pro and Enterprise Tiers. To export an MVF using the Mappedin REST API, follow the steps below. Refer to the Mappedin REST API documentation for more information.

1. Get an API Key​

Follow the steps in the Create a Key & Secret Guide to generate an API key and secret.

2. Exchange API Key and secret for JWT​

Using the API key and secreted generated in the previous step, make a POST call to https://app.mappedin.com/api/v1/api-key/token using basic authentication. Use the API key as the username and the secret as the password. The API responds with JSON that contains a Java Web Token (JWT) token that can be used to authenticate to other Mappedin REST API endpoints.

Refer to the Exchange API Key and secret for JWT REST API documentation for more information and examples.

Using the JWT token generated in the previous step, make a GET call to https://app.mappedin.com/api/v1/venue/__VENUEID__/mvf. Replace __VENUEID__ with the ID of the venue you wish to export. Use the Authorization header with the value Bearer __JWT__ where __JWT__ is the JWT token. The API responds with JSON that contains a link to download a zip file containing the MVF. This download link expires after 48 hours.

Refer to the Get venue MVF REST API documentation for more information and examples.

Get an MVFv2 Locale Package​

Maps that include multiple languages will have locale packages available for download. The translated assets are packaged within locale packages, with each language contained within its own zip file. Links to these zip files are included in the response of the GET /venue/{venueId}/mvf endpoint described above. Locale packages do not contain building geometry data, only the translated assets. Below is an example response that includes links to locale packages:

{
	"url": "https://path/to/mvf.zip",
	"updated_at": "2024-09-07T08:10:07.858Z",
	"locale_packs": {
		"ar": "https://path/to/ar.zip",
		"es": "https://path/to/es.zip",
		"th": "https://path/to/th.zip"
	}
}