Sinyi Agency Profile API Documentation

GET https://scrappa.co/api/sinyi/agency?id=R621

Scrappa's GET /api/sinyi/agency returns the public profile of one Sinyi Realty branch.

What you get

id, name, address, phone, a text description of the trade area, image, map_image, location with city, district and coordinates, the branch manager, awards and news. Take the branch id from store.id of a sale listing. Only business contacts that Sinyi shows publicly are returned.

Run this endpoint

Sinyi Agency Profile API Documentation 1 credit/request

Get API key Open Playground

Request preview

GET

https://scrappa.co/api/sinyi/agency?id=R621

Auth header: x-api-key
Cost: 1 credit/request

id = R621

Response preview

200 OK

{
    "success": true,
    "data": {
        "id": "R621",
        "name": "\u5927\u5b89\u6210\u529f\u5e97",
        "brand": "\u4fe1\u7fa9\u623f\u5c4b",
        "address": "\u5fa9\u8208\u5357\u8def\u4e8c\u6bb5\uff11\uff15\uff11\u5df7\uff11\uff16\u4e4b\uff11\u865f",
        "phone": "02-89786517",
        "description": "\u5927\u5b89\u6210\u529f\u5e97\u65bc96\u5e745\u6708\u6b63\u5f0f\u9032\u99d0\uff0c\u5546\u5708\u7bc4\u570d\u70ba\u4e00\u4f4f\u5546\u6df7\u5408\u5340\uff0c\u6771\u908a\u6566\u5316\u5357\u8def\u6709\u591a\u5bb6\u91d1\u878d\u6a5f\u69cb\u53ca\u6566\u5316\u5546\u5708\uff0c\u4ee5\u6566\u5316\u5357\u8def\u70ba\u4e2d\u5fc3\u5411\u5169\u5074\u5ef6\u4f38\uff0c\u6566\u5316\u5357\u8def\u70ba\uff18\uff10\u7c73\u6797\u852d\u5927\u9053\uff0c\u5169\u65c1\u5927\u5ec8\u6797\u7acb\u4e14\u591a\u70ba\u91d1\u878d\u5546\u696d\u5927\u5ec8\uff0c\u6574\u5340\u5546\u696d\u6c23\u606f\u9f0e\u76db\uff0c\u70ba\u4e00\u91d1\u878d\u7279\u5340\uff0c\u9031\u908a\u751f\u6d3b\u6a5f\u80fd\u5b8c\u5584\uff0c\u6566\u5316\u5357\u8def\u6cbf\u7dda\u591a\u70ba\u5317\u5e02\u4e00\u7d1a\u91d1\u878d\u5546\u8fa6\u5927\u6a13\uff0c\u9817\u8ca0\u76db\u540d\u4e4b\u9060\u4f01\u5927\u98ef\u5e97\u53ca\u8cfc\u7269\u4e2d\u5fc3\u5373\u4f4d\u65bc\u6b64\u3002\u897f\u908a\u70ba\u5fa9\u8208\u5357\u8def\u6709\u4fbf\u6377\u4e4b\u6377\u904b\u7cfb\u7d71\uff0c\u4ea4\u901a\u56db\u901a\u516b\u9054\uff0c\u5169\u689d\u8def\u4e2d\u9593\u70ba\u975c\u8b10\u4e4b\u4f4f\u5b85\u5340\uff0c\u5546\u5708\u5167\u77e5\u540d\u8c6a\u5b85\u6797\u7acb\uff0c\u5982\u570b\u7f8e\u85dd\u8853\u9928\u3001\u51f1\u65cb\u9580\u3001\u5b89\u548c\u4e16\u7d00\u82b1\u5ee3\u7b49\u3002 \u5546\u5708\u5167\u4e4b\u6210\u529f\u570b\u5b85\uff0c\u6574\u500b\u570b\u5b85\u793e\u5340\u6240\u4f54\u57fa\u5730\u7bc4\u570d\u5ee3\u95ca\uff0c\u4f4f\u6236\u773e\u591a\uff0c\u662f\u672c\u5e02\u99b3\u540d\u4e4b\u6a21\u7bc4\u570b\u5b85\u3002 \u9130\u8fd1\u5b78\u5340\u53ca\u5404\u7d1a\u5b78\u6821\u6709\uff1a\u5efa\u5b89\u570b\u5c0f\u3001\u5e2b\u9662\u9644\u5c0f\u3001\u7acb\u4eba\u5c0f\u5b78\u3001\u5927\u5b89\u3001\u4ec1\u611b\u7b49\u570b\u4e2d\u3001\u548c\u5e73\u9ad8\u4e2d\u3001\u5e2b\u5927\u9644\u4e2d\u3001\u570b\u7acb\u5e2b\u9662\u3001\u5e2b\u5927\u3001\u81fa\u5927\u7b49\u7b49\u3002\u6b64\u5916\u793e\u5340\u65c1\u4ea6\u6709\u6210\u529f(\u50b3\u7d71)\u5e02\u5834\uff0c\u8cfc\u7269\u4e0d\u5fc5\u9060\u6c42\uff0c\u751f\u6d3b\u6a5f\u80fd\u8c50\u5bcc\u591a\u6a23\u3002 \u5546\u5708\u5167\u5efa\u5b89\u570b\u5c0f\u3001\u5927\u5b89\u570b\u4e2d\u70ba\u660e\u661f\u5b78\u5340\u5438\u5f15\u8a31\u591a\u5bb6\u9577\u9077\u5165\u8a72\u5b78\u5340\u5c45\u4f4f\uff0c\u672c\u5340\u5df7\u5167\u4f4f\u5bb6\u74b0\u5883\u512a\u96c5\uff0c\u96d6\u591a\u70ba\u8001\u820a\u516c\u5bd3\u4f46\u50f9\u683c\u4ecd\u820a\u9817\u4f73\uff0c\u4fe1\u7dad\u5e02\u5834\u4f4f\u5bb6\u54c1\u8cea\u7a0d\u5dee\uff0c\u800c\u5b89\u548c\u8def\u4e00\u5e36\u7684\u4f4f\u5bb6\u540d\u5b85\u6797\u7acb\u683c\u8abf\u9817\u70ba\u9ad8\u7d1a\uff0c\u4f4f\u5b85\u884c\u60c5\u4ea6\u5c45\u9ad8\u4e0d\u4e0b\uff0c\u6b64\u5340\u57df\u8207\u4fe1\u7fa9\u8a08\u5283\u5340\u76f8\u9130\u751f\u6d3b\u6a5f\u80fd\u5b8c\u5584\uff0c\u5be6\u70ba\u4e00\u826f\u597d\u4e4b\u5c45\u5bb6\u74b0\u5883\u3002",
        "image": "https://res.sinyi.com.tw/store/R621/photo/R621.JPG",
        "map_image": "https://res.sinyi.com.tw/store/R621/map/R621_MAP.JPG",
        "location": {
            "city_id": "1",
            "city": "\u53f0\u5317\u5e02",
...

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.

id


                                        string

Required

Branch id from a sale listing (store id), for example R621.

Example value


                                        R621

Request Examples

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/sinyi/agency?id=R621",
    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/agency?id=R621');

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/agency?id=R621', 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/agency?id=R621',
    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/agency?id=R621")
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/agency?id=R621", 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/agency?id=R621', 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/agency?id=R621")
        .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/agency?id=R621", 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/agency?id=R621"

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/agency?id=R621"));
            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/agency?id=R621',
            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/agency?id=R621")
        .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.

Open in Playground

Example response fields

Scan these fields before integrating.

success data meta

JSON Response

200 OK

{
    "success": true,
    "data": {
        "id": "R621",
        "name": "\u5927\u5b89\u6210\u529f\u5e97",
        "brand": "\u4fe1\u7fa9\u623f\u5c4b",
        "address": "\u5fa9\u8208\u5357\u8def\u4e8c\u6bb5\uff11\uff15\uff11\u5df7\uff11\uff16\u4e4b\uff11\u865f",
        "phone": "02-89786517",
        "description": "\u5927\u5b89\u6210\u529f\u5e97\u65bc96\u5e745\u6708\u6b63\u5f0f\u9032\u99d0\uff0c\u5546\u5708\u7bc4\u570d\u70ba\u4e00\u4f4f\u5546\u6df7\u5408\u5340\uff0c\u6771\u908a\u6566\u5316\u5357\u8def\u6709\u591a\u5bb6\u91d1\u878d\u6a5f\u69cb\u53ca\u6566\u5316\u5546\u5708\uff0c\u4ee5\u6566\u5316\u5357\u8def\u70ba\u4e2d\u5fc3\u5411\u5169\u5074\u5ef6\u4f38\uff0c\u6566\u5316\u5357\u8def\u70ba\uff18\uff10\u7c73\u6797\u852d\u5927\u9053\uff0c\u5169\u65c1\u5927\u5ec8\u6797\u7acb\u4e14\u591a\u70ba\u91d1\u878d\u5546\u696d\u5927\u5ec8\uff0c\u6574\u5340\u5546\u696d\u6c23\u606f\u9f0e\u76db\uff0c\u70ba\u4e00\u91d1\u878d\u7279\u5340\uff0c\u9031\u908a\u751f\u6d3b\u6a5f\u80fd\u5b8c\u5584\uff0c\u6566\u5316\u5357\u8def\u6cbf\u7dda\u591a\u70ba\u5317\u5e02\u4e00\u7d1a\u91d1\u878d\u5546\u8fa6\u5927\u6a13\uff0c\u9817\u8ca0\u76db\u540d\u4e4b\u9060\u4f01\u5927\u98ef\u5e97\u53ca\u8cfc\u7269\u4e2d\u5fc3\u5373\u4f4d\u65bc\u6b64\u3002\u897f\u908a\u70ba\u5fa9\u8208\u5357\u8def\u6709\u4fbf\u6377\u4e4b\u6377\u904b\u7cfb\u7d71\uff0c\u4ea4\u901a\u56db\u901a\u516b\u9054\uff0c\u5169\u689d\u8def\u4e2d\u9593\u70ba\u975c\u8b10\u4e4b\u4f4f\u5b85\u5340\uff0c\u5546\u5708\u5167\u77e5\u540d\u8c6a\u5b85\u6797\u7acb\uff0c\u5982\u570b\u7f8e\u85dd\u8853\u9928\u3001\u51f1\u65cb\u9580\u3001\u5b89\u548c\u4e16\u7d00\u82b1\u5ee3\u7b49\u3002 \u5546\u5708\u5167\u4e4b\u6210\u529f\u570b\u5b85\uff0c\u6574\u500b\u570b\u5b85\u793e\u5340\u6240\u4f54\u57fa\u5730\u7bc4\u570d\u5ee3\u95ca\uff0c\u4f4f\u6236\u773e\u591a\uff0c\u662f\u672c\u5e02\u99b3\u540d\u4e4b\u6a21\u7bc4\u570b\u5b85\u3002 \u9130\u8fd1\u5b78\u5340\u53ca\u5404\u7d1a\u5b78\u6821\u6709\uff1a\u5efa\u5b89\u570b\u5c0f\u3001\u5e2b\u9662\u9644\u5c0f\u3001\u7acb\u4eba\u5c0f\u5b78\u3001\u5927\u5b89\u3001\u4ec1\u611b\u7b49\u570b\u4e2d\u3001\u548c\u5e73\u9ad8\u4e2d\u3001\u5e2b\u5927\u9644\u4e2d\u3001\u570b\u7acb\u5e2b\u9662\u3001\u5e2b\u5927\u3001\u81fa\u5927\u7b49\u7b49\u3002\u6b64\u5916\u793e\u5340\u65c1\u4ea6\u6709\u6210\u529f(\u50b3\u7d71)\u5e02\u5834\uff0c\u8cfc\u7269\u4e0d\u5fc5\u9060\u6c42\uff0c\u751f\u6d3b\u6a5f\u80fd\u8c50\u5bcc\u591a\u6a23\u3002 \u5546\u5708\u5167\u5efa\u5b89\u570b\u5c0f\u3001\u5927\u5b89\u570b\u4e2d\u70ba\u660e\u661f\u5b78\u5340\u5438\u5f15\u8a31\u591a\u5bb6\u9577\u9077\u5165\u8a72\u5b78\u5340\u5c45\u4f4f\uff0c\u672c\u5340\u5df7\u5167\u4f4f\u5bb6\u74b0\u5883\u512a\u96c5\uff0c\u96d6\u591a\u70ba\u8001\u820a\u516c\u5bd3\u4f46\u50f9\u683c\u4ecd\u820a\u9817\u4f73\uff0c\u4fe1\u7dad\u5e02\u5834\u4f4f\u5bb6\u54c1\u8cea\u7a0d\u5dee\uff0c\u800c\u5b89\u548c\u8def\u4e00\u5e36\u7684\u4f4f\u5bb6\u540d\u5b85\u6797\u7acb\u683c\u8abf\u9817\u70ba\u9ad8\u7d1a\uff0c\u4f4f\u5b85\u884c\u60c5\u4ea6\u5c45\u9ad8\u4e0d\u4e0b\uff0c\u6b64\u5340\u57df\u8207\u4fe1\u7fa9\u8a08\u5283\u5340\u76f8\u9130\u751f\u6d3b\u6a5f\u80fd\u5b8c\u5584\uff0c\u5be6\u70ba\u4e00\u826f\u597d\u4e4b\u5c45\u5bb6\u74b0\u5883\u3002",
        "image": "https://res.sinyi.com.tw/store/R621/photo/R621.JPG",
        "map_image": "https://res.sinyi.com.tw/store/R621/map/R621_MAP.JPG",
        "location": {
            "city_id": "1",
            "city": "\u53f0\u5317\u5e02",
            "zip_code": "106",
            "district": "\u5927\u5b89\u5340",
            "latitude": 25.028214308282,
            "longitude": 121.54473585745
        },
        "manager": {
            "id": "265890",
            "name": "\u6797\u4f69\u73b2",
            "title": null,
            "photo": "https://res.sinyi.com.tw/sale/265890/photo/265890.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"
        },
        "awards": [
            {
                "title": "\u5e97\u4e3b\u7ba1\u5148\u92d2\u734e",
                "month": "2024-10"
            },
            {
                "title": "\u5e97\u4e3b\u7ba1\u5148\u92d2\u734e",
                "month": "2024-08"
            }
        ],
        "news": [
            {
                "title": "\u6771\u5340\u90fd\u66f4\u6539\u5efa\u65b0\u7d00\u5143 \u591a\u6848\u623f\u50f9\u7ad9\u4e0a\u5169\u767e\u842c\u5143",
                "summary": "\u6839\u64da\u6700\u65b0\u5be6\u50f9\u63ed\u9732\u8cc7\u6599\u986f\u793a\uff0c\u53f0\u5317\u5e02\u6771\u5340\u90fd\u66f4\u6848\u53c8\u51fa\u73fe\u6bcf\u576a200\u842c\u4ff1\u6a02\u90e8\u7684\u65b0\u5b85\u793e\u5340\uff0c\u539f\u6771\u5340\u77e5\u540d\u7684\u300c\u5171\u548c\u5927\u5ec8\u300d\u793e\u5340\uff0c\u7d93\u90fd\u66f4\u6539\u5efa\u70ba\u300c\u8011\u5e8f\u300d\u8c6a\u5b85\u6848\u5f8c\uff0c\u5be6\u50f9\u6700\u65b0\u51fa\u73fe\u56db\u7b46\u9ad8\u6a13\u5c64\u6bcf\u576a210~219\u842c\u5143\u7684\u5be6\u50f9\u7d00\u9304\uff0c\u6771\u5340\u9084\u6709\u300c\u5143\u5927\u6822\u6085\u300d\u3001\u300c\u5bcc\u90a6\u85dd\u6a39\u300d\u7b49\u6848\uff0c\u518d\u52a0\u4e0a\u6b63\u7fa9\u570b\u5b85\u6539\u5efa\u7684\u53f0\u5317\u4e4b\u661f\u6848\uff0c\u6771\u5340\u7684\u5169\u767e\u842c\u90fd\u66f4\u8c6a\u5b85\u6848\u8d8a\u4f86\u8d8a\u666e\u904d\u3002",
                "date": "2022-08-03",
                "url": "https://www.sinyinews.com.tw/dailynews/newsct/10058"
            }
        ]
    },
    "meta": {
        "endpoint_family": "agency",
        "billable": true
    }
}

Errors

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

404

Not Found

Sinyi has no branch with that id. (`NOT_FOUND`). Non-billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "agency"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "Sinyi has no branch with that id."
    },
    "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": "agency"
    },
    "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.