# Odysee on Onekey

> 9 endpoints for Odysee (9 stable, 0 beta), 1 to 5 credits each. Category: Video & streaming. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/odysee
Reference (Markdown): https://onekey.dev/docs/api/odysee.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 9 mapped Odysee endpoints return each:

- `author.id` (string): 9
- `author.username` (string): 9
- `content.createdAt` (ISO 8601 date): 9
- `content.text` (string): 9
- `author.displayName` (string): 8
- `content.id` (string): 6
- `content.title` (string): 5
- `engagement.shares` (integer): 5
- `media.durationSeconds` (number): 5
- `media.thumbnailUrl` (URL): 5
- `author.avatarUrl` (URL): 3
- `author.contentCount` (integer): 3
- plus 3 platform-specific fields under `ext.`

## Endpoints

### odysee.channel

Odysee channel by name (controlling claim): title, description, avatar, upload count.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/odysee/channel?name=Odysee` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `name` (string, required): Odysee channel name without @
- Fields returned: `author.id`, `author.username`, `author.displayName`, `content.text`, `author.avatarUrl`, `author.contentCount`, `content.createdAt`, `ext.canonical`
- Reference: https://onekey.dev/docs/api/odysee/channel.md

### odysee.channel_by_id

Odysee channel by claim id.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/odysee/channel_by_id?claim_id=80d2590ad04e36fb1d077a9b9e3a8bba76defdf8` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `claim_id` (string, required): Odysee claim id (40 hex chars)
- Fields returned: `author.id`, `author.username`, `author.displayName`, `content.text`, `author.avatarUrl`, `author.contentCount`, `content.createdAt`, `ext.canonical`
- Reference: https://onekey.dev/docs/api/odysee/channel_by_id.md

### odysee.channel_videos

Latest uploads of an Odysee channel.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/odysee/channel_videos?channel=%40Odysee%238` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `channel` (string, required): Odysee channel, e.g. @Odysee#8 (name, optional #claim-id prefix)
- Fields returned: `content.id`, `content.title`, `content.text`, `content.createdAt`, `media.thumbnailUrl`, `media.durationSeconds`, `author.id`, `author.username`, `author.displayName`, `engagement.shares`, `ext.canonical`
- Reference: https://onekey.dev/docs/api/odysee/channel_videos.md

### odysee.comments

Comments on an Odysee video (top-level, newest page).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/odysee/comments?claim_id=c379badf9dd8daf17faec5d2c664238e2ccb6683` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `claim_id` (string, required): Odysee claim id (40 hex chars)
- Fields returned: `content.id`, `content.text`, `content.createdAt`, `author.id`, `author.username`, `ext.pinned`, `ext.tips`
- Reference: https://onekey.dev/docs/api/odysee/comments.md

### odysee.search_channels

Search Odysee channels by text.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/odysee/search_channels?q=news` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search text
- Fields returned: `author.id`, `author.username`, `author.displayName`, `content.text`, `author.avatarUrl`, `author.contentCount`, `content.createdAt`, `ext.canonical`
- Reference: https://onekey.dev/docs/api/odysee/search_channels.md

### odysee.search_videos

Search Odysee videos by text.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/odysee/search_videos?q=linux` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search text
- Fields returned: `content.id`, `content.title`, `content.text`, `content.createdAt`, `media.thumbnailUrl`, `media.durationSeconds`, `author.id`, `author.username`, `author.displayName`, `engagement.shares`, `ext.canonical`
- Reference: https://onekey.dev/docs/api/odysee/search_videos.md

### odysee.tag_videos

Odysee videos with a given tag, newest first.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/odysee/tag_videos?tag=linux` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `tag` (string, required): Odysee tag
- Fields returned: `content.id`, `content.title`, `content.text`, `content.createdAt`, `media.thumbnailUrl`, `media.durationSeconds`, `author.id`, `author.username`, `author.displayName`, `engagement.shares`, `ext.canonical`
- Reference: https://onekey.dev/docs/api/odysee/tag_videos.md

### odysee.trending

Trending videos on Odysee right now.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/odysee/trending` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `content.id`, `content.title`, `content.text`, `content.createdAt`, `media.thumbnailUrl`, `media.durationSeconds`, `author.id`, `author.username`, `author.displayName`, `engagement.shares`, `ext.canonical`
- Reference: https://onekey.dev/docs/api/odysee/trending.md

### odysee.video

A single Odysee video/claim by claim id.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/odysee/video?claim_id=864291658b95336bdadbd92190ce3172d8bf2342` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `claim_id` (string, required): Odysee claim id (40 hex chars)
- Fields returned: `content.id`, `content.title`, `content.text`, `content.createdAt`, `media.thumbnailUrl`, `media.durationSeconds`, `author.id`, `author.username`, `author.displayName`, `engagement.shares`, `ext.canonical`
- Reference: https://onekey.dev/docs/api/odysee/video.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/odysee/channel?name=Odysee" \
  -H "x-api-key: YOUR_API_KEY"
```