Yelp API endpoint
Looks up a single Yelp business by alias or encoded id.
/yelp/business/{id}Path parameters: id is required and accepts a Yelp business alias (e.g. pequods-pizza-chicago-3) or an encoded Yelp business id.
Returns a business profile — name, rating, review count, price, categories, localized hours, address, phone, coordinates, health score, and attributes ("Amenities and More").
| Field | Filled in, of 23 checked | Values in the sample |
|---|---|---|
| title | 23 | “Health Score” and 22 other values |
| value | 23 | “Pass” and 8 other values |
| alias | 22 | “RestaurantsReservations” and 21 other values |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| id (path) | string | Yes | Yelp business alias or encoded id | pequods-pizza-chicago-3 | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/yelp/business/pequods-pizza-chicago-3" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"id": "pequods-pizza-chicago-3",
"alias": "pequods-pizza-chicago-3",
"encoded_id": "DXwSYgiXqIVNdO9dazel6w",
"name": "Pequod's Pizza",
"url": "https://www.yelp.com/biz/pequods-pizza-chicago-3",
"website": "http://pequodspizza.com",
"photos": [
"https://s3-media0.fl.yelpcdn.com/bphoto/8QJUNblfCI0EDhOjuIWJ4A/ms.jpg"
],
"rating": 4,
"review_count": 8947,
"price": "$$",
"categories": [
"Pizza"
],
"address": "2207 N Clybourn Ave, Chicago, IL 60614",
"address_details": {
"address_line_1": "2207 N Clybourn Ave",
"city": "Chicago",
"state": "IL",
"postal_code": "60614",
"country": "US"
},
"coordinates": {
"latitude": 41.92187,
"longitude": -87.664486
},
"neighborhoods": [
"DePaul"
],
"phone": "7733271512",
"phone_number": "(773) 327-1512",
"closed": false,
"hours": [
"Mon-Sat 11:00 am - 2:00 am",
"Sun 11:00 am - 12:00 am"
],
"health_score": "Pass",
"description": "Try Our Famous Carmelized Crust.",
"year_established": 1992,
"photo_count": 6052,
"attributes": [
{
"alias": "RestaurantsReservations",
"title": "Takes Reservations",
"value": "Yes"
}
]
}
}Request schema
No body schema
Response schema
#/definitions/yelp.mobileBusinessResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | yelp.MobileBusinessResponse | No | ||||
| data.address | string | No | ||||
| data.address_details | yelp.AddressDetails | No | ||||
| data.address_details.address_line_1 | string | No | ||||
| data.address_details.address_line_2 | string | No | ||||
| data.address_details.address_line_3 | string | No | ||||
| data.address_details.city | string | No | ||||
| data.address_details.country | string | No | ||||
| data.address_details.formatted_address | array | No | ||||
| data.address_details.postal_code | string | No | ||||
| data.address_details.state | string | No | ||||
| data.alias | string | No | ||||
| data.attributes | array | No | ||||
| data.attributes[].alias | string | No | ||||
| data.attributes[].title | string | No | ||||
| data.attributes[].value | string | No | ||||
| data.attributes[].values | array | No | ||||
| data.categories | array | No | ||||
| data.claimed | boolean | No | ||||
| data.closed | boolean | No | ||||
| data.coordinates | yelp.Coordinates | No | ||||
| data.coordinates.latitude | number | No | ||||
| data.coordinates.longitude | number | No | ||||
| data.description | string | No | ||||
| data.encoded_id | string | No | ||||
| data.health_score | string | No | ||||
| data.hours | array | No | ||||
| data.id | string | No | tonys-pizza-napoletana-san-francisco | |||
| data.image | string | No | ||||
| data.name | string | No | ||||
| data.neighborhoods | array | No | ||||
| data.phone | string | No | ||||
| data.phone_number | string | No | ||||
| data.photo_count | integer | No | ||||
| data.photos | array | No | ||||
| data.price | string | No | ||||
| data.rating | number | No | ||||
| data.review_count | integer | No | ||||
| data.url | string | No | ||||
| data.website | string | No | ||||
| data.year_established | integer | No | ||||
| msg | string | No | OK |
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 404 | Not Found | #/definitions/app.Response |
| 500 | Internal Server Error | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/yelp/business/pequods-pizza-chicago-3" \
-H "x-api-key: $CRAWLORA_API_KEY"