Open To Close API Python Client¶

A modern, type-safe Python wrapper for the Open To Close API. Manage properties, agents, contacts, and more with a clean, intuitive interface.

# Before (complex)
property = client.properties.create_property({
    "team_member_id": 26392,
    "time_zone_id": 1,
    "fields": [{"id": 926565, "value": "My Property"}]
})

# After (simple) ✨
property = client.properties.create_property({
    "title": "My Property",
    "client_type": "Buyer", 
    "status": "Active"
})

🚀 Quick Start¶

🏗️ Core Features¶

Resource Management¶

• Properties: Complete property lifecycle management with CRUD operations
• Agents: Agent profiles, contact information, and team assignments
• Contacts: Customer and lead management with relationship tracking
• Teams: Team organization and user management

Property Sub-Resources¶

• Documents: File attachments and document management per property
• Emails: Email tracking and communication history
• Notes: Internal notes and annotations for properties
• Tasks: Task management and workflow automation
• Contacts: Property-specific contact relationships

Advanced Capabilities¶

• Type Safety: Full type hints and IDE support for better development experience
• Error Handling: Comprehensive exception handling with detailed error messages
• Rate Limiting: Built-in respect for API rate limits and automatic retries
• Lazy Loading: Efficient client initialization with on-demand service loading

📋 API Overview¶

from open_to_close import OpenToCloseAPI

# Initialize client
client = OpenToCloseAPI()

# Core resource operations
properties = client.properties.list_properties()
agents = client.agents.list_agents()
contacts = client.contacts.list_contacts()
teams = client.teams.list_teams()
users = client.users.list_users()
tags = client.tags.list_tags()

# Property-specific operations
property_id = 123

# Manage property documents
documents = client.property_documents.list_property_documents(property_id)

# Track emails and communication
emails = client.property_emails.list_property_emails(property_id)

# Handle notes and tasks
notes = client.property_notes.list_property_notes(property_id)
tasks = client.property_tasks.list_property_tasks(property_id)

# Manage property contacts
contacts = client.property_contacts.list_property_contacts(property_id)

from open_to_close import OpenToCloseAPI
from open_to_close.exceptions import NotFoundError, ValidationError

client = OpenToCloseAPI()

try:
    property_data = client.properties.retrieve_property(123)
except NotFoundError:
    print("Property not found")
except ValidationError as e:
    print(f"Invalid request: {e}")

🎯 Key Benefits¶

📚 Documentation Sections¶

Getting Started¶

Perfect for new users and initial setup:

• Installation Guide - Set up the client library
• Authentication Setup - Configure API access
• Quick Start Tutorial - Your first API calls

API Reference¶

Complete technical documentation:

• API Overview - Core resources and endpoints
• Properties - Property management operations

Guides & Examples¶

Practical usage and best practices:

• Guides Overview - Usage patterns and examples

🔍 Quick Access¶

from open_to_close import OpenToCloseAPI

# Initialize with automatic API key detection
client = OpenToCloseAPI()

# Create a new property
property_data = client.properties.create_property({
    "address": "123 Main St",
    "city": "New York",
    "state": "NY",
    "zip_code": "10001"
})

# Add a note to the property
note = client.property_notes.create_property_note(
    property_data["id"],
    {"content": "Initial property intake completed"}
)

print(f"Created property {property_data['id']} with note {note['id']}")

🚀 Next Steps¶

New to the Open To Close API? Start here:

1. Install the client - Get up and running in minutes
2. Configure authentication - Set up your API key
3. Try the quick start - Make your first API call
4. Explore guides - See usage patterns and examples

Already familiar with the basics? Jump to:

• API Reference - Complete method documentation
• Properties API - Property management operations
• Guides - Usage patterns and examples

Open To Close API Python Client - Built for modern Python development