Read IDX Broker leads, agents, listings and MLS data; create and update leads and notes. Hosted by usefulapi — connect from Claude, ChatGPT, Cursor, or any MCP client.
Team and Enterprise: an Owner adds the connector for the organization first.
Run this command, then run /mcp in Claude Code to log in:
Add to Cursor or add this to ~/.cursor/mcp.json:
{
"mcpServers": {
"idx-broker": {
"url": "https://idx-broker.usefulapi.io/mcp"
}
}
}Add to VS Code or add this to .vscode/mcp.json:
{
"servers": {
"idx-broker": {
"type": "http",
"url": "https://idx-broker.usefulapi.io/mcp"
}
}
}No Add custom MCP server option? It depends on your account or workspace settings: see OpenAI's guide.
Run these commands. The second one opens the login page:
Other MCP clients (Windsurf, Cline, Zed and more): add the URL as a remote MCP server (Streamable HTTP). The client then opens the login page in your browser. Do not add an Authorization header: see Before you connect.
The login page asks for your IDX Broker access key.
Find it in IDX Broker under Home → Access Control (create a key if there is none). The key is 22 characters. Your account allows 300 (Lite) or 500 (Platinum) API accesses per key per hour, and every tool call uses at least one; a dedicated key keeps your other integrations from competing. Your key is used only to call the IDX Broker API on your behalf; it is never shown to anyone.
Add only the URL. Do not add an Authorization header or an API key to the client config. The server signs you in with OAuth: the login page asks for your IDX Broker access key. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.
Turn on the IDX Broker connector, then ask in plain words. The AI picks the tools.
| Tool | Type | What it does |
|---|---|---|
idx_get_account_info | read | Get account info The IDX Broker client account this access key belongs to: company and contact details and account settings (access keys and passwords are never returned). The reply also shows how many of the key's hourly API accesses are used. GET /clients/accountinfo. |
idx_get_account_type | read | Get account type The IDX Broker plan of the account (Lite or Platinum). It sets the hourly API limit: 300 accesses per key on Lite, 500 on Platinum. GET /clients/accounttype. |
idx_list_agents | read | List agents Agents on a multi-user IDX Broker account (id, name, office, contact details, category, language, login dates). Filter by one field or by a time window. GET /clients/agents. |
idx_list_offices | read | List offices Offices on a multi-user IDX Broker account. Filter by one field or by a time window. GET /clients/offices. |
idx_list_leads | read | List leads List the account's leads (website registrants) with contact details, status, agent owner, and last viewed listings and searches. A reply holds up to 500 leads; pass offset to page on and look for pagination information in the reply. Filter by a time window on signup, edit, login or activity date. Uses one of the key's hourly API accesses. GET /leads/lead. |
idx_get_lead | read | Get lead One lead by id with its details, last 5 viewed listings and searches, and the total number of listings viewed. GET /leads/lead/{leadID}. |
idx_list_lead_notes | read | List lead notes Notes on a lead, or one note when note_id is given. GET /leads/note/{leadID}[/{noteID}]. |
idx_list_lead_searches | read | List lead saved searches Saved property searches of a lead (or one search when search_id is given), with the results URL of each. GET /leads/search/{leadID}[/{searchID}]. |
idx_list_lead_saved_properties | read | List lead saved properties Properties a lead saved (or one when property_id is given). GET /leads/property/{leadID}[/{propertyID}]. |
idx_get_lead_traffic | read | Get lead traffic Website traffic history of one lead: date, page, referrer and IP of each visit (at most 5,000 rows per request; use interval/offset/limit to narrow it). GET /leads/leadtraffic/{leadID}. |
idx_list_featured_listings | read | List featured listings The account's featured (active) listings with address, price, status, photos and agent. Only the account's own listings are returned, never general MLS data. GET /clients/featured. |
idx_list_sold_pending_listings | read | List sold and pending listings The account's sold and pending listings, that is those removed from the MLS feed. GET /clients/soldpending. |
idx_list_off_market_listings | read | List off-market listings The account's off-market listings. GET /clients/offmarket. |
idx_list_supplemental_listings | read | List supplemental listings The account's supplemental (non-MLS) listings with a basic set of fields. GET /clients/supplemental. |
idx_list_saved_links | read | List saved links Saved links (pre-built property search pages) of the account with id, name and URL. GET /clients/savedlinks. |
idx_get_saved_link_count | read | Count properties of a saved link The total number of properties a saved link currently matches. GET /clients/savedlinks/{savedLinkID}/count. |
idx_list_widgets | read | List widgets The JavaScript widgets on the account with id, name, URL and options. GET /clients/widgets. |
idx_get_widget | read | Get widget One JavaScript widget with its settings. GET /clients/widgets/{id}. |
idx_list_system_links | read | List system links The system pages of the account's site (search, featured, contact...) with name, id and URL, which can be linked to directly. GET /clients/systemlinks. |
idx_list_approved_mls | read | List approved MLSs The MLSs approved for display on the account, with their IDX ids (such as a001) and names. Use the id in the other MLS tools. GET /mls/approvedmls. |
idx_get_mls_age | read | Get MLS data age When an MLS feed was last downloaded and processed and when its images were last gathered (UTC). GET /mls/age/{idxID}. |
idx_list_mls_property_types | read | List MLS property types Property types of an MLS with the IDX type id, the MLS name, the parent type and subtypes. GET /mls/propertytypes/{idxID}. |
idx_list_mls_search_fields | read | List MLS search fields The fields of an MLS that can be searched under MLS rules: field name, display name and the property types they belong to. GET /mls/searchfields/{idxID}. |
idx_list_mls_locations | read | List MLS cities, counties or postal codes Cities, counties or postal codes present in an MLS's data, with ids and a count of occurrences. Filter fields: cities = cityID, cityName, stateAbrv, mlsPtID; counties = countyID, countyName, stateAbrv, mlsPtID; postalcodes = id, stateAbrv, mlsPtID. GET /mls/{cities|counties|postalcodes}/{idxID}. |
idx_create_lead | write | Create lead WRITE: creates a new lead in the IDX Broker account (and may trigger the account's own lead notifications). Needs a correctly formatted email with a valid MX record; IDX rejects bad addresses with a server error. Extra fields go in `fields` by their IDX name, as seen on a lead returned by idx_get_lead. Returns the new lead id. PUT /leads/lead. |
idx_add_lead_note | write | Add lead note WRITE: adds a note to a lead (visible to the account's agents). Returns the new note id. PUT /leads/note/{leadID}. |
idx_update_lead | write | Update lead WRITE: changes fields of an existing lead; the given values replace the stored ones. Only pass what must change. Field names are the IDX lead field names as seen on a lead returned by idx_get_lead (for example firstName, lastName, email, phone, status). POST /leads/lead/{leadID}. |
idx_usage_status | Usage status (free-tier meter) Report the caller's current free-tier usage this month: calls used, monthly limit, remaining, and whether the cap is reached. Read-only; does not count against the meter. | |
idx_request_feature | Request a missing feature Tell usefulapi that the user needs something the IDX Broker tools cannot do yet (a missing tool, field or filter). Call it only when the user asks for something none of the tools can do, and tell the user that you send the request. Do not call it for errors or for normal requests. Do not include personal data, credentials or customer records. Stored with the product name and the client type (for example Claude or Cursor), without the user's account. At most 5 requests per day. Does not count against the meter. | |
idx_upgrade | Upgrade to Pro (unlimited) Subscribe to the Pro plan for UNLIMITED IDX Broker tool calls (the free tier caps monthly usage). Choose monthly ($9/month) or yearly ($90/year — 2 months free) billing. Returns a short link to open in your browser (it opens Stripe Checkout); after payment your account upgrades automatically. Does not count against the meter. | |
idx_cancel_subscription | Cancel the Pro subscription Cancel the caller's IDX Broker Pro subscription at the end of the paid period (no refund for the current period; unlimited calls continue until then, then the free tier applies). Requires confirm: true. Run idx_upgrade later to undo the cancel before the period ends. Does not count against the meter. |
| Plan | Price | Limit |
|---|---|---|
| Free | $0 | 50 tool calls / month |
| Proper account | $9/mo · $90/yr | Unlimited |
Pro covers this IDX Broker server only. Subscribe with idx_upgrade (it returns a Stripe Checkout link). Cancel any time with idx_cancel_subscription: Pro continues to the end of the paid period, with no refund for the current period, and running idx_upgrade before then undoes the cancel. Or write to [email protected].
No. usefulapi is an independent service. It is not affiliated with or endorsed by IDX Broker. The server calls the IDX Broker API with your own IDX Broker access, so it sees only the data that your account can see.
Yes. In Claude, add this server's URL as a custom connector. In ChatGPT, add it as a custom MCP server in Plugins. Then log in once. Cursor, VS Code, Claude Code and Codex work too. See the setup steps.
The login page asks for your IDX Broker access key. See Before you connect for where to find it.
No. Add only the URL. Do not add an Authorization header or an API key to the client config. The server signs you in with OAuth: the login page asks for your IDX Broker access key. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.
The login stores them encrypted in the authorization grant of your connection. The server uses them to call the IDX Broker API for you and to derive a private account id for usage metering. usefulapi does not show them on any page or in any reply. To stop all access, remove the connector and change or delete these credentials in IDX Broker.
Yes, if you approve it. 3 of the 27 IDX Broker tools can create or change data. The other 24 are marked read-only. Most MCP clients ask you to approve a tool call before it runs.
The Free plan gives 50 tool calls / month. Pro costs $9/mo or $90/yr, with unlimited tool calls, for this IDX Broker server only. Run idx_usage_status to see how many calls you used.
Ask the AI to run idx_upgrade: it returns a Stripe Checkout link. To cancel, run idx_cancel_subscription. Pro continues to the end of the paid period.
Tell the AI what you wanted to do. It can send the request with idx_request_feature. We store the text with the server name, the type of AI client and the tool you tried, not with your account, and read every request when we plan new tools. You can send up to 5 requests per day.
Any client that supports remote MCP servers (Streamable HTTP) with OAuth login: Claude (web and desktop), Claude Code, ChatGPT, Codex, Cursor, VS Code, Windsurf and others.
This is a Model Context Protocol endpoint — meant to be connected from an AI client, not opened in a browser. An invalid_token response at the URL is the auth gate working as designed; clients authenticate automatically.