io.github.DealMachinePublished by GitHub account DealMachinev0.3.1Updated Nov 4, 2026
Find US property owners, including LLCs, plus owner phones and emails. Needs a DealMachine account.
The publisher's own server: SentientData Market Scan
DealMachine MCP server for researching US property owners, owner phones and emails, comparable sales, and prospecting lists from an AI assistant.
Web executable via Streamable HTTP. Remote servers run from the web runtime once configured in a workspace.
Paste this prompt into Claude Code, Codex, Cursor or another agent — or into SourceWeft chat. The agent reads this server's install guide, shows you its publisher, endpoint and sign-in, and adds it to your client once you agree. Keys never go into a command.
Read https://sourceweft.com/mcp/io.github.DealMachine%2Fdealmachine/install.md and connect the MCP server it describes to my client. Before changing any config, show me its publisher, endpoint and sign-in method and wait for my OK. Never put an API key in a command or in a file I would commit; ask me where it should come from.Add this to your client's mcpServers config.
{
"mcpServers": {
"dealmachine": {
"type": "http",
"url": "https://mcp.dealmachine.com/"
}
}
}Maintainers: agent instructions, development, current Command reference, and npm releases.
DealMachine CLI (dm) -- property intelligence from the command line.
A standalone Commander.js CLI that talks to the DealMachine REST API. Provides Commands for authentication, property and people research, enrichment, lists, prospects, tags, webhooks, mail and developer utilities. Compiles to ESM JavaScript via tsc.
This package has zero @dealmachine/* dependencies -- it is a self-contained binary that communicates exclusively through the public API.
This repository is also the public distribution package for the DealMachine MCP server and DealMachine skill.
https://mcp.dealmachine.comhttps://api.docs.dealmachine.comhttps://dealmachine.com/settings/developerhttps://dealmachine.com/privacy-policyhttps://dealmachine.com/terms-of-service[email protected]The MCP server supports OAuth 2.1 for ChatGPT, Claude, Cursor, Codex, and other compatible clients. It can also use a DealMachine API key in developer clients that support bearer-token configuration.
The plugin package includes:
server.jsonThe portable package follows Agent Plugins 1.0.0:
Compatible clients discover the DealMachine skill from skills/dealmachine/ and connect to the
hosted Streamable HTTP MCP server declared in mcp.json. Client-specific manifests remain in the
repository for compatibility, marketplace metadata, and richer presentation.
Example requests:
Direct skill installation:
agents, agents guide, agents playbook, agents install, agents permissionslogin, logout, whoamiconfig get, config set, config pathaccountusagesearch, count, get, ids, exportsearch, count, get, ids, exportaddress, latlng, apn, email, phone, namesearch, create, get, update, delete, build, import, items, add, remove, exportsearch, getautocomplete, validatelicense add, license list, license removeThe canonical implementation package is @dealmachine/cli. The dealmachine package is the short install alias and provides the same dm command.
The binary entry is dist/index.js, declared in package.json under bin.dm. Requires Node.js >= 18.
The CLI supports two authentication methods.
The default dm login command uses the OAuth 2.0 Device Authorization Grant (RFC 8628). This is the recommended flow for interactive use:
POST /v1/auth/device/code with client ID dealmachine-next-cli and your machine's hostname.--no-browser).POST /v1/auth/device/token at the server-specified interval.~/.dealmachine/config.json.The polling handles all RFC 8628 responses: authorization_pending, slow_down (backs off by 5s), access_denied, and expired_token.
For CI pipelines, scripts, or local development, pass an API key directly:
The key is verified against GET /v1/account before being stored. If verification fails, the CLI exits with a non-zero code.
If you do not have an API key yet, use dm signup <email> --login or dm login. Free accounts can count matches and estimate costs before paying. Public plan checkout only accepts self-serve Basic and Pro prices from the shared plan catalog and is capped at 60,000 monthly data credits.
If you are already logged in, you can switch the target API environment without logging out:
Removes the config file at ~/.dealmachine/config.json.
Credentials are stored at ~/.dealmachine/config.json with file permissions 0600 (owner read/write only). The config directory ~/.dealmachine/ is created with mode 0700.
The CLI checks these environment variables for API URL resolution (in priority order):
If none are set, the CLI falls back to the apiEnvironment field in the config file, then defaults to production.
dm agentsPrint concise guidance for agents using the CLI. This is the recommended first command when an agent has access to dm but has not loaded the DealMachine Playbook yet.
The guide tells agents to use --json and --quiet, verify auth, fetch live filters and fields before searches, count before credit-consuming work, and confirm expected credit usage before fetching records or exporting.
dm agents guidePrint the same concise agent guidance explicitly.
dm agents playbookPrint the bundled DealMachine Playbook Markdown. Agents should load this before translating natural language property, people, contact, enrichment, list, export, comps, or credit-usage requests into CLI commands.
The public CLI source keeps its bundled Playbook at playbook/PLAYBOOK.md. The build writes the selected source to dist/agents/dealmachine-playbook.md, so the command works from a published CLI package as well as a local source checkout.
dm agents install claude-codeInstall the Playbook as a native Claude Code skill. Personal scope is the default. Project scope installs under the current repository.
dm agents permissionsPrint the narrow Claude Code allowlist for free discovery and count commands. Paid and mutating commands are not pre-approved.
dm signupCreate a public API account and receive an API key. With --login, the credential is saved locally and omitted from output (including JSON); use this form from an agent:
dm plansList live self-serve plans, included credits, features and free API access. Connected customers receive their workspace prices:
dm checkoutPreview the recurring terms using a current price ID from dm plans. After the customer approves the exact price, billing interval and quantity, add --yes to create the Stripe checkout link:
Payment is completed on Stripe. Creating checkout does not activate a plan; check dm account --json and dm usage after payment before retrying enrichment. Counts do not award credits. Free operations still require authentication and obey permissions and rate limits.
dm loginAuthenticate with your DealMachine account.
dm logoutRemove stored credentials.
dm whoamiShow current authentication status.
dm config get [key]Get a configuration value, or display all values when no key is given.
Available keys: organizationName, organizationSlug, organizationId, apiEnvironment, keyId, apiKey.
dm config set <key> <value>Set a configuration value. Only apiEnvironment is editable.
dm config pathPrint the absolute path to the config file.
dm accountDisplay account information including organization name, ID, creation date, and auth type.
Output:
dm usageShow credit usage for the current billing cycle.
Output:
dm properties searchSearch properties with filters and locations.
dm properties countCount properties matching filters without consuming credits.
dm properties get <id>Get a single property by its DealMachine ID.
Property lookup defaults to owners. If you only need property data, use --contact-audience none. This omits contacts and avoids people credits.
dm properties ids [ids...]Get multiple properties by their IDs in a single batch request.
dm properties exportExport properties as CSV (up to 1,000,000 records). Returns signed download URLs.
dm people searchSearch people with filters and locations.
Non-interactive People Search returns a free estimate unless --yes is supplied. A specific person
by name uses dm enrich name, not People Search.
dm people countCount people matching filters without consuming credits.
dm people get <id>Get a single person by their DealMachine ID.
dm people ids [ids...]Get multiple people by their IDs in a single batch request.
dm people exportExport people as CSV (up to 1,000,000 records). Returns signed download URLs.
Contact filter options are the same as dm properties export.
All enrichment commands support three input modes: a positional argument for single-item lookup, --body/-f for JSON payloads, and -f with a .csv file for batch enrichment from CSV. Batches larger than 250 items are automatically chunked. Every enrichment command accepts --fields <csv> and sends the selected field IDs to the API. Email, phone, and name matches also include a free property_count; use --include-properties when you need the property records themselves.
dm enrich address [address]Look up a property by street address.
Use --contact-audience none whenever you only need the property. The response omits contacts and consumes zero people credits.
dm enrich latlng [coords]Look up a property by latitude/longitude coordinates.
dm enrich apn [apn]Look up a property by Assessor's Parcel Number. Narrow results with --state or --zip.
dm enrich email [email]Look up a person by email address.
dm enrich phone [phone]Look up a person by phone number.
dm enrich name [name]Look up people by name. Supports "First Last" or just "Last" format.
dm comps [property_ids...]Find comparable properties (sales comps) for one or more properties.
Output includes subject property details, value estimation with confidence interval, summary statistics (average/median price, price per sqft), and a table of comparable properties.
dm lists searchSearch and list all saved lists.
dm lists createCreate a new list.
dm lists get <id>Get details of a specific list including status, progress, and error state.
dm lists update <id>Rename a list.
dm lists delete <id>Delete a list and all its items.
dm lists build <id>Build a list from search filters. This is an asynchronous operation -- poll with dm lists get for status.
dm lists import <id>Import record IDs into an existing list.
dm lists items <id>List items in a list with pagination.
dm lists add <id>Add items to a list by ID.
dm lists remove <id>Remove items from a list by ID.
dm lists export <id>Export list items. Credits are charged per record.
dm filtersList available search filters with their types, operators, and groupings.
dm fieldsList available data fields with filterable/sortable flags.
Search and retrieve DealMachine locations.
dm locations autocomplete remains available as a deprecated alias for dm addresses autocomplete.
dm activity searchSearch past API activity with type filters and free-text search.
dm activity get <id>Get full details of a specific activity record, including the original request, result summary, and entity IDs (people and properties).
dm addresses autocomplete <query>Return free, bounded address and normalized location suggestions.
Autocomplete does not request fields, perform enrichment, or consume data credits.
dm addresses validate [address]Validate and standardize addresses via USPS.
Output shows each address as valid, corrected (with corrections listed), or invalid (with reason).
Local development utilities that operate directly against the Docker MySQL container (dealmachine-next-mysql). These require the local database to be running (npm run db:start from the repo root).
dm dev license add <key_id>Add a license to an API key in the local database.
dm dev license list [key_id]List all licenses, optionally filtered by key ID.
dm dev license remove <license_id>Remove a license by its numeric ID.
Every command supports these flags:
Commands that accept a request body support three input methods, checked in this order:
--body <json> -- Inline JSON string.-f, --file <path> -- Read from a JSON file. Enrichment commands also accept .csv files for batch processing.The enrich commands detect .csv files by extension and auto-parse them. Expected column names per command:
Batches larger than 250 items are automatically chunked with progress spinners. If an export limit is reached mid-batch, the CLI stops and returns results collected so far.
The published and deployed checks are release gates. They are expected to fail before a release is
published or the documentation deployment reaches production. The scenario catalog is stored in
evals/claude-code-name-lookup.json so the same prompt variants remain visible and reviewable.
npm test never calls an API. smoke:live:coverage builds the CLI and runs the real dm binary against
the API named by DM_API_URL, authenticated with DM_API_KEY. Both are required; the key is never
printed. Each Command runs with a temporary home directory, so the smoke never reads or changes
your own dm login credentials. It runs only read-only, credit-free Commands:
Requests pass through a local relay that refuses anything outside those read-only Endpoints
(property search must carry estimate_cost: true) and confirms each request sends
X-DealMachine-Source: cli and the CLI User-Agent. The smoke prints one PASS or FAIL line per
Command and exits 0 only when every Command passes.
The compiled dist/index.js includes a #!/usr/bin/env node shebang and is declared in package.json under bin.dm. When installed globally via npm, it becomes available as dm on the PATH.
For distribution as a standalone binary without npm:
The files array in package.json ensures only dist/ is included in the published package.
Create src/commands/mycommand.ts:
Import and wire up the command in src/index.ts:
src/commands/.--json for machine-readable output.ora for spinners during API calls.chalk for colored terminal output.apiRequest<T> from lib/client.ts for all API calls -- it handles auth, errors, and exits.parseRequestBody from lib/output.ts when the command accepts --body, -f, or stdin input.printHeader, printTable, printKeyValue, printCredits, printPagination for consistent output formatting..js extension (ESM requirement with NodeNext resolution).None. This package is a fully standalone binary with zero @dealmachine/* dependencies. It communicates exclusively through the public REST API.
The Playbook at packages/playbooks/playbook/ uses dm commands to execute property intelligence workflows. The CLI is the primary interface through which the Playbook interacts with DealMachine data. Agents can load the bundled Playbook directly with dm agents playbook.
The factory-release-intake.yml workflow is maintained on master and reads merged PRs from staging. It reports source and, where registered, the exact staging deployment to Factory Releases, reusing Linear links or creating one configurable pilot tracking issue. Scheduled reconciliation retries missed events without duplicate issues. It does not deploy this repository, run QA or approve production.
The collector is generated from Factory. See automatic staging intake for configuration, source ownership, regeneration and recovery. Staging remains the branch being checked even though the reporting workflow lives on master.
Source: README.md at commit a1fb258
Start a free DealMachine account
Start a free DealMachine account. Returns the secure browser signup URL. Ask the user to finish signup and connect DealMachine using OAuth. Never ask for passwords, payment details or API keys in chat. Signup does not purchase a plan.
Takes no parameters.
View plan and available credits
Read your active plan and remaining data credits. Free accounts can use this. After Stripe payment, check plan.is_paid and the current balance before retrying approved enrichment. A checkout URL or the user saying they paid is not proof of activation.
Takes no parameters.
Enrich Property by Address
Finds who owns a US property from its street address, given as full_address or as street, city, state and zip. Returns the property details; with contact_audience=owners it also returns the owners with their names, phones (with DNC flags) and emails. Contacts are left out unless contact_audience is set. Needs a connected DealMachine account with paid access. A matched property costs one property credit and returned contacts cost people credits; nothing is charged when no property matches.
zipcitystatefieldsstreetfull_addresscontact_audienceEnrich Property by Coordinates
Finds the property closest to a latitude and longitude, within 300 feet, and who owns it. Returns the property details; with contact_audience=owners it also returns the owners with their names, phones (with DNC flags) and emails. Contacts are left out unless contact_audience is set. Needs a connected DealMachine account with paid access. A matched property costs one property credit and returned contacts cost people credits; nothing is charged when no property matches.
fieldslatituderequiredlongituderequiredcontact_audienceEnrich Property by APN
Finds who owns a property from its Assessor's Parcel Number: one apn, or up to 250 in data sharing the same location and options. A location narrows the match, and APN formatting is normalized automatically. Returns the property details; with contact_audience=owners it also returns the owners with their names, phones (with DNC flags) and emails. Contacts are left out unless contact_audience is set. Needs a connected DealMachine account with paid access. Each matched property costs one property credit and returned contacts cost people credits.
apndatafieldslocationcontact_audienceEnrich Person by Email
Looks up a person by email address (email, required). Returns their name, contact information including phones and emails, and demographics; include_properties=true adds the properties associated with them. Needs a connected DealMachine account with paid access. Each matched person costs one people credit and each included property one property credit; nothing is charged when no one matches.
emailrequiredfieldslocationinclude_propertiesEnrich Person by Phone
Looks up a person by phone number (phone, required). Returns their name, contact information including phones and emails, and demographics; include_properties=true adds the properties associated with them. Needs a connected DealMachine account with paid access. Each matched person costs one people credit and each included property one property credit; nothing is charged when no one matches.
phonerequiredfieldslocationinclude_propertiesEnrich People by Name
Finds people by name: one last_name, optionally with first_name and middle_initial, or up to 250 names in data sharing location, pagination and options. A location narrows the match. Returns paginated people with contact information including phones and emails; include_properties=true adds the properties associated with them. `estimate_cost=true` returns people and associated-property counts without records or credit use. Needs a connected DealMachine account with paid access. Each returned person costs one people credit and associated properties cost property credits; batching reduces requests, not credits.
datapagefieldslocationper_pagelast_namefirst_nameestimate_costmiddle_initialinclude_propertiesList DealMachine Search Filters
Returns DealMachine search filters with filter IDs, source types, operators, and valid options. A `search` value performs a fuzzy concept match across labels, aliases, and option values; without it, the response includes all pages. This read-only request is free of data credit charges, but an uncached read counts toward the API request limit. Reuse these definitions for subsequent lookups; identical requests are cached for 15 minutes.
searchgroup_idsource_typeList DealMachine Data Fields
Returns available DealMachine data fields with field ID, source type, data type, and description. A `search` value performs a fuzzy match across field metadata; without it, the response includes all pages. This read-only request is free of data credit charges, but an uncached read counts toward the API request limit. Reuse these definitions for subsequent lookups; identical requests are cached for 15 minutes.
searchgroup_idsource_typeView DealMachine Credit Usage
Returns live credit usage for the current billing cycle, including the total cap, spendable balance, monthly and additional pools, and usage by entity type. This read-only request is free.
Takes no parameters.
Check DealMachine Authentication
Returns whether the current credential is valid, the active organization name, and the authentication type. This read-only request is free.
Takes no parameters.
Search Properties
Finds US properties matching locations (required) and filters from the filter list, such as is_corporate_owned for properties owned by a corporation, LLC or business. Returns the properties with their owner contacts (names, phones and emails) by default, or with anchor=people one result per contact. contact_audience selects whose contacts and `none` leaves them out; require_phone keeps contacts with a phone. `estimate_cost=true` returns a credit estimate without records or credit use. Needs a connected DealMachine account with paid access. Returned property data and contacts can consume credits.
pagesortanchorfieldsfiltersper_pagelocationsrequiredestimate_costrequire_phonecontact_audienceCount Matching Properties
Counts properties matching locations (required) and filters, such as is_corporate_owned for corporation, LLC or business owners, or with anchor=people their matching contacts. Use the same anchor, contact_audience and require_phone as the search. Needs a connected DealMachine account; counting consumes no credits.
anchorfilterslocationsrequiredrequire_phonecontact_audienceExport Property Owner Leads
Creates a downloadable CSV of properties or property-owner contacts matching locations and filters. Defaults to owner contact rows (`contact_audience=owners`, `anchor=person`) with names, phones, emails, and property addresses. `contact_audience=none` or `anchor=property` produces property rows without contacts. Exported records can consume credits.
limitanchorfieldsfilterslocationsrequiredscrub_dncmobile_onlylandline_onlyrequire_emailrequire_phonecontact_audienceactive_phones_onlyGet Property Details
Returns one property by DealMachine property ID (id, required), with its owners and their names, phones and emails by default. `contact_audience=none` returns property-only data. Needs a connected DealMachine account with paid access. Enriched data costs one property credit unless `enrich=false`; owner contacts cost people credits.
idrequiredenrichfieldscontact_audienceGet Multiple Properties
Returns up to 25 properties by DealMachine property ID (ids, required), with their owners and their names, phones and emails by default. `contact_audience=none` returns property-only data. Needs a connected DealMachine account with paid access. Owner contacts cost people credits; same-cycle repeats are free.
idsrequiredenrichcontact_audienceFind Comparable Properties
Find comparable sales + active listings for up to 25 subject properties. Costs 1 property data credit per subject found. Location/criteria optional (sensible defaults).
criterialocationproperty_idsrequiredSearch People
Returns people matching locations (required) and filters, with their names, phones, emails and primary address plus any requested fields. Filters use the people catalog; property filters return filter_source_mismatch. `estimate_cost=true` returns a credit estimate without records or credit use. Needs a connected DealMachine account with paid access. Returned records can consume credits.
pagesortfieldsfiltersper_pagelocationsrequiredestimate_costCount Matching People
Count matching people without consuming credits. Filters use the people catalog.
filterslocationsrequiredGet Person Details
Returns one person by DealMachine person ID (id, required), with their name, phones, emails, optional extended fields and associated properties. Needs a connected DealMachine account with paid access. The person costs one people credit; chargeable property fields or associated properties can consume property credits.
idrequiredfieldsproperty_limitinclude_propertiesGet Multiple People
Returns up to 250 people by DealMachine person ID (ids, required), with their names, phones, emails, optional extended fields and associated properties. Needs a connected DealMachine account with paid access. Each found person costs one people credit; chargeable property fields or associated properties can consume property credits.
idsrequiredfieldsproperty_limitinclude_propertiesSearch Locations
Returns location identifiers for a name query, including FIPS, ZIP, city place, state, and county IDs. This read-only request is free.
qrequiredpagetypestateper_pageDelete list
Delete list. Delete a list and all its items. This action cannot be undone. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredconfirmedRemove items from list
Remove items from list. Remove specific property or person IDs from a list. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodypathrequiredconfirmedDelete design
Delete design. Delete a design. Designs used in active campaigns cannot be deleted. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredconfirmedDelete return address
Delete return address. Delete a return address. The default return address cannot be deleted — set another as default first. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredconfirmedRemove prospect
Remove prospect. Archive the prospect and end its mail. Its notes, files, and activity are kept; it can be added again later. Pass `?cascade=false` to keep its list memberships and open opportunities. Mail always ends. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredqueryconfirmedDelete prospect file
Delete prospect file. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredconfirmedDelete prospect note
Delete prospect note. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredconfirmedDelete prospect photo
Delete prospect photo. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredconfirmedRemove tag from prospect
Remove tag from prospect. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredconfirmedDelete tag
Delete tag. Delete a workspace tag. Returns 409 while prospects still carry it unless `force=true`, which removes it from them first. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredqueryconfirmedDelete task
Delete task. Delete a task. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredconfirmedDelete webhook
Delete webhook. Removes the webhook and its delivery log. Nothing more is sent to the URL. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredconfirmedGet activity
Get activity. Retrieve the full details of a specific activity record, including the complete original request parameters and paginated entity IDs. Retrieves data without changing records or spending credits.
pathrequiredAutocomplete property addresses
Autocomplete property addresses. Return fast, bounded street-address suggestions from DealMachine property data. Every suggestion includes a DealMachine property ID and may include a normalized city or county location. Retrieves data without changing records or spending credits.
queryrequiredList drives
List drives. List recorded drives for the workspace. Each drive reports how many prospects were added. Retrieves data without changing records or spending credits.
queryGet drive
Get drive. Get a recorded drive with its route, events, visits, and links to prospects added during it. Retrieves data without changing records or spending credits.
pathrequiredList exports
List exports. List past exports for your organization with optional pagination and status filtering. Retrieves data without changing records or spending credits.
queryGet export by ID
Get export by ID. Retrieve a single export by its ID. Only exports belonging to your organization are accessible. Retrieves data without changing records or spending credits.
pathrequiredList all lists
List all lists. List all saved lists for your organization with pagination, search, filtering, and sorting. Retrieves data without changing records or spending credits.
queryGet list by ID
Get list by ID. Retrieve a list by its ID including build status, progress, and total count. Retrieves data without changing records or spending credits.
pathrequiredGet list items
Get list items. Retrieve paginated items in a list. Retrieves data without changing records or spending credits.
pathrequiredqueryGet location
Get location. Retrieve a specific location by its ID. Retrieves data without changing records or spending credits.
pathrequiredGet mail analytics summary
Get mail analytics summary. Get account-wide mail analytics: totals across all campaigns (sent, delivered, failed, opens, unique openers, average open rate) plus a paginated list of campaigns with per-campaign engagement. Retrieves data without changing records or spending credits.
queryGet mail analytics time series
Get mail analytics time series. Get an account-wide time series for a single metric — sent, delivered, scans (QR/link views), or open_rate — bucketed by day or week. Missing buckets are filled with zeroes so the series is continuous. For "scans", each point also includes secondary_value (total scans vs unique properties). Retrieves data without changing records or spending credits.
queryList campaigns
List campaigns. List mail campaigns for your organization with optional filtering. Each campaign has one of six statuses: draft, ready, active, paused, ended or archived. Use accepting_properties=true to list the campaigns properties can be added to now. Archived campaigns are excluded unless status=archived is supplied. Retrieves data without changing records or spending credits.
queryGet campaign
Get campaign. Get a single campaign by ID with steps. Retrieves data without changing records or spending credits.
pathrequiredCampaign analytics
Campaign analytics. Get delivery and engagement analytics for a campaign. Retrieves data without changing records or spending credits.
pathrequiredEstimate campaign cost
Estimate campaign cost. Get a cost estimate for launching a campaign, including wallet balance check. Retrieves data without changing records or spending credits.
pathrequiredEstimate adding properties
Estimate adding properties. What adding a number of properties to the campaign would cost: the charge due today, the amount charged later as later pieces go out, and whether your wallet or auto-reload covers it. Nothing is added or charged. The count is an upper bound; properties skipped when you add them are not charged. For a paused campaign the charge due today is 0 and charged_on_resume is true: each piece is charged as it goes out after the campaign resumes. Retrieves data without changing records or spending credits.
pathrequiredqueryrequiredList campaign recipients
List campaign recipients. List recipients enrolled in a campaign with their delivery status. Retrieves data without changing records or spending credits.
pathrequiredqueryList designs
List designs. List mail designs for your organization. Retrieves data without changing records or spending credits.
queryGet design
Get design. Get a single design by ID, including HTML content. Retrieves data without changing records or spending credits.
pathrequiredList return addresses
List return addresses. List all return addresses for your organization. Default address is listed first. Retrieves data without changing records or spending credits.
Takes no parameters.
Get return address
Get return address. Get a single return address by ID. Retrieves data without changing records or spending credits.
pathrequiredGet mail settings
Get mail settings. Get the organization-level mail settings that act as defaults for new campaigns — default postcard size, sender name, contact frequency limit, QR code URL, and signature image. Retrieves data without changing records or spending credits.
Takes no parameters.
Get wallet balance
Get wallet balance. Get the current wallet balance, including pending charges and auto-reload settings. Retrieves data without changing records or spending credits.
Takes no parameters.
Get mail pricing
Get mail pricing. Get postcard pricing for your plan. Prices are in cents per postcard. Retrieves data without changing records or spending credits.
Takes no parameters.
List wallet transactions
List wallet transactions. List wallet transaction history with optional filtering. Retrieves data without changing records or spending credits.
queryList prospect activity
List prospect activity. Everything that happened to the prospect’s record in this workspace, newest first: prospect changes, notes, tags, files, lists, mail, and CRM events. Retrieves data without changing records or spending credits.
pathrequiredqueryList prospect files
List prospect files. Retrieves data without changing records or spending credits.
pathrequiredDownload prospect file
Download prospect file. Redirects to a 5-minute signed URL. Pass `?redirect=false` to get the URL as JSON instead. Retrieves data without changing records or spending credits.
pathrequiredqueryList prospect notes
List prospect notes. Notes on the prospect, newest first. Retrieves data without changing records or spending credits.
pathrequiredqueryGet prospect note
Get prospect note. Retrieves data without changing records or spending credits.
pathrequiredList prospect photos
List prospect photos. Photos of the prospect’s property, newest first. Property prospects only. Retrieves data without changing records or spending credits.
pathrequiredList prospect tags
List prospect tags. The tag catalog with an `assigned` flag for this prospect. Retrieves data without changing records or spending credits.
pathrequiredGet prospect by record
Get prospect by record. Look up the prospect that tracks a property, person, or company, if there is one. Retrieves data without changing records or spending credits.
queryrequiredCount prospects
Count prospects. Prospect counts by lifecycle and record type, for the workspace or one list. Retrieves data without changing records or spending credits.
queryGet subscription status
Get subscription status. Get your current subscription status, including plan details, billing cycle, and credit caps. Retrieves data without changing records or spending credits.
Takes no parameters.
Get tag
Get tag. Retrieves data without changing records or spending credits.
pathrequiredList tasks
List tasks. List all tasks for the organization. Optionally filter by status, search, or assignee. Retrieves data without changing records or spending credits.
queryGet task
Get task. Get a single task by ID. Retrieves data without changing records or spending credits.
pathrequiredGet webhook
Get webhook. Retrieves data without changing records or spending credits.
pathrequiredList webhook deliveries
List webhook deliveries. The delivery log for one webhook, newest first: status, attempts, response code and time, and any error. Retrieves data without changing records or spending credits.
pathrequiredqueryGet webhook delivery
Get webhook delivery. One delivery with the full event body that was (or will be) sent. Retrieves data without changing records or spending credits.
pathrequiredList webhook event types
List webhook event types. Every event a webhook can subscribe to, with a description and a full example request body. Retrieves data without changing records or spending credits.
Takes no parameters.
Update list
Update list. Update the name of a list. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodypathrequiredconfirmedUpdate campaign
Update campaign. Update a draft campaign. Only draft campaigns can be updated. Audience updates must use exactly one of property_ids, contact_ids, or list_ids. Sending steps replaces the whole step set, so include every step you want to keep. To add properties to a ready, active or paused campaign, use POST /campaigns/{id}/properties. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodypathrequiredconfirmedUpdate design
Update design. Update a design. Supplied HTML is validated before saving. Publishing revalidates both effective draft sides and requires complete front and back HTML. Custom HTML with one outer div declaring inline width and height: 4x6 = 1800 x 1200, 6x9 = 2700 x 1800, 6x11 = 3300 x 1800 CSS pixels. Use inline styles only. Stylesheets, scripts, SVG and embedded documents are unsupported. Put spacing, borders and layout inside the outer div; root transforms, margins and padding are unsupported. Each side must be nonempty and at most 2 MB. Invalid or ambiguous canvases return 400 VALIDATION_ERROR before saving. The API parses and sanitizes HTML without running a browser. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodypathrequiredconfirmedUpdate return address
Update return address. Update a return address. If address fields change, the new address is re-validated via USPS. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodypathrequiredconfirmedUpdate mail settings
Update mail settings. Update one or more organization-level mail settings. Only the fields you include are changed; omitted fields are left untouched. Pass null to clear a setting back to its default. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodyconfirmedMove prospects in bulk
Move prospects in bulk. Move the prospects for up to 1,000 records between active, opportunity, and archived in one call: the bulk form of the single update, and what the app’s selection action bar runs. Records that are not prospects are skipped, as are prospects already in the requested lifecycle; the response counts each. Archiving always ends each prospect’s mail and, unless `cascade` is false, closes its open opportunities. List memberships are kept either way. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodyconfirmedEdit prospect note
Edit prospect note. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodypathrequiredconfirmedUpdate tag
Update tag. Rename, describe, recolor, reorder, or archive a workspace tag. Built-in tags return 403. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodypathrequiredconfirmedUpdate task
Update task. Update a task. Set `is_completed` to `true` to mark as done. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodypathrequiredconfirmedUpdate webhook
Update webhook. Change the URL, events, batch size, contact opt-in, or turn the webhook on or off. Re-enabling clears its failure count. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodypathrequiredconfirmedSearch activity
Search activity. Query your past searches, enrichments, and exports. Filter by activity type, date range, or specific entity IDs — or use free-text search. This endpoint does not consume credits. Retrieves data without changing records or spending credits. Requires confirmed=true for this request.
bodyrequiredconfirmedValidate addresses
Validate addresses. Validate and standardize US addresses using USPS address data. Returns USPS-standardized versions of each submitted address along with a validation status indicating whether the address is deliverable. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodyrequiredconfirmedReverse geocode
Reverse geocode. Look up properties by latitude/longitude coordinates (reverse geocoding). Returns the closest property within 300 feet. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodyrequiredconfirmedBuild list from search filters
Build list from search filters. Add the records matching the given filters and locations to this list. Records already on the list stay, so building again adds to it. Runs asynchronously: the response is this list with status `building`; poll `GET /v1/lists/{list_id}` until status is `completed`. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodypathrequiredconfirmedExport list
Export list. Export all items from a completed list. The list must have status "completed" before export. Credits are charged per record. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodypathrequiredconfirmedImport IDs into list
Import IDs into list. Add property or person ids to this list, matching the list's source_type. Records already on the list stay, so importing again adds to it. Runs asynchronously: the response is this list with status `building`; poll `GET /v1/lists/{list_id}` until status is `completed`. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodypathrequiredconfirmedCreate campaign
Create campaign. Create a new mail campaign. Each step can reference an existing design or provide a design_prompt to generate one; designs are HTML, so generation is instant (no polling required). Provide at most one audience type: property IDs, contact IDs, or saved list IDs. With an audience, set launch=true to send immediately, or leave it as a draft and call POST /campaigns/{id}/send later. Set accepts_properties=true to keep adding properties with POST /campaigns/{id}/properties after it starts; without it the campaign works as before and ends when its mail is done. Without an audience, the campaign is saved as ready with no properties and no charge, and it accepts properties: add them any time with POST /campaigns/{id}/properties. Saving as ready needs a name that does not start with "Draft - " and a design on every step. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodyconfirmedPause campaign
Pause campaign. Pause an active campaign, or a ready campaign that accepts properties. Properties added while it is paused wait at step 1 until it is resumed. Mail already submitted to the vendor will still be delivered. An ended campaign cannot be paused. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredconfirmedResume campaign
Resume campaign. Resume a paused campaign. An ended campaign cannot be resumed. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredconfirmedCreate design
Create design. Create a mail design from custom HTML, or save a prompt as a draft. Custom HTML with one outer div declaring inline width and height: 4x6 = 1800 x 1200, 6x9 = 2700 x 1800, 6x11 = 3300 x 1800 CSS pixels. Use inline styles only. Stylesheets, scripts, SVG and embedded documents are unsupported. Put spacing, borders and layout inside the outer div; root transforms, margins and padding are unsupported. Each side must be nonempty and at most 2 MB. Invalid or ambiguous canvases return 400 VALIDATION_ERROR before saving. The API parses and sanitizes HTML without running a browser. Publishing requires complete validated front and back HTML. Prompt-only designs cannot be auto-published. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodyconfirmedCreate return address
Create return address. Create a new return address. The address is validated via USPS before saving. If the address is invalid, the request is rejected. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodyconfirmedSet default return address
Set default return address. Set a return address as the default for your organization. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredconfirmedExport people to CSV
Export people to CSV. Export matching people as a CSV file. Returns signed download URLs. Limited to 1,000,000 records per export. Pass limit to export only the first N matching records. The request is synchronous — the response is returned once the export is complete (typically up to 30 seconds). Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodyrequiredconfirmedCheck DNC status
Check DNC status. Check Do Not Call (DNC) registry status and phone type for an array of phone numbers. Returns DNC status and phone type without performing a full person enrichment. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodyrequiredconfirmedRegister uploaded file
Register uploaded file. Step two: after the PUT succeeds, record the file on the prospect. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodypathrequiredconfirmedGet file upload URL
Get file upload URL. Step one of attaching a file: returns a presigned URL to PUT the bytes to (valid 5 minutes, max 25 MB) and the `s3_key` to register afterwards with `POST /files`. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodypathrequiredconfirmedAdd prospect photo
Add prospect photo. Attach a photo to the prospect’s property from base64 (small images) or a public https URL (up to 10 MB). Needs an API key created by a user. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodypathrequiredconfirmedAdd tag to prospect
Add tag to prospect. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredconfirmedCheck prospect state
Check prospect state. For up to 500 record IDs, say which are prospects and where they are. Use it to avoid duplicate adds. Retrieves data without changing records or spending credits. Requires confirmed=true for this request.
bodyconfirmedCreate tag
Create tag. Add a workspace tag. Names are unique per workspace and cannot reuse a built-in tag’s name. Up to 200 tags per workspace. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodyconfirmedReorder tags
Reorder tags. Set the display order of workspace tags. IDs not listed keep their order after the listed ones. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodyconfirmedCreate task
Create task. Create a new task. Optionally link it to an opportunity, property, or person. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
bodyconfirmedRedeliver
Redeliver. Queue one delivery to be sent again. Pass `delivery_id=all` with `since` to requeue every delivery after a time. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredqueryconfirmedRotate webhook secret
Rotate webhook secret. Issue a new signing secret. The old one keeps validating signatures for 24 hours so your consumer can switch over. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredconfirmedSend test event
Send test event. Sends one `ping` event to the URL right now, signed like a real delivery, and returns what came back. Requires user approval and confirmed=true before changes or credit use. Writes are never retried automatically.
pathrequiredconfirmedCreate DealMachine List
Creates a list in the workspace, optionally pre-filled with up to 250 property or person IDs. Filed records become prospects unless `add_as_prospects` is false. Free; no credits are charged.
namerequiredrecord_idssource_typeadd_as_prospectsAdd Records to DealMachine List
Adds property or person IDs to an existing list (max 10,000 per request; duplicates are skipped). Filed records become prospects unless `add_as_prospects` is false. Free; no credits are charged.
idsrequiredid_typelist_idrequiredadd_as_prospectsAdd DealMachine Prospects
Tracks one record or up to 1,000 records as prospects in the workspace. Records that are prospects already are returned unchanged; archived ones come back to active. Free; no credits are charged.
favoriterecord_idsrequiredrecord_typeGet DealMachine Prospect
Returns one prospect by prospect ID, or by the record it tracks, with its lifecycle, status (Hot, Warm, Cold, Follow up, Do Not Contact; read only), tags, and note and file counts. Free.
record_idprospect_idrecord_typeSearch DealMachine Prospects
Lists the workspace prospects by lifecycle and source, optionally scoped to a list or a tag, starred only, matching address or name words, by status, by who added them, or by when they were added. Paged, up to 100 per page. Free.
pagesortsearchsourcestatustag_idlist_idadded_byper_pagelifecycleadded_afterrecord_type+3 moreUpdate DealMachine Prospect
Moves a prospect between active, opportunity, and archived, or stars it. Archiving ends its mail. With cascade enabled, it also closes open opportunities. List memberships are kept either way. Free.
cascadefavoritelifecycleprospect_idrequiredAdd DealMachine Prospect Note
Adds a note (up to 10,000 characters) to a prospect. Free.
bodyrequiredprospect_idrequiredSet DealMachine Prospect Tags
Replaces the tags on a prospect with exactly the given tag IDs; an empty list clears them. Free.
tag_idsrequiredprospect_idrequiredList DealMachine Tags
Lists the prospect tag catalog: the built-in tags every workspace has plus the workspace’s own, with how many prospects carry each. Free.
include_inactiveSend Mail Campaign
Launches a draft mail campaign and spends wallet dollars for its recipients and scheduled steps.
confirmedrequiredcampaign_idrequiredAdd Properties to Mail Campaign
Adds properties to a Ready, Active or Paused campaign and spends wallet dollars. Each added property starts at step 1 on its own schedule; properties already in the campaign are untouched. Before calling this, call dealmachine_mail_read with operation add_properties_estimate and the property count, tell the user the charge due today (pay_today_cents) and the amount charged later as mail goes out (pay_later_cents), and get their approval. A paused campaign charges nothing today; each piece is charged as it goes out after it resumes (charged_on_resume). Auto-reload must be on when the campaign has more than one step, a repeating step, or any delay. The response lists added_count and each skipped property with its reason: already_in_campaign, do_not_contact, no_mailing_address, duplicate_mailing_address, archived_prospect or not_found. Find campaigns that accept properties with dealmachine_mail_read search_campaigns and accepting_properties=true.
confirmedrequiredrecipientrequiredcampaign_idrequiredproperty_idsrequiredArchive Mail Campaign
Archives an ended campaign. End active, paused, ready or draft campaigns first; otherwise the API returns 409 CAMPAIGN_NOT_ENDED without changing the campaign. Cancels unsent mail, releases reservations, stops reminders and hides it from default lists. History stays under status=archived. Already submitted mail may still ship. Confirm with the user first.
confirmedrequiredcampaign_idrequiredEnd Mail Campaign
Ends a Ready, Active or Paused mail campaign permanently. Unsent mail is stopped, no properties can be added, and it can never be resumed. Mail already printed or with the carrier still delivers. To reuse its steps, create a new campaign. A draft has not started and cannot be ended (campaign_is_draft). Warn the user that ending cannot be undone.
confirmedrequiredcampaign_idrequiredCancel Mail Campaign
Cancels a mail campaign, kept for existing clients. A started campaign ends as with dealmachine_mail_campaign_end; a draft is cancelled; a campaign that has already ended is returned unchanged. Unsent mail stops, while mail already submitted still delivers.
confirmedrequiredcampaign_idrequiredList DealMachine Webhooks
Lists the workspace’s outbound webhooks with their event types and delivery health, plus the catalog of event types when asked. Free.
include_eventsCreate DealMachine Webhook
Registers an https URL to receive prospect and list events. Returns the signing secret once; relay it to the user. Free.
urlrequiredbatch_maxdescriptionevent_typesrequiredinclude_contacts100% of the applicable checks met
How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.
ly.dealOfficial publisher
Gives an assistant live eBay market intelligence: underpriced listing scans, price distributions, and flip margins.
Published by GitHub account ygfalcon
Deal Radar's hosted MCP server; no sign-in required; Streamable HTTP; 3 tools.
Published by GitHub account Nibbler1250
Remote MealDeal server that gives an assistant access to Quebec grocery deals, weekly meal plans and grocery lists, with an account required.
com.everyhourdeal
Lets an assistant search and compare products in the EveryHourDeal US catalog, check the current hourly deal, and list departments.
Published by GitHub account xiaojiou176-open
DealWatch is a local-first grocery price-tracking tool whose read-only MCP server lets an assistant query tracked product prices and deal history.
dealmachine-cli/├── plugin.json├── mcp.json└── skills/ └── dealmachine/ ├── SKILL.md ├── REFERENCE.md └── SETUP.mdnpx skills add DealMachine/dealmachine-clinpm install -g dealmachinedm logincd dealmachine-clinpm run buildnode dist/index.js whoamicd dealmachine-clinpm linkdm --versiondm login# Skip auto-opening the browserdm login --no-browser
# Target a specific environmentdm login --env localdm login --env stagingdm login --key dm_sk_live_abc123...dm login --env local # Switch to http://localhost:3001/v1dm login --env staging # Switch to https://api-staging.v2.dealmachine.com/v1dm login --env production # Switch to https://api.v2.dealmachine.com/v1dm logout{ "apiKey": "dm_sk_live_...", "keyId": "key_abc123", "organizationId": 42, "organizationName": "Acme Corp", "organizationSlug": "acme-corp", "apiEnvironment": "production"}dm agentsdm agents --jsondm agents guidedm agents guide --jsondm agents playbookdm agents playbook --jsondm agents skill # aliasdm agents install claude-codedm agents install claude-code --projectdm agents permissionsdm agents permissions --jsondm signup [email protected] --first-name Ada --last-name Lovelace --phone-number +15551234567dm signup [email protected] --logindm plansdm plans --jsondm checkout --price-id price_xxx_monthly --quantity 1 --json# Only after approval:dm checkout --price-id price_xxx_monthly --quantity 1 --yes --jsondm login # Device auth flow (opens browser)dm login --no-browser # Device auth, manual code entrydm login --key dm_sk_live_abc123 # Direct API keydm login --env local # Target local APIdm logoutdm whoami # Show stored credentialsdm whoami --verify # Verify credentials against the APIdm config get # Show all config valuesdm config get apiEnvironment # Show specific valuedm config get apiKey # Shows truncated key (first 20 chars)dm config set apiEnvironment localdm config set apiEnvironment stagingdm config set apiEnvironment productiondm config path# /Users/you/.dealmachine/config.jsondm accountAccount────────────────────────────────────────Organization: Acme CorpOrg ID: 42Created: Jan 15, 2025Auth Type: api_keydm usage # Human-readable tabledm usage --json # Machine-readable JSONCredit Usage────────────────────────────────────────────────── Plan: Pro Cycle: Mar 1, 2026 : Mar 31, 2026
Credits: 4,200 / 10,000 (42%) Remaining: 5,800
Breakdown: Properties: 3,100 People: 1,100# Inline JSON bodydm properties search --body '{ "locations": [{"type": "zip_code", "code": "78704"}], "filters": [{"filter_id": "property_type", "operator": "is_any_of", "value": ["single_family"]}]}'
# From a filedm properties search -f search.json
# Pipe from stdincat search.json | dm properties search
# Machine-readable outputdm properties search -f search.json --json # Free estimate for scripts and agentsdm properties search -f search.json --json --yes # Run after approval
# Explicit free estimatedm properties search -f search.json --estimate-cost
# Query Builder protocol filtersdm properties search --include-lists 123,456 --exclude-previously-exported --body '{"locations":[]}'dm properties count --body '{"locations": [{"type": "state", "code": "TX"}]}'dm properties count -f filters.json --jsondm properties get prop_12345dm properties get prop_12345 --contact-audience owners_and_familydm properties get prop_12345 --contact-audience nonedm properties get prop_12345 --fields estimated_value,equitydm properties get prop_12345 --json# Positional argumentsdm properties ids prop_111 prop_222 prop_333
# Via JSON bodydm properties ids --body '{"ids": ["prop_111", "prop_222"]}'
# From filedm properties ids -f ids.json --contact-audience ownersdm properties ids -f ids.json --contact-audience nonedm properties export -f search.jsondm properties export -f search.json --require-phone --scrub-dncdm properties export --body '{"locations": [...]}' --mobile-only --jsondm people search --body '{ "locations": [{"type": "zip_code", "code": "78704"}], "filters": [{"filter_id": "age", "operator": "between", "value": [30, 50]}]}'dm people search -f people-search.json --jsondm people search -f people-search.json --estimate-costdm people search -f people-search.json --json --yesdm people search --include-lists 123 --exclude-lists 456 --exclude-previously-exported --body '{"locations":[]}'dm people count -f filters.jsondm people get per_12345dm people get per_12345 --include-properties --property-limit 20dm people get per_12345 --fields estimated_household_income,estimated_valuedm people get per_12345 --jsondm people ids per_111 per_222 per_333dm people ids --body '{"ids": ["per_111", "per_222"]}' --include-properties --property-limit 20dm people ids per_111 per_222 --fields estimated_household_income,estimated_valuedm people export -f search.json --require-emaildm people export -f search.json --mobile-only --scrub-dnc --json# Single addressdm enrich address "123 Main St, Austin, TX 78704"dm enrich address "123 Main St, Austin, TX 78704" --contact-audience nonedm enrich address "123 Main St, Austin, TX 78704" --fields estimated_value,equity
# Batch from JSONdm enrich address --body '{"data": [{"full_address": "123 Main St, Austin, TX"}]}'
# Batch from CSV (auto-detected by .csv extension)dm enrich address -f addresses.csv --contact-audience owners
# CSV columns: full_address (or street, city, state, zip)dm enrich latlng 30.25,-97.75dm enrich latlng -f coordinates.csv --fields estimated_value,equity --contact-audience none# CSV columns: latitude, longitude (or lat, lng/lon/long)dm enrich apn "0123-456-789" --state TXdm enrich apn -f parcels.csv --zip 78704 --fields estimated_value,equity# CSV columns: apn (or parcel_id, parcel_number)dm enrich email [email protected]dm enrich email [email protected] --include-propertiesdm enrich email -f emails.csv --fields estimated_household_income,estimated_value --json# CSV columns: email (or email_address)dm enrich phone 5125551234dm enrich phone -f phones.csv --include-properties --fields estimated_value# CSV columns: phone (or phone_number)dm enrich name "Jane Doe" --state TX --estimate-costdm enrich name "Jane Doe" --state TX --json --yesdm enrich name "Doe" --state TX --page 2dm enrich name "Jane Doe" --zip 78704 --include-propertiesdm enrich name "Jane Doe" --fields estimated_household_income,estimated_value# Single property with defaultsdm comps prop_12345
# Multiple properties with optionsdm comps prop_12345 prop_67890 --radius 2 --timeframe 12months --limit 50
# Full control via JSON bodydm comps --body '{ "property_ids": ["prop_12345"], "location": {"type": "radius", "radius_miles": 1.5}, "criteria": {"timeframe": "6months", "sort_by": "match", "limit": 25}}'dm lists searchdm lists search --search "Austin" --source-type properties --sort newestdm lists search --page 2 --per-page 50 --json# Empty listdm lists create --name "Austin Leads"
# Pre-populated with record IDs (max 250)dm lists create --name "Hot Leads" --source-type properties --ids 123,456,789
# With search filters for a list builddm lists create --name "TX SFR" -f search-filters.jsondm lists get list_abc123dm lists update list_abc123 --name "New Name"dm lists delete list_abc123dm lists build list_abc123 -f search-filters.jsondm lists import list_abc123 --ids 111,222,333 --source-type propertiesdm lists import list_abc123 -f import-payload.jsondm lists items list_abc123dm lists items list_abc123 --page 2 --per-page 100 --jsondm lists add list_abc123 --ids 111,222,333dm lists add list_abc123 --ids 111,222 --id-type internal_property_iddm lists remove list_abc123 --ids 111,222,333dm lists export list_abc123dm lists export list_abc123 --fields "full_address,estimated_value,owner_name" --anchor propertydm filtersdm filters --source-type properties --search "bed"dm filters --group-id building_information --jsondm fieldsdm fields --source-type people --search "phone"dm fields --group-id contact_info --jsondm locations search -q "Harris" --type county --state TX --jsondm locations get loc_city_48106 --jsondm activity search -t search_properties enrich_addressdm activity search -q "Austin" --page 2dm activity search --body '{"types": ["search_properties"], "page": 1}'dm activity get act_abc123dm activity get act_abc123 --jsondm addresses autocomplete "1200 Barton Springs" --state TXdm addresses autocomplete "saint louis 63101" --scope location --limit 5 --json# Single addressdm addresses validate "123 Main St, Austin, TX 78704"
# Batch via JSONdm addresses validate --body '{"data": [{"full_address": "123 Main St, Austin TX"}]}'
# From filedm addresses validate -f addresses.json --jsondm dev license add key_abc123 --type state --code TXdm dev license add key_abc123 --type zip_code --code 78704dm dev license add key_abc123 --type unlimiteddm dev license add key_abc123 --type county --code 48453 --expires 2026-12-31dm dev license listdm dev license list key_abc123dm dev license remove 42# Inlinedm properties search --body '{"locations": [...]}'
# Filedm properties search -f query.json
# Pipecat query.json | dm properties search
# CSV enrichment (enrich commands only)dm enrich address -f addresses.csvdealmachine-cli/ scripts/ copy-agent-assets.mjs # Bundles the Playbook Markdown into dist/agents src/ index.ts # Program entrypoint -- registers all 17 command groups lib/ config.ts # Read/write ~/.dealmachine/config.json (mode 0600) client.ts # HTTP client wrapper (apiRequest, formatDate, getApiKey) api.ts # Device auth flow client (requestDeviceCode, pollForToken, verifyCredentials) output.ts # Formatting helpers (printTable, printJson, printKeyValue, parseRequestBody) commands/ agents.ts # dm agents -- agent guide and Playbook output login.ts # dm login -- device auth + API key login logout.ts # dm logout -- remove credentials whoami.ts # dm whoami -- show/verify auth status config.ts # dm config -- get, set, path account.ts # dm account -- show account info usage.ts # dm usage -- credit usage properties.ts # dm properties -- search, count, get, ids, export people.ts # dm people -- search, count, get, ids, export enrich.ts # dm enrich -- address, latlng, apn, email, phone, name comps.ts # dm comps -- comparable properties lists.ts # dm lists -- full CRUD + build, import, export filters.ts # dm filters -- list available filters fields.ts # dm fields -- list available fields activity.ts # dm activity -- search, get addresses.ts # dm addresses -- validate dev.ts # dm dev -- local license management dist/ # Compiled output (ESM) package.json tsconfig.jsonnpm run build # Compile TypeScript and bundle agent Playbook assets to dist/npm run dev # Watch mode (tsc --watch)npm run eval:cold-start:local # Verify a clean local install and routing contractnpm run eval:cold-start:published # Verify the latest public npm artifactnpm run eval:cold-start:deployed # Verify deployed documentation and skill assetsnpm test # Unit and behavioral tests with a mocked API (no credentials)npm run check # Typecheck, build, tests and the public artifact guardDM_API_URL=https://api-staging.v2.dealmachine.com/v1 DM_API_KEY=<key> npm run smoke:live:coverage# Buildcd dealmachine-clinpm run build
# The entire dist/ directory is the distributable artifact# dist/index.js is the entrypoint (requires Node.js >= 18 on the target machine)/** * MyCommand -- description of what this command does */
import chalk from 'chalk';import ora from 'ora';import { apiRequest } from '../lib/client.js';import { printJson, printHeader, printKeyValue } from '../lib/output.js';
interface MyResponse { data: { id: string; name: string };}
export async function myCommand(options: { json?: boolean }): Promise<void> { const spinner = ora('Doing something...').start(); const data = await apiRequest<MyResponse>('/my-endpoint'); spinner.stop();
if (options.json) { printJson(data); return; }
printHeader('My Command'); printKeyValue({ ID: data.data.id, Name: data.data.name, }); console.log();}import { myCommand } from './commands/mycommand.js';
// Top-level commandprogram .command('mycommand') .description('Description shown in --help') .option('--json', 'Output as JSON') .action(async (options) => { await myCommand(options); });
// Or as a subcommand groupconst myGroup = program.command('mygroup').description('Group description');
myGroup .command('sub1') .description('Subcommand description') .action(async (options) => { await mySub1(options); });npm run buildnode dist/index.js mycommand --json