# TikTok Effect API

TikTok

Returns a TikTok camera effect or filter, TikTok's own or an Effect House creator's, from its link or ID. You get its name, icon and publish time, the creator's account (ID, handle, profile link, picture and secUid), and exact counts of the posts made with it and the views those posts drew.

GET `/v1/tiktok/effect`

## Example

cURL:

```shell
curl -G 'https://socialtap.dev/v1/tiktok/effect' \
  --data-urlencode 'url=https://www.tiktok.com/effect/Bold-Glamour-14519845' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
```

TypeScript SDK:

```typescript
import { SocialTap } from "socialtap";

const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY

const res = await client.tiktok.effect.get({ url: "https://www.tiktok.com/effect/Bold-Glamour-14519845" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
```

Node.js (fetch):

```javascript
const params = new URLSearchParams({
  url: "https://www.tiktok.com/effect/Bold-Glamour-14519845",
});
const res = await fetch(`https://socialtap.dev/v1/tiktok/effect?${params}`, {
  headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, meta } = body;
console.log(data, meta.credits_charged);
```

Python (requests):

```python
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/tiktok/effect",
    params={"url": "https://www.tiktok.com/effect/Bold-Glamour-14519845"},
    headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, meta = body["data"], body["meta"]
print(data, meta["credits_charged"])
```

Go (net/http):

```go
package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/url"
	"os"
)

