Skip to main content

How to Add a Partner API Key in IMPress for IDX Broker

Overview

Starting in version 2.6.7 of IMPress for IDX Broker, developer partners can add a partner API key to a client’s site.

When applied, all API requests will use both:

  • The client’s API key
  • The partner’s API key

This helps increase API limits and reduce the chance of hitting request caps.

Benefits

  • Increases available API calls
  • Helps prevent API limit errors
  • Improves performance for high-traffic sites

Requirements

  • Access to a partner account in IDX Broker
  • IMPress for IDX Broker plugin version 2.6.7 or higher
  • Access to the client’s WordPress admin

Setup Instructions

Step 1: Get Your Partner API Key

  1. Log into your IDX Broker partner account
  2. Navigate to:
    Home → Access Control
  3. Copy your Partner API Key

Step 2: Enable Partner Key Field in WordPress

  1. Log into the client’s WordPress admin
  2. Navigate to:
    IMPress → Initial Settings
  3. In your browser URL, append the following:
&idxdev
  1. Refresh the page

This will reveal a hidden field for the partner API key.

Step 3: Add the Partner API Key

  1. Paste your partner API key into the newly visible field
  2. Click Save API Key

API Limits

Standard API limits:

  • Platinum accounts: 500 API calls per hour
  • Lite accounts: 300 API calls per hour

With a partner API key applied:

  • The client’s hourly API limit is tripled

Troubleshooting

Partner key field not showing

  • Make sure &idxdev is added to the URL
  • Refresh the page after adding it

API limits still being hit

  • Confirm the partner API key was saved correctly
  • Verify plugin version is 2.6.7 or higher

Changes not taking effect

  • Clear site cache and/or CDN
  • Re-save IMPress settings

Additional Notes

  • This feature is intended for developer/agency partners
  • Useful for sites with high API usage (custom widgets, heavy traffic, etc.)
  • Does not replace the client’s API key—it works alongside it

🤖 Zendesk AI / Answer Bot Intents

Intent: Increase API limits

User might ask:

  • “How do I increase IDX API limits?”
  • “Why am I hitting API limits?”

Answer:
You can increase API limits by adding a partner API key in IMPress settings. This allows API calls to use both the client and partner keys, tripling the hourly limit.

Intent: Add partner API key

User might ask:

  • “Where do I add the partner API key?”

Answer:
Go to IMPress → Initial Settings in WordPress, add &idxdev to the URL, refresh, and paste your partner API key into the new field.

Intent: Partner key field missing

User might ask:

  • “Why don’t I see the partner API key field?”

Answer:
You need to manually enable it by adding &idxdev to the IMPress settings page URL and refreshing.

Intent: API limits explanation

User might ask:

  • “What are IDX API limits?”

Answer:
Lite accounts allow 300 calls/hour and Platinum allows 500 calls/hour. Adding a partner API key triples those limits.

Related articles

Powered by Zendesk