# Nha Tot Project Suggest API Documentation

Find housing projects by name. Each project has the id, the oid, the name, the type, the address, the region, district and ward when known, the Nha Tot page url and the matched text. Use the oid as project_oid in /search to list the ads of one project. The answer also lists matching districts and streets when Nha Tot has them. A query without a match returns empty lists as a successful response.

- **Documentation:** [https://scrappa.co/docs/chotot-nha-api/chotot_nha_projects](https://scrappa.co/docs/chotot-nha-api/chotot_nha_projects)
- **API group:** Nha Tot API
- **Endpoint:** `GET https://scrappa.co/api/chotot-nha/v1/projects`

## 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 |
| --- | --- | --- | --- |
| `q` | string | Yes | Project name, 2 to 80 characters. Example: vinhomes. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/chotot-nha/v1/projects?q=vinhomes"
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A public parameter is missing, unknown or invalid. The response is not billable. |
| 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. |
| 503 | Upstream Unavailable | Nha Tot was temporarily unavailable or blocked the request. The response is not billable and the request never answers 429. |

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