API Reference
Neighborhood and Area Descriptions via API
Generate data-grounded neighborhood and area descriptions in multiple languages. Based on ratings, POIs, and travel times.
- Multi-Language
- Data-Grounded
- Async API
- SEO-Optimized
Use Cases
- Listing text: Explanatory neighborhood text directly in property listings for better conversion.
- SEO landing pages: Unique neighborhood descriptions for area pages. Optimized for SEO and AEO.
- Content scaling: Hundreds of area descriptions via API instead of manual content creation.
API Workflow
- Create place:
POST /places/{lon},{lat}— creates a place and returns an ID. - Generate text (sync):
POST /places/{id}/texts/area-descriptions?wait=true— waits for result (up to 180s). - Generate text (async): Without
?wait=true— returns 202 + Location header + Retry-After. Poll until 200.
Code Example
# 1. Create place
PLACE_ID=$(curl -s -X POST "https://api.geosci.de/places/13.31103,52.51570" \
--header "Authorization: Apikey $GEOSCI_API_KEY" | jq -r .id)
# 2. Generate area description (sync, DE+EN)
curl -L -X POST "https://api.geosci.de/places/$PLACE_ID/texts/area-descriptions?wait=true" \
--header "Authorization: Apikey $GEOSCI_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"languages": ["de", "en"],
"parameters": {
"name": "Berlin-Charlottenburg",
"geo_level": "neighborhood"
}
}' Request Parameters
| Parameter | Type | Description |
|---|---|---|
languages | string[] | Languages, e.g. ["de", "en"] |
parameters.name | string | Area name |
parameters.geo_level | string | Geographic level, e.g. "neighborhood" |