> For the complete documentation index, see [llms.txt](https://docs.pullbay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pullbay.com/api-reference/yelp.md).

# Yelp

Yelp: places, reviews, and search.

## Get a place by ID

> Returns a Yelp place by its Yelp business ID.\
> \
> \*\*Cost: 50 credits/request + 1 credit/item\*\*

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"yelp","description":"Yelp: places, reviews, and search."}],"servers":[{"url":"https://api.pullbay.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"YelpPlace":{"type":"object","description":"A Yelp place / business profile.","properties":{"id":{"type":"string"},"alias":{"type":"string"},"title":{"type":"string"},"website":{"type":"string"},"phoneNumber":{"type":"string"},"avgRating":{"type":"number"},"unroundedAvgRating":{"type":"number"},"reviewCount":{"type":"integer"},"priceRange":{"type":"string"},"isBusinessClosed":{"type":"boolean"},"primaryPhoto":{"type":"string"},"mediaCount":{"type":"integer"},"address":{"type":"object","additionalProperties":true},"coordinates":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"categories":{"type":"array","items":{"type":"object","additionalProperties":true}},"operationHours":{"type":"array","items":{"type":"object","additionalProperties":true}},"amenities":{"type":"array","items":{"type":"object","additionalProperties":true}},"about":{"type":"object","additionalProperties":true}}},"ErrorEnvelope":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/yelp/place/{id}":{"get":{"operationId":"getYelpPlaceById","summary":"Get a place by ID","description":"Returns a Yelp place by its Yelp business ID.\n\n**Cost: 50 credits/request + 1 credit/item**","tags":["yelp"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/YelpPlace"}},"pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Get reviews for a place

> Returns reviews for a Yelp place. Use \`page\` (1-indexed) to paginate or \`maxItems\` for a one-shot bulk pull (mutually exclusive).\
> \
> \*\*Cost: 40 credits/request + 1 credit/item\*\*

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"yelp","description":"Yelp: places, reviews, and search."}],"servers":[{"url":"https://api.pullbay.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"YelpReview":{"type":"object","description":"A Yelp review for a place.","properties":{"id":{"type":"string"},"url":{"type":"string"},"rating":{"type":"number"},"text":{"type":"string"},"language":{"type":"string"},"date":{"type":"string","format":"date-time"},"images":{"type":"array","items":{"type":"string"}},"feedback":{"type":"object","additionalProperties":true},"reviewer":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"profileUrl":{"type":"string"},"image":{"type":"string"}}}}},"Pagination":{"type":"object","properties":{"page":{"type":"integer","nullable":true},"hasNextPage":{"type":"boolean","nullable":true},"cursor":{"type":"string","nullable":true},"offset":{"type":"string","nullable":true,"description":"Numeric offset string for offset-paginated endpoints (e.g. Google Maps place search)."}}},"ErrorEnvelope":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/yelp/place/{id}/reviews":{"get":{"operationId":"getYelpPlaceReviews","summary":"Get reviews for a place","description":"Returns reviews for a Yelp place. Use `page` (1-indexed) to paginate or `maxItems` for a one-shot bulk pull (mutually exclusive).\n\n**Cost: 40 credits/request + 1 credit/item**","tags":["yelp"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":50}},{"name":"maxItems","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/YelpReview"}},"pagination":{"$ref":"#/components/schemas/Pagination"},"pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Get a place by handle

> Returns a Yelp place by its handle / slug.\
> \
> \*\*Cost: 50 credits/request + 1 credit/item\*\*

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"yelp","description":"Yelp: places, reviews, and search."}],"servers":[{"url":"https://api.pullbay.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"YelpPlace":{"type":"object","description":"A Yelp place / business profile.","properties":{"id":{"type":"string"},"alias":{"type":"string"},"title":{"type":"string"},"website":{"type":"string"},"phoneNumber":{"type":"string"},"avgRating":{"type":"number"},"unroundedAvgRating":{"type":"number"},"reviewCount":{"type":"integer"},"priceRange":{"type":"string"},"isBusinessClosed":{"type":"boolean"},"primaryPhoto":{"type":"string"},"mediaCount":{"type":"integer"},"address":{"type":"object","additionalProperties":true},"coordinates":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"categories":{"type":"array","items":{"type":"object","additionalProperties":true}},"operationHours":{"type":"array","items":{"type":"object","additionalProperties":true}},"amenities":{"type":"array","items":{"type":"object","additionalProperties":true}},"about":{"type":"object","additionalProperties":true}}},"ErrorEnvelope":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/yelp/place/handle/{handle}":{"get":{"operationId":"getYelpPlaceByHandle","summary":"Get a place by handle","description":"Returns a Yelp place by its handle / slug.\n\n**Cost: 50 credits/request + 1 credit/item**","tags":["yelp"],"parameters":[{"name":"handle","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/YelpPlace"}},"pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```

## Search Yelp places

> Search Yelp places by query and location. Use \`page\` (1-indexed) to paginate or \`maxItems\` for a one-shot bulk pull (mutually exclusive).\
> \
> \*\*Cost: 50 credits/request + 1 credit/item\*\*

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"tags":[{"name":"yelp","description":"Yelp: places, reviews, and search."}],"servers":[{"url":"https://api.pullbay.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"YelpSearchResult":{"type":"object","description":"A Yelp search result entry (place summary).","properties":{"id":{"type":"string"},"alias":{"type":"string"},"name":{"type":"string"},"rating":{"type":"number"},"reviewCount":{"type":"integer"},"priceRange":{"type":"string"},"phone":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"coordinates":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"categories":{"type":"array","items":{"type":"object","additionalProperties":true}},"images":{"type":"array","items":{"type":"string"}}}},"Pagination":{"type":"object","properties":{"page":{"type":"integer","nullable":true},"hasNextPage":{"type":"boolean","nullable":true},"cursor":{"type":"string","nullable":true},"offset":{"type":"string","nullable":true,"description":"Numeric offset string for offset-paginated endpoints (e.g. Google Maps place search)."}}},"ErrorEnvelope":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}},"paths":{"/yelp/search":{"get":{"operationId":"searchYelpPlaces","summary":"Search Yelp places","description":"Search Yelp places by query and location. Use `page` (1-indexed) to paginate or `maxItems` for a one-shot bulk pull (mutually exclusive).\n\n**Cost: 50 credits/request + 1 credit/item**","tags":["yelp"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"location","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":50}},{"name":"maxItems","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Successful request","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/YelpSearchResult"}},"pagination":{"$ref":"#/components/schemas/Pagination"},"pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```