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

Waze Place Search API Documentation

GET https://scrappa.co/api/waze/search

Waze Place Search API Documentation Search places and addresses on Waze. Each suggestion has its position, name, display name, address, latitude, longitude, id, type and the highlighted parts of the display name. Paid ads are removed. A call returns up to 10 suggestions; there is no paging. Send lat and lon to bias the suggestions to a point. The region (row, na or il) follows the point, or row when you send no point. A search with no suggestion answers 200 with an empty list and costs no credit. The search takes text only: a coordinate as text returns an empty list, so there is no reverse lookup. Cost: 1 credit per successful search with results.

Waze Place Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/waze/search
Auth header
x-api-key
Cost
1 credit/request
q = coffee shops
Response preview
200 OK
{
    "data": {
        "count": 3,
        "query": "berlin hauptbahnhof",
        "region": "row",
        "results": [
            {
                "id": "googlePlaces.ChIJO1yL-b1RqEcRZJuytxpzjVI",
                "lat": 52.525083,
                "lon": 13.369389,
                "name": "Hauptbahnhof",
                "type": "place",
                "address": "Europaplatz, Berlin, Germany",
                "position": 1,
...

Parameters

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

Runnable path

1 required parameter needed before sending a request.

4 optional filters available.

q string Required

Place or address text, 2 to 100 characters. Example: berlin hauptbahnhof.

Example value coffee shops
lat number Optional

Latitude of a point to bias the suggestions, -90 to 90. Send it together with lon.

Example value 10
lon number Optional

Longitude of a point to bias the suggestions, -180 to 180. Send it together with lat.

Example value 10
region string Optional

Waze region: row (rest of the world), na (North America) or il (Israel). Default: the region of lat and lon, else row.

Example value US
lang string Optional

Language code of the suggestions, for example en or de. Optional.

Example value example

Response Schema

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

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "count": 3,
        "query": "berlin hauptbahnhof",
        "region": "row",
        "results": [
            {
                "id": "googlePlaces.ChIJO1yL-b1RqEcRZJuytxpzjVI",
                "lat": 52.525083,
                "lon": 13.369389,
                "name": "Hauptbahnhof",
                "type": "place",
                "address": "Europaplatz, Berlin, Germany",
                "position": 1,
                "display_name": "Hauptbahnhof, Europaplatz, Berlin, Germany",
                "match_ranges": [
                    {
                        "start": 27,
                        "length": 6
                    },
                    {
                        "start": 35,
                        "length": 7
                    }
                ]
            },
            {
                "id": "googlePlaces.ChIJ_3Pm_L1RqEcRPtHs6p2i0AY",
                "lat": 52.525125,
                "lon": 13.369619,
                "name": "Berlin Hauptbahnhof",
                "type": "place",
                "address": "Mitte, Berlin, Germany",
                "position": 2,
                "display_name": "Berlin Hauptbahnhof, Mitte, Berlin, Germany",
                "match_ranges": [
                    {
                        "start": 28,
                        "length": 6
                    },
                    {
                        "start": 36,
                        "length": 7
                    }
                ]
            },
            {
                "id": "venues.8782349.87626885.331859",
                "lat": 52.524858,
                "lon": 13.36883,
                "name": "Berlin Hauptbahnhof",
                "type": "venue",
                "address": "Europaplatz, Berlin",
                "position": 3
            }
        ]
    },
    "meta": {
        "credits": 1,
        "billable": true,
        "endpoint_family": "place_search"
    },
    "success": 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": {
        "q": [
            "A search text is required, e.g. berlin."
        ]
    },
    "message": "The request validation failed"
}
503

Service Unavailable

Waze could not be reached, refused the request or changed its answer. This response is not billable. Retry later.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "place_search"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The Waze 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.