Skip to content
Scrappa Get API key
Rent.com API 1 credit/request

Rent.com Autocomplete API Documentation

GET https://scrappa.co/api/rent-com/autocomplete

Scrappa's GET /api/rent-com/autocomplete suggests places and properties for a text such as Aus or 78701.

What you get

locations lists cities, ZIP codes, neighborhoods and schools with their type. Each place has a search_location value. Send it as location to /api/rent-com/search. Schools have no search_location because a school cannot be searched. properties lists apartment communities and homes whose name matches, each with the listing id for /api/rent-com/listing.

Limits

limit (1 to 25, default 10) caps each of the two lists. Results are cached for a few hours.

Rent.com Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/rent-com/autocomplete
Auth header
x-api-key
Cost
1 credit/request
q = Aus
Response preview
200 OK
{
    "data": {
        "query": "Aus",
        "locations": [
            {
                "id": "4805000",
                "name": "Austin, TX",
                "type": "city",
                "seo_path": "/texas/austin/",
                "search_location": "/texas/austin/"
            }
        ],
        "properties": [
            {
...

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.

1 optional filter available.

q string Required

Search text, 2 to 100 characters.

Example value Aus
limit integer Optional

Results per list, 1 to 25. Default 10.

Example value 5

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": {
        "query": "Aus",
        "locations": [
            {
                "id": "4805000",
                "name": "Austin, TX",
                "type": "city",
                "seo_path": "/texas/austin/",
                "search_location": "/texas/austin/"
            }
        ],
        "properties": [
            {
                "id": "lc6755889",
                "url": "https://www.rent.com/apartment/emerson-apartments-at-town-lake-austin-tx-lc6755889",
                "city": "Austin",
                "name": "Emerson Apartments at Town Lake",
                "address": "1919 Burton Dr, Austin, TX 78741",
                "state_code": "TX",
                "property_type": "APARTMENTS"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}

Errors

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

422

Validation Error

A query parameter is missing, unknown or unusable. Unknown parameters are rejected, never ignored. Non-billable.

{
    "errors": {
        "sort": [
            "The selected sort is invalid."
        ]
    },
    "message": "The selected sort is invalid."
}
503

Upstream Unavailable

Rent.com could not be reached after retries, or answered with an unexpected result (`upstream_unavailable`). Retryable and never billed. Clients are never rate limited.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "autocomplete"
    },
    "error": {
        "code": "upstream_unavailable",
        "message": "Rent.com could not be reached. Please retry shortly."
    },
    "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.