# Homestra Ad

## Overview

| Property | Value |
|----------|-------|
| **Status** | active |
| **Method** | `GET` |
| **Endpoint** | `/v2/homestra/ad` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 1 credit per call |
| **Documentation** | https://www.piloterr.com/library/homestra-ad |

## Description

Retrieve detailed property listing data from Homestra, including price, size, location, features, photos, and nearby properties.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/homestra/ad' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Get chateau listing in Civray, France

```json
{
  "id": "c6ff90a7-d152-42c9-a1a3-ff0b5cbbcdaf",
  "city": "Civray",
  "size": 240,
  "slug": "charming-4-bedroom-stone-house-with-historic-towers-in-idyllic-french-village",
  "type": "chateau",
  "price": 474500,
  "title": "Charming 4-Bedroom Stone House with Historic Towers in Idyllic French Village",
  "garden": true,
  "region": "Cher",
  "status": "for_sale",
  "address": "France",
  "parking": true,
  "basement": true,
  "location": {
    "type": "Point",
    "coordinates": [
      46.94515,
      2.17684
    ]
  },
  "lot_size": 3933,
  "condition": "good",
  "furnished": false,
  "created_at": "2024-06-01T17:43:55.361Z",
  "country_code": "fr",
  "swimming_pool": false,
  "nearby_properties": [
    {
      "id": "a08d69ea-888e-4ed2-8bbd-6a731efd1bd5",
      "slug": "charming-3-bedroom-home-in-aquitaine-france",
      "price": 275000,
      "title": "Charming 3 Bedroom Home in Aquitaine, France"
    }
  ],
  "amount_of_bedrooms": 4,
  "featured_photo_url": "https://storage.googleapis.com/homestra-images/property-image-cab7dff4-ce7b-4f20-9d35-2df09ae9d283-1717266265.jpg",
  "amount_of_bathrooms": 1
}
```

## Documentation

## Overview
The Homestra Ad endpoint retrieves full details for any Homestra property listing, including price, size, features, photos, and location data.

## Quickstart
```
GET https://api.piloterr.com/v2/homestra/ad?query=charming-4-bedroom-stone-house-with-historic-towers-in-idyllic-french-village
```

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Homestra property URL or slug |

## Response fields
| Field | Type | Description |
|---|---|---|
| `title` | string | Property listing title |
| `type` | string | Property type |
| `price` | number | Listing price |
| `size` | number | Living area in sqm |
| `amount_of_bedrooms` | number | Number of bedrooms |
| `location` | object | GPS coordinates |
| `condition` | string | Property condition |
| `photos` | array | Property photos |

## Notes
- Accepts full Homestra URLs or property slugs.
- GPS in GeoJSON Point format: `[longitude, latitude]`.

## Main use cases
- Build real estate comparison tools for international property buyers
- Analyze Homestra price trends by region, type, or country
- Enrich property investment research with structured listing data
- Monitor properties for price changes in automated workflows