# Sinyi Listing Details API Documentation

Scrappa's `GET /api/sinyi/listing` returns the full record of one Sinyi sale or rent listing as structured JSON.

## What you get

A sale listing (a number such as `9069HC`) returns the price in New Taiwan dollars and in 萬, the first asking price and discount, the price per ping, the monthly management fee, the area breakdown in ping and square metres, layout and room counts, floor and total floors, building age, directions, parking, balcony, building manager, `location` with city, district, zip code, address and coordinates, the community, all `images`, the floor plan and map pictures, a 3D tour preview picture, video and AI tour links, `listed_at`, the listing `agent` and the branch `store`.

A rent listing (a number such as `C364110`) returns the monthly rent, what the rent includes, the deposit, the rental and registered area, layout, floor, building type, lease term, management fee, pets and cooking rules, `furniture`, `features`, `nearby` facilities, `transit` with metro stations, all `images`, `location` with coordinates, the `agent`, the branch `store`, `updated_at` and `nearby_listings`.

Agent and branch data is the business contact that Sinyi shows publicly on the listing. A field Sinyi does not state is `null`.

## Branch id

The `store.id` of a sale listing is the `id` for `/api/sinyi/agency`.

- **Documentation:** [https://scrappa.co/docs/sinyi-api/sinyi_listing](https://scrappa.co/docs/sinyi-api/sinyi_listing)
- **API group:** Sinyi API
- **Endpoint:** `GET https://scrappa.co/api/sinyi/listing`

## 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 |
| --- | --- | --- | --- |
| `id` | string | Yes | Listing number from search: a sale number such as 9069HC or a rent number such as C364110. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/sinyi/listing?id=9069HC"
```

## Example response

```json
{
    "success": true,
    "data": {
        "id": "9069HC",
        "title": "\u25cf\u4fe1\u7fa9\u6566\u5357\u25cf\u4e5d\u9f8d",
        "url": "https://www.sinyi.com.tw/buy/house/9069HC",
        "share_url": "https://sinyi.in/o/9069HC/0/3",
        "listing_type": "sale",
        "property_types": [
            "high_rise",
            "office"
        ],
        "price": 20000000,
        "price_wan": 2000,
        "original_price": 16000000,
        "discount_percent": 25,
        "currency": "TWD",
        "area": {
            "building_ping": 10.61,
            "building_sqm": 35.07,
            "main_building_ping": 8.96,
            "main_building_sqm": 29.62,
            "land_ping": 1.13,
            "land_sqm": 3.74
        },
        "layout": "1\u5ef31\u885b",
        "rooms": 0,
        "halls": 1,
        "bathrooms": 1,
        "floor": "6",
        "total_floors": 12,
        "age_years": 47.9,
        "is_presale": false,
        "has_parking": false,
        "parking": null,
        "community": null,
        "cover_image": "https://res.sinyi.com.tw/buy/9069HC/bigimg/A.JPG",
        "images": [
            "https://res.sinyi.com.tw/buy/9069HC/bigimg/A.JPG",
            "https://res.sinyi.com.tw/buy/9069HC/bigimg/B.JPG"
        ],
        "views_3_months": 163,
        "has_vr": true,
        "unit_price": {
            "text": "188.50 \u842c/\u576a",
            "per_ping": 1885000,
            "currency": "TWD"
        },
        "monthly_fee": "\u6bcf\u6708\u7d04 825 \u5143\u3002",
        "area_breakdown": [
            {
                "label": "\u4e3b\u5efa\u7269",
                "ping": 8.96,
                "sqm": 29.62
            },
            {
                "label": "\u5171\u6709\u90e8\u4efd",
                "ping": 1.65,
                "sqm": 5.45
            }
        ],
        "extra_rooms": {
            "rooms": 0,
            "halls": 0,
            "bathrooms": 0,
            "open_rooms": 0
        },
        "has_balcony": false,
        "building_manager": "\u65e5\u9593",
        "directions": {
            "house": "\u5357",
            "building": "\u897f",
            "window": "\u5317",
            "land": null
        },
        "location": {
            "city_id": "1",
            "city": "\u53f0\u5317\u5e02",
            "zip_code": "106",
            "district": "\u5927\u5b89\u5340",
            "address": "\u53f0\u5317\u5e02\u5927\u5b89\u5340\u6566\u5316\u5357\u8def\u4e8c\u6bb5",
            "latitude": 25.032869880023,
            "longitude": 121.54920239332
        },
        "layout_image": "https://res.sinyi.com.tw/buy/9069HC/bigimg/E.JPG",
        "map_image": "https://res.sinyi.com.tw/buy/9069HC/lifeimg/9069HC_MAP.JPG",
        "vr_preview_image": "https://res.sinyi.com.tw/buy/9069HC/3dvr/9069HC.jpg",
        "video_url": null,
        "ai_tour_url": "https://www.sinyi.com.tw/ai-tour/?houseno=9069HC",
        "listed_at": "2024-12-30 15:03:42",
        "agent": {
            "id": "218751",
            "name": "\u5f35\u7389\u7444",
            "title": "\u672c\u6848\u5c08\u5bb6",
            "photo": "https://res.sinyi.com.tw/sale/218751/photo/218751.JPG",
            "phone": "0900000000",
            "store_id": "R621",
            "store_name": "\u5927\u5b89\u6210\u529f\u5e97",
            "store_address": "\u53f0\u5317\u5e02\u5927\u5b89\u5340\u5fa9\u8208\u5357\u8def\u4e8c\u6bb5\uff11\uff15\uff11\u5df7\uff11\uff16\u4e4b\uff11\u865f",
            "store_phone": "02-89786517"
        },
        "store": {
            "id": "R621",
            "name": "\u5927\u5b89\u6210\u529f\u5e97",
            "address": "\u53f0\u5317\u5e02\u5927\u5b89\u5340\u5fa9\u8208\u5357\u8def\u4e8c\u6bb5\uff11\uff15\uff11\u5df7\uff11\uff16\u4e4b\uff11\u865f",
            "phone": "02-89786517"
        }
    },
    "meta": {
        "endpoint_family": "listing",
        "billable": true
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | Sinyi has no listing with that number. It may be sold, rented or withdrawn. (`NOT_FOUND`). Non-billable. |
| 422 | Validation Error | A query parameter is missing, unknown or unusable. Unknown parameters and unknown values are rejected before any lookup, never ignored. Non-billable. |
| 503 | Upstream Unavailable | Sinyi could not be reached after one retry, answered with an error or changed its format (`UPSTREAM_UNAVAILABLE`). Retryable and never billed. Clients are never rate limited. |

## 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)
