# GalaxyIDX

> MLS/IDX listings and lead capture for real-estate websites, built to be installed by AI coding agents. Listing pages render server-side on the customer's own domain, the MLS display rules are enforced by the API, and every key is limited to one account. Install via a WordPress plugin, server-rendered routes (Next.js, Astro, any stack) or the remote MCP server.

Rules an agent must follow when installing:

- Keep the secret key (`sk_…`) on the server only, in an environment variable (`IDX_SECRET_KEY`). Never in client code, a public env var, or source control.
- Render listings server-side on the customer's domain. Never an iframe.
- Show the listing firm, MLS name/logo, last-updated date and disclaimer with every listing. Never crop or overlay photos (`object-fit: contain`).
- Never invent or estimate a listing fact; a missing value is shown as `—`.
- Objective search filters only (Fair Housing). No SMS consent on lead forms.
- The customer's broker must authorize the site with the MLS before listings appear; an agent cannot do that step.

## Docs

- [Overview](https://docs.galaxyidx.com/docs/index.md): what it is, the install paths, prerequisites, price
- [Quickstart: WordPress](https://docs.galaxyidx.com/docs/quickstart-wordpress.md): plugin install and checks
- [Quickstart: Next.js and Astro](https://docs.galaxyidx.com/docs/quickstart-nextjs-astro.md): server-rendered routes and env vars
- [Quickstart: any site](https://docs.galaxyidx.com/docs/quickstart-api.md): plain HTTP from any server stack
- [Authentication](https://docs.galaxyidx.com/docs/authentication.md): secret vs publishable keys, errors
- [Listings](https://docs.galaxyidx.com/docs/listings.md): search, detail, area stats, snapshot, field reference
- [Leads and notifications](https://docs.galaxyidx.com/docs/leads.md): lead capture, email/CRM/webhook routing, webhook signatures
- [MLS licensing and price](https://docs.galaxyidx.com/docs/mls-licensing.md): broker authorization, onboarding, $10/month per site + MLS fee at cost
- [Compliance](https://docs.galaxyidx.com/docs/compliance.md): the display rules and what the API enforces
- [SEO and AI search](https://docs.galaxyidx.com/docs/seo.md): one indexed page per listing, schema.org, sitemaps, area pages
- [MCP server](https://docs.galaxyidx.com/docs/mcp.md): connect an AI agent; tool list

## API

- [OpenAPI 3.1 spec](https://docs.galaxyidx.com/openapi.json): every endpoint, both key types, the error shape
- [Agent skill](https://docs.galaxyidx.com/skill/SKILL.md): step-by-step install skill for AI coding agents

## Optional

- [llms-full.txt](https://galaxyidx.com/llms-full.txt): all docs in one file