# YellowPages.com — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search and retrieve business listings, contact info, hours, categories, and customer reviews from YellowPages.com. Browse by category or location across the US.

**Category:** Business Directories | **Website:** [yellowpages.com/](https://yellowpages.com/) | **Docs:** [parse.bot/marketplace/18a9974e-d7e1-43ee-9f44-8ff3a4e58ef6/yellowpages-com-api](https://parse.bot/marketplace/18a9974e-d7e1-43ee-9f44-8ff3a4e58ef6/yellowpages-com-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-yellowpages-com-api-18a9974e/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### check_pos_technology

Check a business website for POS (Point of Sale) technology signals by scanning the page HTML for mentions of specific software platforms (MICROS Simphony, MICROS 3700, Oracle Hospitality). Returns whether any POS technology was detected and the list of detected technologies.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `website_url` | string | Yes | Business website URL to check (e.g., 'https://www.example.com') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yellowpages-com-api-18a9974e/check_pos_technology \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"website_url":"<string>"}'
```

### explore_cities

Return a list of all US states from the YellowPages sitemap for browsing businesses by location. Each state entry includes the state name and its browse URL.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yellowpages-com-api-18a9974e/explore_cities \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_business_details

Fetch comprehensive details for a specific business by its YellowPages URL path. Returns name, contact info, hours of operation, categories, description, neighborhoods, amenities, social links, and payment methods. Optionally checks the business website for POS technology signals.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `check_pos` | boolean | No | When true, also checks the business website for POS technology stack signals. |
| `url` | string | Yes | Full YellowPages business URL or path (e.g., 'https://www.yellowpages.com/new-york-ny/mip/rr-plumbing-roto-rooter-574238364' or '/new-york-ny/mip/rr-plumbing-roto-rooter-574238364') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yellowpages-com-api-18a9974e/get_business_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"check_pos":"<boolean>","url":"<string>"}'
```

### get_business_reviews

Retrieve customer reviews for a business from its YellowPages detail page. Returns review author, date, star rating, optional title, and review text. Returns an empty array if the business has no reviews.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full YellowPages business URL or path (e.g., 'https://www.yellowpages.com/new-york-ny/mip/punch-28771538') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yellowpages-com-api-18a9974e/get_business_reviews \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"<string>"}'
```

### get_category_list

List business categories from the YellowPages categories page, organized by service group (e.g., Home Services, Medical Services, Auto Services). Each group contains named sub-categories with their browse paths.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yellowpages-com-api-18a9974e/get_category_list \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_search_filters

Get available search filters for a query and location. Returns quick filter options (e.g., 'OPEN 24 Hours') and nearby location refinements when available. Useful for discovering refinement options before narrowing a search.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | Yes | Location (e.g., 'new york ny', 'los angeles ca') |
| `query` | string | Yes | Search keyword (e.g., 'plumber', 'restaurant') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yellowpages-com-api-18a9974e/get_search_filters \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"location":"<string>","query":"<string>"}'
```

### search_businesses

Full-text search for businesses by keyword and location on YellowPages.com. Returns up to 30 organic listings per page with pagination support up to page 17. Each listing includes name, phone, address, categories, and rating when available. Pagination is automatic; the limit caps the total items returned across all pages.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Maximum number of results to return across all pages |
| `location` | string | Yes | Location to search in (e.g., 'new york ny', 'los angeles ca') |
| `page` | integer | No | Starting page number for pagination |
| `query` | string | Yes | Search keyword (e.g., 'plumber', 'restaurant', 'dentist') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yellowpages-com-api-18a9974e/search_businesses \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","location":"<string>","page":"<integer>","query":"<string>"}'
```