REST API
The DealSurface REST API lets you programmatically access prospect intelligence, map buying committees, and craft personalized outreach.
Base URL
All API requests are made to the following base URL:
https://dealsurface.com/api/v1Authentication
Authenticate by passing your API key as a Bearer token in the Authorization header. API keys can be created from Settings → API Keys in your dashboard.
curl https://dealsurface.com/api/v1/products \
-H "Authorization: Bearer ds_live_..."See the Authentication guide for details on scopes and key management.
Endpoints
| Method | Path | Description | Credits |
|---|---|---|---|
| GET | /products | List active products | Free |
| GET | /products/:id | Get an active product | Free |
| GET | /prospects | List ranked prospects | Free |
| GET | /prospects/:ticker | Get prospect detail | Free |
| GET | /excerpts | Search evidence excerpts | Free |
| GET | /dealmap | Get buying committee DealMap | Free |
| POST | /dealmap/generate | Generate DealMap | 0-10 |
| PATCH | /dealmap/node-role | Override stakeholder role | Free |
| POST | /outreach | Generate outreach copy | 1 |
Versioning
The current API version is v1. The version is included in the URL path. Breaking changes will be introduced in a new version number; non-breaking additions (new fields, new optional parameters) may be added to v1 at any time.
Content type
All responses are JSON. POST endpoints accept application/json request bodies.