# Realty In Au MCP Server
English | [简体中文](./README.md) | [繁體中文](./README_ZH-TW.md)
An MCP server for accessing Realty In Au API.
## 🚀 Quick Start with EMCP Platform
**[EMCP](https://sit-emcp.kaleido.guru)** is a powerful MCP server management platform that allows you to quickly use various MCP servers without manual configuration!
### Quick Start:
1. 🌐 Visit **[EMCP Platform](https://sit-emcp.kaleido.guru)**
2. 📝 Register and login
3. 🎯 Go to **MCP Marketplace** to browse all available MCP servers
4. 🔍 Search or find this server (`bach-realty_in_au`)
5. 🎉 Click the **"Install MCP"** button
6. ✅ Done! You can now use it in your applications
### EMCP Platform Advantages:
- ✨ **Zero Configuration**: No need to manually edit config files
- 🎨 **Visual Management**: Easy-to-use GUI for managing all MCP servers
- 🔐 **Secure & Reliable**: Centralized API key and authentication management
- 🚀 **One-Click Install**: Rich selection of servers in MCP Marketplace
- 📊 **Usage Statistics**: Real-time service call monitoring
Visit **[EMCP Platform](https://sit-emcp.kaleido.guru)** now to start your MCP journey!
---
## Introduction
This is an MCP server for accessing the Realty In Au API.
- **PyPI Package**: `bach-realty_in_au`
- **Version**: 1.0.0
- **Transport Protocol**: stdio
## 安装
### 从 PyPI 安装:
```bash
pip install bach-realty_in_au
```
### 从源码安装:
```bash
pip install -e .
```
## 运行
### 方式 1: 使用 uvx（推荐，无需安装）
```bash
# 运行（uvx 会自动安装并运行）
uvx --from bach-realty_in_au bach_realty_in_au
# 或指定版本
uvx --from bach-realty_in_au@latest bach_realty_in_au
```
### 方式 2: 直接运行（开发模式）
```bash
python server.py
```
### 方式 3: 安装后作为命令运行
```bash
# 安装
pip install bach-realty_in_au
# 运行（命令名使用下划线）
bach_realty_in_au
```
## Configuration
### API Authentication
This API requires authentication. Please set environment variable:
```bash
export API_KEY="your_api_key_here"
```
### Environment Variables
| Variable | Description | Required |
|----------|-------------|----------|
| `API_KEY` | API Key | Yes |
| `PORT` | N/A | No |
| `HOST` | N/A | No |
### Using with Cursor
Edit Cursor MCP config file `~/.cursor/mcp.json`:
```json
{
"mcpServers": {
"bach-realty_in_au": {
"command": "uvx",
"args": ["--from", "bach-realty_in_au", "bach_realty_in_au"],
"env": {
"API_KEY": "your_api_key_here"
}
}
}
}
```
### Using with Claude Desktop
Edit Claude Desktop config file `claude_desktop_config.json`:
```json
{
"mcpServers": {
"bach-realty_in_au": {
"command": "uvx",
"args": ["--from", "bach-realty_in_au", "bach_realty_in_au"],
"env": {
"API_KEY": "your_api_key_here"
}
}
}
}
```
## 可用工具
此服务器提供以下工具:
### `agentsget_listings`
Get listings of an agent
**端点**: `GET /agents/get-listings`
**参数**:
- `page` (number): For paging purpose
- `channel` (string): One of the following : SOLD|BUY
- `linkedSalespeopleIds` (string) *必需*: The values of linkedSalespeopleIds returned in .../agents/list endpoint. Separated by comma to accept multiple IDs
- `pageSize` (number): The number of items returned per page, for paging purpose
---
### `agencyget_listings`
Get listings of an agency
**端点**: `GET /agency/get-listings`
**参数**:
- `page` (number): For paging purpose
- `channel` (string): One of the following : SOLD|BUY|RENT
- `agencyId` (string) *必需*: The value of agencyId returned in .../agency/list endpoint
- `timeframe` (string): One of the following : -12|-9|-6|-3 (Only function with channel as SOLD)
- `pageSize` (number): The number of items returned per page, for paging purpose
---
### `agentsdetail`
Get agent detailed information
**端点**: `GET /agents/detail`
**参数**:
- `id` (string) *必需*: The value of id field returned in .../agents/list endpoint
---
### `agencydetail`
Get agency detailed information
**端点**: `GET /agency/detail`
**参数**:
- `agencyId` (string) *必需*: The value of agencyId returned in .../agency/list endpoint
---
### `agentslist`
List agents with options and filters
**端点**: `GET /agents/list`
**参数**:
- `page` (number): For paging purpose
- `sortBy` (string): SUBURB_SALES_AND_PERFORMANCE|LEAD_PROPERTY_SALES|REVIEWS|MEDIAN_SALE_PRICE|MEDIAN_DAYS_ADVERTISED|YEARS_EXPERIENCE|TOTAL_SALES_ACROSS_ALL_SUBURBS
- `propertyType` (string): One of the following : ALL|HOUSE|UNIT_APARTMENT|LAND|TOWNHOUSE|RURAL|VILLA|ACREAGE|UNITBLOCK|RETIRE
- `suburbId` (string) *必需*: The value of 'atlasId' returned in .../auto-complete endpoint. Ex : 7d1625e0-a6fd-420c-b969-572b5dbb5248 type field must be \"suburb\"
- `timeframe` (string): One of the following : -3|-6|-12|-24
- `hasRatingsReviewsToggle` (string): true|false
- `hasRatingsReviewsDisplayToggle` (string): true|false
---
### `agencylist`
List agency with options and filters
**端点**: `GET /agency/list`
**参数**:
- `page` (number): For paging purpose
- `sort` (string): One of the following relevance|new-asc|new-desc|price-asc|price-desc|sold-relevance|sold-date-desc|sold-price-desc|sold-price-asc
- `channelType` (string): One of the following : BUY|RENT
- `locationType` (string): One of the following : OPERATING|SERVICING
- `suburb` (string) *必需*: The value of 'display/text' returned in .../auto-complete endpoint. Spaces must be replaced with '-', removed comma if present, and in lower cases. Ex : Caulfield South, VIC 3162 -> caulfield-vic-3162 type field must be 'suburb'
---
### `auto_complete`
Get suggestions by term or phrase. The returned data will be used with .../properties/list endpoint
**端点**: `GET /auto-complete`
**参数**:
- `query` (string) *必需*: Any term or phrase you are familiar with. It can be an address to get the property id directly to use with .../properties/detail endpoint.
---
### `schoolslist`
List schools around a GEO location
**端点**: `GET /schools/list`
**参数**:
- `lat` (number) *必需*: The latitude of GEO location
- `lon` (string) *必需*: The longitude of GEO location
---
### `propertieslookup_deprecated`
Look for off-market property by id * Use .../properties/v2/lookup endpoint instead for more data returned.
**端点**: `GET /properties/lookup`
**参数**:
- `id` (number) *必需*: The value of 'id' field returned in .../auto-complete endpoint with display as 'Property history'
---
### `propertiesv3lookup`
Look for off-market property by id
**端点**: `GET /properties/v3/lookup`
**参数**:
- `id` (number) *必需*: The value of 'id' field returned in .../auto-complete endpoint with display as 'Property history'
---
### `propertiesdetail`
Get detailed information of a property
**端点**: `GET /properties/detail`
**参数**:
- `id` (number) *必需*: The value of 'listingId' field returned in .../properties/list endpoint or 'id' field returned in .../auto-complete endpoint with type as listing
---
### `propertieslist`
List properties with options and filters
**端点**: `GET /properties/list`
**参数**:
- `page` (number): For paging purpose
- `pageSize` (number): The number of items returned per response. For paging purpose (max is 30)
- `sortType` (string): One of the following relevance|new-asc|new-desc|price-asc|price-desc|sold-relevance|sold-date-desc|sold-price-desc|sold-price-asc
- `channel` (string) *必需*: One of the following : buy|rent|sold
- `propertyTypes` (string): Ignore or one of the following : townhouse|unit apartment|retire|acreage|land|unitblock|house|villa|rural. Separated by comma for multiple options. Ex : townhouse,house,villa
- `surroundingSuburbs` (string): Example value:
- `searchLocation` (string) *必需*: The value of text field returned in .../auto-complete endpoint
- `searchLocationSubtext` (string) *必需*: The value of subtext field returned in .../auto-complete endpoint
- `type` (string) *必需*: The value of region field returned in .../auto-complete endpoint
- `minimumBedrooms` (number): Example value:
- `maximumBedrooms` (number): Example value:
- `minimumLandSize` (number): In m2
- `minimumBathroom` (number): Example value:
- `minimumCars` (number): Example value:
- `minimumPrice` (number): Example value:
- `maximumPrice` (number): Example value:
- `ex-under-contract` (string): Example value:
- `constructionStatus` (string): Ignore or one of the following : established|new
- `keywords` (string): Facilities you are looking for. Separated by comma for multiple options. Ex : pool,garage,etc...
- `maxSoldAge` (number): Houses sold in the last x months
---
### `propertiesv2lookup_deprecated`
Look for off-market property by id
**端点**: `GET /properties/v2/lookup`
**参数**:
- `id` (number) *必需*: The value of 'id' field returned in .../auto-complete endpoint with display as 'Property history'
---
## Tech Stack
- **Transport Protocol**: stdio
- **HTTP Client**: httpx
## License
MIT License - See [LICENSE](./LICENSE) file for details.
## Development
This server is generated by [API-to-MCP](https://github.com/BACH-AI-Tools/api-to-mcp) tool.
Version: 1.0.0
