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.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
string
Required
Listing number from search: a sale number such as 9069HC or a rent number such as C364110.
9069HC
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/sinyi/listing?id=9069HC",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: YOUR_API_KEY_HERE"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
<?php
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/sinyi/listing?id=9069HC');
if ($response->successful()) {
echo $response->body();
} else {
echo "Error: " . $response->status();
}
const options = {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE'
}
};
fetch('https://scrappa.co/api/sinyi/listing?id=9069HC', options)
.then(response => {
if (!response.ok) {
throw new Error(`HTTP error! status: ${response.status}`);
}
return response.text();
})
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/sinyi/listing?id=9069HC',
headers: {
x-api-key: 'YOUR_API_KEY_HERE',
}
};
try {
const response = await axios(options);
console.log(response.data);
} catch (error) {
console.error('Error:', error.message);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/sinyi/listing?id=9069HC")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'
request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'
begin
response = http.request(request)
puts response.body
rescue => e
puts "Error: #{e.message}"
end
import http.client
import json
conn = http.client.HTTPSConnection("scrappa.co")
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
conn.request("GET", "/api/sinyi/listing?id=9069HC", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
except Exception as e:
print(f"Error: {e}")
finally:
conn.close()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/sinyi/listing?id=9069HC', headers=headers)
response.raise_for_status()
print(response.text)
except requests.exceptions.RequestException as e:
print(f"Error: {e}")
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;
public class ApiExample {
public static void main(String[] args) {
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://scrappa.co/api/sinyi/listing?id=9069HC")
.addHeader("x-api-key", "YOUR_API_KEY_HERE")
.build();
try (Response response = client.newCall(request).execute()) {
if (response.isSuccessful()) {
System.out.println(response.body().string());
} else {
System.out.println("Error: " + response.code());
}
} catch (IOException e) {
System.out.println("Error: " + e.getMessage());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/sinyi/listing?id=9069HC", nil)
if err != nil {
fmt.Println("Error creating request:", err)
return
}
req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")
resp, err := client.Do(req)
if err != nil {
fmt.Println("Error making request:", err)
return
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
fmt.Println("Error reading response:", err)
return
}
fmt.Println(string(body))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/sinyi/listing?id=9069HC"
using System;
using System.Net.Http;
using System.Threading.Tasks;
class Program
{
static async Task Main()
{
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");
try
{
var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/sinyi/listing?id=9069HC"));
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
import axios from 'axios';
async function run(): Promise<void> {
try {
const response = await axios({
method: 'GET',
url: 'https://scrappa.co/api/sinyi/listing?id=9069HC',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE',
},
});
console.log(response.data);
} catch (error) {
console.error('Error:', error);
}
}
void run();
use reqwest::Client;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Client::new();
let response = client
.get("https://scrappa.co/api/sinyi/listing?id=9069HC")
.header("x-api-key", "YOUR_API_KEY_HERE")
.send()
.await?;
println!("{}", response.text().await?);
Ok(())
}
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
success
data
meta
{
"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
Handle these documented responses before retrying or showing customer-facing failures.
Not Found
Sinyi has no listing with that number. It may be sold, rented or withdrawn. (`NOT_FOUND`). Non-billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "listing"
},
"error": {
"code": "NOT_FOUND",
"message": "Sinyi has no listing with that number. It may be sold, rented or withdrawn."
},
"success": false
}Validation Error
A query parameter is missing, unknown or unusable. Unknown parameters and unknown values are rejected before any lookup, never ignored. Non-billable.
{
"errors": {
"trade": [
"The selected trade is invalid."
]
},
"message": "The selected trade is invalid."
}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.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "listing"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Sinyi is temporarily unavailable. Please retry."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.