# TikTok Hashtag Videos (`tiktok.hashtag_videos`)

Recent TikTok videos posted under a hashtag, with caption, creator, sound and view, like, comment and share counts.

Docs: https://primaryapi.com/docs/api-reference/tiktok/hashtag_videos

- Endpoint: `POST https://api.primaryapi.com/v1/run/tiktok.hashtag_videos`
- Category: Social · Platform: `tiktok` · Kind: list · Status: live
- Price: 3 credits per call; up to 8 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=tiktok.hashtag_videos`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `hashtag` | string | yes |  | max 100 chars | Hashtag without the # prefix (e.g. booktok); a leading # is ignored. |
| `limit` | integer | no | 20 | 1–20 | Maximum number of results to return (1-20, default 20). |
| `cursor` | string | no |  |  | Opaque pagination cursor: pass the previous response's nextCursor. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `items` | object[] |  |
| `items[].id` | string | TikTok video id (aweme_id) |
| `items[].url` | string \| null |  |
| `items[].text` | string \| null | Caption including hashtags |
| `items[].createdUtc` | string \| null |  |
| `items[].durationSeconds` | number \| null |  |
| `items[].hashtags` | string[] |  |
| `items[].image` | string \| null | Cover image (signed URL, expires) |
| `items[].likeCount` | integer \| null |  |
| `items[].commentCount` | integer \| null |  |
| `items[].shareCount` | integer \| null |  |
| `items[].collectCount` | integer \| null |  |
| `items[].playCount` | integer \| null |  |
| `items[].authorHandle` | string \| null |  |
| `items[].authorName` | string \| null |  |
| `items[].authorUserId` | string \| null |  |
| `items[].authorImage` | string \| null |  |
| `items[].authorVerified` | boolean \| null |  |
| `items[].authorFollowers` | integer \| null | Only when the source provides it |
| `items[].soundTitle` | string \| null |  |
| `items[].soundAuthor` | string \| null |  |
| `items[].soundClipId` | string \| null |  |
| `items[].videoUrl` | string \| null | Playable MP4 URL (signed, expires) |
| `items[].region` | string \| null |  |
| `nextCursor` | string \| null |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

Pagination: pass the previous response’s `nextCursor` as `cursor` to get the next page; `nextCursor: null` means there are no more results.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/tiktok.hashtag_videos" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"hashtag":"cooking","limit":20}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "items": [
        {
          "id": "string",
          "url": "https://example.com",
          "text": "string",
          "createdUtc": "string",
          "durationSeconds": 0,
          "hashtags": [
            "string"
          ],
          "image": "string",
          "likeCount": 0,
          "commentCount": 0,
          "shareCount": 0,
          "collectCount": 0,
          "playCount": 0,
          "authorHandle": "string",
          "authorName": "string",
          "authorUserId": "string",
          "authorImage": "string",
          "authorVerified": true,
          "authorFollowers": 0,
          "soundTitle": "string",
          "soundAuthor": "string",
          "soundClipId": "string",
          "videoUrl": "https://example.com",
          "region": "string"
        }
      ],
      "nextCursor": null
    }
  },
  "provider": "PrimaryAPI",
  "credits": 3,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
  "nextCursor": null
}
```

## Pricing and reliability

- Usual price: 3 credits per call
- Price ceiling: up to 8 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=tiktok.hashtag_videos`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

TikTok caps hashtag feeds (a few thousand posts) and may repeat videos across pages. Same vendor routes as tiktok.search_hashtag.

