Skip to content

API Reference

Complete method reference for the ReZEN Python API client. This section covers all available API endpoints, parameters, and return types.

🚀 API Overview

✅ All APIs Operational

All ReZEN API endpoints are fully operational with real-time data access.

📊 API Status Overview

API Section Status Endpoints Coverage
Transaction Builder ✅ Available 52+ endpoints Complete
Transactions ✅ Available 49+ endpoints Complete
Agents ✅ Available 36+ endpoints Complete
Teams ✅ Available 4 endpoints Complete
Users ✅ Available 3 endpoints Complete
Directory ✅ Available 16 endpoints Complete
Checklist ✅ Available 9 endpoints Complete
Documents ✅ Available 13 endpoints Complete

📋 Quick Reference

Core Components

Main Client

The RezenClient serves as the main entry point, providing access to all API modules through a unified interface.

Specialized Clients

  • Transaction Builder: Create and configure new transactions
  • Transactions: Manage live transactions and participants
  • Teams: Search and filter team information
  • Agents: Comprehensive agent search and network management
  • Users: Access user profiles and team/office membership
  • Directory: Standalone directory services
  • Checklist: Transaction checklists and item management
  • Documents: Document uploads and digital signatures

Common Patterns

from rezen import RezenClient

# Initialize client
client = RezenClient()

# Access specialized APIs
teams = client.teams.search_teams(status="ACTIVE")
agents = client.agents.search_active_agents(name="John")
checklist = client.checklist.get_checklist("checklist-123")

from rezen import RezenClient
from rezen.exceptions import RezenError, NotFoundError

try:
    client = RezenClient()
    transaction = client.transactions.get_transaction("tx-123")
except NotFoundError:
    print("Transaction not found")
except RezenError as e:
    print(f"API error: {e}")

from rezen import RezenClient
from rezen.enums import TeamStatus, SortDirection

client = RezenClient()

# Advanced team search with enums
teams = client.teams.search_teams(
    status=TeamStatus.ACTIVE,
    sort_direction=SortDirection.DESC,
    page_size=50
)

🔧 Client Setup

Getting Started

Before using any API methods, you need to set up authentication. See the Authentication Guide for setup instructions.

Quick Setup

from rezen import RezenClient

# Using environment variable (recommended)
client = RezenClient()

# Or with explicit API key
client = RezenClient(api_key="your_api_key_here")

📖 API Endpoints by Category

🏗️ Transaction Management

Build and manage real estate transactions:

👥 People & Organizations

Work with agents, teams, and contacts:

  • Teams - Search and manage team information
  • Agents - Agent search and network management
  • Users - User profiles and team/office membership
  • Directory - Contact and agent directory services

📄 Documents & Compliance

Handle documents and digital workflows:

  • Documents - Digital signatures and document management
  • Checklist - Transaction checklists and compliance tracking

🎯 Key Features

Type Safety

  • Full type hints for all methods and parameters
  • IDE autocompletion and error detection
  • Runtime type validation with Pydantic

Error Handling

  • Specific exception types for different error conditions
  • Rich error context with request/response details
  • Comprehensive error handling patterns

Developer Experience

  • Google-style docstrings with examples
  • Automatic retry logic for transient failures
  • Built-in rate limiting and pagination support

Additional Resources

🚀 Quick Start

New to the ReZEN API? Start here:

  1. Install the client - Get up and running
  2. Configure authentication - Set up your API key
  3. Try the quick start - Make your first API call
  4. Explore examples - See real-world use cases

🔍 Method Lookup

Looking for a specific method? Use the search function above or browse by category: