/odysee/videos/search

POST /api/odysee/videos/search

Price: 5 credits

Search Odysee Videos

How to use it

Search Odysee videos by keyword, by relevance or by release date, optionally limited to today, this week, this month or this year. Mature-tagged results are excluded. Rows are full video records with the publishing channel.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Search query (examples: "bitcoin"; minLength: 1)
• count integer required — Max result count (examples: 50; min: 1; max: 500)
• sort string — Result order: relevance, newest, or oldest first (default: "relevance"; one of: "relevance", "newest", "oldest")
• upload_date string nullable — Only videos released within this window (one of: "today", "thisweek", "thismonth", "thisyear")

Response

• @type string (default: "OdyseeVideo")
• id string required
• alias string required
• url string nullable
• lbry_url string nullable
• permanent_url string nullable
• description string nullable
• image string nullable
• tags array (default: [])
• languages array (default: [])
• license string nullable
• stream_type string nullable
• media_type string nullable
• duration_seconds integer nullable
• width integer nullable
• height integer nullable
• size_bytes integer nullable
• published_at integer nullable
• created_at integer nullable
• fee_amount number nullable
• fee_currency string nullable
• effective_amount number nullable
• support_amount number nullable
• repost_count integer nullable
• channel object nullable
  • @type string (default: "OdyseeChannelRef")
  • id string required
  • alias string nullable
  • url string nullable
  • image string nullable
• is_channel_signature_valid boolean nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.