> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/yelp/businesses/search/get](https://www.socialfetch.dev/docs/api/v1/yelp/businesses/search/get)
- **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/yelp/businesses/search/get.mdx](https://www.socialfetch.dev/docs/api/v1/yelp/businesses/search/get.mdx)

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/openapi.json)

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages.
- [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths.
- [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 237 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
- [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).
- Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`).

---
# Search Yelp businesses (https://www.socialfetch.dev/docs/api/v1/yelp/businesses/search/get)

## Summary

Search Yelp businesses by name, category, or location.

**Tags:** `Yelp`

## HTTP

- **Method:** GET
- **Path:** `/v1/yelp/businesses/search`
- **operationId:** `yelp.businesses.search`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.yelp.searchBusinesses({ query: "guitar lessons", location: "New York, NY" })`
- **Accepted identifiers:** `query` (query)
- **Pagination:** page via `page`, next page: `data.page.nextPage`, has more: `data.page.hasMore`

## Credits

- **Base:** 1 credit per successful lookup.
- **Maximum on success (200):** 1 credit.
- **Normalization failure (502):** 1 credit charged.
- **Authoritative field:** `meta.creditsCharged`.

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `query` (query)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 200
- **Description:** Business name, service, or category to search for.

### `location` (query)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 200
- **Description:** City, neighbourhood, postcode or address to search near.

### `page` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 1; maximum: 24
- **Description:** Page number, starting at 1. Each page has up to 10 businesses.

### `sort` (query)

- **Required:** no
- **Constraints:** type `string`; enum: recommended, highest_rated, most_reviewed
- **Description:** Result order. `recommended` is Yelp's default ranking. `highest_rated` and `most_reviewed` use Yelp's own sorts.

## Responses (status codes)

- **200**: Yelp business pages found for this query and location.
- **400**: Invalid query or location.
- **401**: Missing or invalid API key.
- **402**: Insufficient credits.
- **500**: Unexpected or billing error.
- **502**: Discovery could not be completed.
- **503**: Discovery is temporarily unavailable.

## Response body (200)

Yelp business pages found for this query and location.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **query** (required) — type `string`
  - **location** (required) — type `string`
  - **sort** (required) — type `string`; enum: recommended, highest_rated, most_reviewed. Result order. `recommended` is Yelp's default ranking. `highest_rated` and `most_reviewed` use Yelp's own sorts.
  - **source** (required) — type `string`; enum: yelp, web_index. `yelp`: Yelp's own search results with verified listing data. `web_index`: fallback from a web search index when Yelp search is unavailable; fields it cannot see are null.
  - **totalResults** (required) — type `integer`; minimum: 0; nullable. Total results Yelp reports for this search (Yelp shows at most 240); null for web-index results.
  - **resolvedLocation** (required) — type `string`; nullable. Where Yelp actually searched, as Yelp describes it (e.g. `Austin, Texas`). Check it for ambiguous place names: a bare `Glasgow` can resolve to Glasgow, Delaware; add the country to disambiguate. Null for web-index results.
  - **businesses** (required) — type `array`
    - _items:_
      - **alias** (required) — type `string`; minLength: 2; maxLength: 200. Business alias from its Yelp URL.
      - **name** (required) — type `string`; minLength: 1
      - **url** (required) — type `string`
      - **ranking** (required) — type `integer`; minimum: 1; nullable. Position in Yelp's results for this search; null for web-index results.
      - **rating** (required) — type `number`; minimum: 0; maximum: 5; nullable
      - **reviewCount** (required) — type `integer`; minimum: 0; nullable
      - **priceRange** (required) — type `string`; nullable
      - **phone** (required) — type `string`; nullable
      - **categories** (required) — type `array`
        - _items:_
      - **address** (required) — type `object`; nullable
      - **coordinates** (required) — type `object`; nullable
      - **photoUrl** (required) — type `string`; nullable
      - **isClosed** (required) — type `boolean`; nullable. True when the listing is marked closed; null when not reported.
  - **page** (required) — type `object`
    - **page** (required) — type `integer`; minimum: 1
    - **hasMore** (required) — type `boolean`
    - **nextPage** (required) — type `integer`; minimum: 2; nullable
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.
  - **cached** (optional) — type `boolean`. True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present.

### Example JSON (derived from schema)

```json
{
  "data": {
    "query": "string",
    "location": "string",
    "sort": "recommended",
    "source": "yelp",
    "totalResults": 0,
    "resolvedLocation": "string",
    "businesses": [
      {
        "alias": "string",
        "name": "string",
        "url": "string",
        "ranking": 0,
        "rating": 0,
        "reviewCount": 0,
        "priceRange": "string",
        "phone": "string",
        "categories": [
          {
            "alias": "string",
            "title": "string"
          }
        ],
        "address": {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "region": "string",
          "postalCode": "string",
          "country": "string",
          "formatted": "string"
        },
        "coordinates": {
          "latitude": 0,
          "longitude": 0
        },
        "photoUrl": "string",
        "isClosed": false
      }
    ],
    "page": {
      "page": 0,
      "hasMore": false,
      "nextPage": 0
    }
  },
  "meta": {
    "requestId": "string",
    "creditsCharged": 0,
    "version": "v1",
    "cached": false
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid query or location. **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key. **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits. **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error.
- **502**: Discovery could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Discovery is temporarily unavailable. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.yelp.searchBusinesses({
  query: "coffee shops",
  location: "San Francisco, CA",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/yelp/businesses/search?query=coffee shops&location=San Francisco, CA",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/yelp/businesses/search?query=coffee shops&location=San Francisco, CA" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/yelp/businesses/search?query=coffee shops&location=San Francisco, CA",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```