API Reference
Start typing to search…

API Overview

What is TAMradar API?

TAMradar is a company intelligence solution that provides a powerful API for developers. Our system:

  • Uses AI to continuously monitor and analyze publicly available web data
  • Processes information through advanced machine learning pipelines
  • Structures data into meaningful insights about companies
  • Delivers real-time notifications about important changes and events
  • Provides a simple REST API with webhook-based delivery

The API lets developers easily integrate company monitoring capabilities into their applications, whether for sales intelligence, competitive analysis, or market research.

How TAMradar Works

TAMradar operates on a simple yet powerful concept:

  1. You create a radar - Define what company and what type of information you want to monitor
  2. We scan and monitor - Our AI-powered system continuously monitors online sources
  3. We detect relevant changes - When matching information is found, it's processed and structured
  4. You receive notifications - Event data is sent to your webhook endpoint in real-time

Simplified Overview of how TAMradar works

flowchart TD
    Start([Start]) --> CreateRadar[Create Radar<br/>POST /v1/radars]
    CreateRadar --> DeductBalance[Deduct Balance<br/>-$0.15]
    DeductBalance --> CheckCompany{Can we track<br/>this company?}
    
    CheckCompany -->|Yes| Active[Radar Active<br/>Status: active]
    CheckCompany -->|No| RefundBalance[Refund Balance<br/>+$0.15]
    
    Active --> parallel{Parallel Processes}
    parallel --> Updates[Receive Updates<br/>via Webhook<br/>event_type: radar_finding]
    parallel --> Check[Check Status<br/>GET /v1/radars/:id]
    parallel --> MonthlyDeduction[Monthly Balance<br/>Deduction: -$0.15]
    
    RefundBalance --> NotifyWebhook[Notify via Webhook<br/>event_type: radar_status<br/>status: tracking_failed]
    
    Updates --> Continue{Continue<br/>Tracking?}
    Continue -->|Yes| parallel
    Continue -->|No| Deactivate[Deactivate Radar<br/>DELETE /v1/radars/:id]
    
    style Start fill:#1a73e8,stroke:#0d47a1,stroke-width:2px,color:white
    style CreateRadar fill:#34a853,stroke:#1e8e3e,stroke-width:2px,color:white
    style DeductBalance fill:#fbbc04,stroke:#f29900,stroke-width:2px,color:black
    style CheckCompany fill:#4285f4,stroke:#185abc,stroke-width:2px,color:white
    style Active fill:#34a853,stroke:#1e8e3e,stroke-width:2px,color:white
    style Updates fill:#4285f4,stroke:#185abc,stroke-width:2px,color:white
    style Check fill:#4285f4,stroke:#185abc,stroke-width:2px,color:white
    style MonthlyDeduction fill:#fbbc04,stroke:#f29900,stroke-width:2px,color:black
    style RefundBalance fill:#ea4335,stroke:#c5221f,stroke-width:2px,color:white
    style NotifyWebhook fill:#ea4335,stroke:#c5221f,stroke-width:2px,color:white
    style Deactivate fill:#616161,stroke:#3c4043,stroke-width:2px,color:white
    style Continue fill:#4285f4,stroke:#185abc,stroke-width:2px,color:white
    style parallel fill:#4285f4,stroke:#185abc,stroke-width:2px,color:white


Core Components

Radars

Radars are the fundamental monitoring units in TAMradar:

  • Each radar monitors a specific company domain (e.g., example.com)
  • Each radar has a specific type (e.g., job_openings, new_hires)
  • Radars run continuously until deactivated
  • Creating and maintaining radars requires available balance

Common radar types include monitoring for new job postings, employee changes, social media activity, and company mentions across the web.

Webhooks

Webhooks are how TAMradar delivers information to your systems:

  • When a radar detects relevant information, it triggers a webhook
  • Webhook payloads are sent as HTTP POST requests to your specified URL
  • Each payload contains structured data about the detected event
  • You can specify custom fields that will be included in every webhook

This push-based model ensures you receive updates in real-time without having to poll our API.

Contact-Based Radars

Some radar types track specific individuals rather than company-wide events:

  • Contact radars monitor career changes for specific people at a company
  • Identified using personal information: email, LinkedIn profile URL, or full name
  • Multiple contacts can be tracked per company domain
  • Contact identifiers are used for radar creation but not included in webhook payloads for privacy

Persona-Based Filtering

To help you reduce noise and focus on the most relevant signals, TAMradar supports persona-based filtering on certain radar types. By providing a filters object when creating a radar, you can receive webhook notifications only for the records that match your specific criteria.

  • Filter by departments and seniorities.
  • Use advanced boolean queries for job_titles.
  • Supported for new_hires, job_openings, promotions, and company_social_posts_cxo.

For a complete guide on how to use this powerful feature, see the Persona-Based Filtering Guide.

Balance System

TAMradar now uses a prepaid USD balance:

  • Add Funds: Top-up your account with any USD amount (e.g., $100).
  • Initial Creation: Creating a new radar immediately deducts its USD cost from your balance (rate set on your plan).
  • Recurring Charges: Every active radar renews every 30 days and deducts its customer-specific USD rate.
  • Automatic Deduction: Charges are applied automatically whenever a radar is created or renewed—no manual steps required.
  • Optional Expiry: Top-ups can carry an expiration date; any unused balance is removed automatically when it expires.
  • Balance Visibility: Call GET /v1/account to see balance_remaining_usd and balance_used_usd for the current or any past month.

The TAMradar Lifecycle

A typical interaction with TAMradar follows this pattern:

  1. Setup: Create a radar for a company domain with a specific monitoring type
  2. Initial Processing: TAMradar begins scanning relevant sources
  3. Ongoing Monitoring: Continuous monitoring for new information
  4. Event Detection: When relevant information is found, it's processed
  5. Notification: Structured data is sent to your webhook
  6. Renewal: Monthly balance deduction to maintain the radar
  7. Deactivation: Optional radar deactivation when monitoring is no longer needed

Use Cases

TAMradar API powers a variety of applications:

  • Sales Intelligence: Get notified about potential sales triggers
  • Competitive Analysis: Monitor competitor activities
  • Recruitment: Track hiring patterns at target companies
  • Market Research: Stay informed about industry movements
  • Investor Intelligence: Monitor portfolio companies or potential investments

Technical Foundation

While detailed API specifications are available in our API Reference, here's a high-level overview:

  • RESTful API: Standard HTTP methods and status codes
  • JSON Responses: All API responses use consistent JSON formatting
  • API Key Authentication: Simple API key-based authentication
  • Webhook Delivery: Real-time event notifications via HTTP POST
  • Rate Limiting: Fair usage policies to ensure service reliability

Getting Started

Ready to start monitoring companies with TAMradar?

  1. Get Started Guide: Step-by-step tutorial to create your first radar
  2. API Definitions: Detailed API specifications
  3. Authentication: Learn about authentication and rate limits
  4. Webhook Payloads: Understand the structure of webhook data
  5. Error Handling: Guide to handling errors and troubleshooting

Need personalized assistance? Contact our support team