API Documentation

Integrate HypeTorch's advanced analytics into your applications. Access real-time influence scores, controversy detection, and narrative intelligence.

Get API Key
Base URL: https://api.hypetorch.com
45+
Tracked Entities
8
Core Metrics
12+
API Endpoints
Weekly
Data Updates

Getting Started

1. Get Your API Key

Contact our sales team to get your API key. Each key comes with rate limits and usage tracking.

Request API Key

2. Authenticate Requests

Include your API key in the request header for all endpoints (except health check).

X-API-Key: your-api-key-here

Rate Limits

60
Requests per Minute
Standard endpoints
1,000
Requests per Hour
Generous hourly limit
10,000
Requests per Day
High daily allowance

Rate Limit Headers

All responses include rate limit information in headers: X-RateLimit-Remaining-Minute, X-RateLimit-Reset, etc.

Quick Examples

javascript

// Using fetch API
const response = await fetch('https://api.hypetorch.com/v2/entities?include_metrics=true', {
  method: 'GET',
  headers: {
    'X-API-Key': 'your-api-key',
    'Content-Type': 'application/json'
  }
});

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

python

import requests

headers = {
    'X-API-Key': 'your-api-key',
    'Content-Type': 'application/json'
}

response = requests.get(
    'https://api.hypetorch.com/v2/entities',
    headers=headers,
    params={'include_metrics': True}
)

data = response.json()
print(data)

curl

curl -X GET 'https://api.hypetorch.com/v2/entities?include_metrics=true' \
  -H 'X-API-Key: your-api-key' \
  -H 'Content-Type: application/json'

API Endpoints

GET/v2/entities

Get All Entities

Retrieve all entities with optional metrics and filtering

Parameters

include_metricsbooleanDefault: false

Include current metrics

categorystringOptional

Filter by category (Sports, Crypto)

subcategorystringOptional

Filter by subcategory (NFL, WNBA)

Example

Request
curl -X GET 'https://api.hypetorch.com/v2/entities?include_metrics=true&category=Sports' \
  -H 'X-API-Key: your-api-key'
Response
{
  "status": "success",
  "data": [
    {
      "id": 1,
      "name": "Caitlin Clark",
      "type": "person",
      "category": "Sports",
      "subcategory": "WNBA",
      "metrics": {
        "hype_score": 85.2,
        "rodmn_score": 12.3,
        "mentions": 156,
        "talk_time": 45.7
      }
    }
  ]
}
GET/v2/entities/search

Search Entities

Search for entities by name or keyword

Parameters

qstringRequired

Search query

categorystringOptional

Filter by category

limitintegerDefault: 20

Max results (1-100)

Example

Request
curl -X GET 'https://api.hypetorch.com/v2/entities/search?q=Clark&limit=5' \
  -H 'X-API-Key: your-api-key'
Response
{
  "status": "success",
  "data": [
    {
      "id": 1,
      "name": "Caitlin Clark",
      "type": "person",
      "category": "Sports",
      "subcategory": "WNBA"
    }
  ]
}
POST/v2/entities/bulk

Bulk Entity Query

Get multiple entities with specific metrics and optional history

Example

Request
curl -X POST 'https://api.hypetorch.com/v2/entities/bulk' \
  -H 'X-API-Key: your-api-key' \
  -H 'Content-Type: application/json' \
  -d '{
    "entity_names": ["Caitlin Clark", "Angel Reese"],
    "metrics": ["hype_score", "rodmn_score", "mentions"],
    "include_history": false
  }'
Response
{
  "status": "success",
  "data": [
    {
      "name": "Caitlin Clark",
      "metrics": {
        "hype_score": 85.2,
        "rodmn_score": 12.3,
        "mentions": 156
      }
    },
    {
      "name": "Angel Reese",
      "metrics": {
        "hype_score": 78.9,
        "rodmn_score": 8.7,
        "mentions": 143
      }
    }
  ]
}
GET/v2/trending

Get Trending Entities

Get entities with the biggest changes in metrics

Parameters

metricstringDefault: hype_score

Metric to analyze for trends

limitintegerDefault: 10

Max results (1-50)

categorystringOptional

Filter by category

Example

Request
curl -X GET 'https://api.hypetorch.com/v2/trending?metric=hype_score&limit=5' \
  -H 'X-API-Key: your-api-key'
Response
{
  "status": "success",
  "data": [
    {
      "name": "Caitlin Clark",
      "current_value": 85.2,
      "previous_value": 72.1,
      "percent_change": 18.2,
      "trend_direction": "up"
    }
  ]
}
GET/v2/dashboard/widgets

Dashboard Widgets

Get pre-configured dashboard data for top movers, alerts, and opportunities

Example

Request
curl -X GET 'https://api.hypetorch.com/v2/dashboard/widgets' \
  -H 'X-API-Key: your-api-key'
Response
{
  "status": "success",
  "data": {
    "top_movers": [
      {
        "name": "Caitlin Clark",
        "current_score": 85.2,
        "change": 15.2,
        "trend": "up"
      }
    ],
    "narrative_alerts": [
      {
        "name": "Angel Reese",
        "rodmn_score": 25.8,
        "alert_level": "high",
        "context": "High controversy detected in recent discussions"
      }
    ]
  }
}

Error Handling

The API uses standard HTTP response codes and returns detailed error information in a consistent format.

Common Error Codes

  • 401 - Missing or invalid API key
  • 404 - Entity not found
  • 429 - Rate limit exceeded
  • 500 - Internal server error
Error Response Format
{
  "status": "error",
  "error": {
    "message": "Invalid API key",
    "code": 401,
    "details": "Please check your API key and try again"
  },
  "metadata": {
    "timestamp": 1234567890
  }
}

Need Help?

Our team is here to help you integrate HypeTorch analytics into your applications. Get your API key, ask technical questions, or discuss custom enterprise solutions.

Contact SupportEnterprise Solutions