# odysee.comments

**stable** **Advanced**

Comments on an Odysee video (top-level, newest page).

`GET /v1/odysee/comments`

## 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

| Name | Type | Required | Default | What it is | Constraints |
| --- | --- | --- | --- | --- | --- |
| `claim_id` | string | yes | (required) | Odysee claim id (40 hex chars) | max 40 chars; must match `[0-9a-f]{40}`; trimmed, lowercased |

## Request

```bash
curl "https://api.onekey.dev/v1/odysee/comments?claim_id=c379badf9dd8daf17faec5d2c664238e2ccb6683" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/odysee/comments",
    params={"claim_id": "c379badf9dd8daf17faec5d2c664238e2ccb6683"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ claim_id: "c379badf9dd8daf17faec5d2c664238e2ccb6683" });
const res = await fetch(`https://api.onekey.dev/v1/odysee/comments?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## 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": [
    {
      "content": {
        "id": "d84bb7ca77bdba2a6fa5dbbbeaa95a96ef3c6533d669612b3f3c39e7c0a87845",
        "text": "Radio Quebec 28-09-2026 L'aigle et le Dragon - Alexis Cossette Trudel - Les webjournaux sont gratuits, mais Radio-Québec ne peut survivre sans votre soutien.\n1 - L'#Ormuz médiatique de Trump contre les médias\n2 - ONU: Trump défenseur de la #chrétieneté et de la souveraineté\n3 - L'Entente Trump-Xi: Paix et Prospérité\n4 - Réforme de l'UE: Rien d'impossible\n\nLIENS OFFICIELS d'Alexis !!!! Abonnez vous et si vous pouvez soutenez ou partagez...\nhttps://radioquebec.tv/\net YOUTUBE \"Radio-Québec Inc.\" https://www.youtube.com/channel/UCxLJZvb6-tlvk5Lq_vyETOQ\net https://x.com/alexis_cossette\net https://odysee.com/@Radio-Quebec:a\net https://rumble.com/user/RadioQuebec plus besoin de VPN en France depuis qques temps\net https://www.gettr.com/user/radioquebec\net https://crowdbunker.com/@Radio-Quebec (MANQUAIT dans la description du site d'Alexis !)\net https://t.me/radio_quebec\net https://truthsocial.com/@RadioQuebec\n***********************************************************\nRadio-Québec ne peut exister sans votre soutien (merci aux contributeurs):\nhttps://www.radioquebec.tv/#sociofinancement\n",
        "createdAt": "2026-09-28T11:57:42Z"
      },
      "author": {
        "id": "d943f08cffcc54c3fa57f3d1ff78aef3de1d9108",
        "username": "@WakeUp"
      },
      "ext": {
        "pinned": false,
        "tips": 0
      }
    }
  ],
  "metadata": {
    "platform": "odysee",
    "endpoint": "comments",
    "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](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `comment_id` | `content.id` | - |
| `comment` | `content.text` | - |
| `timestamp` | `content.createdAt` | `toIsoDate` |
| `channel_id` | `author.id` | - |
| `channel_name` | `author.username` | - |
| `is_pinned` | `ext.pinned` | `toBoolean` |
| `support_amount` | `ext.tips` | `toNumber` |

## 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

| Status | Code | What to do |
| --- | --- | --- |
| 401 | `unauthorized` | Check the `x-api-key` header. |
| 402 | `insufficient_credits` | [Add credits](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | Unknown endpoint path. |
| 422 | `invalid_params` | Fix the parameters using the table above. Free. |
| 429 | `rate_limited` | Wait `Retry-After` seconds, then retry. |
| 502 | `upstream_error` | The source failed. Refunded; retry with backoff. |

See [Errors](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).