func main() {
	q := url.Values{}
	q.Set("url", "https://www.tiktok.com/effect/Bold-Glamour-14519845")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/tiktok/effect?"+q.Encode(), nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer res.Body.Close()
	var body struct {
		Data  json.RawMessage `json:"data"`
		Meta  map[string]any  `json:"meta"`
		Error *struct {
			Code    string `json:"code"`
			Message string `json:"message"`
		} `json:"error"`
	}
	if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
		log.Fatal(err)
	}
	if body.Error != nil {
		log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
	}
	fmt.Println(string(body.Data), body.Meta["credits_charged"])
}
```

200 OK:

```json
{
  "data": {
    "approximate_fields": [],
    "creator": {
      "avatar_url": null,
      "display_name": "Effect Assistant",
      "id": null,
      "is_verified": null,
      "url": null,
      "username": null
    },
    "description": null,
    "icon_url": "https://lf16-effectcdn-us.tiktokcdn-us.com/obj/tiktok-loki-effect-oracle-tx/4712bb553f7a528d9e6ffeef6d943e82",
    "id": "14519845",
    "is_official": true,
    "media": [],
    "metrics": {
      "post_count": 304524339,
      "total_view_count": 72079393008
    },
    "name": "Bold Glamour",
    "platform": "tiktok",
    "platform_specific": {
      "tiktok": {
        "creator_sec_uid": null
      }
    },
    "published_at": "2023-02-24T10:32:30Z",
    "unknown_fields": [
      "media"
    ],
    "url": "https://www.tiktok.com/effect/-14519845"
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "tiktok",
    "source": "api",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 271,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": {
      "kind": "effect",
      "id": "14519845",
      "url": "https://www.tiktok.com/effect/-14519845"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}
```

> [!NOTE]
>
> **Good to know**
>
> - Counts are exact, as TikTok reports them: post_count is the effect page's videos figure, total_view_count the views of those posts.
> - TikTok's own effects name no account: creator has only the display name TikTok shows (Effect Assistant), and is_official is true.
> - A community creator comes with ID, handle and picture, but creator.display_name is null because the effect detail doesn't carry it (the TikTok Profile API has it).
> - Some effects have alias IDs, the same effect under a neighboring ID with the same name and post count: each answers under the ID you sent, with its own view count.
> - media is \[\] and listed in unknown_fields, because TikTok serves no preview of an effect logged out. The TikTok Effect Posts API returns the posts made with it.
> - An ID TikTok knows no effect by, or a retired effect, returns not_found.

## Authorizations

`x-api-key`stringheaderrequired

Your API key. [Authentication](https://socialtap.dev/docs/authentication/index.md)

## Query parameters

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `url` required | `string`<br>max 2,048 chars | A TikTok effect link (the effect page's tiktok.com/effect/Bold-Glamour-14519845, or the older tiktok.com/sticker/Bold-Glamour-14519845) or the effect's numeric ID (the number at the end of that link). Short share links (vm.tiktok.com/…) are not accepted: open one and send the link it lands on. | `https://www.tiktok.com/effect/Bold-Glamour-14519845` |

`url` takes TikTok effect links; another kind of link, or another platform's, fails free with [`invalid_input`](https://socialtap.dev/docs/errors/index.md#invalid_input). Unknown parameters are rejected with a suggestion, never ignored ([Requests](https://socialtap.dev/docs/requests/index.md)).

**Parameters every endpoint accepts**

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `max_age` optional | `integer`<br>min 0 | Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. | — |
| `fields` optional | `string` | Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments\[\].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole. | — |

## Response

### 200

`{data, meta}`. `data` is a [effect](https://socialtap.dev/resources/effect/index.md) object; `meta` describes the request ([meta](https://socialtap.dev/docs/reference/index.md#meta)). Fields only TikTok has are under `platform_specific.tiktok`.

| Field | Type | Description |
| --- | --- | --- |
| `data.platform` | `string` | Platform ID (tiktok, …). |
| `data.id` | `string` | Platform-native effect ID (string; TikTok's effect ID, the number ending its /effect/ link). |
| `data.url` | `string` (uri) | Canonical public page of the effect. |
| `data.name` | `string` | The effect's name as the platform shows it. |
| `data.description` | `string` or `null` | The creator's description of the effect; null when empty or not exposed. |
| `data.creator` | `object` | The account that made the effect. Fields are null where the platform names no account (TikTok's own effects show only a display name). |
| `data.creator.id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `data.creator.username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data.creator.display_name` | `string` or `null` | Display name shown on the profile. |
| `data.creator.url` | `string` (uri) or `null` | Canonical profile URL. |
| `data.creator.avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `data.creator.is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data.is_official` | `boolean` or `null` | True when the platform itself made the effect, false for an effect made by a community creator; null when not exposed. |
| `data.icon_url` | `string` (uri) or `null` | The effect's icon image URL. Platform CDN URLs can expire within hours. |
| `data.media` | `object[]` | Preview images and videos the platform shows of the effect in use; \[\] if none or not exposed. |
| `data.media[].type` | `string` | Kind of file. New values may be added; treat unknown values as other.<br>One of `image`, `video`, `audio`, `gif` |
| `data.media[].url` | `string` (uri) or `null` | Direct file URL; null when the platform withholds it, or when the link would only work from SocialTap's network or with a login. Often signed and expiring: see expires_at. |
| `data.media[].expires_at` | `string` (date-time) or `null` | When url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown or when it does not expire. |
| `data.media[].thumbnail_url` | `string` (uri) or `null` | Poster or preview image URL. |
| `data.media[].width` | `integer` or `null` | Width in pixels. |
| `data.media[].height` | `integer` or `null` | Height in pixels. |
| `data.media[].duration_ms` | `integer` or `null` | Duration in milliseconds (video and audio only). |
| `data.media[].alt_text` | `string` or `null` | Accessibility text provided by the author or platform. |
| `data.published_at` | `string` (date-time) or `null` | When the effect was published, RFC 3339 UTC. |
| `data.metrics` | `object` | Counts at fetch time; null = hidden or not exposed, 0 = zero. |
| `data.metrics.post_count` | `integer` or `null` | Public posts made with the effect, as the platform counts them (TikTok's "videos" figure on the effect page). |
| `data.metrics.total_view_count` | `integer` or `null` | Views across all posts made with the effect. |
| `data.platform_specific` | `object` | Fields only this platform has, under its ID (platform_specific.\<platform>); each null when unknown. |
| `data.platform_specific.tiktok` | `object` or `null` | A TikTok effect's own fields. |
| `data.platform_specific.tiktok.creator_sec_uid` | `string` or `null` | The creator's secUid, TikTok's account key that survives a rename; null for TikTok's own effects. |
| `data.approximate_fields` | `string[]` | JSON paths of values rounded by the platform or parsed from display text (e.g. metrics.post_count from "304.5M videos"). A list path (media) means the list may be incomplete. \[\] when all exact. |
| `data.unknown_fields` | `string[]` | JSON paths of lists whose \[\] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. \[\] when every list is known. |

not_found is item-level: the request was fine, the item can't be returned.

### 400

400 Bad Request: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `invalid_input` | 400 | No | A parameter is missing or malformed, or the link is not one this endpoint takes. | Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one. |

### 401

401 Unauthorized: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `unauthorized` | 401 | No | The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired. | Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url. |

### 402

402 Payment Required: 2 error codes. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `insufficient_credits` | 402 | No | The account does not have enough credits for this request. | Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically. |
| `spend_limit_reached` | 402 | No | The API key reached its spend limit for this period. The account may still have credits. | Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically. |

### 403

403 Forbidden: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `forbidden` | 403 | No | The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code. | Act on details.reason. suspended: contact [support](mailto:support@socialtap.dev). scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP. |

### 404

404 Not Found: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `not_found` | 404 | No | The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why). | Check the link or ID. Do not retry. |

### 429

429 Too Many Requests: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `rate_limited` | 429 | Yes, later | The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it. | Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask [support](mailto:support@socialtap.dev) to raise the ceiling; without an API key, send one. |

### 500

500 Internal Error: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `internal` | 500 | Yes, later | An unexpected error on SocialTap's side. | Retry with backoff. If it keeps happening, contact [support](mailto:support@socialtap.dev) with the request_id. |

### 502

502 Bad Gateway: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_error` | 502 | Yes, later | The platform failed, or answered with something we could not read. | Retry with backoff. Failed requests are free. |

### 503

503 Unavailable: 2 error codes. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_blocked` | 503 | Yes, later | The platform refused every attempt, our own retries included. | Retry later with backoff. Failed requests are free. |
| `overloaded` | 503 | Yes, later | SocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged. | Retry after the seconds in the retry-after header. Failed requests are free. |

## Pricing

From **1 credit** per request. Charged only for successful requests. Errors are free. The price depends on the source that produced the result, reported as `meta.source`.

| Source | Price per successful request | Per 1,000 requests |
| --- | --- | --- |
| Any source | 1 credit | $0.75–$1.97 |

**Balance, sources and what you were charged**

Your balance must be at least **1 credit** to start a request; with less, it is refused with [`insufficient_credits`](https://socialtap.dev/docs/errors/index.md#insufficient_credits) (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.

| meta.source | Source | What it means |
| --- | --- | --- |
| `api` | Platform API | The platform's public, logged-out API. |

`meta.credits_charged` and the `x-credits-charged` header show what you paid. [How credits work](https://socialtap.dev/docs/credits/index.md) · [Packs](https://socialtap.dev/pricing/index.md)

Endpoint ID `tiktok.effect` · operationId `tiktok.effect.get` · [Product overview](https://socialtap.dev/apis/tiktok/effect/index.md)

---

[HTML version](https://socialtap.dev/docs/reference/tiktok/effect/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)