UltraReach.ai

API Reference

UltraReach.ai provides a comprehensive RESTful API that allows you to integrate our AI-powered features into your existing systems. This guide covers the basics of our API and provides examples for common use cases.

Authentication

All API requests require authentication using an API key. You can generate API keys in your dashboard under Settings → API Keys.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.ultrareach.ai/v1/properties

Base URL

All API requests should be made to:

https://api.ultrareach.ai/v1/

Properties API

List Properties

Retrieve a list of properties with optional filtering.

GET /properties
GET /properties?type=residential&min_price=500000

Create Property

Add a new property to the system.

POST /properties
{ "type": "residential", "price": 750000, "bedrooms": 3, "bathrooms": 2, "location": { "address": "123 Main St", "city": "San Francisco", "state": "CA" } }

Leads API

Create Lead

Submit a new lead for AI qualification.

POST /leads
{ "name": "John Doe", "email": "john@example.com", "phone": "+1234567890", "preferences": { "property_type": "residential", "price_range": { "min": 500000, "max": 1000000 } } }

Get Lead Score

Retrieve AI-generated lead qualification score.

GET /leads/{lead_id}/score

Analytics API

Get Market Insights

Retrieve AI-powered market analysis for a specific area.

GET /analytics/market
GET /analytics/market?city=san_francisco&property_type=residential

Rate Limits

API requests are limited based on your subscription plan:

  • Basic: 1,000 requests per day
  • Professional: 10,000 requests per day
  • Enterprise: Custom limits

Error Handling

The API uses standard HTTP response codes:

  • 200: Success
  • 400: Bad Request
  • 401: Unauthorized
  • 403: Forbidden
  • 404: Not Found
  • 429: Too Many Requests
  • 500: Internal Server Error

Need Help?

For additional support with API integration: