Get estimated wait time

GET 
/v1/partner/locations/:location_id/wait-time

Retrieves and calculates the estimated wait time range for a given location. The response includes a formatted wait time range based on the current estimated wait time and the optional range_minutes parameter. If the location is closed, it will return 'Currently Closed'. If the wait time is unavailable, it will return 'Unavailable'.

Token scope:

{'scope': 'read:locations'}

Request

Path Parameters

location_id Location Idrequired

Query Parameters

range_minutes Range Minutes

Default value: 15

Optional. Range in minutes to calculate the wait time interval around the estimated wait time.

Responses

200

Successful Response

application/json

Schema

Schema

estimated_wait_time_range Estimated Wait Time Range (string)required

The estimated wait time for the location, formatted as a string.

Example (from schema)

{
  "estimated_wait_time_range": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...