Docs
View as Markdown

odysee.search_channels

stable Advanced

Search Odysee channels by text.

GET /v1/odysee/search_channels

What you get#

A list of Odysee results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

  • Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
qstringyes(required)Search textmax 100 chars; must match [^\x00-\x1f]{1,100}; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/odysee/search_channels?q=news" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Odysee response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "author": {
        "id": "3ee49390d7ae6bdf781011e9f869d5c2bf941d32",
        "username": "@usa",
        "displayName": "Make America Great Again",
        "avatarUrl": null,
        "contentCount": 2
      },
      "content": {
        "text": null,
        "createdAt": "2021-10-21T20:12:00Z"
      },
      "ext": {
        "canonical": "lbry://@usa#3ee"
      }
    },
    {
      "author": {
        "id": "b65c2697c93190787724e2caea04843d221c7861",
        "username": "@UnknownSoldiersofImamZaman",
        "displayName": "\"Real news that is happening in the Middle East world\"",
        "avatarUrl": null,
        "contentCount": 0
      },
      "content": {
        "text": "\"Stay updated with the real news unfolding in the Middle East! 🌍 From escalating tensions in Gaza and Israel’s bold strikes in Qatar to Iran’s strategic moves and regional shifts, we dive deep into the unfiltered truth. No mainstream spin, just facts from the ground. 📰 Join us to explore the latest developments shaking the region, including exclusive insights you won’t find elsewhere. Subscribe now, hit the bell 🔔, and share your thoughts in the comments! Let’s uncover what’s really happening in the Middle East. #MiddleEastNews #RealTalk #RumbleViral\"",
        "createdAt": "2025-09-15T18:41:20Z"
      },
      "ext": {
        "canonical": "lbry://@UnknownSoldiersofImamZaman#b"
      }
    }
  ],
  "metadata": {
    "platform": "odysee",
    "endpoint": "search_channels",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
claim_idauthor.id-
nameauthor.username-
value.titleauthor.displayName-
value.descriptioncontent.text-
canonical_urlext.canonical-
value.thumbnail.urlauthor.avatarUrlsafeUrl
meta.claims_in_channelauthor.contentCounttoNumber
timestampcontent.createdAttoIsoDate

Caching and freshness#

  • Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
  • Between 2 minutes and 15 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
  • A "not found" is remembered for 1 minute and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).