Quick Start
Get your first API response in under 5 minutes. Choose your path:
CLI (Fastest)
One command to authenticate, instant access
API Key
Create a key in the dashboard, call the API directly
Start free, then choose whether to upgrade
You can use the API before paying. Create an account and authenticate, then discover fields and filters, count matching properties or people, and request supported cost estimates. These operations do not spend data credits.
Enrichment and returning records require paid access.
GET /v1/plans explains the free capabilities and public plans. Once connected, use GET /v1/account/plans for your workspace's current prices and benefits. GET /v1/usage shows your actual balance; an included allowance is not the same as the remaining balance.For ChatGPT or another MCP client, start with
dealmachine_signup, complete signup in your browser, and connect through OAuth. Keep passwords, API keys and payment details out of chat. The MCP guide covers the flow.For the CLI,
dm signup <email> --login creates and stores your key, or dm login connects an existing account. Run dm plans, then dm checkout --price-id <id> to review a plan. Add --yes only after the customer approves that recurring price, billing interval and quantity. Complete payment on Stripe, then check dm account --json and dm usage before retrying paid work.Option 1: DealMachine CLI
Step 1: Login
12npm install -g dealmachine dm login
Your browser opens. Sign in and approve the device. That's it.
Step 2: Check Your Account
1dm account
123456Account ---------------------------------------- Organization: My Company Org ID: 1 Created: Jan 1, 2024 Auth Type: api_key
Step 3: Use the API Key Programmatically
The CLI stores your API key at
~/.dealmachine/config.json. Use it in your code:123456789101112import { readFileSync } from 'fs'; import { join } from 'path'; import { homedir } from 'os'; const config = JSON.parse(readFileSync(join(homedir(), '.dealmachine', 'config.json'), 'utf-8')); const response = await fetch('https://api.v2.dealmachine.com/v1/account', { headers: { Authorization: `Bearer ${config.apiKey}` }, }); const { data } = await response.json(); console.log(data.organization.name);
Option 2: API Key
Step 1: Create an API Key
- Go to Developer Settings
- Click Create API Key
- Copy the key (starts with
dm_sk_live_)
Copy the key now. It won't be shown again.
Step 2: Make Your First Request
12curl https://api.v2.dealmachine.com/v1/account \ -H "Authorization: Bearer dm_sk_live_YOUR_KEY_HERE"
Step 3: See the Response
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" } } }
You're authenticated and ready to go.