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

NoBroker Location Autocomplete API Documentation

GET https://scrappa.co/api/nobroker/autocomplete

NoBroker Location Autocomplete API Find places in one city by a search text of 3 or more characters. Each result has a place_id, a name, a type (locality, building or place) and an area text. Send the place_id of a locality as the place_id parameter of the search endpoint. A building (needs_coordinates=true) has no area of its own: search around it with lat and lon instead. NoBroker gives no coordinates in autocomplete.

NoBroker Location Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/nobroker/autocomplete
Auth header
x-api-key
Cost
1 credit/request
query = coffee shops city = example
Response preview
200 OK
{
    "data": {
        "city": "bangalore",
        "query": "koramangala",
        "results": [
            {
                "area": "Bangalore, Karnataka, IN",
                "name": "Koramangala",
                "type": "locality",
                "place_id": "ChIJLfyY2E4UrjsRVq4AjI7zgRY",
                "description": "Koramangala, Bengaluru, Karnataka, India",
                "needs_coordinates": false
            },
            {
...

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

Search text, 3 to 100 characters, e.g. koramangala.

Example value coffee shops
city string Required

One of bangalore, mumbai, pune, chennai, gurgaon, hyderabad, delhi, noida, greater_noida, ghaziabad, faridabad. Bengaluru, Gurugram and New Delhi also work.

Example value example
service string Optional

rent or buy (default rent). The same places are found for both.

Example value example
limit integer Optional

Rows to return, 1 to 20 (default 10).

Example value 10

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": {
        "city": "bangalore",
        "query": "koramangala",
        "results": [
            {
                "area": "Bangalore, Karnataka, IN",
                "name": "Koramangala",
                "type": "locality",
                "place_id": "ChIJLfyY2E4UrjsRVq4AjI7zgRY",
                "description": "Koramangala, Bengaluru, Karnataka, India",
                "needs_coordinates": false
            },
            {
                "area": "Koramangala, Bengaluru, Karnataka 560095",
                "name": "Koramangala Comforts",
                "type": "building",
                "place_id": "63aac691f372ac00019d9179_NBB",
                "description": "Koramangala Comforts Koramangala, Bengaluru, Karnataka 560095",
                "needs_coordinates": true
            },
            {
                "area": "20th Main Road, 6th Block, Koramangala, Bangalore, Karnataka, IN",
                "name": "Koramangala Police Station",
                "type": "place",
                "place_id": "ChIJ0WI9b0YUrjsRrGwyZxIzk_0",
                "description": "Koramangala Police Station, 20th Main Road, 6th Block, Koramangala, Bengaluru, Karnataka, India",
                "needs_coordinates": false
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}

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.

{
    "errors": {
        "query": [
            "The search text needs at least 3 characters."
        ]
    },
    "message": "The request validation failed"
}
503

Temporarily Unavailable

NoBroker did not answer or refused the request after several attempts. This response is not billable. Retry after a short pause.

{
    "meta": {
        "attempts": 3,
        "billable": false,
        "retryable": true
    },
    "error": {
        "message": "NoBroker data is temporarily unavailable. Please retry.",
        "failure_type": "upstream_unavailable"
    },
    "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.