Search For A Store

Use this API to search among 1M+ restaurants, grocery stores, electronic stores, etc. in the US and Canada.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The search query. Try leaving this empty to browse what's available!

number
required
Defaults to 37.7786357

The latitude of the user.

number
required
Defaults to -122.3918135

The longitude of the user. In the US, this value is negative.

string
Defaults to restaurant

The type of stores to search from. Can be restaurant, grocery, or empty string for both.

number
Defaults to 20

The maximum amount, in Dollars, that the user has specified they'd like to spend on this meal. Required for applying a sort.

string
Defaults to 188

Street number of the user. Required if fetch_quotes is true and pickup is false.

string
Defaults to King Street

Street name of the user. Required if fetch_quotes is true and pickup is false.

string
Defaults to San Francisco

City of the user. Required if fetch_quotes is true and pickup is false.

string
Defaults to CA

State abbreviation of the user. Required if fetch_quotes is true and pickup is false.

string
Defaults to 94107

Zipcode of the user. Required if fetch_quotes is true and pickup is false.

string
Defaults to US

Country of the user. Can be US or CA. Required if fetch_quotes is true and pickup is false.

boolean
Defaults to false

If true, filter stores to only those that offer pickup. If false, filter to only stores with delivery.

boolean
Defaults to false

Whether to fetch realtime delivery/pickup quotes. Note that this being true greatly increases response time. Note that if this is true and the query is also empty then store hours will not be in the response.

integer

Timeout to apply if fetch_quotes = true, in seconds.

string
Defaults to relevance

The sort type. Can be cheapest, fastest, rating, distance or the default relevance.

boolean
Defaults to false

Whether or not to return only open restaurants.

integer

ex: 2 (which would signal $$). Cost for the average meal. This can represent 1 ($) for the cheapest stores or 4 ($$$$) for the most expensive stores.

string

The cuisine to filter stores by.

number

ex: 4.6. The minimum rating allowed.

number
Defaults to 3

ex: 1.5. The maximum distance allowed, in miles.

integer

ex: 0. The page to fetch, to retrieve more results. This is returned as next_page in the response.

number

The minimum latitude for a "Search In This Area".

number

The maximum latitude for a "Search In This Area".

number

The minimum longitude for a "Search In This Area".

number

The maximum longitude for a "Search In This Area".

string
Defaults to store

Whether to focus the search on store name or item name. Can be item, store, or left empty for both.

boolean
Defaults to false

Whether to return one default quote when fetch_quotes is true.

boolean
Defaults to false

Whether to include store hours in utc time.

string
Defaults to _id,name,address,type,is_open

A comma-delimited list of store properties to include in the response, exclusively. Note that the following properties cannot be excluded: _id, name, address, type, is_open. If fetch_quotes is true, quotes cannot be excluded.

Allowed values: _id, name, phone_number, address, description, hours, local_hours, cuisines, food_photos, logo_photos, store_photos, dollar_signs, pickup_enabled, delivery_enabled, is_open, offers_first_party_delivery, offers_third_party_delivery, miles, weighted_rating_value, aggregated_rating_count, supports_upc_codes, type

boolean
Defaults to true

Whether to perform the store search among a new database. Note that if use_new_db is true, use_new_db must also be true when making a request to Get Inventory or Get MealMe Store with any store _id returned from this request.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json