{"openapi":"3.1.0","info":{"title":"SimplyRETS (BYOK) API","version":"0.1.0","description":"SimplyRETS (BYOK) lets an AI assistant read your own SimplyRETS data through the SimplyRETS API with a key you supply (SimplyRETS API key (use 'simplyrets' for the public demo data)). Read-only: 5 tools (search_listings, get_listing, get_market_statistics, search_open_houses, list_agents). The BYOK key travels with each request, is used for that one call only and is never stored, logged or...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-simplyrets.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-simplyrets/docs"},"termsOfService":"https://connectorbay.com/byok-simplyrets/terms"},"servers":[{"url":"https://byok-simplyrets.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-simplyrets/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/search_listings":{"post":{"operationId":"search_listings","summary":"Search MLS listings by keyword, status, type, price, beds, baths, area, city, state or postal code; returns price, addre","description":"Search MLS listings by keyword, status, type, price, beds, baths, area, city, state or postal code; returns price, address, size, status and days on market. Up to 500 per page. Use for \"Find active 3 bedroom houses in Houston under 400000\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"q":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Keyword search over MLS number, street, unit, city, postal code, subdivision and area. One value.","title":"Q"},"status":{"anyOf":[{"enum":["Active","Pending","Closed","ActiveUnderContract","Hold","Withdrawn","Expired","ComingSoon"],"type":"string"},{"type":"null"}],"default":null,"description":"Listing status; the API default is Active.","title":"Status"},"type":{"anyOf":[{"enum":["residential","rental","mobilehome","condominium","multifamily","commercial","commerciallease","land","farm"],"type":"string"},{"type":"null"}],"default":null,"description":"Property type; the API default is residential and rental.","title":"Type"},"minprice":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Minimum list price.","title":"Minprice"},"maxprice":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Maximum list price.","title":"Maxprice"},"minbeds":{"anyOf":[{"maximum":50,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Minimum bedrooms.","title":"Minbeds"},"maxbeds":{"anyOf":[{"maximum":50,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Maximum bedrooms.","title":"Maxbeds"},"minbaths":{"anyOf":[{"maximum":50,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Minimum bathrooms.","title":"Minbaths"},"minarea":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Minimum living area in square feet.","title":"Minarea"},"cities":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"City name (case-insensitive, one value).","title":"Cities"},"state":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"State or province (one value).","title":"State"},"postal_codes":{"anyOf":[{"maxLength":12,"type":"string"},{"type":"null"}],"default":null,"description":"Postal or ZIP code (one value).","title":"Postal Codes"},"vendor":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"MLS vendor id; required only on accounts with several MLS feeds.","title":"Vendor"},"sort":{"anyOf":[{"enum":["listprice","-listprice","listdate","-listdate","beds","-beds","baths","-baths"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort order; a leading minus means descending.","title":"Sort"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Listings per page (1 to 500, API default 20).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Listings to skip, for paging (increase by limit).","title":"Offset"}},"title":"search_listingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_listing":{"post":{"operationId":"get_listing","summary":"Get one MLS listing by its MLS id: price, address, bedrooms, bathrooms, living area, type, year built, status, days on m","description":"Get one MLS listing by its MLS id: price, address, bedrooms, bathrooms, living area, type, year built, status, days on market, agent and office. Use for \"Show listing 1005252\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"mls_id":{"description":"Numeric MLS id of the listing (the mlsId field of a search result).","minimum":1,"title":"Mls Id","type":"integer"},"vendor":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"MLS vendor id; needed only on multi-MLS accounts.","title":"Vendor"}},"required":["mls_id"],"title":"get_listingArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_market_statistics":{"post":{"operationId":"get_market_statistics","summary":"Get average price, living area, bedrooms, baths, lot size and year built plus listing count for all listings matching a ","description":"Get average price, living area, bedrooms, baths, lot size and year built plus listing count for all listings matching a search. Use for \"What is the average price of active condos in Austin\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"q":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Keyword search over MLS number, street, unit, city, postal code, subdivision and area. One value.","title":"Q"},"status":{"anyOf":[{"enum":["Active","Pending","Closed","ActiveUnderContract","Hold","Withdrawn","Expired","ComingSoon"],"type":"string"},{"type":"null"}],"default":null,"description":"Listing status; the API default is Active.","title":"Status"},"type":{"anyOf":[{"enum":["residential","rental","mobilehome","condominium","multifamily","commercial","commerciallease","land","farm"],"type":"string"},{"type":"null"}],"default":null,"description":"Property type; the API default is residential and rental.","title":"Type"},"minprice":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Minimum list price.","title":"Minprice"},"maxprice":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Maximum list price.","title":"Maxprice"},"minbeds":{"anyOf":[{"maximum":50,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Minimum bedrooms.","title":"Minbeds"},"maxbeds":{"anyOf":[{"maximum":50,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Maximum bedrooms.","title":"Maxbeds"},"minbaths":{"anyOf":[{"maximum":50,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Minimum bathrooms.","title":"Minbaths"},"minarea":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Minimum living area in square feet.","title":"Minarea"},"cities":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"City name (case-insensitive, one value).","title":"Cities"},"state":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"State or province (one value).","title":"State"},"postal_codes":{"anyOf":[{"maxLength":12,"type":"string"},{"type":"null"}],"default":null,"description":"Postal or ZIP code (one value).","title":"Postal Codes"},"vendor":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"MLS vendor id; required only on accounts with several MLS feeds.","title":"Vendor"}},"title":"get_market_statisticsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_open_houses":{"post":{"operationId":"search_open_houses","summary":"List scheduled open houses with start and end time, type and the listing's address, price and size. Up to 500 per page. ","description":"List scheduled open houses with start and end time, type and the listing's address, price and size. Up to 500 per page. Use for \"What open houses are coming up in Houston\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"enum":["residential","rental","mobilehome","condominium","multifamily","commercial","commerciallease","land","farm"],"type":"string"},{"type":"null"}],"default":null,"description":"Listing property type; the API default is residential.","title":"Type"},"cities":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"City name (one value).","title":"Cities"},"minprice":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Minimum list price of the listing.","title":"Minprice"},"maxprice":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Maximum list price of the listing.","title":"Maxprice"},"minbeds":{"anyOf":[{"maximum":50,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Minimum bedrooms of the listing.","title":"Minbeds"},"startdate":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only open houses at or after this date or time, for example 2026-11-01.","title":"Startdate"},"listing_id":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only open houses of this listing id.","title":"Listing Id"},"vendor":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"MLS vendor id (multi-MLS accounts).","title":"Vendor"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Open houses per page (1 to 500).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Open houses to skip, for paging.","title":"Offset"}},"title":"search_open_housesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_agents":{"post":{"operationId":"list_agents","summary":"List listing agents known to the account by name or state: id, first and last name and office MLS id; contact details ar","description":"List listing agents known to the account by name or state: id, first and last name and office MLS id; contact details are not returned. Use for \"Which agents named Smith are in Texas\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"First name, last name or both.","title":"Name"},"state":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Two-letter state or province of the agent's address.","title":"State"}},"title":"list_agentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}