> ## Documentation Index
> Fetch the complete documentation index at: https://docs.maple.inc/llms.txt
> Use this file to discover all available pages before exploring further.

# Estimate the wait

> The wait a new party of `party_size` would be quoted now: the parties ahead that compete for the same tables and a minutes band, never a single number. Parties above 50 answer 422 party_size_out_of_bounds. Requires bookings:read.



## OpenAPI

````yaml /openapi/developer-api.json get /locations/{locationId}/waitlist_estimate
openapi: 3.1.0
info:
  title: Maple Developer API
  version: 0.0.1
  description: >-
    Public API for POS and platform partners to integrate with Maple: granted
    locations and connections, the order loop (validation, notification,
    accept/deny, status updates), payment-link visibility, menu publishing, and
    HMAC-signed webhooks. Authenticate every request with a Bearer API key
    (`mpk_test_…` / `mpk_live_…`). The credential determines the environment:
    test-mode credentials only see test data, live-mode credentials only see
    live data.
servers:
  - url: https://api.maple.inc/v1
    description: Production
  - url: https://api.staging.maple.inc/v1
    description: Sandbox (development and testing)
security: []
tags:
  - name: General
    description: Service status and credential introspection.
  - name: Locations
    description: The restaurant locations your app has been granted access to.
  - name: Connections
    description: Become (or stop being) a granted location’s order receiver.
  - name: Menu
    description: Publish and read a connected location’s menu.
  - name: Delivery zones
    description: >-
      Manage a connected location’s delivery zones and check whether a
      coordinate is deliverable.
  - name: Orders
    description: 'The order loop: read orders, submit validation results, and decide orders.'
  - name: Bookings
    description: >-
      Bookings (rolling out per location): a location’s booking profile,
      availability, holds, bookings, walk-ins, venue verbs, configuration, and
      live floor.
  - name: Waitlist
    description: >-
      A Maple-native location’s walk-up waitlist: the queue and wait estimate,
      joining, and venue actions.
  - name: Webhooks
    description: Event-type catalog, subscriptions, the event ledger, and replay.
  - name: Feedback
    description: >-
      Tell Maple about a bug, a missing capability, wrong docs, or an error you
      could not act on.
paths:
  /locations/{locationId}/waitlist_estimate:
    get:
      tags:
        - Waitlist
      summary: Estimate the wait
      description: >-
        The wait a new party of `party_size` would be quoted now: the parties
        ahead that compete for the same tables and a minutes band, never a
        single number. Parties above 50 answer 422 party_size_out_of_bounds.
        Requires bookings:read.
      operationId: developer-api-waitlist.getWaitlistEstimate
      parameters:
        - name: locationId
          in: path
          schema:
            type: string
          required: true
        - name: party_size
          in: query
          schema:
            type: string
            allOf:
              - pattern: ^[+-]?\d*\.?\d+(?:[Ee][+-]?\d+)?$
          required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                      - waitlist_estimate
                  location_id:
                    type: string
                  livemode:
                    type: boolean
                  party_size:
                    type: integer
                  parties_ahead:
                    type: integer
                  wait_minutes:
                    type: object
                    properties:
                      min:
                        type: integer
                      max:
                        type: integer
                    required:
                      - min
                      - max
                    additionalProperties: false
                required:
                  - object
                  - location_id
                  - livemode
                  - party_size
                  - parties_ahead
                  - wait_minutes
                additionalProperties: false
        '400':
          description: DeveloperApiBadRequest
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/DeveloperApiBadRequest'
                  - $ref: '#/components/schemas/DeveloperApiBadRequest'
        '401':
          description: DeveloperApiUnauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiUnauthorized'
        '403':
          description: DeveloperApiForbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiForbidden'
        '404':
          description: DeveloperApiNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiNotFound'
        '422':
          description: DeveloperApiUnprocessable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiUnprocessable'
        '429':
          description: DeveloperApiRateLimited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiRateLimited'
          headers:
            Retry-After:
              description: >-
                Seconds to wait before retrying; also returned as retry_after in
                the body.
              schema:
                type: integer
                minimum: 1
      security:
        - bearer: []
components:
  schemas:
    DeveloperApiBadRequest:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiBadRequest
        code:
          type: string
        message:
          type: string
        feedback:
          type: string
          description: Where to report this error if it does not tell you what to change.
      required:
        - _tag
        - message
        - feedback
      additionalProperties: false
    DeveloperApiUnauthorized:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiUnauthorized
        message:
          type: string
        feedback:
          type: string
          description: Where to report this error if it does not tell you what to change.
      required:
        - _tag
        - message
        - feedback
      additionalProperties: false
    DeveloperApiForbidden:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiForbidden
        code:
          type: string
          enum:
            - insufficient_scope
            - wrong_environment
        message:
          type: string
        feedback:
          type: string
          description: Where to report this error if it does not tell you what to change.
      required:
        - _tag
        - code
        - message
        - feedback
      additionalProperties: false
    DeveloperApiNotFound:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiNotFound
        message:
          type: string
        feedback:
          type: string
          description: Where to report this error if it does not tell you what to change.
      required:
        - _tag
        - message
        - feedback
      additionalProperties: false
    DeveloperApiUnprocessable:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiUnprocessable
        code:
          type: string
        message:
          type: string
        details:
          type: object
        feedback:
          type: string
          description: Where to report this error if it does not tell you what to change.
      required:
        - _tag
        - code
        - message
        - feedback
      additionalProperties: false
    DeveloperApiRateLimited:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiRateLimited
        message:
          type: string
        retry_after:
          anyOf:
            - type: number
            - type: string
              enum:
                - NaN
            - type: string
              enum:
                - Infinity
            - type: string
              enum:
                - '-Infinity'
        feedback:
          type: string
          description: Where to report this error if it does not tell you what to change.
      required:
        - _tag
        - message
        - retry_after
        - feedback
      additionalProperties: false
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        API key — `mpk_test_…` for the sandbox, `mpk_live_…` for production.
        Issued by Maple during partner onboarding.

````