Place Search

query

• string
  A string to be matched against all content for this place, including but not limited to venue name, category, telephone number, taste, and tips.

ll

• string
  The latitude/longitude around which to retrieve place information. This must be specified as latitude,longitude (e.g., ll=41.8781,-87.6298).

radius

• int32
  Sets a radius distance (in meters) used to define an area to bias search results. The maximum allowed radius is 100,000 meters. Radius can be used in combination with ll or ip biased geolocation only.

fsq_category_ids

• string
  Filters the response and returns FSQ Places matching the specified categories. Supports multiple Category IDs, separated by commas.

fsq_chain_ids

• string
  Filters the response and returns FSQ Places matching the specified chains. Supports multiple chain IDs, separated by commas.

exclude_fsq_chain_ids

• string
  Filters the response and returns FSQ Places not matching any of the specified chains. Supports multiple chain IDs, separated by commas.

exclude_all_chains

• boolean
  Filters the response by only returning FSQ Places that are not known to be part of any chain.

fields

• string
  Indicate which fields to return in the response, separated by commas. If no fields are specified, all Pro Fields are returned by default.

min_price

• int32
  Restricts results to only those places within the specified price range. Valid values range between 1 (most affordable) to 4 (most expensive), inclusive.

max_price

open_at

• string
  Support local day and local time requests through this parameter. To be specified as DOWTHHMM (e.g., 1T2130).

open_now

• boolean
  Restricts results to only those places that are open now.

tel_format

• string
  Specifies the format of the returned telephone number.

ne

• string
  The latitude/longitude representing the north/east points of a rectangle.

sw

• string
  The latitude/longitude representing the south/west points of a rectangle.

near

• string
  A string naming a locality in the world (e.g., "Chicago, IL").

sort

• string
  Specifies the order in which results are listed.

limit

• int32
  The number of results to return, up to 50. Defaults to 10.

X-Places-Api-Version

• string
  Required version of the API to use.

200 success

object

• results
  • array of objects
    • object
      • fsq_place_id: string
      • latitude: double
      • longitude: double
      • categories: [{fsq_category_id: string, name: string, short_name: string, plural_name: string, icon: {id: string, created_at: string, prefix: string, suffix: string, width: integer, height: integer}}]
      • chains: [{fsq_chain_id: string, name: string, logo: {id: string, created_at: string, prefix: string, suffix: string, width: integer, height: integer}}]
      • date_closed: date
      • date_created: string
      • date_refreshed: string
      • description: string
      • distance: integer
      • email: string
      • extended_location: {dma: string, census_block_id: string}
      • attributes: object
      • hours: object
      • hours_popular: [{close: string, day: integer, open: string}]
      • link: string
      • location: object
      • menu: string
      • name: string
      • photos: [{fsq_photo_id: string, created_at: date, prefix: string, suffix: string, width: integer, height: integer}]
      • place_actions: [{action: string, url: string, provider_id: string}]
      • popularity: double
      • placemaker_url: string
      • price: integer
      • rating: double
      • related_places: object
      • social_media: object
      • stats: object
      • store_id: string
      • tastes: [string]
      • tel: string
      • tips: [{fsq_tip_id: string, created_at: date, text: string, url: string}]
      • website: string

400 bad request

401 unauthorized