# Melo

Melo provides a comprehensive API for accessing real-time, deduplicated real estate listings and market analytics across France.

- **Category:** analytics
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 4
- **Triggers:** 0
- **Slug:** `MELO`
- **Version:** 20260223_00

## Tools

### Get Cities

**Slug:** `MELO_GET_CITIES`

Tool to retrieve a list of cities with optional filters. Use when you need to fetch available cities before processing location-specific data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for paginated results (must be ≥ 1). |
| `search` | string | No | Search keyword to filter cities. |
| `per_page` | integer | No | Number of results per page (1–100). |
| `country_code` | string | No | Filter by ISO 2-letter country code (e.g., 'FR'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Searches

**Slug:** `MELO_LIST_SEARCHES`

Retrieves all property searches saved by the authenticated user from the Melo API. Use this tool to: - View all saved property searches with their filtering criteria - Check notification settings for each search - Paginate through large lists of searches - Filter searches by title or notification status - Sort searches alphabetically by title Returns search details including location filters, budget ranges, property types, and notification configurations. The API uses Hydra collection format for pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (must be >= 1, defaults to 1) |
| `title` | string | No | Filter searches by title (case-sensitive string match) |
| `order_title` | string | No | Sort searches by title ('asc' for ascending, 'desc' for descending) |
| `notification_enabled` | boolean | No | Filter searches by notification status (true for enabled, false for disabled) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Simulate Webhook

**Slug:** `MELO_SIMULATE_WEBHOOK`

Simulates sending a Melo webhook event to a specified endpoint for testing webhook integrations. This tool triggers the Melo API to send a sample webhook payload (either a property match or event notification) to your specified HTTPS endpoint. Useful for testing webhook handlers before going live. The API will send realistic property data including advert details, contact information, and geographic data to your endpoint. Use this when you need to test how your webhook endpoint handles Melo notifications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `endpoint` | string | Yes | The target HTTPS URL where the simulated webhook event will be sent. Must use HTTPS protocol. |
| `event_type` | string | Yes | The type of webhook event to simulate. Valid options: 'ad.update.price' (price changes), 'ad.update.surface' (surface area changes), 'ad.update.pictures' (picture updates), 'ad.update.expired' (advert expiration), 'property.ad.create' (new property advert), 'property.ad.update' (property advert updates). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |