API Reference Overview

Hello Battle Card provides a comprehensive REST API for programmatic access to your competitive intelligence data.

Base URL

https://app.hellobattlecard.com

Authentication

All API requests require authentication via API key. Include your API key in the X-API-Key header:

curl -H "X-API-Key: your-api-key-here" https://app.hellobattlecard.com/api/products

See the Authentication guide for details on obtaining and using API keys.

Rate Limits

• Default: 1000 requests per hour per API key
• Rate limit headers are included in responses:
  • X-RateLimit-Limit: Maximum requests per hour
  • X-RateLimit-Remaining: Remaining requests in current window
  • X-RateLimit-Reset: Unix timestamp when the limit resets

Response Format

All responses are JSON. Errors follow this format:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message",
    "details": {}
  }
}

Endpoints

• Products - Manage products
• Competitors - Track competitors
• Battlecards - Generate battlecards
• Intel - Access competitive intelligence
• Matrix - Competitive matrices
• Solutions - Manage solution themes
• Jobs - Background job tracking
• API Keys - Manage API keys

Interactive API Explorer

Use the interactive API explorer below to test API calls directly. Enter your API key to make live requests:

Your API key is stored locally and only sent to Hello Battle Card servers.