NIXUS API Documentation

Real-time social media intelligence across YouTube, TikTok, and Instagram. One API, three platforms, actionable data.

BASE URL https://nixus.pro/api/v1

The NIXUS API gives you programmatic access to trending content, hashtag analytics, top-performing videos, and deep social listening across major short-form platforms. All responses are JSON with a data envelope.

Free tier available. Get 1 test request (lifetime) on YouTube with no credit card required. Create your API key in seconds.

Authentication

All API requests require an API key passed via the X-API-Key header. You can also pass it as a query parameter ?api_key=YOUR_KEY, but the header method is preferred.

# Header method (recommended)
curl https://nixus.pro/api/v1/trends \
  -H "X-API-Key: nix_your_key_here"

# Query parameter method
curl "https://nixus.pro/api/v1/trends?api_key=nix_your_key_here"

API keys start with nix_ and are 52 characters long. Keep your key secret - it controls your rate limits and usage tracking.

Quickstart

Get up and running in under a minute.

Step 1: Get your API key

curl -X POST https://nixus.pro/api/v1/keys \
  -H "Content-Type: application/json" \
  -d '{"email": "you@example.com"}'
Response
{
  "data": {
    "api_key": "nix_a1b2c3d4e5f6...",
    "email": "you@example.com",
    "plan": "free",
    "daily_limit": 100
  }
}

Step 2: Make your first request

cURL
Python
JavaScript
curl https://nixus.pro/api/v1/trends \
  -H "X-API-Key: YOUR_API_KEY" \
  -G -d "platform=youtube" \
     -d "category=health" \
     -d "limit=5"
import requests

API_KEY = "YOUR_API_KEY"
BASE = "https://nixus.pro/api/v1"

r = requests.get(
    f"{BASE}/trends",
    headers={"X-API-Key": API_KEY},
    params={"platform": "youtube", "category": "health"}
)

for video in r.json()["data"]:
    print(f"{video['title']} - {video['views']:,} views")
const API_KEY = "YOUR_API_KEY";

const res = await fetch(
  "https://nixus.pro/api/v1/trends?platform=youtube&category=health",
  { headers: { "X-API-Key": API_KEY } }
);

const { data } = await res.json();
data.forEach(v => console.log(`${v.title} - ${v.views} views`));

Rate Limits

Rate limits are applied per API key based on your plan. When you exceed the limit, you'll receive a 429 response with details.

PlanDaily RequestsPer MinutePlatforms
Free10010YouTube
Starter40030YouTube, TikTok
Pro2,00060All 3
Business22,000120All 3
Enterprise40,000300All 3

Daily limits reset at midnight UTC. Check your current usage anytime via the /v1/usage endpoint.

Error Handling

The API uses standard HTTP status codes. Errors include a JSON body with details.

CodeMeaning
200Success
201Created (new resource)
400Bad request (missing/invalid params)
401Unauthorized (missing/invalid API key)
403Forbidden (feature not in your plan)
409Conflict (e.g., email already registered)
429Rate limit exceeded
500Internal server error
Error Response Example
{
  "error": "Daily rate limit exceeded.",
  "limit": 100,
  "plan": "free",
  "upgrade_url": "https://nixus.pro/api/pricing"
}

Hashtags

GET /v1/hashtags Free

Get hashtag analytics including usage count and total views across tracked content.

Query Parameters

ParameterTypeDefaultDescription
platformstringyoutubePlatform to query
categorystringtrendingCategory filter
limitinteger20Max results (1-100)
Response 200
{
  "data": [
    {
      "hashtag": "#shorts",
      "platform": "youtube",
      "count": 10926,
      "total_views": 869912593
    },
    {
      "hashtag": "#health",
      "platform": "youtube",
      "count": 3616,
      "total_views": 274258005
    }
  ],
  "count": 2
}

Videos

GET /v1/videos Free

Get top-performing videos in any niche. Filter by minimum views, platform, and time period.

Query Parameters

ParameterTypeDefaultDescription
platformstringyoutubePlatform to query
nichestringNiche/topic to search
time_periodstringthis_weektoday, this_week, this_month, this_year
min_viewsinteger0Minimum view count filter
limitinteger20Max results (1-50)
sort_bystringviewsSort field: views, date

Request

curl "https://nixus.pro/api/v1/videos?niche=castor+oil&min_views=100000&limit=5" \
  -H "X-API-Key: YOUR_KEY"

Orbit (Deep Social Listening)

POST /v1/orbit Starter+

Queue a deep social listening job. Multi-keyword, multi-platform analysis with aggregated insights. Returns an orbit_id for retrieving results.

Requires Starter plan or above. Free tier users will receive a 403 response.

Request Body (JSON)

FieldTypeRequiredDescription
namestringNoDescriptive name for this search job
keywordsstring[]YesKeywords to search (1-10)
platformsstring[]NoPlatforms to analyze (default: all available)

Request

curl -X POST https://nixus.pro/api/v1/orbit \
  -H "X-API-Key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Health Niche Research",
    "keywords": ["cold shower benefits", "cortisol reduction", "castor oil"],
    "platforms": ["youtube"]
  }'
Response 201
{
  "data": {
    "orbit_id": "a1b2c3d4e5f6...",
    "status": "completed",
    "name": "Health Niche Research"
  }
}

Orbit Results

GET /v1/orbit/:orbit_id Starter+

Retrieve results from a completed orbit job. Includes videos, total views, and aggregated analysis.

Response 200
{
  "data": {
    "id": "a1b2c3d4...",
    "status": "completed",
    "results": {
      "videos": [...],
      "total_videos": 47,
      "analysis": {
        "top_performing": {...},
        "avg_views": 2450000,
        "total_views": 115150000
      }
    }
  }
}

Create API Key

POST /v1/keys No Auth

Generate a free API key. One key per email address. Starts on the Free plan (1 test request (lifetime)).

Request Body (JSON)

FieldTypeRequiredDescription
emailstringYesValid email address
curl -X POST https://nixus.pro/api/v1/keys \
  -H "Content-Type: application/json" \
  -d '{"email": "dev@yourapp.com"}'

Usage

GET /v1/usage Free

Check your current API usage, plan details, and remaining daily quota.

Response 200
{
  "data": {
    "plan": "free",
    "requests_today": 23,
    "requests_total": 156,
    "daily_limit": 100,
    "platforms": ["youtube"],
    "orbit_access": false
  }
}

Plans

GET /v1/plans No Auth

Get all available plans with pricing and feature details.

Pricing

Start free, upgrade when you need more.

Free
$0/mo
  • 1 test request (lifetime)
  • YouTube only
  • Trends, Search, Videos
  • Hashtag analytics
Starter
$19/mo
  • 400 requests/day
  • YouTube + TikTok
  • Orbit deep search
  • Email support
Pro
$49/mo
  • 2,000 requests/day
  • All 3 platforms
  • AI analysis
  • Priority support
Business
$99/mo
  • 22,000 requests/day
  • Webhook notifications
  • Custom niches
  • Dedicated support
Enterprise
$299/mo
  • 40,000 requests/day
  • White-label option
  • Custom integrations
  • SLA guarantee

Changelog

v1.0.0 - March 7, 2026

Built by NIXUS. Questions? api@nixus.pro