---
title: "Get one Burger King restaurant's real-time fulfillment status"
method: GET
path: "/burgerking/availability"
tags: ["Burger King"]
---

# Get one Burger King restaurant's real-time fulfillment status

`GET /burgerking/availability`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/burgerking/availability`
- Auth: API key in header `x-api-key`

Returns one restaurant's live open/closed status per order channel (curbside, delivery, drive-thru, eat-in, mobile-order drive-thru, takeout), distinct from /burgerking/locations' published weekly schedule. Each channel carries whether it is taking orders right now, its current open window when open, and the following window's start/end -- a channel with no current or next window at all means this restaurant does not offer it, not merely that it is closed. Also returns the restaurant's own local time, timezone and an overall available flag. Setting forecast=true additionally returns a multi-day forward schedule per channel, including two catering-only channels not present in the current-status list.

## Query parameters

- `store_id` string, required
- `market` string
- `forecast` boolean

## Headers

- `x-api-key` string, required

## Response `200`

OK

- BurgerkingAvailabilityResponseDoc
  - `code` integer: Code is the HTTP status code or a custom code used to indicate the result of the request @example 200
  - `data` BurgerkingAvailabilityResponse
    - `available` boolean: Available is the upstream's own overall open/closed flag for the store, independent of any single channel.
    - `fetched_at` string
    - `forecast` BurgerkingServiceModeForecast[]: Forecast is a multi-day forward schedule per channel, present only when the request set forecast=true.
      - `mode` string: Mode is one of `catering_delivery`, `catering_pickup`, `curbside`, `delivery`, `drive_thru`, `eat_in`, `mobile_order_drive_thru`, `takeout` -- two more values than ServiceModeAvailability.Mode ever carries (the catering channels only appear in the forecast).
      - `slots` BurgerkingForecastSlot[]
        - `closes_at` string
        - `date` string
        - `is_closed` boolean: IsClosed is nil in the common case (a normal open day); the upstream only appears to set it for a day it flags as a specific exception.
        - `opens_at` string
    - `local_time` string: LocalTime is the restaurant's own current local time, per Timezone.
    - `market` string: Market is the RBI region this store belongs to.
    - `service_modes` BurgerkingServiceModeAvailability[]
      - `closes_at` string
      - `is_open_24_hours` boolean
      - `is_open_now` boolean: IsOpenNow is true when the upstream reports this channel as currently taking orders.
      - `mode` string: Mode is one of `curbside`, `delivery`, `drive_thru`, `eat_in`, `mobile_order_drive_thru`, `takeout`.
      - `next_closes_at` string
      - `next_opens_at` string
      - `opens_at` string: OpensAt/ClosesAt are this channel's current open window, when IsOpenNow is true. NextOpensAt/NextClosesAt are the following window's start/end. All four are RFC3339 timestamps in the restaurant's own local timezone; a nil OpensAt/ClosesAt with a nil NextOpensAt/NextClosesAt too means this restaurant does not offer the channel at all, not merely that it is closed right now.
    - `source_url` string
    - `store_id` string
    - `timezone` string
  - `msg` unknown

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `429`: Too Many Requests
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/0497899e2016?raw)