Skip to content
agent-data

Search Restaurants

GET
/v1/restaurants/search
 
agent-data call e79d7149-781a-482c-b101-0d1e15d29c9c search-restaurants --platform <platform> [--text <text>] [--name <name>] --city <city> [--state <state>] [--neighborhood <neighborhood>] [--cuisine <cuisine>] [--price_tier <price_tier>] [--min_price_tier <min_price_tier>] [--max_price_tier <max_price_tier>] [--page_token <page_token>] [--max_page_size <max_page_size>] [--strict_location <strict_location>] [--strict_cuisine <strict_cuisine>]

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
platform
required
Platform

Choose exactly one platform. Do not omit this field. Use resy or opentable explicitly.

string
Allowed values: opentable resy

Choose exactly one platform. Do not omit this field. Use resy or opentable explicitly.

text
Any of:
string
>= 1 characters

Use this for broad discovery words such as a restaurant name, dining style, or keyword. Do not rely on text alone when you need strict cuisine or geography matching.

name
Any of:
string
>= 1 characters

Use this when you are trying to find a specific restaurant by identity rather than category.

city
required
City

Provide the city or platform location name you want to search in. This field is required. If you provide a close synonym or spelling variant, the API may normalize it and echo the resolved value.

string
>= 1 characters

Provide the city or platform location name you want to search in. This field is required. If you provide a close synonym or spelling variant, the API may normalize it and echo the resolved value.

state
Any of:
string

Provide the two-letter state code when you know it. Include this whenever the city name could be ambiguous.

neighborhood
Any of:
string

Provide the neighborhood you want to constrain the search to. Always pair this with city and state for the most reliable matching.

cuisine
Any of:
Array<string>

Provide one or more cuisine labels you want enforced. The API may normalize close variants and will echo the resolved values it applied.

price_tier
Any of:
integer
>= 1 <= 4

Provide an exact canonical price tier from 1 through 4 when you need an exact price match.

min_price_tier
Any of:
integer
>= 1 <= 4

Provide the inclusive minimum price tier when you want a price range instead of an exact tier.

max_price_tier
Any of:
integer
>= 1 <= 4

Provide the inclusive maximum price tier when you want a price range instead of an exact tier.

page_token
Any of:
string
max_page_size
Max Page Size
integer
default: 10 >= 1 <= 50
strict_location
Strict Location

Keep this as true when location fields must match returned restaurant metadata exactly after normalization.

boolean
default: true

Keep this as true when location fields must match returned restaurant metadata exactly after normalization.

strict_cuisine
Strict Cuisine

Keep this as true when cuisine fields must match returned restaurant metadata after normalization.

boolean
default: true

Keep this as true when cuisine fields must match returned restaurant metadata after normalization.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
RestaurantSearchResponse
object
results
required
Results
Array<object>
Restaurant
object
id
required
Id
string
name
required
Name
string
tags
Tags
Array<string>
phone
Any of:
string
rating
Any of:
number
<= 5
cuisine
Cuisine
Array<string>
currency
Currency
string
default: USD
location
Any of:
Location
object
lat
Any of:
number
lng
Any of:
number
city
Any of:
string
state
Any of:
string
country
Any of:
string
address1
Any of:
string
address2
Any of:
string
postal_code
Any of:
string
neighborhood
Any of:
string
platform
required
Platform
string
Allowed values: opentable resy
price_tier
Any of:
integer
>= 1 <= 4
description
Any of:
string
platform_id
required
Platform Id
string
rating_count
Any of:
integer
max_party_size
Any of:
integer
availability_href
required
Availability Href
string
is_global_dining_access
Is Global Dining Access
boolean
warnings
Warnings
Array<string>
normalizations
SearchNormalizations
object
input
Input
object
key
additional properties
any
sources
Sources
object
key
additional properties
string
resolved
Resolved
object
key
additional properties
any
confidence
Confidence
object
key
additional properties
DiscoveryConfidence
string
Allowed values: high medium low
applied_filters
required
RestaurantSearchAppliedFilters
object
city
required
City
string
name
Any of:
string
text
Any of:
string
state
Any of:
string
cuisine
Cuisine
Array<string>
platform
required
Platform
string
Allowed values: opentable resy
price_tier
Any of:
integer
>= 1 <= 4
neighborhood
Any of:
string
max_price_tier
Any of:
integer
>= 1 <= 4
min_price_tier
Any of:
integer
>= 1 <= 4
strict_cuisine
Strict Cuisine
boolean
default: true
strict_location
Strict Location
boolean
default: true
next_page_token
Any of:
string
Example 
{
  "results": [
    {
      "currency": "USD",
      "platform": "opentable",
      "is_global_dining_access": false
    }
  ],
  "normalizations": {
    "confidence": {
      "additionalProperty": "high"
    }
  },
  "applied_filters": {
    "platform": "opentable",
    "strict_cuisine": true,
    "strict_location": true
  }
}

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"
    }
  ]
}