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.

12curl 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.

App APIs

Build against Driving and Mail app workflows from the Apps tab.

Device Auth Flow

RFC 8628 device authorization for CLI and MCP server login.

Quick Start

Using the CLI (Recommended)

123456# Install and login
npm install -g dealmachine
dm login

# Check your account
dm account

Using an API Key

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

Base URL

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

Authentication

Include your API key in the Authorization header:

1Authorization: Bearer dm_sk_live_xxx

Get your API key from Developer Settings or by running dm 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:

1234567891011121314151617181920{
  "data": {
    "organization": {
      "id": 1,
      "name": "My Company",
      "createdAt": "2024-01-01T00:00:00.000Z"
    },
    "user": {
      "id": null,
      "authType": "api_key"
    },
    "plan": {
      "name": "Basic",
      "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:

1234567{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key",
    "request_id": "req_abc123def456"
  }
}