idx-broker

What this skill does

# IDX Broker

IDX Broker provides real estate professionals with customizable IDX (Internet Data Exchange) solutions to display property listings on their websites. Real estate agents and brokers use it to attract and engage potential homebuyers with comprehensive property search tools.

Official docs: https://middleware.idxbroker.com/docs

## IDX Broker Overview

- **IDX Broker API**
  - **Endpoints**
    - **Featured Properties**
      - Get Featured Properties — Retrieves a list of featured properties.
    - **Supplemental Listings**
      - Get Supplemental Listings — Retrieves a list of supplemental listings.
    - **Hot Sheet**
      - Get Hot Sheet — Retrieves a hot sheet.
    - **Global Settings**
      - Get Global Settings — Retrieves global settings.
    - **Sub Type**
      - Get Sub Type — Retrieves a sub type.
    - **Property Details**
      - Get Property Details — Retrieves details of a specific property.
    - **Saved Link**
      - Get Saved Link — Retrieves a saved link.
    - **Seo City**
      - Get Seo City — Retrieves SEO city data.
    - **State**
      - Get State — Retrieves a state.
    - **Property**
      - Get Property — Retrieves a list of properties.
    - **Listing Company**
      - Get Listing Company — Retrieves a listing company.
    - **Agent**
      - Get Agent — Retrieves an agent.
    - **Office**
      - Get Office — Retrieves an office.
    - **Showcase Inventory**
      - Get Showcase Inventory — Retrieves showcase inventory.
    - **School**
      - Get School — Retrieves a school.
    - **County**
      - Get County — Retrieves a county.
    - **City**
      - Get City — Retrieves a city.
    - **Zipcode**
      - Get Zipcode — Retrieves a zipcode.
    - **Open House**
      - Get Open House — Retrieves a list of open houses.
    - **Bedrooms**
      - Get Bedrooms — Retrieves bedroom options.
    - **Bathrooms**
      - Get Bathrooms — Retrieves bathroom options.
    - **Property Types**
      - Get Property Types — Retrieves property types.
    - **Property Sub Types**
      - Get Property Sub Types — Retrieves property sub types.
    - **MLS Ids**
      - Get MLS Ids — Retrieves MLS IDs.
    - **Features**
      - Get Features — Retrieves property features.
    - **Listing Statuses**
      - Get Listing Statuses — Retrieves listing statuses.
    - **Virtual Tours**
      - Get Virtual Tours — Retrieves virtual tours.
    - **Waterfronts**
      - Get Waterfronts — Retrieves waterfront options.
    - **Views**
      - Get Views — Retrieves property views.
    - **Lots**
      - Get Lots — Retrieves lot options.
    - **Building Types**
      - Get Building Types — Retrieves building types.
    - **Garage Parking**
      - Get Garage Parking — Retrieves garage parking options.
    - **Stories**
      - Get Stories — Retrieves story options.
    - **Home Styles**
      - Get Home Styles — Retrieves home style options.
    - **New Construction**
      - Get New Construction — Retrieves new construction options.
    - **Age**
      - Get Age — Retrieves property age options.
    - **Year Built**
      - Get Year Built — Retrieves year built options.
    - **Remodeled Year**
      - Get Remodeled Year — Retrieves remodeled year options.
    - **Price Range**
      - Get Price Range — Retrieves price range options.
    - **Square Footage**
      - Get Square Footage — Retrieves square footage options.
    - **Acres**
      - Get Acres — Retrieves acreage options.
    - **Search Field**
      - Get Search Field — Retrieves search field options.

Use action names and parameters as needed.

## Working with IDX Broker

This skill uses the Membrane CLI to interact with IDX Broker. Membrane handles authentication and credentials refresh automatically — so you can focus on the integration logic rather than auth plumbing.

### Install the CLI

Install the Membrane CLI so you can run `membrane` from the terminal:

```bash
npm install -g @membranehq/cli@latest
```

### Authentication

```bash
membrane login --tenant --clientName=<agentType>
```

This will either open a browser for authentication or print an authorization URL to the console, depending on whether interactive mode is available.

**Headless environments:** The command will print an authorization URL. Ask the user to open it in a browser. When they see a code after completing login, finish with:

```bash
membrane login complete <code>
```

Add `--json` to any command for machine-readable JSON output.

**Agent Types** : claude, openclaw, codex, warp, windsurf, etc. Those will be used to adjust tooling to be used best with your harness

### Connecting to IDX Broker

Use `membrane connection ensure` to find or create a connection by app URL or domain:

```bash
membrane connection ensure "https://idxbroker.com/" --json
```
The user completes authentication in the browser. The output contains the new connection id.

This is the fastest way to get a connection. The URL is normalized to a domain and matched against known apps. If no app is found, one is created and a connector is built automatically.

If the returned connection has `state: "READY"`, skip to **Step 2**.

#### 1b. Wait for the connection to be ready

If the connection is in `BUILDING` state, poll until it's ready:

```bash
npx @membranehq/cli connection get <id> --wait --json
```

The `--wait` flag long-polls (up to `--timeout` seconds, default 30) until the state changes. Keep polling until `state` is no longer `BUILDING`.

The resulting state tells you what to do next:

- **`READY`** — connection is fully set up. Skip to **Step 2**.
- **`CLIENT_ACTION_REQUIRED`** — the user or agent needs to do something. The `clientAction` object describes the required action:
  - `clientAction.type` — the kind of action needed:
    - `"connect"` — user needs to authenticate (OAuth, API key, etc.). This covers initial authentication and re-authentication for disconnected connections.
    - `"provide-input"` — more information is needed (e.g. which app to connect to).
  - `clientAction.description` — human-readable explanation of what's needed.
  - `clientAction.uiUrl` (optional) — URL to a pre-built UI where the user can complete the action. Show this to the user when present.
  - `clientAction.agentInstructions` (optional) — instructions for the AI agent on how to proceed programmatically.

  After the user completes the action (e.g. authenticates in the browser), poll again with `membrane connection get <id> --json` to check if the state moved to `READY`.

- **`CONFIGURATION_ERROR`** or **`SETUP_FAILED`** — something went wrong. Check the `error` field for details.

### Searching for actions

Search using a natural language description of what you want to do:

```bash
membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json
```

You should always search for actions in the context of a specific connection.

Each result includes `id`, `name`, `description`, `inputSchema` (what parameters the action accepts), and `outputSchema` (what it returns).

## Popular actions

| Name | Key | Description |
|---|---|---|
| List Leads | list-leads | Retrieve a list of leads with optional filtering by date range |
| List Agents | list-agents | Get a list of all agents in the account |
| List Offices | list-offices | Get a list of all offices in the account |
| List Saved Links | list-saved-links | Get a list of all saved search links |
| List Lead Saved Searches | list-lead-saved-searches | Get all saved searches for a lead |
| List Lead Saved Properties | list-lead-saved-properties | Get all saved properties for a lead |
| Get Listing Details | get-listing-details | Get details for a specific listing |
| Get Lead | get-lead | Retrieve detailed information about a specific lead |
| Create Lead | create-lead | Create a new lead in IDX Broker |
| Create Lead Note | create-lead-note | Add a note to a lead |
| Update Lead | update-lead | Update an existing lead's information |
| Update Lead Note | upd