Skip to content
Scrappa Get API key
Yellow Pages API 12 credits / request

Yellow Pages Business Search API Documentation

GET https://scrappa.co/api/yellowpages/search?query=plumbers&location=Austin%2C+TX

Search public Yellow Pages businesses by term and place (City, ST or ZIP), up to 30 per page: id, name, categories, rating, review count, address, phone, website, open status and snippet. Costs 12 credits per request. Failed requests are free.

Yellow Pages Business Search API Documentation 12 credits / request

Endpoint

Request preview
GET
https://scrappa.co/api/yellowpages/search?query=plumbers&location=Austin%2C+TX
Auth header
x-api-key
Cost
12 credits / request
query = plumbers location = Austin, TX
Response preview
200 OK
{
    "success": true,
    "data": {
        "query": "plumbers",
        "location": "Austin, TX",
        "page": 1,
        "per_page": 30,
        "total": 495,
        "has_more": true,
        "next_page": 2,
        "results": [
            {
                "id": "/austin-tx/mip/clarke-kent-plumbing-10674347",
                "ypid": "10674347",
...

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.

1 optional filter available.

query string Required

What to look for, 2 to 100 characters. Example: plumbers.

Example value plumbers
location string Required

US city and state or ZIP code, 2 to 100 characters. Example: Austin, TX or 90210.

Example value Austin, TX
page integer Optional

Page number, 1 to 50. Each page holds up to 30 businesses. A page past the end returns an empty list and the real total.

Example value 1

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/yellowpages/search?query=plumbers&location=Austin%2C+TX",
    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/yellowpages/search?query=plumbers&location=Austin%2C+TX');

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/yellowpages/search?query=plumbers&location=Austin%2C+TX', 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/yellowpages/search?query=plumbers&location=Austin%2C+TX',
    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/yellowpages/search?query=plumbers&location=Austin%2C+TX")
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/yellowpages/search?query=plumbers&location=Austin%2C+TX", 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/yellowpages/search?query=plumbers&location=Austin%2C+TX', 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/yellowpages/search?query=plumbers&location=Austin%2C+TX")
        .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/yellowpages/search?query=plumbers&location=Austin%2C+TX", 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/yellowpages/search?query=plumbers&location=Austin%2C+TX"
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/yellowpages/search?query=plumbers&location=Austin%2C+TX"));
            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/yellowpages/search?query=plumbers&location=Austin%2C+TX',
            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/yellowpages/search?query=plumbers&location=Austin%2C+TX")
        .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": "plumbers",
        "location": "Austin, TX",
        "page": 1,
        "per_page": 30,
        "total": 495,
        "has_more": true,
        "next_page": 2,
        "results": [
            {
                "id": "/austin-tx/mip/clarke-kent-plumbing-10674347",
                "ypid": "10674347",
                "name": "Clarke Kent Plumbing",
                "url": "https://www.yellowpages.com/austin-tx/mip/clarke-kent-plumbing-10674347",
                "categories": [
                    "Plumbers",
                    "Plumbing-Drain & Sewer Cleaning"
                ],
                "rating": 2.87,
                "review_count": 15,
                "address": {
                    "street": "1408 W Ben White Blvd",
                    "city": "Austin",
                    "region": "TX",
                    "postal_code": "78704",
                    "formatted": "1408 W Ben White Blvd, Austin, TX 78704"
                },
                "phone": "(512) 766-0970",
                "website": "http://www.clarkekentplumbing.com",
                "coordinates": null,
                "years_in_business": 40,
                "open_status": "closed now",
                "hours": [
                    "Mo-Fr 09:00-17:00"
                ],
                "snippet": "Josh was wonderful and very professional."
            }
        ]
    },
    "meta": {
        "endpoint_family": "business_search",
        "billable": true,
        "credits": 12
    }
}

Errors

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

422

Validation Error

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

502

Upstream Unavailable

Yellow Pages did not answer with usable data. This response is not billable. Retry later.

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.