API overview
Rentametrix publishes one programmatic surface today: an MCP server over Streamable HTTP. Any MCP client, including the agent you write yourself, uses it. A public REST reference is coming; see REST below.
The MCP endpoint
Section titled “The MCP endpoint”- URL:
https://api.rentametrix.com/mcp - Transport: Streamable HTTP, stateless, POST only. GET and DELETE return 405.
- Authentication, two ways:
- Browser sign-in. Clients that support MCP sign-in (OAuth) open a browser and you sign in with your Rentametrix login. No key to handle. See Connect your AI tool. If sign-in is not available for your account yet, ask us for a key.
- An account key in
Authorization: Bearer <key>(also accepted inX-Api-Key). Keys startrmx_live_orrmx_test_followed by 32 hex characters. Use a key for agents and scripts that run without a browser.
- Every request is authenticated and scoped on its own. There is no session.
Four meta tools
Section titled “Four meta tools”Your client does not receive a catalog of hundreds of tools. It gets four, and finds the rest through them.
| Tool | Arguments | Returns |
|---|---|---|
search_tools | query (what you want to do), topK (default 5, max 10) | Exact contract references from the catalog your key may use, with a one-line description and when to use each. The result can be empty. |
describe_tool | contract: {id, version} | The input and output JSON schemas |
describe_bundle | taskFrame (goals, intents, measures, subject kinds) | Contracts that fit a task frame |
invoke_tool | contract: {id, version}, arguments | The tool’s result, validated against its schema |
A contract is written id@version, for example leasing.get_pacing_series_by_property@1. A contract never changes in place; a change ships as a new version and the old one returns a typed retired result naming its replacement.
search_tools matches capability queries (“list leases for a property”), not entity names. To turn a property name into an id, invoke context.resolve_authorized_resource@2; to list what the key may see, context.list_authorized_resources@2.
What an account key can reach
Section titled “What an account key can reach”26 tools today, in these groups: context (2), lease query (8), leasing renewals (2), market (4), position (3), property setup reads (3), rate tiers (1), concessions (1), residents (1), specials (1). The full list with descriptions is the table on Connect your AI tool.
All of them read or export. No key reaches a tool that writes, configures or administers. Resident identity tools need the ResidentRead capability on the key (resident data access).
A tool outside your key’s grants is absent from search_tools, not denied. Naming a property outside the grant returns not found.
Results
Section titled “Results”Every result is a structured envelope: outcome (Ok, Partial, Error), scope, the data, evidence and warnings. There is no single top-level as-of; each fact carries its own asOf, asOfBasis, observedAt, source (SystemOfRecord, PublicWeb, CustomerProvided, Manual, Derived), confidence and verification. A derived figure’s asOf is the oldest input that fed it.
A Partial outcome with a coverage warning means rows were withheld by the grant (for example unverified market observations). It is not “no data”.
Limits
Section titled “Limits”Per key, per minute and per day: test keys 10 and 1,000; live keys 60 and 10,000. Headers X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset are returned. Limits are counted per server replica. Meta tool calls are capped at two per agent turn.
Also available, documented on request
Section titled “Also available, documented on request”POST https://api.rentametrix.com/api/v1/chat/completions is an OpenAI-shaped streaming endpoint over the same runtime and the same checks. It takes an account key, requires stream: true, and answers as the Rentametrix assistant for the key’s account. Partner keys cannot use it.
A public REST reference is coming. Until it is published, the REST API behind the app (/api/v1/...) has no public contract and accepts app sign-in tokens only, so build on MCP. Older drafts of a REST reference that you may have seen describe routes that do not exist; ignore them.
Getting a key
Section titled “Getting a key”Keys are minted by Rentametrix on an account admin’s approval, scoped to named properties and named tools, with an optional expiry. The full key shows once. Write to support@rentametrix.com with the account, the properties and what the tool must do.