Skip to main content

​
DealMachine API

Access real estate data, manage properties, and automate workflows through the DealMachine API. Authenticate via API key or the DealMachine CLI and start building integrations. 
curl https://api.v2.dealmachine.com/v1/account \
  -H "Authorization: Bearer dm_sk_live_xxx"

​
Key Features

API Key Authentication

Secure API key authentication with SHA-256 hashed storage. No test keys needed.

DealMachine CLI

Command-line interface for quick access. Login with a single command.

OAuth 2.0

Full OAuth 2.0 authorization code flow for third-party integrations.

Device Auth Flow

RFC 8628 device authorization for CLI and MCP server login.

​
Quick Start

# Install and login
npx @dealmachine/cli login

# Check your account
dealmachine account

​
Using an API Key

curl https://api.v2.dealmachine.com/v1/account \
  -H "Authorization: Bearer dm_sk_live_xxx"

​
Base URL

https://api.v2.dealmachine.com/v1

​
Authentication

Include your API key in the Authorization header: 
Authorization: Bearer dm_sk_live_xxx
Get your API key from Developer Settings or by running dealmachine login.
API keys are scoped to your organization. Keep them secure and never expose them in client-side code.

​
Response Format

All responses are JSON. Successful responses wrap their payload in a data envelope: 
{
  "data": {
    "organization": {
      "id": 1,
      "name": "My Company",
      "createdAt": "2024-01-01T00:00:00.000Z"
    },
    "user": {
      "id": null,
      "authType": "api_key"
    },
    "plan": {
      "name": "Starter",
      "enrichment_credit_cap": 10000,
      "is_paid": true,
      "billing_cycle_start": "2024-01-01T00:00:00.000Z",
      "billing_cycle_end": "2024-02-01T00:00:00.000Z"
    }
  }
}
Error responses include a request ID for debugging: 
{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key",
    "request_id": "req_abc123def456"
  }
}

​
Next Steps

Authentication

Learn about API key formats and security best practices

Quick Start

Get up and running in 5 minutes

CLI Documentation

Install and use the DealMachine CLI

API Reference

Browse all available endpoints