# Yelp Place API

> Get a Yelp business by place ID or alias with rating, review count, categories, hours, address, phone, website, amenities and menu.

Source: https://www.sandbase.ai/apis/yelp/place
API reference: https://www.sandbase.ai/apis/yelp/place#api

## Facts

- Provider: Yelp
- Type: Data API
- Endpoint: `POST https://api.sandbase.ai/v1/api/yelp/place`
- Price: $0.01 per call
- Capabilities: api, yelp, local, reviews
- Billing: pay per use from one SandBase balance; no provider account or subscription needed

## Call it

`POST https://api.sandbase.ai/v1/api/yelp/place` with `Authorization: Bearer $SANDBASE_API_KEY` and the parameters as a JSON body.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `place_id` | string | yes |  |
| `yelp_domain` | string | no |  |
| `business_alert` | string | no |  |
| `full_menu` | string | no |  |
| `menu_name` | string | no |  |
| `json_restrictor` | string | no |  |

## FAQ

### How do I use the Yelp Place API?

Send a POST request to https://api.sandbase.ai/v1/api/yelp/place with your SandBase API key in the Authorization header (Bearer) and the parameters as a JSON body. You can also try it in the Playground on this page without writing code.

### How much does the Yelp Place API cost?

$0.01 per call, billed from your SandBase balance. You are only charged for calls you make; there is no subscription.

### What parameters does the Yelp Place API accept?

Required: place_id (string). Optional: yelp_domain (string), business_alert (string), full_menu (string), menu_name (string) and json_restrictor (string). The Parameters table and the Playground on this page list every field.

### What does the Yelp Place API return?

A JSON response returned in the same HTTP request (synchronous).

### Do I need a Yelp developer account or API key?

No. Yelp Place runs through SandBase, so one SandBase API key covers this endpoint and every other API and model in the catalog. You do not need to apply for Yelp API access separately.

## README

### Yelp Place

Get a Yelp business by place ID or alias with rating, review count, categories, hours, address, phone, website, amenities and menu.

#### Request

```bash
curl -X POST "https://api.sandbase.ai/v1/api/yelp/place" \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"place_id": "arabica-brooklyn"}'
```

The result is returned in `outputs[0].data` as structured JSON.

#### Parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `place_id` | string | Yes | Parameter defines the Yelp ID of a place. Each place has two unique IDs (e.g. `ED7A7vDdg8yLNKJTSVHHmg` and `arabica-brooklyn`) and you can use either of them as a value of the `place_id`. To extract the IDs of a place you can use our Yelp S |
| `yelp_domain` | string | No | Parameter defines the Yelp domain to use. It defaults to `yelp.com`. Head to the Yelp domains for a full list of supported Yelp domains. |
| `business_alert` | string | No | Set parameter to `true` to include business alert information when available. It defaults to `false`. Business alerts are temporarily unavailable. With this parameter, `place_results` are returned without `business_alert`. |
| `full_menu` | string | No | Set parameter to `true` to scrape business full menu when available. It defaults to `false`. When the parameter `full_menu` is set to `true`, but the business queried doesn't have a full menu page, then `place_results` will be returned inst |
| `menu_name` | string | No | Parameter defines the name of which Full Menu to scrape when more than one Full Menu is available. It can only be used in combination with `full_menu` parameter. |
| `json_restrictor` | string | No | Parameter defines the fields you want to include in the output, reducing payload size for faster response. See the JSON Restrictor documentation for more details. |

#### Pricing

$0.010 per successful call. Failed calls are not charged.
