EasyAgentIDX

Next.js Website Starter

Start with property search, listing pages, inquiry capture, and responsive layouts. Customize the design for your brokerage while EasyAgentIDX handles the approved MLS connection.

Download the starterMLS compliance checklist

Note

This is a website template, not the Starter subscription. Developer API access requires Pro or higher, an active subscription, a verified website, and an active MLS approval.

What is included

  • Server-rendered property search and listing detail pages
  • A bounded inquiry form with origin validation and Redis rate limiting
  • MLS attribution components and a display-rule checklist
  • Instructions for your developer or AI coding assistant
  • Loading, empty, unavailable, and removed-listing states

Set up your project

  1. Extract the download into a new project and install Node.js 24.
  2. Install dependencies, then copy .env.example to .env.local.
  3. Add your production domain under Settings and Sites in EasyAgentIDX.
  4. Copy the internal site ID from its verification tag into EASYAGENTIDX_VERIFICATION_ID.
  5. Deploy the template on that domain without API credentials. It renders the verification tag before property services are connected.
  6. Verify the website, complete MLS approval, and create a scoped key under Developer.
  7. Add the API key and its public site identifier to the server environment. Select platform:read, listings:read, and leads:write.
  8. Set the exact website origin and both Upstash Redis variables. Redeploy.
  9. Replace the brokerage branding and privacy template. Complete the included compliance checklist before launch.
npm install
cp .env.example .env.local
npm run dev
npm run test
npm run typecheck
npm run build

The local template runs on port 3002. API calls still resolve through the verified website bound to your key. Local development does not bypass MLS approval.

Keep credentials on the server

The template uses server-only API requests and no-store listing responses. Never place the API key in a public environment variable, client component, browser request, or AI prompt. The inquiry route allows only lead creation. It is not a public proxy for private platform resources.

Build beyond the template

Use the Platform Resources API for capabilities, widgets, analytics, HomeThread collections, Brokerage team profiles, and Agency Partner client summaries. Protect private experiences with your own application login and authorization.

Warning

The checklist assists development. It does not guarantee MLS approval. Your signed agreement and current board-specific display rules remain authoritative.
PreviousTeam Seats and RolesNextOverview