A RESTful Service for querying food trucks info based on location.
The APIs are consistent with Yelp's Fusion API, but it focuses on searching food trucks.
By posting this request, you will get a access_token and token_type.
Please attach the two parameters into HTTP Headers when you send a GET request for searching food trucks.
POST /foodtrucks/auth
POST https://jirv8u2ell.execute-api.us-west-1.amazonaws.com/dev/foodtrucks/auth
Response Body
{
"access_token": "UOG4x25kRFF6bWtb-Sq8wP2J3mD9NZfSKbKdweHWO0nC7C-A5-ROuVH30RQ7_2tQrYpIAvOuIjI9OBtON8BtUb49la3UGXmc0B_tgTddC14pp0ceMTSHY_xxnyhtWXYx",
"expires_in": 15270710,
"token_type": "Bearer"
}Search food trucks by city or geolocation.
GET /foodtrucks/search
Search Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| location | string | Required | if either latitude or longitude is not provided. Specifies the combination of "address, neighborhood, city, state or zip, optional country" to be used when searching for businesses. |
| latitude | decimal | Required | if location is not provided. Latitude of the location you want to search nearby. |
| longitude | decimal | Required | if location is not provided. Longitude of the location you want to search nearby. |
| radius | int | Optional | Search radius in meters. If the value is too large, a AREA_TOO_LARGE error may be returned. The max value is 40000 meters (25 miles). |
| categories | string | Optional | Categories to filter the search results with. See the list of supported categories. The category filter can be a list of comma delimited categories. For example, "bars,french" will filter by Bars and French. The category identifier should be used (for example "discgolf", not "Disc Golf"). |
| locale | string | Optional | Specify the locale to return the business information in. See the list of supported locales. |
| limit | int | Optional | Number of business results to return. By default, it will return 20. Maximum is 50. |
| offset | int | Optional | Offset the list of returned business results by this amount. |
| sort_by | string | Optional | Sort the results by one of the these modes: best_match, rating, review_count or distance. By default it's best_match. The rating sort is not strictly sorted by the rating value, but by an adjusted rating value that takes into account the number of ratings, similar to a bayesian average. This is so a business with 1 rating of 5 stars doesn’t immediately jump to the top. |
| price | string | Optional | Pricing levels to filter the search result with: 1 = |
| open_now | boolean | Optional | Default to false. When set to true, only return the businesses open now. Notice that open_at and open_now cannot be used together. |
| open_at | int | Optional | An integer represending the Unix time in the same timezone of the search location. If specified, it will return business open at the given time. Notice that open_at and open_now cannot be used together. |
| attributes | string | Optional | Additional filters to restrict search results. Possible values are:
|
GET https://jirv8u2ell.execute-api.us-west-1.amazonaws.com/dev/foodtrucks/search?latitude=37.3533530886479&longitude=-122.013784749846&radius_filter=500
Request Headers
Authorization === ${token_type} ${access_token}
Content-Type: application/json
Authorization: Bearer UOG4x25kRFF6bWtb-Sq8wP2J3mD9NZfSKbKdweHWO0nC7C-A5-ROuVH30RQ7_2tQrYpIAvOuIjI9OBtON8BtUb49la3UGXmc0B_tgTddC14pp0ceMTSHY_xxnyhtWXYx
Response Body
{
"statusCode": 200,
"body": {
"businesses": [
{
"id": "delhi-chaat-sunnyvale-2",
"name": "Delhi Chaat",
"image_url": "https://s3-media4.fl.yelpcdn.com/bphoto/g7ZZOXWzR5dAAu3OhJ-9hw/o.jpg",
"is_closed": false,
"url": "https://www.yelp.com/biz/delhi-chaat-sunnyvale-2?adjust_creative=XlnTMhO5pJ8whMNEegSKig&utm_campaign=yelp_api_v3&utm_medium=api_v3_business_search&utm_source=XlnTMhO5pJ8whMNEegSKig",
"review_count": 170,
"rating": 4,
"coordinates": {
"latitude": 37.3676143,
"longitude": -122.0225156
},
"transactions": [],
"price": "$",
"location": {
"address1": "603 Old San Francisco Rd",
"address2": "",
"address3": "",
"city": "Sunnyvale",
"zip_code": "94086",
"country": "US",
"state": "CA",
"display_address": [
"603 Old San Francisco Rd",
"Sunnyvale, CA 94086"
]
},
"phone": "",
"display_phone": "",
"distance": 726.874826268
},
...
]
}
}| Name | Data Type | Description |
|---|---|---|
| businesses | object[] | A list of business Yelp finds based on the search criteria. |
| businesses[x].coordinates | object | The coordinates of this business. |
| businesses[x].coordinates.latitude | decimal | The latitude of this business. |
| businesses[x].coordinates.longitude | decimal | The longitude of this business. |
| businesses[x].display_phone | string | Phone number of the business formatted nicely to be displayed to users. The format is the standard phone number format for the business's country. |
| businesses[x].distance | decimal | The distance in meters from the search location. This returns meters regardless of the locale. |
| businesses[x].id | string | Yelp id of this business. |
| businesses[x].image_url | string | URL of photo for this business. |
| businesses[x].is_closed | bool | Whether business has been (permanently) closed |
| businesses[x].location | object | The location of this business, including address, city, state, zip code and country. |
| businesses[x].location.address1 | string | Street address of this business. |
| businesses[x].location.address2 | string | Street address of this business, continued. |
| businesses[x].location.address3 | string | Street address of this business, continued. |
| businesses[x].location.city | string | City of this business. |
| businesses[x].location.country | string | ISO 3166-1 alpha-2 country code of this business. |
| businesses[x].location.display_address | string[] | Array of strings that if organized vertically give an address that is in the standard address format for the business's country. |
| businesses[x].location.state | string | ISO 3166-2 (with a few exceptions) state code of this business. |
| businesses[x].location.zip_code | string | Zip code of this business. |
| businesses[x].name | string | Name of this business. |
| businesses[x].phone | string | Phone number of the business. |
| businesses[x].price | string | Price level of the business. Value is one of |
| businesses[x].rating | decimal | Rating for this business (value ranges from 1, 1.5, ... 4.5, 5). |
| businesses[x].review_count | int | Number of reviews for this business. |
| businesses[x].url | string | URL for business page on Yelp. |
| businesses[x].transactions | string[] | A list of Yelp transactions that the business is registered for. Current supported values are "pickup", "delivery", and "restaurant_reservation". |
Get food truck by id.
GET /foodtrucks/{id}
GET https://jirv8u2ell.execute-api.us-west-1.amazonaws.com/dev/foodtrucks/gold-rush-eatery-sunnyvale-6
Request Headers
Content-Type: application/json
Authorization: Bearer UOG4x25kRFF6bWtb-Sq8wP2J3mD9NZfSKbKdweHWO0nC7C-A5-ROuVH30RQ7_2tQrYpIAvOuIjI9OBtON8BtUb49la3UGXmc0B_tgTddC14pp0ceMTSHY_xxnyhtWXYx
Response Body
{
"statusCode": 200,
"body": {
"id": "gold-rush-eatery-sunnyvale-6",
"name": "Gold Rush Eatery",
"image_url": "https://s3-media3.fl.yelpcdn.com/bphoto/jV0YqLFFvpWIUlJuMR9Owg/o.jpg",
"is_claimed": true,
"is_closed": false,
"url": "https://www.yelp.com/biz/gold-rush-eatery-sunnyvale-6?adjust_creative=XlnTMhO5pJ8whMNEegSKig&utm_campaign=yelp_api_v3&utm_medium=api_v3_business_lookup&utm_source=XlnTMhO5pJ8whMNEegSKig",
"phone": "+14087435336",
"display_phone": "(408) 743-5336",
"review_count": 110,
"categories": [
{
"alias": "foodtrucks",
"title": "Food Trucks"
},
{
"alias": "burgers",
"title": "Burgers"
},
{
"alias": "sandwiches",
"title": "Sandwiches"
}
],
"rating": 4,
"location": {
"address1": "1010 S Wolfe Rd",
"address2": null,
"address3": "",
"city": "Sunnyvale",
"zip_code": "94036",
"country": "US",
"state": "CA",
"display_address": [
"1010 S Wolfe Rd",
"Sunnyvale, CA 94036"
],
"cross_streets": ""
},
"coordinates": {
"latitude": 37.3551306948281,
"longitude": -122.010198819353
},
"photos": [
"https://s3-media3.fl.yelpcdn.com/bphoto/jV0YqLFFvpWIUlJuMR9Owg/o.jpg",
"https://s3-media2.fl.yelpcdn.com/bphoto/ZZA6l-8dp9y-GzQ1XrZITw/o.jpg",
"https://s3-media3.fl.yelpcdn.com/bphoto/5aZk_HEHoQ25L6fqKO4T3w/o.jpg"
],
"price": "$$",
"hours": [
{
"open": [
{
"is_overnight": false,
"start": "0900",
"end": "2100",
"day": 0
},
{
"is_overnight": false,
"start": "0900",
"end": "2100",
"day": 1
},
{
"is_overnight": false,
"start": "0900",
"end": "2100",
"day": 2
},
{
"is_overnight": false,
"start": "0900",
"end": "2100",
"day": 3
},
{
"is_overnight": false,
"start": "0900",
"end": "2100",
"day": 4
},
{
"is_overnight": false,
"start": "0900",
"end": "2100",
"day": 5
},
{
"is_overnight": false,
"start": "0900",
"end": "2100",
"day": 6
}
],
"hours_type": "REGULAR",
"is_open_now": false
}
],
"transactions": [
"pickup"
]
}
}You can test the APIs through POSTMAN
