Yardi API
Yardi is real estate software used by property managers, owners, and investment firms to run day-to-day operations and finance. With an unofficial API, you can read properties and unit inventory, lease and resident profiles, charges and receipts, maintenance requests, general ledger postings, and as
What is Yardi?
Yardi is a property and investment management platform serving residential, commercial, coworking/flex, and investment operations. It covers leasing, resident engagement, payments, maintenance, accounting/GL, energy optimization, and investor relations.
Core product families include:
- Yardi Voyager: End-to-end enterprise management system (flagship)
- Yardi Breeze: Small-to-mid portfolios (<1,000 units), $3/unit/month ($400 minimum)
- Yardi Breeze Premier: Mid-sized firms
- RENTCafé: Resident portal & engagement
- Yardi Kube: Coworking & flex space management
- Yardi Investment Suite: Investment lifecycle management
- Yardi Elevate: Asset performance & energy optimization
Common data entities:
- Properties, buildings, floorplans, and units
- Residents and prospects
- Leases, renewals, and move-in/move-out
- Charges, payments, receipts, credits, and balances
- Maintenance requests (service requests) and work orders
- Vendors, invoices, purchase orders, and payables
- GL accounts, batches, postings, and bank reconciliations
- Energy meters, consumption, and performance KPIs
- Investors, capital calls, contributions, and distributions
The Yardi Integration Challenge
Teams rely on Yardi daily, but turning portal-centric workflows and batch exports into automated pipelines is hard:
- Product entitlements and licensing: Access and features vary by Voyager, Breeze, Breeze Premier, RENTCafé, Kube, Investment Suite, and Elevate
- API availability and cost concerns: Public APIs can be limited or require paid interface modules and partner certification; many orgs fall back to SFTP/flat-file exports
- Portal-first experiences: Key capabilities (lease creation, work order routing, GL posting) live primarily in the web apps
- Enterprise controls: SSO, MFA, IP allowlists, and hosted environments complicate headless automation
- Accounting and posting semantics: Batch posting, GL periods, charge codes, and ledger adjustments need careful handling and normalization
- Data freshness and normalization: Nightly exports and custom reports often lead to stale or inconsistent schemas across portfolios
How Supergood Creates Yardi APIs
Supergood reverse-engineers authenticated browser flows and network interactions across Yardi products to deliver a resilient API endpoint layer for your operations.
- Handles username/password, SSO/OAuth, and MFA (SMS, email, TOTP) securely for Voyager and Breeze
- Maintains session continuity with automated refresh and change detection
- Normalizes responses across product lines (Voyager, Breeze, RENTCafé, Kube) so your systems integrate once
- Aligns with customer entitlements and licensing constraints to ensure compliant access; we do not bypass paid interfaces
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your Yardi product mix, licensing, and authentication model.
- Supergood Builds and Validates Your API
We deliver a hardened Yardi adapter tailored to your workflows and entitlements.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as Yardi evolves.
API Endpoints
Authentication
/auth/sessionsEstablish a session using credentials. Supergood manages MFA (SMS, email, TOTP) and SSO/OAuth when enabled. Returns a short-lived auth token maintained by the platform.
Authentication
/auth/sessions/refreshRefresh an existing token to keep sessions uninterrupted.
Properties
/propertiesList properties with basic profile and portfolio context.
Units
/unitsRetrieve unit inventory and availability for a property.
Leases
/leasesCreate or upsert a lease with resident details and rent schedule.
Use Cases
Unit Availability Sync
- Pull real-time property, unit status (vacant, occupied, on notice), market rent, and availability dates - Power websites, ILS feeds, and coworking booking engines with consistent inventory data - Reduce manual CSV uploads and nightly report dependencies
Resident Onboarding & Lease Creation
- Create or upsert resident profiles and generate lease terms from your CRM or onboarding flow - Set rent schedules, deposits, and move-in dates - Trigger portal invitations via RENTCafé
Payment Reconciliation & Delinquency Reporting
- Retrieve charges, receipts, adjustments, and current balances for leases - Flag delinquencies and feed BI dashboards or collections automations - Export ledger artifacts for audit trails and accounting systems
Maintenance Workflow Automation
- Ingest resident service requests and create work orders with categories, priorities, and vendor assignments - Sync status changes (open, scheduled, completed) to external ticketing tools - Streamline communications and reduce duplicate data entry
Technical Specifications
Authentication
Username/password with MFA (SMS, email, TOTP) and SSO/OAuth where enabled; supports service accounts or customer-managed credentials for hosted environments
Response format
JSON with consistent resource schemas and pagination across Voyager, Breeze, RENTCafé, and Kube data models
Rate limits
Tuned for portfolio-scale throughput while honoring licensing and usage controls
Session management
Automatic reauth and cookie/session rotation with health checks
Data freshness
Near real-time retrieval of units, leases, charges, and work orders; supports scheduled syncs for accounting artifacts
Security
Encrypted transport, scoped tokens, and audit logging; respects Yardi entitlements and interface licensing
Webhooks
Optional asynchronous delivery for ledger updates, work order state changes, and resident events
Latency
Sub-second responses for list/detail queries under normal load
Throughput
Designed for high-volume leasing, availability syncs, and payment reconciliation pipelines
Reliability
Retry logic, backoff, and idempotency keys minimize duplicate actions and handle batch posting semantics
Adaptation
Continuous monitoring for UI/API changes with rapid adapter updates
Frequently asked questions
Supergood supports workflows across Yardi Voyager, Yardi Breeze and Breeze Premier, RENTCafé, Yardi Kube, Yardi Investment Suite, and Yardi Elevate—subject to your licensing and entitlements. We scope coverage during integration assessment.
We support username/password + MFA (SMS, email, TOTP) and can operate behind SSO/OAuth when enabled. Sessions are refreshed automatically with secure challenge handling.
Yes. You can create or upsert leases, attach residents, configure rent schedules and deposits, and create work orders with categories, priorities, and vendor assignments. Status updates can be delivered via webhooks or polling endpoints.
We respect Yardi’s posting semantics. Charges and receipts are normalized with batch metadata, GL periods, and posting states so downstream systems can reconcile without parsing product-specific reports.
Many Yardi capabilities are gated by paid interface modules or partner programs. Supergood operates within your entitled access and does not bypass licensing. Where public APIs are limited, we stabilize portal-driven flows and reduce reliance on manual SFTP/CSV exports.