Place Search
GET {{baseUrl}}/v3/places/search?query=Burgers&ll=41.8781,-87.6298&radius=36105&categories=13000&exclude_all_chains=true&fields=fsq_id,name,location&min_price=3&max_price=3&open_at=&open_now=true&near=&sort=DISTANCE&limit=20&session_token={{session_token}}
Search for places in the FSQ Places database using a location and querying by name, category name, telephone number, taste label, or chain name. For example, search for coffee
to get back a list of recommended coffee shops.
You may pass a location with your request by using one of the following options. If none of the following options are passed, Place Search defaults to geolocation using ip biasing with the optional radius parameter.
- ll & radius (circular boundary)
- near (geocodable locality)
- ne & sw (rectangular boundary)
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
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 | number | 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. By using radius, global search results will be omitted. | |
categories | number | Filters the response and returns FSQ Places matching the specified categories. Supports multiple Category IDs, separated by commas. |
For a complete list of Foursquare Category IDs, refer to the <a href="https://docs.foursquare.com/docs/categories" target="blank">Category Taxonomy</a> page. |
| chains | null | | Filters the response and returns FSQ Places matching the specified chains. Supports multiple chain IDs, separated by commas.
For more information on Foursquare Chain IDs, refer to the <a href="https://docs.foursquare.com/docs/chains" target="blank">Chains</a> page. |
| exclude_chains | null | | Filters the response and returns FSQ Places not matching any of the specified chains. Supports multiple chain IDs, separated by commas.
For more information on Foursquare Chain IDs, refer to the <a href="https://docs.foursquare.com/docs/chains" target="blank">Chains</a> page. |
| 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 <a href="https://docs.foursquare.com/reference/response-fields#core-data-fields" target="_blank">Core Fields</a> are returned by default.
For a complete list of returnable fields, refer to the <a href="https://docs.foursquare.com/reference/response-fields" target="_blank">Response Fields</a> page. |
| min_price | number | | 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 | number | | Restricts results to only those places within the specified price range. Valid values range between 1 (most affordable) to 4 (most expensive), inclusive. |
| open_at | null | | Support local day and local time requests through this parameter. To be specified as DOWTHHMM (e.g., 1T2130), where DOW is the day number 1-7 (Monday = 1, Sunday = 7) and time is in 24 hour format.
Places that do not have opening hours will not be returned if this parameter is specified. |
| open_now | boolean | | Restricts results to only those places that are open now.
Places that do not have opening hours will not be returned if this parameter is specified. |
| ne | null | | The latitude/longitude representing the north/east points of a rectangle. Must be used with sw parameter to specify a rectangular search box. Global search results will be omitted. |
| sw | null | | The latitude/longitude representing the south/west points of a rectangle. Must be used with ne parameter to specify a rectangular search box. Global search results will be omitted. |
| near | null | | A string naming a locality in the world (e.g., "Chicago, IL"). If the value is not geocodable, returns an error. |
| sort | string | | Specifies the order in which results are listed. Possible values are:<ul><li>relevance (default)</li><li>rating</li><li>distance</li></ul> |
| limit | number | | The number of results to return, up to 50. Defaults to 10. |
| session_token | string | | A user-generated token to identify a session for billing purposes. Learn more about session tokens. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"results":[{"fsq_id":"12340b116d390f4708ed099a","categories":[{"id":13065,"name":"Restaurant","icon":{"id":"1234","created_at":"2022-04-23T18:25:43.511Z","prefix":"https://ss3.4sqi.net/img/categories_v2/food/hotdog_","suffix":".png","width":1500,"height":1500,"classifications":["food"],"tip":{"id":"123ABC","created_at":"2022-04-23T18:25:43.511Z","text":"A POI tip","url":"somelink.com","photo":"photolink.com","lang":"EN","agree_count":1000,"disagree_count":1000}}}],"chains":[{"id":"12345","name":"Chain Name"}],"date_closed":"2023-01-15","description":"description of poi","distance":292,"email":"poi@site.com","fax":"123-456-7890","features":{"payment":{"credit_cards":{"accepts_credit_cards":{},"discover":{},"visa":{},"diners_club":{},"master_card":{}},"digital_wallet":{"accepts_nfc":{}}},"food_and_drink":{"alcohol":{"beer":{},"byo":{},"cocktails":{},"full_bar":{},"wine":{}},"meals":{"breakfast":{},"brunch":{},"lunch":{},"happy_hour":{},"dessert":{},"dinner":{}}},"services":{"delivery":{},"takeout":{},"drive_through":{},"dine_in":{"reservations":{},"online_reservations":{},"groups_only_reservations":{}}},"amenities":{"restroom":{},"smoking":{},"jukebox":{},"music":{},"live_music":{},"private_room":{},"outdoor_seating":{},"tvs":{},"atm":{},"coat_check":{},"wheelchair_accessible":{},"parking":{"parking":{},"street_parking":{},"valet_parking":{},"public_lot":{},"private_lot":{}}}},"geocodes":{"drop_off":{"latitude":41.879136,"longitude":-87.632628},"front_door":{"latitude":41.879136,"longitude":-87.632628},"main":{"latitude":41.879136,"longitude":-87.632628},"road":{"latitude":41.879136,"longitude":-87.632628},"roof":{"latitude":41.879136,"longitude":-87.632628}},"hours":{"display":"lorem","is_local_holiday":false,"open_now":true,"regular":[{"close":"10:00pm","day":"1","open":"6:00am"}],"seasonal":[{"closed":"true","end_date":"2023-01-15","hours":[{"close":"10:00pm","day":"1","open":"6:00am"}],"start_date":"2023-01-14"}]},"hours_popular":[{"close":"10:00pm","day":"1","open":"6:00am"}],"link":"/v3/places/4c6b0b116d390f4708ed099a","location":{"address":"Ut magna ut","address_extended":"exercitation cupidatat lab","admin_region":"ad id nostrud exercitation commodo","census_block":"culpa id est deserunt","country":"sed exercitation ipsum","cross_street":"labore est dolore tempor eiusm","dma":"cillum cupidatat deserunt officia","formatted_address":"quis anim voluptate labore tempor","locality":"amet deserunt sunt eiusmod","neighborhood":["quis anim"],"po_box":"culpa incididunt amet in","post_town":"in","postcode":"sed ","region":"amet reprehenderit eu Lorem"},"menu":"lorem ipsum","name":"The Florentine","photos":[{"id":"123455f5b863c0008b1edca","created_at":"2020-01-14T02:50:07.000Z","prefix":"https://fastly.4sqi.net/img/general/","suffix":"/12345438_8tJRLpG3PbPVN-Ekde66x8XN7IVVYP__YaS1KmLfntc.png","width":2000,"height":1500,"classifications":["food"],"tip":{"id":"123ABC","created_at":"2022-04-23T18:25:43.511Z","text":"A POI tip","url":"somelink.com","photo":"photolink.com","lang":"EN","agree_count":1000,"disagree_count":1000}}],"popularity":"1.75","price":2,"rating":"75.52","related_places":{"parent":"lorem ipsom"},"social_media":{"facebook_id":"lorem","instagram":"ipsom","twitter":"plurubus"},"stats":{"total_photos":20,"total_ratings":50,"total_tips":25},"store_id":"plurubus","tastes":["lorem"],"tel":"123-456-7890","timezone":"America/Chicago","tips":[{"id":"ullamco qui dolore","created_at":"1963-08-21T13:57:06.927Z","text":"eiusmod","url":"eu commodo ut","photo":"lorem ipsom","lang":"nulla","agree_count":40683730,"disagree_count":-65410876}],"verified":true,"website":"www.thesite.com"}],"context":{"geo_bounds":{"circle":{"center":{"latitude":41.8781,"longitude":-87.6298},"radius":36105}}}}