amberstudent.com APIamberstudent.com ↗
Access student accommodation listings, room types, reviews, and price trends from amberstudent.com via a structured JSON API with 6 endpoints.
curl -X GET 'https://api.parse.bot/scraper/1452ac1e-93a1-4534-a1c4-9fb928512e1f/search_listings?page=1&limit=5&query=london' \ -H 'X-API-Key: $PARSE_API_KEY'
Search for student accommodation listings by city, university, or property name. Returns a paginated list of properties with pricing, metadata, and location information.
| Param | Type | Description |
|---|---|---|
| page | integer | Page number for pagination. |
| limit | integer | Max results per page. |
| query | string | City or region canonical name to filter by (e.g. 'london', 'melbourne'). Omitting returns all active listings. |
| filters | object | Additional filter parameters as a JSON object. Keys are merged into the query parameters sent upstream. |
| sort_key | string | Key to sort results by (e.g. 'price', 'relevance'). |
| sort_order | string | Sort direction: 'asc' or 'desc'. |
{
"type": "object",
"fields": {
"agg": "object with aggregation data",
"meta": "object containing pagination info (prev, next, count, limit, pages, current_page)",
"result": "array of property listing objects with id, name, pricing, meta, description, images, location, etc."
},
"sample": {
"data": {
"agg": {},
"meta": {
"next": 2,
"prev": null,
"count": 2000,
"limit": 5,
"pages": [
1,
2,
3,
400
],
"current_page": 1
},
"result": [
{
"id": 2051,
"name": "West 6th, Tempe",
"pricing": {
"currency": "dollar",
"duration": "monthly",
"max_price": 5493,
"min_price": 1444
}
}
]
},
"status": "success"
}
}About the amberstudent.com API
The Amber Student API provides structured access to student accommodation data from amberstudent.com across 6 endpoints, covering property listings, room-type inventory, tenant reviews, and historical price trends. The search_listings endpoint alone returns per-property fields including pricing, location coordinates, images, and metadata, making it suitable for building accommodation finders, price comparison tools, or university housing guides.
Listings and Search
The search_listings endpoint accepts a query parameter for city or region (e.g. london, melbourne), optional filters as a JSON object, and sort_key/sort_order for ordering results by fields like price or relevance. Responses include paginated arrays of property objects with id, name, pricing (min/max price, currency, duration, deposits), location (country, locality, district, coordinates), images, and descriptive meta. The meta field in the response body tracks pagination state: prev, next, count, limit, pages, and current_page.
Property Details and Room Types
The get_property_details endpoint takes a property slug in the format property-name-inventoryNumber — sourced from canonical_name in search results — and returns a full property record including meta.distances, meta.amenity_prices, meta.unit_types, meta.cro_tags, and meta.price_trends. The get_property_room_types endpoint uses the same slug and returns a paginated list of room type objects, each with its own pricing, features, images, and availability status. These two endpoints together provide enough detail to render a complete property page.
Reviews and Price Trends
The get_property_reviews endpoint returns two separate arrays for a given property: result (reviews that include media attachments alongside id, content, rating, and user_details) and resultWithoutMedia (text-only reviews with the same core fields). The get_property_price_trend endpoint accepts either a numeric property ID or a slug and returns a trends array where each entry covers month_of_date, year_of_date, price, city_avg_cost, cost_difference_percent, and forecasting metrics — useful for charting rental price trajectories over multiple years.
City and Country Coverage
The list_popular_cities endpoint requires no inputs and returns a country-keyed map (e.g. United Kingdom, United States) where each country maps to an array of city objects. Each city object contains property inventories with pricing, images, and availability, making it a convenient starting point for building geographic navigation or seeding slugs for downstream calls.
- Build a student housing search tool filtered by city using
search_listingswith thequeryparameter - Display per-property room inventory and per-room pricing by combining
get_property_detailsandget_property_room_types - Render a rental price history chart using monthly
priceandcity_avg_costfields fromget_property_price_trend - Aggregate and display tenant sentiment by pulling
ratingandcontentfields fromget_property_reviews - Populate a country and city navigation structure for a housing portal using
list_popular_cities - Compare deposit requirements across properties by extracting the
depositsfield frompricingin search results - Identify properties with amenity surcharges by reading
meta.amenity_pricesfromget_property_details
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 100 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 250 req/min |
One credit = one API call regardless of which marketplace API you call. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does amberstudent.com have an official developer API?+
What does `get_property_reviews` return, and how are reviews split?+
result contains reviews that have media attachments (photos or videos) alongside id, content, rating, and user_details; resultWithoutMedia contains text-only reviews with the same core fields. The meta object tracks count, limit, and current_page.How do I get a valid property slug to use across endpoints?+
property-name-inventoryNumber (e.g. my-student-hall-123456789). You can obtain them from the canonical_name field in search_listings responses or from the property inventory arrays returned by list_popular_cities. The get_property_price_trend endpoint also accepts a bare numeric property ID as an alternative.Does the API support filtering listings by specific amenities or room features?+
search_listings endpoint accepts a filters object whose keys are merged into the query, so you can pass filter parameters that correspond to fields the site exposes. Detailed amenity-level filtering is not a documented first-class parameter. Amenity pricing data is available per-property via meta.amenity_prices in get_property_details. You can fork this API on Parse and revise it to add a dedicated amenity-filter endpoint if your use case requires it.