# ARIS

> ARIS is a 24/7 AI real estate assistant widget. Embed it on any website to search MLS listings, answer buyer questions, capture leads, and book showings — automatically.

## Docs

- [Get featured listings for a brokerage](https://docs.aris247.com/api-reference/get-featured-listings-for-a-brokerage.md): Returns the brokerage's featured/promoted listings from IDX Broker. These are the listings the agent has manually promoted in their IDX Broker dashboard. Supports pagination.
- [Get widget display configuration](https://docs.aris247.com/api-reference/get-widget-display-configuration.md): Returns the widget display and behavior settings for a brokerage. This is called by the embedded widget on page load to apply the brokerage's custom branding.
- [Search MLS property listings](https://docs.aris247.com/api-reference/search-mls-property-listings.md): Searches live MLS listings for a brokerage. Routes automatically to IDX Broker or the brokerage's custom database depending on their integration type.
- [Send a message and receive an AI response](https://docs.aris247.com/api-reference/send-a-message-and-receive-an-ai-response.md): Sends a conversation turn to the ARIS AI engine and streams back a response. The AI classifies the intent, invokes tools (property search, mortgage calculator, etc.) as needed, and returns a natural-language reply with any relevant listing data embedded in the stream.
- [POST /v1/chat](https://docs.aris247.com/docs/api/chat.md): Send a message to the ARIS AI engine and receive a streamed response.
- [GET /v1/config](https://docs.aris247.com/docs/api/config.md): Returns the widget display and behavior settings for your brokerage.
- [POST /v1/listings/featured](https://docs.aris247.com/docs/api/listings-featured.md): Returns the brokerage's featured/promoted listings from IDX Broker.
- [POST /v1/listings/search](https://docs.aris247.com/docs/api/listings-search.md): Search MLS property listings with structured filters and natural language.
- [API Overview](https://docs.aris247.com/docs/api/overview.md): Programmatic access to the ARIS AI engine, MLS listings, and widget configuration.
- [aris config](https://docs.aris247.com/docs/cli/config.md): View or update widget configuration from the CLI.
- [aris init](https://docs.aris247.com/docs/cli/init.md): Interactive setup wizard for adding ARIS to your project.
- [CLI Overview](https://docs.aris247.com/docs/cli/overview.md): Developer tools for setup, testing, and configuration from your terminal.
- [aris test](https://docs.aris247.com/docs/cli/test.md): Validate your API key and test connectivity to all ARIS endpoints.
- [aris whoami](https://docs.aris247.com/docs/cli/whoami.md): Display your account and connection information.
- [Widget Configuration](https://docs.aris247.com/docs/embedding/configuration.md): Customize ARIS widget colors, position, greeting, and branding.
- [HTML / Vanilla JS](https://docs.aris247.com/docs/embedding/html.md): Embed the ARIS widget on any website with a single script tag.
- [React / Next.js](https://docs.aris247.com/docs/embedding/react-nextjs.md): Embed the ARIS widget in a React or Next.js application.
- [WordPress](https://docs.aris247.com/docs/embedding/wordpress.md): Embed the ARIS widget on a WordPress site via plugin or manual code.
- [Authentication](https://docs.aris247.com/docs/getting-started/authentication.md): How to authenticate with the ARIS widget, REST API, MCP server, and CLI.
- [Plans & Pricing](https://docs.aris247.com/docs/getting-started/plans.md): ARIS pricing plans for agents, small teams, and large brokerages.
- [Quickstart](https://docs.aris247.com/docs/getting-started/quickstart.md): Get ARIS running on your website in under 5 minutes.
- [What is ARIS?](https://docs.aris247.com/docs/getting-started/what-is-aris.md): AI real estate assistant that embeds on any website to search MLS listings, answer buyer questions, capture leads, and book showings 24/7.
- [Custom Database](https://docs.aris247.com/docs/integrations/custom-database.md): Connect your own database to ARIS for listing search.
- [IDX Broker](https://docs.aris247.com/docs/integrations/idx-broker.md): Connect ARIS to IDX Broker for live MLS listing search.
- [MLS Grid](https://docs.aris247.com/docs/integrations/mls-grid.md): Import MLS Grid listing data into ARIS via CSV or API.
- [Claude Desktop](https://docs.aris247.com/docs/mcp/claude-desktop.md): Add ARIS MCP tools to Claude Desktop.
- [Cursor Setup](https://docs.aris247.com/docs/mcp/cursor.md): Configure ARIS MCP in Cursor for AI-powered real estate tools.
- [Hosted Endpoint](https://docs.aris247.com/docs/mcp/hosted.md): Connect to ARIS MCP over HTTP — no local install required.
- [MCP Overview](https://docs.aris247.com/docs/mcp/overview.md): Give AI agents direct access to ARIS real estate tools via the Model Context Protocol.
- [Compare Properties](https://docs.aris247.com/docs/tools/compare-properties.md): Provides a side-by-side comparison of multiple listings across key dimensions.
- [Mortgage Calculator](https://docs.aris247.com/docs/tools/mortgage-calculator.md): Estimates monthly mortgage payments based on property price, down payment, interest rate, and loan term.
- [Neighborhood Info](https://docs.aris247.com/docs/tools/neighborhood-info.md): Provides contextual information about a location — schools, walkability, transit, market trends, and lifestyle.
- [Tools Overview](https://docs.aris247.com/docs/tools/overview.md): All 6 AI tools that power ARIS.
- [Property Details](https://docs.aris247.com/docs/tools/property-details.md): Returns detailed information about specific listings, including photos, descriptions, and listing history.
- [Property Search](https://docs.aris247.com/docs/tools/property-search.md): Search MLS listings by location, price, bedrooms, and other criteria.
- [Schedule Viewing](https://docs.aris247.com/docs/tools/schedule-viewing.md): Captures a showing request from a potential buyer, including their contact information and preferred listing.

## OpenAPI Specs

- [openapi](https://docs.aris247.com/openapi.yaml)