REST API v1

API Reference

Build powerful integrations with the ScoutzOS API. Access deal analysis, investor matching, property management, and more.

Get API Key View Examples

Base URL:https://api.scoutzos.com/v1

Authentication

All API requests require authentication using an API key. Include your key in the Authorization header.

// Using API Key authentication
const response = await fetch('https://api.scoutzos.com/v1/deals', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

Security: Never expose your API key in client-side code. Always make API calls from your server.

Endpoints

Deals

Method	Endpoint	Description
GET	/deals	List all deals
POST	/deals	Create a new deal
GET	/deals/:id	Get deal details
PUT	/deals/:id	Update a deal
POST	/deals/:id/analyze	Run deal analysis

Investors

Method	Endpoint	Description
GET	/investors	List all investors
POST	/investors	Create an investor
GET	/investors/:id	Get investor details
GET	/investors/:id/matches	Get matched deals

Properties

Method	Endpoint	Description
GET	/properties	List all properties
POST	/properties	Add a property
GET	/properties/:id	Get property details
GET	/properties/:id/units	List property units

Leads

Method	Endpoint	Description
GET	/leads	List all leads
POST	/leads	Create a lead
PUT	/leads/:id/stage	Update lead stage
POST	/leads/:id/activity	Log activity

Example: Analyze a Deal

Run a complete underwriting analysis on a property.

// Analyze a property deal
const analysis = await fetch('https://api.scoutzos.com/v1/deals/analyze', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    address: '123 Main St, Austin, TX 78701',
    purchasePrice: 450000,
    downPayment: 112500,
    interestRate: 7.5,
    loanTerm: 30,
    estimatedRent: 3200,
    propertyType: 'single_family'
  })
});

const result = await analysis.json();
// Returns: { capRate, cashOnCash, noi, cashFlow, score, ... }

Webhooks

Subscribe to events and receive real-time notifications when things happen in ScoutzOS.

deal.created

deal.analyzed

investor.matched

lead.created

lease.signed

payment.received

// Webhook payload example
{
  "event": "deal.analyzed",
  "timestamp": "2025-12-01T12:00:00Z",
  "data": {
    "deal_id": "deal_123abc",
    "score": 78,
    "metrics": {
      "capRate": 6.2,
      "cashOnCash": 8.4,
      "noi": 27840
    }
  }
}

Rate Limits

Plan	Requests/minute	Requests/day
Starter	60	10,000
Growth	120	50,000
Pro	300	200,000
Enterprise	Custom	Unlimited

Need Help?

Our developer support team is here to help you integrate with ScoutzOS.

Contact Support Join Discord