SDK

Python SDK

Use the ColdDMCalculator Outreach Intelligence API in your Python projects — scripts, web apps, data pipelines, and automation workflows.

View API Docs View Examples

Getting Started

Python SDK Overview

The Python SDK provides a simple interface to the ColdDMCalculator Outreach Intelligence API. Use it to forecast replies, booked calls, clients, revenue, campaign scores, and optimization recommendations.

Coming soon: The Python SDK package is not yet published to PyPI. The code examples below show how to integrate directly with the REST API using the requests library. pip install colddmcalculator will be available in a future release.

Installation

pip (coming soon)

# Coming soon — placeholder only
pip install colddmcalculator

Authentication

Include your API key in the Authorization header of every request.

Header

Authorization: Bearer YOUR_API_KEY

Forecast Example

Python — DM Forecast

import requests

response = requests.post(
    "https://api.colddmcalculator.com/v1/dm/forecast",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
        "dms_sent": 1000,
        "reply_rate": 12,
        "positive_reply_rate": 35,
        "call_booking_rate": 25,
        "close_rate": 20,
        "average_client_value": 1500
    }
)

data = response.json()
print(data)
# {
#     "estimated_replies": 120,
#     "estimated_positive_replies": 42,
#     "estimated_booked_calls": 10,
#     "estimated_clients": 2,
#     "estimated_revenue": 3000,
#     "campaign_score": 82,
#     "risk_level": "medium",
#     "recommendations": [...]
# }

Score Example

Python — Campaign Score

import requests

response = requests.post(
    "https://api.colddmcalculator.com/v1/dm/score",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
        "channel": "linkedin",
        "audience_quality": "high",
        "personalization_level": "medium",
        "offer_clarity": "high",
        "follow_up_count": 3,
        "daily_dm_volume": 30
    }
)

data = response.json()
print(data)
# {
#     "campaign_score": 85,
#     "deliverability_risk": "low",
#     "conversion_confidence": "high",
#     "strengths": [...],
#     "issues": [...],
#     "next_steps": [...]
# }

Error Handling

Python — Error Handling

import requests

response = requests.post(
    "https://api.colddmcalculator.com/v1/dm/forecast",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={"dms_sent": -1}  # invalid input
)

if not response.ok:
    error = response.json()
    print(error["error"]["code"])    # "invalid_input"
    print(error["error"]["message"]) # "dms_sent must be greater than 0"
else:
    data = response.json()
    print(data)