# Jirani

> Jirani is a Nairobi residential building and rental intelligence platform.

Jirani helps renters and AI agents reason about Nairobi homes by combining public
building profiles, rent signals, exact locations, and commute scoring.

## Agent Tools

- [Public Agent API](https://api.getjirani.com/api/public/v1/health): Health check for Jirani's public agent tools.
- [Search Homes (GET)](https://api.getjirani.com/api/public/v1/search?area=Nairobi&limit=5): Search public Jirani buildings by area, bedrooms, and price via a plain GET URL — usable by chatbots with web browsing.
- [Recommend Homes (GET)](https://api.getjirani.com/api/public/v1/recommend?destination=Westlands&limit=5): Rank public Jirani buildings by commute destination via a plain GET URL.
- [Recommend Homes (POST)](https://api.getjirani.com/api/public/v1/recommend-homes): Rank public Jirani building knowledge cards by area and commute destination (POST body).
- [Resolve Place](https://api.getjirani.com/api/public/v1/resolve-place): Resolve common Nairobi places into coordinates.
- [Commute Score](https://api.getjirani.com/api/public/v1/commute-score): Calculate Jirani distance-weighted commute scores.
- [OpenAPI JSON](https://api.getjirani.com/openapi.json): Machine-readable API schema.
- [Human Docs](https://getjirani.com/agents): Agent API documentation and examples.
- [Building Sitemap](https://getjirani.com/sitemap-buildings.xml): Public building profile URLs.

## GET Endpoint Quick Reference

Search buildings:
  https://api.getjirani.com/api/public/v1/search?area=Juja&limit=10
  https://api.getjirani.com/api/public/v1/search?area=South+B&bedrooms=2&max_price=60000

Rank by commute:
  https://api.getjirani.com/api/public/v1/recommend?destination=Juja&limit=10
  https://api.getjirani.com/api/public/v1/recommend?destination=Upper+Hill&area=Kilimani&bedrooms=2

## Auth And Use

- Public agent endpoints do not require an API key.
- Agents should cache stable place and building responses where reasonable.
- Avoid high-volume crawling of public endpoints without coordination.

## Important Semantics

- `wiki_building` results are knowledge-base records, not guaranteed live vacancies.
- `live_listing` results are currently available only when `availability` is `available_now`.
- `summary.status=no_public_inventory` means Jirani lacks exact public coverage for that query. It does not mean the area has no rentals.
- `fallback_results` are known buildings from other covered areas ranked by commute, not exact-area matches.
- Commute scores use Jirani distance-weighted commute math.
- Agents should preserve availability and rent-confidence labels when answering users.