Skip to main content
The DealMachine API is organized around REST. All endpoints accept and return JSON.

Base URL

Authentication

All protected endpoints require a Bearer token in the Authorization header:
Two token types are supported:

Request Format

  • Content type: application/json
  • All timestamps are ISO 8601 format
  • IDs are integers or prefixed strings (e.g., key_abc123)

Response Format

Search endpoints return results in a data array alongside a pagination object:
See Response Format for full details on always-included fields, field types, and pagination. Error responses use a consistent structure:

Response Headers

Endpoint Groups

Interactive Playground

Each endpoint page includes an interactive playground where you can test API calls directly in your browser. Enter your API key and try the endpoints in real time.