Skip to main content
GET
/
usage
Get usage statistics
curl --request GET \
  --url https://api.vidnavigator.com/v1/usage \
  --header 'X-API-Key: <api-key>'
{
  "status": "success",
  "data": {
    "usage_period": {
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z"
    },
    "billing_period": {
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z"
    },
    "subscription": {
      "plan_id": "<string>",
      "plan_name": "<string>",
      "status": "<string>",
      "cancel_at_period_end": true
    },
    "credits": {
      "monthly_total": 123,
      "monthly_remaining": 123,
      "purchased": 123
    },
    "usage": {
      "video_transcripts": {
        "used": 123,
        "unit": "<string>"
      },
      "youtube_transcripts": {
        "used": 123,
        "unit": "<string>"
      },
      "video_searches": {
        "used": 123,
        "unit": "<string>"
      },
      "video_analyses": {
        "used": 123,
        "unit": "<string>"
      },
      "video_scene_analyses": {
        "used": 123,
        "unit": "<string>"
      },
      "video_uploads": {
        "used": 123,
        "unit": "<string>"
      }
    },
    "channels_indexed": {
      "used": 123,
      "limit": 123,
      "remaining": 123,
      "percentage": 123
    },
    "storage": {
      "used_bytes": 123,
      "used_formatted": "<string>",
      "limit_bytes": 123,
      "limit_formatted": "<string>",
      "remaining_bytes": 123,
      "remaining_formatted": "<string>",
      "percentage": 123
    },
    "generated_at": "2023-11-07T05:31:56Z"
  }
}
Retrieve your credit balances, resource usage counters, storage usage, and channel indexing metrics.

​
Overview

All API operations consume credits from a shared credit pool — there are no per-service limits. This endpoint gives you a complete picture of your account’s consumption and remaining capacity.

​
What’s Included

  • Credits: Monthly allocation, remaining balance, and purchased credits
  • Usage counters: Activity counts per resource type (informational, not individual limits)
  • Storage: Used vs. allocated storage
  • Channels indexed: Non-public YouTube channels indexed
  • Subscription details: Plan, billing period, and status

​
Example Request

curl "https://api.vidnavigator.com/v1/usage" \
  -H "X-API-Key: YOUR_API_KEY"

​
Success Response (200 OK)

{
  "status": "success",
  "data": {
    "usage_period": {
      "start": "2026-03-01T00:00:00Z",
      "end": "2026-04-01T00:00:00Z"
    },
    "billing_period": {
      "start": "2026-03-15T00:00:00Z",
      "end": "2026-04-15T00:00:00Z",
      "interval": "month"
    },
    "subscription": {
      "plan_id": "pro",
      "plan_name": "Voyager",
      "interval": "month",
      "status": "active",
      "cancel_at_period_end": false
    },
    "credits": {
      "monthly_total": 80,
      "monthly_remaining": 62.5,
      "purchased": 50
    },
    "usage": {
      "standard_request": { "used": 150 },
      "residential_request": { "used": 45 },
      "search_request": { "used": 30 },
      "analysis_request": { "used": 12 },
      "video_scene_analyses": { "used": 3 },
      "transcription_hour": { "used": 2.5, "unit": "hours" }
    },
    "channels_indexed": {
      "used": 5,
      "limit": 15,
      "remaining": 10,
      "percentage": 33.3
    },
    "storage": {
      "used_bytes": 2684354560,
      "used_formatted": "2.5 GB",
      "limit_bytes": 536870912000,
      "limit_formatted": "500 GB",
      "remaining_bytes": 534186557440,
      "remaining_formatted": "497.5 GB",
      "percentage": 0.5
    },
    "generated_at": "2026-03-28T10:00:00Z"
  }
}

​
Credits Object

FieldTypeDescription
monthly_totalnumber | "unlimited"Total monthly credits included in your plan
monthly_remainingnumber | "unlimited"Monthly credits remaining for the current period
purchasednumberAdditional purchased credits (persist across billing periods)
Enterprise plans return "unlimited" for monthly_total and monthly_remaining. The shared credit pool is what limits usage — individual service counters under usage are informational only and do not impose per-service caps.

​
Usage Counters

The usage object shows how many resource units were used during the current period. These are activity counters — the shared credit pool is what actually limits usage.
CounterDescription
standard_requestNon-YouTube transcripts and non-proxy scraper page fetches
residential_requestYouTube transcript retrievals and scraping requests that require residential proxies
search_requestVideo searches across YouTube or your own files
analysis_requestVideo/file analysis and AI extraction units
video_scene_analysesScene analysis requests
transcription_hourVideo/audio transcription hours processed by speech-to-text

​
Channels Indexed

A hard plan limit (not credit-gated). Shows how many non-public YouTube channels you have indexed vs. your plan’s capacity.

​
Error: No Subscription

If you don’t have an active subscription, the endpoint returns 404: 
{
  "status": "error",
  "error": "no_subscription",
  "message": "You are not subscribed to any plan."
}

Authorizations

​
X-API-Key
string
header
required

API key authentication. Include your VidNavigator API key in the X-API-Key header.

Response

Usage statistics retrieved successfully

​
status
enum<string>
Available options:
success
​
data
object

Usage statistics for the authenticated user. All API operations consume credits from a shared pool — there are no per-service limits.