# YouTube Hashtag Scraper (`w3crawler/youtube-hashtag-scraper`) Actor

Collect rich public video cards from one or more current YouTube hashtag pages.

- **URL**: https://apify.com/w3crawler/youtube-hashtag-scraper.md
- **Developed by:** [w3crawler](https://apify.com/w3crawler) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $2.99 / 1,000 hashtag videos

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

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

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

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

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## YouTube Hashtag Scraper

Collect rich public video and Shorts observations for one or more hashtags. The actor queries ordinary public YouTube search pages using the hashtag, parses embedded public page metadata, and avoids private clients, browser automation, and continuation endpoints.

### Input

| Field | Default | Description |
|---|---:|---|
| `hashtags` | — | Required; 1–20 tags, with or without `#`. |
| `limit` | `10` | Maximum unique records per hashtag, 1–50. |
| `countryCode` | `US` | Two-letter public page country context. |
| `locale` | `en-US` | Public page language-country locale. |
| `includeDiagnostics` | `true` | Emit exact four-field diagnostics for failed/empty pages. |
| `enableProxyFallback` | `true` | Try account-authorized Apify Proxy after direct access fails. |
| `requestDelayMs` | `250` | Delay between hashtag requests, 0–5000 ms. |
| `requestTimeoutSecs` | `60` | Public request timeout, 15–180 seconds. |
| `proxyConfiguration` | — | Optional standard Apify Proxy configuration; proxy URLs must be credential-free. |

Example:

```json
{
  "hashtags": ["music", "travel"],
  "limit": 10,
  "countryCode": "US",
  "locale": "en-US",
  "includeDiagnostics": true,
  "enableProxyFallback": true
}
```

Each dataset row includes the hashtag and rank, video/Short type, title, description and accessibility text, IDs and public URLs, thumbnails, displayed and parsed views, duration and seconds, channel identity, badges and verification flags, publication labels, query/page provenance, locale, parser metadata, and scrape time. The `OUTPUT` key-value record contains item counts, page coverage, proxy state, failures, and timings. Diagnostics contain only `url`, `error`, `errorCode`, and `scrapedAt`.

Run locally with `apify run --purge --input-file qa-inputs/youtube-hashtag-scraper/local-validation.json`, inspect `storage/datasets/default/`, and run `npm run validate-dataset`. Deploy with `apify push`, then verify direct and proxy cloud calls.

# Changelog

This Actor's version history is a separate document: https://apify.com/w3crawler/youtube-hashtag-scraper/changelog.md

# Actor input Schema

## `hashtags` (type: `array`):

One to 20 hashtags, with or without #.

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

Maximum unique public video/Short records per hashtag.

## `countryCode` (type: `string`):

Two-letter country code for public page localization.

## `locale` (type: `string`):

Language-country locale, for example en-US or fr.

## `includeDiagnostics` (type: `boolean`):

Store exact four-field diagnostics for failed or empty public pages.

## `enableProxyFallback` (type: `boolean`):

Try the configured account-authorized Apify Proxy route after direct access fails.

## `requestDelayMs` (type: `integer`):

Bounded delay between hashtag requests.

## `requestTimeoutSecs` (type: `integer`):

Timeout for one public page request.

## `proxyConfiguration` (type: `object`):

Optional standard Apify Proxy configuration. Proxy URLs must be credential-free.

## Actor input object example

```json
{
  "hashtags": [
    "music",
    "travel"
  ],
  "limit": 10,
  "countryCode": "US",
  "locale": "en-US",
  "includeDiagnostics": true,
  "enableProxyFallback": true,
  "requestDelayMs": 250,
  "requestTimeoutSecs": 60,
  "proxyConfiguration": {
    "useApifyProxy": false
  }
}
```

# Actor output Schema

## `dataset` (type: `string`):

No description

## `keyValueStore` (type: `string`):

No description

# 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 = {
    "hashtags": [
        "music",
        "travel"
    ],
    "limit": 10,
    "countryCode": "US",
    "locale": "en-US",
    "includeDiagnostics": true,
    "enableProxyFallback": true,
    "requestDelayMs": 250,
    "requestTimeoutSecs": 60,
    "proxyConfiguration": {
        "useApifyProxy": false
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("w3crawler/youtube-hashtag-scraper").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 = {
    "hashtags": [
        "music",
        "travel",
    ],
    "limit": 10,
    "countryCode": "US",
    "locale": "en-US",
    "includeDiagnostics": True,
    "enableProxyFallback": True,
    "requestDelayMs": 250,
    "requestTimeoutSecs": 60,
    "proxyConfiguration": { "useApifyProxy": False },
}

# Run the Actor and wait for it to finish
run = client.actor("w3crawler/youtube-hashtag-scraper").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 '{
  "hashtags": [
    "music",
    "travel"
  ],
  "limit": 10,
  "countryCode": "US",
  "locale": "en-US",
  "includeDiagnostics": true,
  "enableProxyFallback": true,
  "requestDelayMs": 250,
  "requestTimeoutSecs": 60,
  "proxyConfiguration": {
    "useApifyProxy": false
  }
}' |
apify call w3crawler/youtube-hashtag-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,w3crawler/youtube-hashtag-scraper"
        }
    }
}
```

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/HUEBfEBbF6s0yawfU/builds/l82dHPaEI2bD3yukq/openapi.json