🏢 Estate — Official Python SDK by Rylse

Estate is the official Python SDK for interacting with the Rylse Engine PropTech and Real Estate API.

Instead of processing heavy geospatial data or managing vast property registries locally, the estate package offloads computational logic and data filtering directly to the Rylse Edge Network (api.rylse.com).

⚡ Installation

Install the package directly from PyPI:

pip install estate

🔑 Authentication

To connect to the Rylse Edge Network, authenticate your client using a Rylse API key.

• Production Key: Your dedicated rylse_live_... token.
• Diagnostic Mode: Use rylse_test_ping for network handshake and latency testing without accessing private workloads.

🚀 Quick Start

Diagnostic Test

No production credentials are required for a basic connectivity test:

import estate

client = estate.Client(api_key="rylse_test_ping")

status = client.ping()

print(status)
# Output:
# {
#     'status': 'connected',
#     'mode': 'diagnostic',
#     'latency_ms': 18.4,
#     ...
# }

Production Workload

Use your production API key to access real estate workloads:

import estate

client = estate.Client(
    api_key="rylse_live_YOUR_TOKEN"
)

result = client.properties.search(
    city="Warsaw",
    radius_km=10
)

print(result)

📚 Documentation

For complete API documentation, error handling, pipeline configuration, and advanced usage, visit:

Rylse Documentation — docs.rylse.com

📄 License

This project is licensed under the MIT License.