Skip to content
agent-data

Get Availability

GET
/v1/availability
 
agent-data call e79d7149-781a-482c-b101-0d1e15d29c9c check-availability --platform <platform> [--platform_id <platform_id>] [--query <query>] [--location <location>] --date <date> --party_size <party_size> [--time_start <time_start>] [--time_end <time_end>] [--include_raw <include_raw>]

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
platform
required
Platform

Required. Set this to resy or opentable. Do not omit it.

string

Required. Set this to resy or opentable. Do not omit it.

platform_id
Any of:
string

Use this when you already know the provider-specific restaurant ID. Prefer this field because it avoids an extra name-resolution step.

query
Any of:
string

Use this only for platform=opentable when platform_id is unknown. Provide the restaurant name to resolve before fetching availability.

location
Any of:
string

Use this only with OpenTable query resolution. Provide the city or market needed to disambiguate the restaurant name.

date
required
Date

Required. Provide the target dining date in YYYY-MM-DD format.

string format: date

Required. Provide the target dining date in YYYY-MM-DD format.

party_size
required
Party Size

Required. Provide the total number of diners as an integer from 1 to 20.

integer
>= 1 <= 20

Required. Provide the total number of diners as an integer from 1 to 20.

time_start
Any of:
string format: time

Optional. Use this to keep only slots at or after the specified local time.

time_end
Any of:
string format: time

Optional. Use this to keep only slots at or before the specified local time.

include_raw
Include Raw

Optional. Set this to true only when you need provider raw payload fragments for debugging. Leave it false for normal agent use.

boolean

Optional. Set this to true only when you need provider raw payload fragments for debugging. Leave it false for normal agent use.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
AvailabilityResponse
object
date
required
Date
string format: date
slots
required
Slots
Array<object>
AvailabilitySlot
object
raw
Any of:
object
key
additional properties
any
date
required
Date
string format: date
time
required
Time
string format: time
platform
required
Platform
string
Allowed values: opentable resy
slot_type
required
SlotType
string
Allowed values: standard experience counter outdoor
party_size
required
Party Size
integer
>= 1 <= 20
table_type
Any of:
string
booking_url
required
Booking Url
string
restaurant_id
required
Restaurant Id
string
deposit_required
required
Deposit Required
boolean
duration_minutes
Any of:
integer
>= 1
deposit_amount_cents
Any of:
integer
platform_restaurant_id
required
Platform Restaurant Id
string
errors
Any of:
Array<object>
PlatformError
object
message
required
Message
string
platform
required
Platform
string
Allowed values: opentable resy
retryable
required
Retryable
boolean
error_type
required
Error Type
string
Allowed values: rate_limited blocked timeout parse_error not_found unknown
retry_after_seconds
Any of:
integer
platform
required
Platform
string
Allowed values: opentable resy
party_size
required
Party Size
integer
queried_at
required
Queried At
string format: date-time
restaurant_name
required
Restaurant Name
string
Example 
{
  "slots": [
    {
      "platform": "opentable",
      "slot_type": "standard"
    }
  ],
  "errors": [
    {
      "platform": "opentable",
      "error_type": "rate_limited"
    }
  ],
  "platform": "opentable"
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
Example generated
{
  "detail": [
    {
      "ctx": {},
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example"
    }
  ]
}