Autocomplete
Query Parameters
Query
- Type:
string - Required: Yes
- Description: A search term to be applied against titles. Must be at least 3 characters long.
Latitude/Longitude (ll)
- Type:
string - Description: The latitude/longitude around which you wish to retrieve place information. Specified as latitude,longitude (e.g., ll=41.8781,-87.6298). If you do not specify ll, the server will attempt to retrieve the IP address from the request, and geolocate that IP address.
Radius
- Type:
int32 - Description: Defines the distance (in meters) within which to return place results. Setting a radius biases the results to the indicated area, but may not fully restrict results to that specified area. If not provided, default radius is set to 5000 meters.
Types
- Type:
string - Description: The types of results to return; any combination of place, search, and/or geo. If no types are specified, all types will be returned.
Bias
- Type:
string - Description: Bias the autocomplete results by a specific type; one of place, search, or geo.
Session Token
Type:
stringDescription: A user-generated token to group the user's query and the user's selected result into a discrete session for billing purposes. Learn more about session tokens.
If the session_token parameter is omitted, the session is charged per keystroke/request.
Limit
- Type:
int32 - Description: The number of results to return, up to 50. Defaults to 10.
X-Places-Api-Version
- Type:
string - Enum: Required
- Defaults to:
2025-06-17 - Allowed:
2025-06-17
- Defaults to:
Example Response
200 Success
{
"results": [
{
"type": "string",
"text": {
"primary": "string",
"secondary": "string",
"highlight": [{
"start": 0,
"length": 0
}]
},
"icon": {
"fsq_photo_id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"prefix": "string",
"suffix": "string",
"width": 0,
"height": 0,
"classifications": ["string"],
"tip": {
"fsq_tip_id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"text": "string",
"url": "string",
"photo": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"prefix": "string",
"suffix": "string",
"width": 0,
"height": 0,
"classifications": ["string"],
"tip": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"text": "string",
"url": "string",
"lang": "string",
"agree_count": 0,
"disagree_count": 0
}
},
"lang": "string",
"agree_count": 0,
"disagree_count": 0
}
},
"link": "string",
"place": {
"fsq_place_id": "string",
"latitude": 0,
"longitude": 0,
"categories": [{
"fsq_category_id": "string",
"name": "string",
"short_name": "string",
"plural_name": "string",
"icon": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"prefix": "string",
"suffix": "string",
"width": 0,
"height": 0,
"classifications": ["string"],
"tip": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"text": "string",
"url": "string",
"lang": "string",
"agree_count": 0,
"disagree_count": 0
}
}
}],
"chains": [{
"fsq_chain_id": "string",
"name": "string",
"logo": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"prefix": "string",
"suffix": "string",
"width": 0,
"height": 0,
"classifications": ["string"],
"tip": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"text": "string",
"url": "string",
"lang": "string",
"agree_count": 0,
"disagree_count": 0
}
},
"parent_id": "string"
}],
"date_closed": "2026-07-25",
"date_created": "string",
"date_refreshed": "string",
"description": "string",
"distance": 0,
"email": "string",
"extended_location": {
"dma": "string",
"census_block_id": "string"
},
"attributes": {
"restroom": true,
"outdoor_seating": true,
"atm": true,
"has_parking": true,
"wifi": "string",
"delivery": true,
"reservations": true,
"takes_credit_card": true
},
"hours": {
"display": "string",
"is_local_holiday": true,
"open_now": true,
"regular": [{
"close": "string",
"day": 0,
"open": "string"
}]
},
"hours_popular": [{
"close": "string",
"day": 0,
"open": "string"
}],
"link": "string",
"location": {
"address": "string",
"locality": "string",
"region": "string",
"postcode": "string",
"admin_region": "string",
"post_town": "string",
"po_box": "string",
"country": "string",
"formatted_address": "string"
},
"menu": "string",
"name": "string",
"photos": [{
"fsq_photo_id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"prefix": "string",
"suffix": "string",
"width": 0,
"height": 0,
"classifications": ["string"],
"tip": {
"fsq_tip_id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"text": "string",
"url": "string",
"photo": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"prefix": "string",
"suffix": "string",
"width": 0,
"height": 0,
"classifications": ["string"],
"tip": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"text": "string",
"url": "string",
"lang": "string",
"agree_count": 0,
"disagree_count": 0
}
},
"lang": "string",
"agree_count": 0,
"disagree_count": 0
}
}],
"place_actions": [{
"action": "string",
"url": "string",
"provider_id": "string"
}],
"popularity": 0,
"placemaker_url": "string",
"price": 0,
"rating": 0,
"related_places": {
"parent": {
"fsq_place_id": "string",
"latitude": 0,
"longitude": 0,
"categories": [{
"fsq_category_id": "string",
"name": "string",
"short_name": "string",
"plural_name": "string",
"icon": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"prefix": "string",
"suffix": "string",
"width": 0,
"height": 0,
"classifications": ["string"],
"tip": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"text": "string",
"url": "string",
"lang": "string",
"agree_count": 0,
"disagree_count": 0
}
}
}],
"chains": [{
"fsq_chain_id": "string",
"name": "string",
"logo": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"prefix": "string",
"suffix": "string",
"width": 0,
"height": 0,
"classifications": ["string"],
"tip": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"text": "string",
"url": "string",
"lang": "string",
"agree_count": 0,
"disagree_count": 0
}
},
"parent_id": "string"
}],
"date_closed": "2026-07-25",
"date_created": "string",
"date_refreshed": "string",
"description": "string",
"distance": 0,
"email": "string",
"extended_location": {
"dma": "string",
"census_block_id": "string"
},
"attributes": {
"restroom": true,
"outdoor_seating": true,
"atm": true,
"has_parking": true,
"wifi": "string",
"delivery": true,
"reservations": true,
"takes_credit_card": true
},
"hours": {
"display": "string",
"is_local_holiday": true,
"open_now": true,
"regular": [{
"close": "string",
"day": 0,
"open": "string"
}]
},
"hours_popular": [{
"close": "string",
"day": 0,
"open": "string"
}],
"link": "string",
"location": {
"address": "string",
"locality": "string",
"region": "string",
"postcode": "string",
"admin_region": "string",
"post_town": "string",
"po_box": "string",
"country": "string",
"formatted_address": "string"
},
"menu": "string",
"name": "string",
"photos": [{
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"prefix": "string",
"suffix": "string",
"width": 0,
"height": 0,
"tip": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"text": "string",
"url": "string",
"lang": "string",
"agree_count": 0,
"disagree_count": 0
}
}],
"place_actions": [{
"action": "string",
"url": "string",
"provider_id": "string"
}],
"popularity": 0,
"placemaker_url": "string",
"price": 0,
"rating": 0,
"social_media": {
"facebook_id": "string",
"instagram": "string",
"twitter": "string"
},
"stats": {
"total_photos": 0,
"total_ratings": 0,
"total_tips": 0
},
"store_id": "string",
"tastes": ["string"],
"tel": "string",
"tips": [{
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"text": "string",
"url": "string",
"lang": "string",
"agree_count": 0,
"disagree_count": 0
}],
"website": "string"
},
"children": [{
"fsq_place_id": "string",
"latitude": 0,
"longitude": 0,
"categories": [{
"fsq_category_id": "string",
"name": "string",
"short_name": "string",
"plural_name": "string",
"icon": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"prefix": "string",
"suffix": "string",
"width": 0,
"height": 0,
"classifications": ["string"],
"tip": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"text": "string",
"url": "string",
"lang": "string",
"agree_count": 0,
"disagree_count": 0
}
}
}],
"chains": [{
"fsq_chain_id": "string",
"name": "string",
"logo": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"prefix": "string",
"suffix": "string",
"width": 0,
"height": 0,
"classifications": ["string"],
"tip": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"text": "string",
"url": "string",
"lang": "string",
"agree_count": 0,
"disagree_count": 0
}
},
"parent_id": "string"
}],
"date_closed": "2026-07-25",
"date_created": "string",
"date_refreshed": "string",
"description": "string",
"distance": 0,
"email": "string",
"extended_location": {
"dma": "string",
"census_block_id": "string"
},
"attributes": {
"restroom": true,
"outdoor_seating": true,
"atm": true,
"has_parking": true,
"wifi": "string",
"delivery": true,
"reservations": true,
"takes_credit_card": true
},
"hours": {
"display": "string",
"is_local_holiday": true,
"open_now": true,
"regular": [{
"close": "string",
"day": 0,
"open": "string"
}]
},
"hours_popular": [{
"close": "string",
"day": 0,
"open": "string"
}],
"link": "string",
"location": {
"address": "string",
"locality": "string",
"region": "string",
"postcode": "string",
"admin_region": "string",
"post_town": "string",
"po_box": "string",
"country": "string",
"formatted_address": "string"
},
"menu": "string",
"name": "string",
"photos": [{
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"prefix": "string",
"suffix": "string",
"width": 0,
"height": 0,
"tip": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"text": "string",
"url": "string",
"lang": "string",
"agree_count": 0,
"disagree_count": 0
}
}],
"place_actions": [{
"action": "string",
"url": "string",
"provider_id": "string"
}],
"popularity": 0,
"placemaker_url": "string",
"price": 0,
"rating": 0,
"social_media": {
"facebook_id": "string",
"instagram": "string",
"twitter": "string"
},
"stats": {
"total_photos": 0,
"total_ratings": 0,
"total_tips": 0
},
"store_id": "string",
"tastes": ["string"],
"tel": "string",
"tips": [{
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"text": "string",
"url": "string",
"lang": "string",
"agree_count": 0,
"disagree_count": 0
}],
"website": "string"
}
]
},
"search": {
"query": "string",
"category": {
"fsq_category_id": "string",
"name": "string",
"short_name": "string",
"plural_name": "string",
"icon": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"prefix": "string",
"suffix": "string",
"width": 0,
"height": 0,
"classifications": ["string"],
"tip": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"text": "string",
"url": "string",
"lang": "string",
"agree_count": 0,
"disagree_count": 0
}
}
},
"chain": {
"fsq_chain_id": "string",
"name": "string",
"logo": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"prefix": "string",
"suffix": "string",
"width": 0,
"height": 0,
"classifications": ["string"],
"tip": {
"id": "string",
"created_at": "2026-07-25T03:53:04.381Z",
"text": "string",
"url": "string",
"lang": "string",
"agree_count": 0,
"disagree_count": 0
}
},
"parent_id": "string"
}
},
"geo": {
"name": "string",
"center": {
"latitude": 0,
"longitude": 0
},
"bounds": {
"ne": {
"latitude": 0,
"longitude": 0
},
"sw": {
"latitude": 0,
"longitude": 0
}
},
"cc": "string",
"type": "string"
},
"debug": {
"score": 0
}
}
]
}