# Amberstudent — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search student accommodation listings across popular cities and access comprehensive property information including room types, pricing trends, and tenant reviews. Get detailed insights into student housing options to compare amenities, prices, and community feedback all in one place.

**Category:** Real Estate | **Website:** [amberstudent.com/](https://amberstudent.com/) | **Docs:** [parse.bot/marketplace/7e16d303-696d-4262-bd6a-3f60f49c7d90/amberstudent-com-api](https://parse.bot/marketplace/7e16d303-696d-4262-bd6a-3f60f49c7d90/amberstudent-com-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/amberstudent/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get property details

Retrieve comprehensive details for a single property by its slug. Returns the full property record including pricing, metadata (distances, amenities, lease info, cro_tags), descriptions, images, videos, location, features, FAQs, region info, and child room types. The slug format is 'property-name-inventoryNumber' from the canonical_name field in search results. Metadata sub-fields vary by property type and source; fields like unit_types, available_types, total_videos_count, total_virtual_views_count, and is_budget_friendly may or may not be present depending on the property.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `slug` | string | Yes | Property slug in the format 'property-name-inventoryNumber' (e.g. 'west-6th-1607141041479'). Found in search_listings results as canonical_name. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/amberstudent/get-property-details \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"slug":"<string>"}'
```

### Get property price trend

Get historical price trend data for a property across multiple years. Returns monthly data points including price, city average cost, cost difference percent, and forecasting metrics. Accepts either a numeric property ID directly or a slug (which is resolved to an ID via an extra lookup).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `slug_or_id` | string | Yes | Property numeric ID (e.g. '2051') or property slug (e.g. 'west-6th-1607141041479'). Numeric IDs skip the resolution step. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/amberstudent/get-property-price-trend \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"slug_or_id":"<string>"}'
```

### Get property reviews

Get student reviews for a property. Returns reviews split into two arrays: those with media attachments and those without. Some properties have no reviews, in which case both arrays are empty.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `slug` | string | Yes | Property slug (e.g. 'hyde-park-tower-apartments-1607149772661'). Found in search_listings results as canonical_name. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/amberstudent/get-property-reviews \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"slug":"<string>"}'
```

### Get property room types

Get all room type inventory for a property, including pricing, features, images, and availability for each room type. Each room type contains active_children_with_filters showing specific lease term variants.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `slug` | string | Yes | Property slug (e.g. 'west-6th-1607141041479'). Found in search_listings results as canonical_name. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/amberstudent/get-property-room-types \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"slug":"<string>"}'
```

### List popular cities

Get popular cities and featured properties organized by country. Returns a mapping of country names to arrays of city objects, each containing a city name and an inventories array with property summaries (id, name, pricing, status, images, location, reviews). No input parameters required.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/amberstudent/list-popular-cities \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Search listings

Search for student accommodation listings by city or region. Returns paginated results with property pricing, metadata, descriptions, images, and location. Pagination via integer page counter; each result object carries a canonical_name usable as the slug for detail endpoints. Omitting query returns all active listings globally (2000+).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `filters` | object | No | Additional filter parameters as a JSON object. Keys are merged into the query parameters sent upstream. |
| `limit` | integer | No | Max results per page (1-100). |
| `page` | integer | No | Page number for pagination. |
| `query` | string | No | City or region canonical name to filter by (e.g. 'london', 'melbourne', 'tempe-1811051325535'). Omitting returns all active listings. |
| `sort_key` | string | No | Key to sort results by (e.g. 'price', 'relevance'). |
| `sort_order` | string | No | Sort direction: 'asc' or 'desc'. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/amberstudent/search-listings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"filters":"<object>","limit":"<integer>","page":"<integer>","query":"<string>","sort_key":"<string>","sort_order":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://paywithlocus.com/agent/index.md): every Locus agent page.