> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration. ## This page - **On-site (HTML):** - **Markdown (.mdx) URL:** ## API base URL and authentication - **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev` - **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route). - **OpenAPI JSON:** ## Recommended docs entrypoints (this site) - [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown). - [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope. - [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`. - [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages. - [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples. - [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths. - [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install. - [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 910 endpoint tools, plus docs_search/docs_read for implementation help. - [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples. - [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start. - [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog. - [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI). - [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls). - [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist. - [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping. - [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages. - [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance. - [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs. - Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract. ## Markdown docs convention - Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`). - Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`). - Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`). --- # Search Vimeo channels (https://www.socialfetch.dev/docs/api/v1/vimeo/channels/search/get) ## Summary Search Vimeo channels by term. **Tags:** `Vimeo` ## HTTP - **Method:** GET - **Path:** `/v1/vimeo/channels/search` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.vimeo.searchChannels({ query: "cats", limit: 25 })` - **Accepted identifiers:** `query` (query) - **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore` ## Credits - **Base:** 1 credit per successful lookup. - **Maximum on success (200):** 1 credit. - **Failed requests (`lookup_failed`, `503`):** not charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `query` (query) - **Required:** yes - **Constraints:** type `string`; minLength: 1; maxLength: 200 - **Description:** Search term, e.g. `cats`. ### `page` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1; maximum: 20000 - **Description:** Page number, 1-20000. Default: 1. Use `page.nextCursor` to continue; a page past the last is an empty page. ### `limit` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1; maximum: 100 - **Description:** Rows per page, 1-100. Default: 25. ### `cursor` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 512 - **Description:** Opaque cursor, 1 to 512 characters. Pass `page.nextCursor` from the previous response to get the next page; omit it to start at the first page. It is tied to the other filters. ## Pagination This endpoint uses **cursor-based pagination** via the `cursor` query parameter. - Read **hasMore** from `data.page.hasMore`. - When that value is `true`, read **nextCursor** from `data.page.nextCursor` and pass it as the `cursor` query parameter on the **next** request (URL-encode when building a query string). - Omit `cursor` on the **first** request. - Stop when **hasMore** is `false` or **nextCursor** is null (end of list). ## Responses (status codes) - **200**: A page of channel search results. - **400**: Invalid request - **401**: Missing or invalid API key - **402**: Insufficient credits - **500**: Unexpected or billing error - **502**: Lookup could not be completed. - **503**: Service temporarily unavailable; safe to retry with backoff. ## Response body (200) A page of channel search results. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **channels** (required) — type `array`. Channels, in order. - _items:_ - **id** (required) — type `integer`; minimum: 0. Channel id. - **name** (required) — type `string`; nullable. Channel name. - **description** (required) — type `string`; nullable. Description as plain text. - **logo** (required) — type `string`; nullable. Channel logo. - **badge** (required) — type `string`; nullable. Badge text; empty when the channel has none. - **url** (required) — type `string`; nullable. Channel page URL. - **createdAt** (required) — type `string`; nullable. When the channel was created, in UTC. - **updatedAt** (required) — type `string`; nullable. When the channel was last changed. - **creator** (required) — type `object`; nullable. The user who created a channel or group. - **counts** (required) — type `object`. Counts for the channel. - **tags** (required) — type `array`. Tags on Vimeo. - _items:_ - type `string` - **categories** (required) — type `array`. Vimeo category names. - _items:_ - type `string` - **total** (required) — type `integer`; minimum: 0; nullable. Total matches Vimeo reports, when it does. - **page** (required) — type `object`. Pagination state for the current page. A short page is not the end: hasMore says whether another page exists. - **page** (required) — type `integer`; minimum: 0. Current page number (1-based). - **perPage** (required) — type `integer`; minimum: 0; nullable. Rows per page, when fixed; otherwise null. - **total** (required) — type `integer`; minimum: 0; nullable. How many rows match; null when no total is available. Vimeo's totals drift between pages. - **hasMore** (required) — type `boolean`. Whether another page is available. A page can be shorter than `perPage` when a row is unavailable. - **nextCursor** (required) — type `string`; nullable. Opaque cursor for the next request; null on the last page or an empty page. - **truncated** (optional) — type `boolean`. True when Vimeo stops this list before its end, so more rows exist beyond the last page. - **meta** (required) — type `object`. Metadata describing the request and billing outcome. - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call. - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request. - **version** (required) — type `string`; enum: v1. Public API version that served the response. ### Example JSON (found) ```json { "data": { "channels": [ { "id": 8237, "name": "Film School - Filmmaking", "description": "http://tommyrodriguezfilms.com/\nThis is the free Film School of www.cinemacuteo.com which are published videos tutorials to make your film projects, from the special effects, to the steadycam, lights, cranes. Filmmaking demystifies. Also visit the free Film School Group at: http://www.vimeo.com/groups/filmschool\nSubs…", "logo": "https://i.vimeocdn.com/video/824046256-886f128c297031d32de361f086a809ea72b6532b6cf77288387c4f5e3332da64-d?region=us", "badge": null, "url": "https://vimeo.com/channels/filmschool", "createdAt": "2008-04-14T04:25:43.000Z", "updatedAt": "2026-10-27T16:08:54.000Z", "creator": { "id": 324433, "name": "Tommy Rodriguez", "url": "https://vimeo.com/tommyrodriguez" }, "counts": { "videos": 1057, "subscribers": 87676 }, "tags": [ "dslr" ], "categories": [ "Cameras & Techniques" ] } ], "total": 29007, "page": { "page": 1, "perPage": 5, "total": 29007, "hasMore": true, "nextCursor": "eyJwIjoyLCJmIjoiZTE0ZDQzOWFiZGEyN2ViMzljNjkifQ" } }, "meta": { "requestId": "req_8f26dfdc-eb9f-4837-81c3-136e871a8ed6", "creditsCharged": 1, "version": "v1" } } ``` ### Machine-readable error codes When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime): - `bad_request` ## Error handling & retries Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status. - **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help. - **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help. - **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help). - **500**: Unexpected or billing error - **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable. - **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter. ### Suggested client defaults - Send the API key using the `x-api-key` header on every request. - On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user. - On `402`, surface an actionable billing message rather than blind retries. ## Examples ### TypeScript SDK ```typescript import { SocialFetchClient } from "@socialfetch/sdk"; const client = new SocialFetchClient({ apiKey: process.env.SOCIALFETCH_API_KEY!, }); const result = await client.vimeo.searchChannels({ query: "cats", }); if (!result.ok) { console.error(result.error); } else { console.log(result.value.data); } ``` ### Node.js ```javascript const response = await fetch( "https://api.socialfetch.dev/v1/vimeo/channels/search?query=cats", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/vimeo/channels/search?query=cats" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/vimeo/channels/search?query=cats", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ``` ### Example: next page (pagination) After a successful response, if pagination is not finished, request the next page using `cursor` (URL-encode when composing the query string): ```javascript const previous = await response.json(); const nextCursor = previous?.data?.page?.nextCursor; const hasMore = previous?.data?.page?.hasMore; if (!hasMore || nextCursor == null) { // no more pages } else { const nextUrl = new URL("https://api.socialfetch.dev/v1/vimeo/channels/search"); nextUrl.searchParams.set("cursor", nextCursor); // optionally preserve sort: nextUrl.searchParams.set("sortBy", "latest"); const nextResponse = await fetch(nextUrl.toString(), { headers: { "x-api-key": "YOUR_API_KEY" }, }); const nextData = await nextResponse.json(); } ```