Tathor API Documentation

Welcome

Tathor analyzes competitors and delivers scorecards, pain points, solutions, and revenue impact predictions. Our API lets you access these capabilities from your applications.

With the Tathor API, you can:

• Analyze competitors and extract useful information
• Generate competitor profiles
• Access scorecards, pain points, and solutions
• Get revenue impact predictions

Quickstart

Get up and running with the Tathor API in minutes.

1. Get Your API Key

Sign up for a Tathor account and navigate to your dashboard to generate an API key.

2. Make Your First Request

Here's a simple example using JavaScript:

const response = await fetch('https://app.tathor.com/api/v1/analyze', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  body: JSON.stringify({
    url: 'https://example.com',
    analysis_type: 'business_intelligence'
  })
});

const data = await response.json();
console.log(data);

Authentication

All API requests require authentication using a Bearer token. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

You can find your API key in your dashboard.

API Endpoints

The Tathor API is organized around RESTful principles. All endpoints return JSON responses.

Analyze Endpoint

The analyze endpoint allows you to submit a business or website for analysis.

Request

POST https://app.tathor.com/api/v1/analyze
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

{
  "url": "https://example.com",
  "analysis_type": "business_intelligence"
}

Response

{
  "id": "analysis_123",
  "status": "processing",
  "url": "https://example.com",
  "created_at": "2024-01-26T10:00:00Z"
}

Rate Limits

API requests are rate-limited to ensure fair usage. Rate limits vary by plan:

• Free: 100 requests per day
• Pro: 1,000 requests per day
• Enterprise: Custom limits

Rate limit information is included in response headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1643200000

Error Handling

The API uses standard HTTP status codes and returns error details in the response body:

{
  "error": {
    "code": "invalid_request",
    "message": "The request is missing required parameters",
    "details": {
      "field": "url",
      "reason": "required"
    }
  }
}