Venue Maps API Developer's Guide

Frequently Asked Questions

Frequently asked questions about Venue Maps API.

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 a large number of venues, but it is not yet 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.

How to detect venues in the viewport?

There are three ways to detect venues in the viewport:

  1. Use Floor IATileMembers.
  2. Use Venues Index, which contains a 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.
  3. Use the Discovery Service which takes bounding box as a parameter.

    In this case, the bounding box should be the coordinates of the viewport.

How to detect floor range in a viewport?

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

  1. Use 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.
  2. Use 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.
  3. Use the ResultItemVenue object from the Discovery Service response