NIXUS API Documentation
Real-time social media intelligence across YouTube, TikTok, and Instagram. One API, three platforms, actionable data.
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.
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"}'
{
"data": {
"api_key": "nix_a1b2c3d4e5f6...",
"email": "you@example.com",
"plan": "free",
"daily_limit": 100
}
}
Step 2: Make your first request
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.
| Plan | Daily Requests | Per Minute | Platforms |
|---|---|---|---|
| Free | 100 | 10 | YouTube |
| Starter | 400 | 30 | YouTube, TikTok |
| Pro | 2,000 | 60 | All 3 |
| Business | 22,000 | 120 | All 3 |
| Enterprise | 40,000 | 300 | All 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.
| Code | Meaning |
|---|---|
200 | Success |
201 | Created (new resource) |
400 | Bad request (missing/invalid params) |
401 | Unauthorized (missing/invalid API key) |
403 | Forbidden (feature not in your plan) |
409 | Conflict (e.g., email already registered) |
429 | Rate limit exceeded |
500 | Internal server error |
{
"error": "Daily rate limit exceeded.",
"limit": 100,
"plan": "free",
"upgrade_url": "https://nixus.pro/api/pricing"
}
Trends
Get trending topics and viral content across platforms. Returns videos sorted by view count with metadata.
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
platform | string | youtube | Platform to query: youtube, tiktok, instagram |
category | string | all | Content category: all, health, tech, finance, entertainment |
limit | integer | 20 | Max results (1-50) |
Request
curl https://nixus.pro/api/v1/trends?platform=youtube&category=health&limit=3 \
-H "X-API-Key: YOUR_KEY"
{
"data": [
{
"video_id": "dQw4w9WgXcQ",
"platform": "youtube",
"title": "What Happens When You Take Cold Showers Every Day",
"views": 17640605,
"channel": "RealLogic",
"published": "2 weeks ago",
"thumbnail": "https://i.ytimg.com/vi/...",
"url": "https://youtube.com/watch?v=dQw4w9WgXcQ"
}
],
"platform": "youtube",
"date": "2026-03-07",
"count": 1
}
Videos
Get top-performing videos in any niche. Filter by minimum views, platform, and time period.
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
platform | string | youtube | Platform to query |
niche | string | Niche/topic to search | |
time_period | string | this_week | today, this_week, this_month, this_year |
min_views | integer | 0 | Minimum view count filter |
limit | integer | 20 | Max results (1-50) |
sort_by | string | views | Sort 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"
Search
Keyword-based video search across platforms. The most flexible endpoint for content research.
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
q | string | Search query required | |
platform | string | youtube | Platform to search |
min_views | integer | 0 | Minimum view count |
limit | integer | 20 | Max results (1-50) |
Request
curl "https://nixus.pro/api/v1/search?q=intermittent+fasting&platform=youtube&min_views=50000" \ -H "X-API-Key: YOUR_KEY"
Orbit (Deep Social Listening)
Queue a deep social listening job. Multi-keyword, multi-platform analysis with aggregated insights. Returns an orbit_id for retrieving results.
403 response.
Request Body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Descriptive name for this search job |
keywords | string[] | Yes | Keywords to search (1-10) |
platforms | string[] | No | Platforms 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"] }'
{
"data": {
"orbit_id": "a1b2c3d4e5f6...",
"status": "completed",
"name": "Health Niche Research"
}
}
Orbit Results
Retrieve results from a completed orbit job. Includes videos, total views, and aggregated analysis.
{
"data": {
"id": "a1b2c3d4...",
"status": "completed",
"results": {
"videos": [...],
"total_videos": 47,
"analysis": {
"top_performing": {...},
"avg_views": 2450000,
"total_views": 115150000
}
}
}
}
Create API Key
Generate a free API key. One key per email address. Starts on the Free plan (1 test request (lifetime)).
Request Body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Valid email address |
curl -X POST https://nixus.pro/api/v1/keys \ -H "Content-Type: application/json" \ -d '{"email": "dev@yourapp.com"}'
Usage
Check your current API usage, plan details, and remaining daily quota.
{
"data": {
"plan": "free",
"requests_today": 23,
"requests_total": 156,
"daily_limit": 100,
"platforms": ["youtube"],
"orbit_access": false
}
}
Plans
Get all available plans with pricing and feature details.
Pricing
Start free, upgrade when you need more.
Free
- 1 test request (lifetime)
- YouTube only
- Trends, Search, Videos
- Hashtag analytics
Starter
- 400 requests/day
- YouTube + TikTok
- Orbit deep search
- Email support
Pro
- 2,000 requests/day
- All 3 platforms
- AI analysis
- Priority support
Business
- 22,000 requests/day
- Webhook notifications
- Custom niches
- Dedicated support
Enterprise
- 40,000 requests/day
- White-label option
- Custom integrations
- SLA guarantee
Changelog
v1.0.0 - March 7, 2026
- Initial public beta release
- Endpoints: trends, hashtags, videos, search, orbit
- YouTube support (TikTok and Instagram coming soon)
- Free tier: 100 req/day, no credit card
- 5 pricing tiers from Free to Enterprise
Built by NIXUS. Questions? api@nixus.pro