# Apartments.com Renter Guides

kind=index returns the renter guide, kind=article returns one blog article by slug, kind=neighborhood returns the authored neighbourhood guide for a city. A neighbourhood with no authored guide comes back with section_count 0 rather than failing, so check it before reading items. These pages are rendered per request, so body size and word count vary between repeats.

- **Documentation:** [https://scrappa.co/docs/apartments-com-api/apartments_com_renter_guides](https://scrappa.co/docs/apartments-com-api/apartments_com_renter_guides)
- **API group:** Apartments.com API
- **Endpoint:** `GET https://scrappa.co/api/apartments-com/renter-guides`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `kind` | string | No | index, article, or neighborhood. |
| `slug` | string | No | Article slug, required for kind=article. |
| `neighborhood` | string | No | Neighbourhood name, required for kind=neighborhood. |
| `city` | string | No | City, required for kind=neighborhood. |
| `state` | string | No | State, required for kind=neighborhood. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/apartments-com/renter-guides?kind=index"
```

## Example response

```json
{
    "success": true,
    "data": {
        "title": "Renter's Guide",
        "word_count": 3200
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | The requested listing, guide, or sitemap was not found. This response is not billable. |
| 422 | Validation Error | A required public parameter is missing or invalid. This response is not billable. |
| 503 | Service Unavailable | The service could not obtain a complete result. This response is not billable. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)