API reference / v1

Explore the signals.
Reveal the reference.

Browse anonymized metrics without spending reveal credits. Request one specific reference to unlock its identity and source metadata.

Download the OpenAPI specification ↗

1. Browse metrics for free

curl 'https://www.fanedit.com/api/v1/edits?limit=25' \
  -H "Authorization: Bearer $FANEDIT_API_KEY"

{
  "data": [{
    "reference": "fe_ref_...",
    "views_count": 420000,
    "comments_count": 820,
    "hashtags": ["movieedit"]
  }],
  "next_cursor": "fe_ref_...",
  "credits": 0
}

Example values illustrate the response shape. List responses omit video titles, source URLs, canonical video IDs, creator IDs, names and bios. References and cursors are encrypted and resource scoped. Do not try to construct a platform URL from a reference.

2. Reveal a specific record

curl 'https://www.fanedit.com/api/v1/edits?id=fe_ref_...' \
  -H "Authorization: Bearer $FANEDIT_API_KEY"

{
  "data": [{
    "video_id": "canonical-id-as-string",
    "caption": "The source post title or caption",
    "url": "https://www.tiktok.com/@creator/video/...",
    "creator": { "username": "creator", "display_name": "Creator" }
  }],
  "next_cursor": null,
  "credits": 1
}

A successful specific reveal consumes one credit. Validation, missing-record, authentication, rate-limit and failed-data responses consume no reveal credits. Repeated API reveals count again. The website’s reference library saves revealed records so you can re-open or export them without another charge.

Resources and filters

EndpointDiscovery signals
/api/v1/editsViews, comments, likes, shares, hashtags, platform and edit classification
/api/v1/creatorsVerification, follower and aggregate performance metrics
/api/v1/hashtagsHashtags and aggregate performance
/api/v1/soundsAggregate performance signals
/api/v1/communitiesLinked hashtag signals

All endpoints accept limit (1–100, default 25), cursor, and id. Use an opaque discovery reference as id for a specific full record. Edits additionally accept creator_id, platform, and format (edits or all). Format classification follows original hashtags. Configured official accounts are excluded.

Preserve next_cursor and filters for the next page. Cursors hide the underlying IDs. This is a live catalog rather than a fixed snapshot; later additions behind a cursor require a fresh traversal. No historical time series or true change feed is included in v1.

Allowances and billing

Free includes 5 reveals per week. Creator is $4.99/month with 50 weekly reveals; Creator Plus is $19.99/month with 200; Pro is $99/month with 1,000. All allowances reset Monday at 00:00 UTC, independently from monthly subscription billing. Credits do not roll over and there are no automatic overage charges.

Browsing is free in credits but rate limited for every plan. API reads and website reveals share one account allowance. Multiple keys do not multiply limits. A paid upgrade increases the current week’s ceiling while retaining consumption already recorded. Saved-reference CSV exports are free.

Responses include X-Quota-Remaining, X-Quota-Reset and X-Request-Id. Concurrent requests can show different remaining balances. A successful server response lost in transit still counts as a reveal.

400Invalid filter, cursor or reference
401Missing, invalid or revoked API key
404The requested specific record is unavailable
429Rate limit or weekly reveal allowance exhausted
503Service unavailable or not yet configured

Security, freshness and rights

Keep API keys on your server. Never embed them in browser code or query strings. Metrics reflect the catalog’s last observation without a guaranteed refresh schedule. The product supplies data and source links. Video files, private contact fields, campaign submissions, signed media URLs and raw provider records are excluded.

Studio agreements start at $1,499/month through enterprise contact. Bulk delivery, training and dataset redistribution require separately agreed scope and rights. Read the usage policy →

Start free or manage API keys ↗