# Yelp Business

## Overview

| Property | Value |
|----------|-------|
| **Status** | active |
| **Method** | `GET` |
| **Endpoint** | `/v2/yelp/business` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 2 credits per call |
| **Documentation** | https://www.piloterr.com/library/yelp-business |

## Description

Fetch a Yelp business profile from a full business URL with phone, address, website, logo, hours, and claim status.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/yelp/business' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Lookup Novela, San Francisco

```json
{
  "url": "https://www.yelp.com/biz/novela-san-francisco-2?osq=bars+open&rr=4",
  "logo": "https://s3-media0.fl.yelpcdn.com/businessregularlogo/dkB_F32_r_PfLpQLAuNsFA/ms.jpg",
  "name": "Novela",
  "phone": "(415) 896-6500",
  "address": "662 Mission St San Francisco, CA 94105",
  "website": "novelasf.com",
  "open_hours": {
    "fri": "4:00 PM - 2:00 AM (Next day)",
    "mon": "4:00 PM - 12:00 AM (Next day)",
    "sat": "5:00 PM - 2:00 AM (Next day)",
    "sun": "Closed",
    "thu": "4:00 PM - 2:00 AM (Next day)",
    "tue": "4:00 PM - 1:00 AM (Next day)",
    "wed": "4:00 PM - 1:00 AM (Next day)"
  },
  "business_id": "cX5dOMkwZ5rqWbeIJpw_Ig",
  "claim_status": "claimed"
}
```

## Documentation

## Overview
Retrieve the public Yelp business profile for any listing: contact details, address, website, logo, weekly hours, and claim status. Pass a full Yelp business URL. Uses browser rendering to bypass Cloudflare and return clean JSON.

## Quickstart
```
GET https://api.piloterr.com/v2/yelp/business?query=https%3A%2F%2Fwww.yelp.com%2Fbiz%2Fnovela-san-francisco-2
```

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Full Yelp business URL (`https://www.yelp.com/biz/...`) |

## Response fields
| Field | Type | Description |
|---|---|---|
| `url` | string | Canonical Yelp business URL |
| `name` | string | Business name |
| `business_id` | string | Yelp business encid |
| `logo` | string | Business logo image URL |
| `phone` | string \| null | Formatted phone number |
| `address` | string | Full street address |
| `website` | string \| null | External website domain or URL |
| `open_hours` | object | Weekly hours keyed by weekday (`mon`..`sun`) |
| `claim_status` | string | Claim state (e.g. `claimed`) |

## Notes
- Use an organic `results[].link` from **Yelp Search** as `query`.
- Hour labels follow the locale of the Yelp page.
- Use `business_id` from this response as `query` on **Yelp Reviews**.

## Main use cases
- Enrich CRM records with phone, website, and hours
- Verify business claim status and contact data
- Power local SEO and listings monitoring workflows