Skip to content
Scrappa Get API key
Nha Tot API 1 credit/request

Nha Tot Property Search API Documentation

GET https://scrappa.co/api/chotot-nha/v1/search?for=rent&category=apartment&region_id=13000&min_price=5000000&max_price=15000000&bedrooms=2&sort=price_asc

Search Nha Tot (Cho Tot) listings for sale or rent in Vietnam: apartments, houses, commercial space, land and rooms. Filter by region, district and ward, price in VND, area in square metres, bedrooms, bathrooms, direction, legal document, apartment type and keyword, sort and page through the results. Each item is grouped: price with label and price per square metre, size, rooms, details, location with coordinates, project, photos and videos, seller with rating, and times as ISO dates. A page holds 20 listings by default and up to 50 with per_page. The page you ask for is the page you get, and every returned item satisfies your filters. Nha Tot serves only the first 10000 results of a search, so total stops at 10000 and page times per_page may not pass 10000: narrow the filters for deeper results. bedrooms and bathrooms match the exact number. Pass account_id (the numeric seller id from a search item) to list one seller. Pass project_oid (from /projects) to list one project. Sort supports newest and price_asc only. Use /regions, /wards and /autocomplete to find location ids. Phone numbers are never returned.

Nha Tot Property Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/chotot-nha/v1/search?for=rent&category=apartment&region_id=13000&min_price=5000000&max_price=15000000&bedrooms=2&sort=price_asc
Auth header
x-api-key
Cost
1 credit/request
for = rent
Response preview
200 OK
Example JSON appears below when a response schema is available for this 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.

19 optional filters available.

for string Required

sale or rent.

Example value rent
category string Optional

all (default), apartment, house, commercial, land or room. Room exists only for rent.

Example value apartment
region_id integer Optional

Region id from /regions. Example: 13000 for Tp Ho Chi Minh.

Example value 13000
district_id integer Optional

District id from /regions. Example: 13107 for Quan 12.

Example value 1234567890
ward_id integer Optional

Ward id from /wards. Example: 9232.

Example value 1234567890
min_price integer Optional

Lowest price in VND. For rent this is the monthly rent.

Example value 5000000
max_price integer Optional

Highest price in VND.

Example value 15000000
min_area integer Optional

Smallest area in square metres.

Example value 10
max_area integer Optional

Largest area in square metres.

Example value 10
bedrooms integer Optional

Exact number of bedrooms.

Example value 2
bathrooms integer Optional

Exact number of bathrooms.

Example value 10
direction string Optional

Main door direction: east, west, south, north, northeast, southeast, northwest or southwest.

Example value example
apartment_type string Optional

commercial, serviced_mini, duplex, penthouse, collective, officetel or social_housing.

Example value example
keyword string Optional

Free text matched against title and description, 2 to 100 characters.

Example value running shoes
account_id integer Optional

Numeric seller id (seller.account_id of an item). Lists only that seller. Use the for and category of the seller ads.

Example value 1234567890
project_oid string Optional

Project oid from /projects. Lists only ads of that project.

Example value example
sort string Optional

newest (default) or price_asc.

Example value price_asc
page integer Optional

One-based page number. Defaults to 1. page times per_page may not pass 10000.

Example value 1
per_page integer Optional

Listings per page, 1 to 50. Defaults to 20.

Example value 10

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/chotot-nha/v1/search?for=rent&category=apartment&region_id=13000&min_price=5000000&max_price=15000000&bedrooms=2&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/chotot-nha/v1/search?for=rent&category=apartment&region_id=13000&min_price=5000000&max_price=15000000&bedrooms=2&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/chotot-nha/v1/search?for=rent&category=apartment&region_id=13000&min_price=5000000&max_price=15000000&bedrooms=2&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/chotot-nha/v1/search?for=rent&category=apartment&region_id=13000&min_price=5000000&max_price=15000000&bedrooms=2&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/chotot-nha/v1/search?for=rent&category=apartment&region_id=13000&min_price=5000000&max_price=15000000&bedrooms=2&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/chotot-nha/v1/search?for=rent&category=apartment&region_id=13000&min_price=5000000&max_price=15000000&bedrooms=2&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/chotot-nha/v1/search?for=rent&category=apartment&region_id=13000&min_price=5000000&max_price=15000000&bedrooms=2&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/chotot-nha/v1/search?for=rent&category=apartment&region_id=13000&min_price=5000000&max_price=15000000&bedrooms=2&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/chotot-nha/v1/search?for=rent&category=apartment&region_id=13000&min_price=5000000&max_price=15000000&bedrooms=2&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/chotot-nha/v1/search?for=rent&category=apartment&region_id=13000&min_price=5000000&max_price=15000000&bedrooms=2&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/chotot-nha/v1/search?for=rent&category=apartment&region_id=13000&min_price=5000000&max_price=15000000&bedrooms=2&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/chotot-nha/v1/search?for=rent&category=apartment&region_id=13000&min_price=5000000&max_price=15000000&bedrooms=2&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/chotot-nha/v1/search?for=rent&category=apartment&region_id=13000&min_price=5000000&max_price=15000000&bedrooms=2&sort=price_asc")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Errors

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

422

Validation Error

A public parameter is missing, unknown or invalid. The response is not billable.

{
    "errors": {
        "for": [
            "The for field is required."
        ]
    },
    "message": "The request validation failed"
}
503

Unexpected Upstream Response

Nha Tot answered with a body that is not the documented shape or a result that breaks a requested filter. The response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "PARSER_DRIFT",
        "message": "The Nha Tot API is temporarily unavailable. Please retry."
    },
    "success": false
}
503

Upstream Unavailable

Nha Tot was temporarily unavailable or blocked the request. The response is not billable and the request never answers 429.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The Nha Tot API 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.