Skip to content
Scrappa Get API key
Yelp API 1 credit/request

Yelp Business Search API Documentation

GET https://scrappa.co/api/yelp/search?query=gary+danko&location=San+Francisco%2C+CA

Find public Yelp businesses by name or keyword near a free-text location: position, id, alias, name, public url, rating, review count, price level, categories, street address, city and photo. This is a business name match as Yelp suggests it, not Yelp ranked search: it has no sort or filters, pages hold up to 25 results in total, and results can include loosely related businesses. Use the business endpoint with a returned alias for full details.

Yelp Business Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/yelp/search?query=gary+danko&location=San+Francisco%2C+CA
Auth header
x-api-key
Cost
1 credit/request
query = gary danko location = San Francisco, CA
Response preview
200 OK
{
    "success": true,
    "data": {
        "query": "gary danko",
        "location": "San Francisco, CA",
        "results": [
            {
                "position": 1,
                "encid": "WavvLdfdP6g8aZTtbBQHTw",
                "alias": "gary-danko-san-francisco",
                "name": "Gary Danko",
                "url": "https://www.yelp.com/biz/gary-danko-san-francisco",
                "rating": 4.5,
                "review_count": 6148,
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

2 required parameters needed before sending a request.

2 optional filters available.

query string Required

Business name or keyword, 1 to 100 characters. Example: gary danko.

Example value gary danko
location string Required

Free-text location, 2 to 100 characters. Example: San Francisco, CA.

Example value San Francisco, CA
limit integer Optional

Results to return, 1 to 10. Defaults to 10.

Example value 10
page integer Optional

Page number, starting at 1. Yelp answers at most 25 results per search, so later pages run out. Follow has_more and next_page. Defaults to 1.

Example value 1

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/yelp/search?query=gary+danko&location=San+Francisco%2C+CA",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/yelp/search?query=gary+danko&location=San+Francisco%2C+CA');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/yelp/search?query=gary+danko&location=San+Francisco%2C+CA', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/yelp/search?query=gary+danko&location=San+Francisco%2C+CA',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/yelp/search?query=gary+danko&location=San+Francisco%2C+CA")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/yelp/search?query=gary+danko&location=San+Francisco%2C+CA", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/yelp/search?query=gary+danko&location=San+Francisco%2C+CA', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/yelp/search?query=gary+danko&location=San+Francisco%2C+CA")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/yelp/search?query=gary+danko&location=San+Francisco%2C+CA", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/yelp/search?query=gary+danko&location=San+Francisco%2C+CA"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/yelp/search?query=gary+danko&location=San+Francisco%2C+CA"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/yelp/search?query=gary+danko&location=San+Francisco%2C+CA',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/yelp/search?query=gary+danko&location=San+Francisco%2C+CA")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

success data meta
JSON Response
200 OK
{
    "success": true,
    "data": {
        "query": "gary danko",
        "location": "San Francisco, CA",
        "results": [
            {
                "position": 1,
                "encid": "WavvLdfdP6g8aZTtbBQHTw",
                "alias": "gary-danko-san-francisco",
                "name": "Gary Danko",
                "url": "https://www.yelp.com/biz/gary-danko-san-francisco",
                "rating": 4.5,
                "review_count": 6148,
                "price": "$$$$",
                "categories": [
                    {
                        "alias": "newamerican",
                        "title": "New American"
                    }
                ],
                "address": {
                    "line1": "800 N Point St",
                    "city": "San Francisco"
                },
                "photo": "https://s3-media0.fl.yelpcdn.com/bphoto/5dbjkeTld05HumeToIAhRQ/1000s.jpg"
            }
        ],
        "page": 1,
        "has_more": false
    },
    "meta": {
        "endpoint_family": "business_search",
        "billable": true
    }
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A required query parameter is missing or invalid. This response is not billable.

{
    "errors": {
        "query": [
            "The query field is required."
        ]
    },
    "message": "The request validation failed"
}
502

Invalid Source Response

The upstream answered with a shape that no longer matches the documented contract. This response is not billable.

{
    "error": {
        "code": "PARSER_DRIFT",
        "message": "The Yelp API is temporarily unavailable. Please retry."
    },
    "success": false
}
503

Service Unavailable

The upstream service is temporarily unavailable. Please retry shortly.

{
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The Yelp API is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.