Venue Maps API Developer's Guide

Frequently Asked Questions

Frequently Asked Questions about Venue Maps API.

What files types are offered by Venue Maps API?

The Venue Maps API offers venue maps information in two types; Tiles and Models. Each type variation is provided using a different URL.

Venue Maps API Tiles are explained in detail in Tiles Resources. The provided variations of Venue Maps API Tiles are:

Venue Maps API Models offer all venue-related information in JSON format, fully explained in Models Resources. Models have two variations; Full Models and Points of Interest (POI) Models.

  • Full Models: provides venue information, geometry data, metadata, Points of Interest (POI) data and routing data in JSON format.
  • POI Models: provides venue information and Points of Interest (POI) data inside a venue in JSON format.

What are the supported Zoom Levels in Venue Maps API?

Venue Maps API supports Zoom Level 14 to 20. Having 20 as the most zoomed-in level / highest level.

What versions are currently supported by Venue Maps API?

Version 1 is the current version of Venue Maps API and it is fully supported.

What types of places are offered by Venue Maps API?

Venue Maps API offers a wide variety of types of places, which are being updated, and added to constantly. The list includes but not limited to:

  • Airports
  • Shopping: Malls, Large Retail Stores, Outlet Centres, Supermarkets
  • Stations: Train Stations, Metro Stations, Bus Terminals, Ferry Terminals
  • Tourist Destinations: Theme Parks, Zoos, National Monuments, Amusement Parks, Museums
  • Convention Centers
  • Exhibition Centers
  • Hospitals
  • University Campuses
  • Sports Stadiums and Arenas

Does Venue Maps API Support Indoor Routing?

A Routing Graph is present in every venue. The Routing Graph provides full details which can be used to route users inside the venues. Routing Graph is present only as part of the models-full resource. The venue routing API provides routing inside and outside venues.

How to Detect venues in the viewport?

There are three ways to detect venues in the viewport

  • Using Floor IATileMembers. Load Interaction Tiles layer. The value of buildingId property in Floor IATileMembers contains identifier of the venue. Obtain buildingIds of all venues in the viewport from Floor IATileMembers whose areas are in the viewport.
  • Using Venues Index which contains list of all venues. The value of bb property represents the bounding box of the venue, use it to detect which are in the viewport. The value of gml:id property contains venue identifier.
  • Using the Discovery Service which takes bounding box as a parameter, which should be in this case the viewport coordinates.

How to Detect floor range in the viewport?

There are three ways to detect floor range of venues in the viewport

  • Using Floor IATileMembers, Load Interaction Tiles layer. The value of buildingMinLevel and buildingMaxLevel properties in Floor IATileMembers contain minimum and maximum floor levels of venue. Obtain all Floor IATileMembers in the viewport to find the lowest buildingMinLevel and highest buildingMaxLevel the viewport can display.
  • Using Venues Index with Venues Models. Detect venues in the viewport using Venues Index. Load details of venues, use groundLevel property and levels array to obtain floor range of each venue.
  • Based on the ResultItemVenue from Discovery Service response