# FreeReels API (`ezvidnet/freereels-api`) Actor

FreeReels API Actor wrapping Ezvid endpoints for feeds, search, details, episodes, HLS sources and subtitles.

- **URL**: https://apify.com/ezvidnet/freereels-api.md
- **Developed by:** [Ezvid.Net](https://apify.com/ezvidnet) (community)
- **Categories:** Videos, Social media, Other
- **Stats:** 1 total users, 0 monthly users, 35.7% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-usage

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## FreeReels API Actor

Apify Actor wrapping the FreeReels endpoints exposed by the Ezvid API.

### Endpoints

- `langs` — supported languages
- `home` — home tab list or home feed
- `tabs` — home tabs
- `tab` — tab payload; requires `id` (tab key)
- `foryou` — for-you feed
- `hotwords` — popular search titles
- `trending` — trending titles
- `search` — requires `query`
- `detail` — requires `id`
- `episodes` — requires `id`; returns episode metadata, HLS sources and subtitles

List endpoints support `language`, `category`, `limit`, `cursor` pagination internally and `maxPages` in Actor input. Authentication uses the `X-API-Key` header.

### Local development

```bash
npm install
cp .env.example .env
npm run lint
npm start
```

Set `FREEREELS_API_KEY` in `.env` or as an Apify Actor environment variable. Never commit the real key.

# Actor input Schema

## `action` (type: `string`):

Select a FreeReels API endpoint.

## `query` (type: `string`):

Required for search.

## `id` (type: `string`):

Required for tab, detail and episodes.

## `language` (type: `string`):

For example en, vi or id.

## `category` (type: `string`):

Optional category or section identifier.

## `limit` (type: `integer`):

Number of records per page.

## `maxPages` (type: `integer`):

Maximum cursor pages to fetch.

## `apiKey` (type: `string`):

Leave blank to use FREEREELS\_API\_KEY.

## Actor input object example

```json
{
  "action": "home",
  "limit": 20,
  "maxPages": 1
}
```

# Actor output Schema

## `results` (type: `string`):

All drama, episode, search and catalog records returned by the Actor.

## `runSummary` (type: `string`):

Summary of the completed run, stored under the OUTPUT key.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "action": "home"
};

// Run the Actor and wait for it to finish
const run = await client.actor("ezvidnet/freereels-api").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "action": "home" }

# Run the Actor and wait for it to finish
run = client.actor("ezvidnet/freereels-api").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "action": "home"
}' |
apify call ezvidnet/freereels-api --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,ezvidnet/freereels-api"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/5jewcJS19E3zZ5iX4/builds/LU1VEW2TlHWn5Jcbs/openapi.json