Skip to content
Scrappa Get API key
Sinyi API 1 credit/request

Sinyi Property Search API Documentation

GET https://scrappa.co/api/sinyi/search?trade=sale&location=106&min_price=20000000&max_price=30000000&sort=price_asc

Scrappa's GET /api/sinyi/search returns Sinyi Realty property in Taiwan as structured JSON, for sale or for rent, with location, type, price, rooms, area, building age, sort and paging.

What you get

One request returns one page of listings (30 by default, up to 50), Sinyi's own match count in pagination.total and the real page. Sale rows have id, title, url, property_types, price (New Taiwan dollars), price_wan (the same price in units of 萬), original_price, discount_percent, area, layout, rooms, halls, bathrooms, floor, total_floors, age_years, address, zip_code, latitude, longitude, community, images and views_3_months. Rent rows have id, title, price per month, area.rental_ping, layout, rooms, bathrooms, floor, address, coordinates, cover_image and updated_at. A field Sinyi does not state is null. Call the listing endpoint for fees, all images, the agent and the branch.

Filters are honoured

Sinyi ignores a filter it does not know and returns the unfiltered list. This API therefore checks every value before the lookup and rejects unknown values with 422. It also checks every returned row against min_price, max_price, min_rooms, max_rooms, min_area, max_area and type. A row that breaks a filter is dropped and counted in pagination.dropped_by_filter. query echoes the applied filters. Area is in ping (1 ping is 3.3058 square metres). Sinyi has no bathroom filter, so none is offered.

Location

Take location from search_params of /api/sinyi/autocomplete or from /api/sinyi/locations. A three digit value is a district zip code, for example 106 for Da'an. A one or two digit value is a city id, for example 1 for Taipei. Without a location the search covers Taiwan. Rent search is available for cities 1 to 21.

Sorting

recommended is the default. Sale supports price_asc, price_desc, area_asc, area_desc, age_asc and age_desc. Rent supports price_asc, price_desc, newest and area_desc.

Pagination

page runs from 1 to 500. A page past the last one returns an empty list with the real total and the real page. It never returns page 1 data under another page number.

Sinyi Property Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/sinyi/search?trade=sale&location=106&min_price=20000000&max_price=30000000&sort=price_asc
Auth header
x-api-key
Cost
1 credit/request
trade = sale
Response preview
200 OK
{
    "success": true,
    "data": {
        "items": [
            {
                "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"
                ],
...

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.

13 optional filters available.

trade string Required

sale or rent.

Example value sale
location string Optional

District zip code (3 digits, for example 106) or city id (1 to 22) from autocomplete or locations.

Example value 106
type string Optional

Sale: apartment, high_rise, mid_rise, suite, villa, office, warehouse, store, factory, land, parking or other. Rent: whole_home, private_suite, shared_suite, room, store, office, factory or parking.

Example value example
min_price integer Optional

Minimum price in New Taiwan dollars (monthly rent for rent).

Example value 20000000
max_price integer Optional

Maximum price in New Taiwan dollars (monthly rent for rent).

Example value 30000000
min_rooms integer Optional

Minimum number of bedrooms. 0 is a studio.

Example value 10
max_rooms integer Optional

Maximum number of bedrooms.

Example value 10
min_area number Optional

Minimum area in ping. Sale uses the building area, rent the rental area.

Example value 10
max_area number Optional

Maximum area in ping.

Example value 10
min_age integer Optional

Sale only. Minimum building age in years.

Example value 10
max_age integer Optional

Sale only. Maximum building age in years.

Example value 10
sort string Optional

recommended (default), price_asc, price_desc. Sale also area_asc, area_desc, age_asc, age_desc. Rent also newest, area_desc.

Example value price_asc
page integer Optional

Result page, 1 to 500.

Example value 1
per_page integer Optional

Listings per page, 1 to 50. Default 30.

Example value 10

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/sinyi/search?trade=sale&location=106&min_price=20000000&max_price=30000000&sort=price_asc",
    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
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/sinyi/search?trade=sale&location=106&min_price=20000000&max_price=30000000&sort=price_asc');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/sinyi/search?trade=sale&location=106&min_price=20000000&max_price=30000000&sort=price_asc', 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));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/sinyi/search?trade=sale&location=106&min_price=20000000&max_price=30000000&sort=price_asc',
    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);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/sinyi/search?trade=sale&location=106&min_price=20000000&max_price=30000000&sort=price_asc")
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
Python
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/search?trade=sale&location=106&min_price=20000000&max_price=30000000&sort=price_asc", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/sinyi/search?trade=sale&location=106&min_price=20000000&max_price=30000000&sort=price_asc', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
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/search?trade=sale&location=106&min_price=20000000&max_price=30000000&sort=price_asc")
        .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());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/sinyi/search?trade=sale&location=106&min_price=20000000&max_price=30000000&sort=price_asc", 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))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/sinyi/search?trade=sale&location=106&min_price=20000000&max_price=30000000&sort=price_asc"
C#
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/search?trade=sale&location=106&min_price=20000000&max_price=30000000&sort=price_asc"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/sinyi/search?trade=sale&location=106&min_price=20000000&max_price=30000000&sort=price_asc',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
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/search?trade=sale&location=106&min_price=20000000&max_price=30000000&sort=price_asc")
        .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
JSON Response
200 OK
{
    "success": true,
    "data": {
        "items": [
            {
                "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,
                "address": "\u53f0\u5317\u5e02\u5927\u5b89\u5340\u6566\u5316\u5357\u8def\u4e8c\u6bb5",
                "zip_code": "106",
                "latitude": 25.032869880023,
                "longitude": 121.54920239332,
                "community": null,
                "cover_image": "https://res.sinyi.com.tw/buy/9069HC/bigimg/A.JPG",
                "images": [
                    "https://res.sinyi.com.tw/buy/9069HC/smallimg/A.JPG"
                ],
                "tag_codes": [
                    "12",
                    "10",
                    "16",
                    "17",
                    "18",
                    "19",
                    "100",
                    "102",
                    "107"
                ],
                "views_3_months": 163,
                "has_vr": true,
                "has_video": false
            }
        ],
        "pagination": {
            "page": 1,
            "per_page": 30,
            "total": 116,
            "total_pages": 4,
            "returned": 1,
            "dropped_by_filter": 0,
            "has_more": true
        },
        "query": {
            "trade": "sale",
            "sort": "price_asc",
            "location": "106",
            "min_price": 20000000,
            "max_price": 30000000
        }
    },
    "meta": {
        "endpoint_family": "search",
        "billable": true
    }
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

404

Not Found

Sinyi has no rent search for that location. Take the location from autocomplete or locations. (`NOT_FOUND`). Non-billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "search"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "Sinyi has no rent search for that location. Take the location from autocomplete or locations."
    },
    "success": false
}
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.

{
    "errors": {
        "trade": [
            "The selected trade is invalid."
        ]
    },
    "message": "The selected trade is invalid."
}
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.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "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.