# Yellowpages Business

## Overview

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

## Description

Extract a full Yellow Pages business profile from a listing URL, including phone, website, categories, and ratings via browser rendering.

## 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/yellowpages/business' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Lookup Ritz Plumbing, Los Angeles

```json
{
  "name": "Ritz Plumbing Heating, Air & Electrical",
  "phone": "323 452-4915",
  "rating": "five",
  "address": "1355 S La Brea Ave, Los Angeles, CA 90019",
  "website": "http://www.ritzplumbinginc.org",
  "categories": [
    "Plumbers",
    "Air Conditioning Contractors & Systems",
    "Air Conditioning Service & Repair",
    "Plumbers",
    "Air Conditioning Contractors & Systems",
    "Air Conditioning Service & Repair",
    "Building Contractors",
    "Building Contractors-Commercial & Industrial",
    "Electricians",
    "Furnace Repair & Cleaning",
    "Furnaces-Heating",
    "Heating Contractors & Specialties",
    "Heating Equipment & Systems",
    "Plumbing Contractors-Commercial & Industrial",
    "Plumbing-Drain & Sewer Cleaning",
    "Sewer Contractors",
    "Water Heaters"
  ],
  "rating_count": 3
}
```

## Documentation

## Overview
Extract the full public profile of any Yellow Pages business listing (`/mip/{slug}`). Returns phone, address, website, categories, star rating label, and review count.

Yellow Pages business profile pages are JavaScript SPAs. Contact details, categories, and ratings load client-side after the initial HTML shell. Piloterr uses **website rendering** to load the page in a browser, wait for the profile to hydrate, and scrape structured JSON from the rendered DOM.

## Quickstart
```
GET https://api.piloterr.com/v2/yellowpages/business?query=https://www.yellowpages.com/los-angeles-ca/mip/anawalt-lumber-13945594?lid=1002108313121
```

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Full Yellow Pages `/mip/` business URL |

## Response fields
| Field | Type | Description |
|---|---|---|
| `name` | string | Business name |
| `phone` | string \| null | Formatted phone number |
| `address` | string \| null | Full formatted address |
| `website` | string \| null | External website URL |
| `rating` | string \| null | Star rating label (e.g. `five`, `four`) |
| `rating_count` | integer \| null | Number of reviews |
| `categories` | array | Category labels |

## Notes
- Targets **yellowpages.com** (US).
- `rating` is a word label, not a numeric score.
- `categories` may contain duplicates when Yellow Pages lists a business under multiple headings.

## Main use cases
- Enrich CRM records with phone, website, and category data
- Extract full business profiles for local SEO workflows
- Monitor individual listings for rating changes
- Build category-tagged business directories from profile pages