canonical: https://jentic.com/apis/reso.org/reso

# RESO Web API

RESO Web API standard based on OData V4 for real estate data exchange. Provides access to property listings, agents, and real estate data following RESO Data Dictionary standards. The API exposes 7 endpoints secured with bearer authentication.

## For AI agents

Programmatically list properties, get property by listing key. Covers 7 operations with bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- List Properties
- Get Property by Listing Key
- Integrate RESO Web API into automated workflows
- Query and filter RESO Web API records by parameters
- Monitor RESO Web API operational status and events

## Use cases

### E-Commerce Operations

Use the RESO Web API to perform e commerce operations programmatically. The API provides 7 endpoints covering core functionality including list properties, get property by listing key, list members/agents.

Example prompt: Call GET /Property to list properties

### Automated Media Management

Automate media operations by combining multiple RESO Web API endpoints. Agents can get property by listing key and then list members/agents in a single workflow.

Example prompt: Call GET /Property('{listingKey}') to get property by listing key, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call RESO Web API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually.

Example prompt: Search Jentic for 'list properties', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/Property` | List Properties |
| GET | `/Property('{listingKey}')` | Get Property by Listing Key |
| GET | `/Member` | List Members/Agents |
| GET | `/Office` | List Offices |
| GET | `/Media` | List Media |
| GET | `/OpenHouse` | List Open Houses |
| GET | `/$metadata` | Get Service Metadata |

## Key resources

- **Media** — Operations related to Media
- **Member** — Operations related to Member
- **Metadata** — Operations related to Metadata
- **Office** — Operations related to Office
- **Open House** — Operations related to Open House

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 66 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 44 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/reso.org/reso/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the RESO Web API by hand means setting its bearer auth on every request, building OData query strings against the api.reso.org/odata host, and reading the $metadata document to shape entity calls yourself. Through Jentic you install once, import the RESO Web API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** The RESO Web API puts the listing key in the URL path (/Property('{listingKey}')), so a rule can pin your agent to reading a specific property. Every operation here is read-only, and you choose which of them the agent may call.
- **Credential handling:** Your RESO Web API token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list properties' or 'get a property by listing key', and Jentic returns the matching RESO Web API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the RESO Web API use?

The RESO Web API uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I list properties with the RESO Web API?

Yes. Use the GET /Property endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the RESO Web API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I list properties through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list properties'. Jentic returns the matching RESO Web API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the RESO Web API have?

The RESO Web API exposes 7 endpoints covering media, member, metadata operations.

### Can I limit what my agent is allowed to do with the RESO Web API?

Yes. Because you run Jentic One yourself, your own rules decide which RESO Web API operations and credentials the agent may use, and every operation here (GET /Property, /Member, /Office, /Media, /OpenHouse, and /$metadata) is read-only, so the agent can never modify listing data. Since the listing key sits in the URL path, GET /Property('{listingKey}'), you can pin the agent to reading one specific property. You choose which of these endpoints the agent is allowed to call and which are off limits.
