Get Venue By Key

GET

https://api.woosmap.com/indoor/venues/{venue_id}

Returns a Venue based on the ID given.

Rate limit: 20/1s

Authorization

private_key

apiKey query

X-Api-Key

apiKey header

key

apiKey query

Path Parameters

venue_id

string required

ID of the Venue to retrieve.

Response

200 application/json

venue_id

string required

ID of the Venue

name

string required

Name of the Venue

bbox

array required

Bounding Box of Venue

levels

object[]

Information on each level of the venue

Show 4 propertiesHide 4 properties

levels. level

integer required

Floor level as a number

levels. name

string

Name of the floor level

levels. ref

string

Reference to identify floor level

levels. bbox

number[] required

Bounding Box of floor level

routing_profiles

string[]

Available routing profiles for the venue

categories

string[]

buildings

object[]

Buildings present at the venue

Show 8 propertiesHide 8 properties

buildings. ref

string required

Reference to identify Building

buildings. name

string

Name of the Building

buildings. localized_name

object

Defaults to:

{}

Translated names of the Building

buildings. description

string

Building Description

buildings. opening_hours

string

Building Opening Hours

buildings. logo

string

buildings. cover

string

buildings. levels

object[] required

Levels associated with the Building

Show 4 propertiesHide 4 properties

buildings.levels. level

integer required

Floor level as a number

buildings.levels. name

string

Name of the floor level

buildings.levels. ref

string

Reference to identify floor level

buildings.levels. bbox

number[] required

Bounding Box of floor level

languages

string[] required

Language translations available for the venue

updated_at

string (date-time) required

When this venue was last updated

Errors

401

Unauthorized

application/json

detail

string required

402

Payment Required

application/json

No properties defined

403

Forbidden

application/json

No properties defined

422

Unprocessable Entity

application/json

detail

object[] required

The validation errors.

context

object required

Context

            curl -L -X GET 'https://api.woosmap.com/indoor/venues/west_pal?key=YOUR_PUBLIC_API_KEY' \
-H 'Referer: http://localhost'

            import requests

url = "https://api.woosmap.com/indoor/venues/west_pal?key=YOUR_PUBLIC_API_KEY"

payload={}
headers = {
    'Referer': 'http://localhost'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

            var requestOptions = {
  method: 'GET',
  redirect: 'follow'
};

fetch("https://api.woosmap.com/indoor/venues/west_pal?key=YOUR_PUBLIC_API_KEY", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

            {
  "bbox": [
    -0.1258015,
    51.4981306,
    -0.1236527,
    51.5008191
  ],
  "buildings": [
    {
      "cover": null,
      "description": null,
      "levels": [
        {
          "bbox": [
            -0.1258015,
            51.4981306,
            -0.1236527,
            51.5008191
          ],
          "level": 1,
          "name": "Palace of Westminster",
          "ref": "Ground"
        }
      ],
      "localized_name": {},
      "logo": null,
      "name": "Palace of Westminster",
      "opening_hours": null,
      "ref": "Palace of Westminster"
    }
  ],
  "categories": [],
  "languages": [],
  "levels": [
    {
      "bbox": [
        -0.1258015,
        51.4981306,
        -0.1236527,
        51.5008191
      ],
      "level": 1,
      "name": "Palace of Westminster",
      "ref": "Ground"
    }
  ],
  "name": "Westminster palace",
  "routing_profiles": [],
  "updated_at": "2023-07-17T13:11:32.267Z",
  "venue_id": "west_pal"
}

    