> ## Documentation Index > Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt > Use this file to discover all available pages before exploring further. # TikTok ad API > Get a TikTok ad's details and reach. Call the TikTok ad API and get JSON back in one request. 1 credit per call. Failed calls cost nothing. Returns a TikTok ad's details and reach. The ad is identified by its URL or ID. ## Request Exactly one of `adUrl` or `adId` is required. A request that sets both, or none, fails with `invalidRequest`. ```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null} import { Stophy } from "stophy"; const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY }); const result = await stophy.tiktok.ads.ad({ adUrl: "https://library.tiktok.com/ads/detail?ad_id=1756783467412593" }); console.log(result.data); ``` ```python Python icon="python" theme={null} from stophy import Stophy stophy = Stophy() # reads STOPHY_API_KEY result = stophy.tiktok.ads.ad(ad_url="https://library.tiktok.com/ads/detail?ad_id=1756783467412593") print(result["data"]) ``` ```bash cURL icon="terminal" theme={null} curl -X POST https://api.stophy.dev/v1/tiktok/ads/ad \ -H "Authorization: Bearer $STOPHY_API_KEY" \ -H "content-type: application/json" \ -d '{"adUrl":"https://library.tiktok.com/ads/detail?ad_id=1756783467412593"}' ``` ```bash CLI icon="square-terminal" theme={null} stophy tiktok ads ad --adUrl "https://library.tiktok.com/ads/detail?ad_id=1756783467412593" ``` ## Response If successful, the response body contains the standard envelope. `data` contains the ad's advertiser, dates, reach and the countries it ran in. The following example is a real response, truncated: each list shows one item and long strings are cut. ```json theme={null} { "success": true, "data": { "adId": "1871322782235922", "adUrl": "https://library.tiktok.com/ads/detail/?ad_id=1871322782235922", "advertiserName": "adidas AG", "headline": "adidas Hyperboost Euphoria", "firstShownAt": "2026-07-30T00:00:00.000Z", "lastShownAt": "2026-07-30T00:00:00.000Z", "reachMin": 0, "reachMax": 1000, "videoUrl": "https://library.tiktok.com/api/v1/cdn/1791233253/video/aHR0cHM6Ly92NzcudGlrdG9rY2RuLmNvbS9mMWE4ZmZhNTczZjRjZmEwNDk0ZTk4…", "thumbnailUrl": "https://p16-common-sign.tiktokcdn.com/tos-alisg-p-0051c001-sg/ocWADVmTAmAiP6zVOz19NgNcBaIZEwYAlBniU~tplv-tiktokx-origin…", "imageUrls": ["https://p16-common-sign.tiktokcdn.com/tos-alisg-p-0051c001-sg/ocWADVmTAmAiP6zVOz19NgNcBaIZEwYAlBniU~tplv-tiktokx-origin…"], "advertiserId": "6885261436319171329", "advertiserCountry": "United Kingdom", "paidBy": "PHD INTERNATIONAL LIMITED", "linkUrl": "https://ad.doubleclick.net/ddm/clk/645481797;451468138;a?utm_source=tiktok&utm_medium=paid", "ctaText": "Learn more", "objective": "Video views", "category": "Apparel & Accessories", "audienceSizeMin": 2500000, "audienceSizeMax": 3000000, "impressionsMin": 0, "impressionsMax": 1000, "countries": ["DE"], "interests": "Men's Shoes, Fitness Training Supplies, Exercise & Fitness, Coffee, Gaming Devices, Sports & Fitness, Health &…", "regions": [ { "country": "DE", "impressionsMin": 0, "impressionsMax": 1000, "ages": ["18-24"], "genders": ["female", "male"] } ] }, "creditsUsed": 1, "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b" } ``` | Field | Type | Description | | - | - | - | | `firstShownAt` | string (ISO 8601) | The first day the ad was shown. | | `lastShownAt` | string (ISO 8601) | The last day the ad was shown. | | `reachMin` | integer | With `reachMax`, the range for the number of people the ad reached. | | `impressionsMin` | integer | With `impressionsMax`, the range for the number of times the ad was shown. | | `paidBy` | string | The entity that paid for the ad. | | `countries` | string\[] | The countries in which the ad was shown. | For every field, see the response schema on this page. ## Billing Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed. ## Pagination This method is not paginated. A single request returns the complete result. ## Related methods * [TikTok ads search](/api-reference/endpoint/tiktok-ads-search): Accepts the `advertiserName` as `advertiser`. Searches ads in the TikTok ad library. ## OpenAPI ````yaml api-reference/openapi.json POST /v1/tiktok/ads/ad openapi: 3.1.0 info: title: Stophy API version: '1' description: >- Every endpoint is a POST that takes its input as a JSON object body. Unknown fields are rejected with 400. Responses leave out empty values: null, empty strings, empty objects and empty nested lists are not sent. x-credits is what one call costs. Every call costs the same, whatever it returns, unless an operation's description says it costs per 10 results, or per second of audio. Then x-credits is the lowest price and x-credits-max the most one call can cost. Where an operation takes limit, send it to return fewer results and pay for fewer. When a response has a cursor, send it back unchanged with the same input to get the next page. When it has a page, send the next page number. servers: - url: https://api.stophy.dev security: - apiKey: [] paths: /v1/tiktok/ads/ad: post: summary: Get a TikTok ad's details and reach description: Costs 1 credit per call. operationId: tiktokAdsAd requestBody: required: true content: application/json: schema: type: object properties: adUrl: type: string description: >- Link to the TikTok ad, like https://library.tiktok.com/ads/detail?ad_id=1756783467412593. Send this or adId. adId: type: string description: TikTok ad id, like 1756783467412593. Send this or adUrl. sendOne: - adUrl - adId additionalProperties: false responses: '200': description: The data, and the credits this call used. headers: X-Request-ID: $ref: '#/components/headers/RequestId' x-credits-used: $ref: '#/components/headers/CreditsUsed' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' x-cache: $ref: '#/components/headers/Cache' x-cache-age: $ref: '#/components/headers/CacheAge' content: application/json: schema: type: object required: - success - data - creditsUsed - requestId properties: success: const: true data: type: object additionalProperties: false properties: adId: type: string adUrl: type: string format: uri advertiserName: type: string headline: type: string firstShownAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ lastShownAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ reachMin: type: integer minimum: -9007199254740991 maximum: 9007199254740991 reachMax: type: integer minimum: -9007199254740991 maximum: 9007199254740991 videoUrl: type: string format: uri thumbnailUrl: type: string format: uri imageUrls: type: array items: type: string format: uri advertiserId: type: string advertiserCountry: type: string paidBy: type: string linkUrl: type: string format: uri ctaText: type: string objective: type: string category: type: string audienceSizeMin: type: integer minimum: -9007199254740991 maximum: 9007199254740991 audienceSizeMax: type: integer minimum: -9007199254740991 maximum: 9007199254740991 impressionsMin: type: integer minimum: -9007199254740991 maximum: 9007199254740991 impressionsMax: type: integer minimum: -9007199254740991 maximum: 9007199254740991 countries: type: array items: type: string languages: type: array items: type: string interests: type: string regions: type: array items: type: object additionalProperties: false properties: country: type: string impressionsMin: type: integer minimum: -9007199254740991 maximum: 9007199254740991 impressionsMax: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ages: type: array items: type: string genders: type: array items: type: string required: [] required: - adUrl - imageUrls - countries - languages - regions creditsUsed: type: integer requestId: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' components: headers: RequestId: description: The request id. Quote it when you report a problem. schema: type: string CreditsUsed: description: Credits this call used. schema: type: integer RateLimitLimit: description: Requests allowed in the current window. schema: type: integer RateLimitRemaining: description: Requests left in the current window. schema: type: integer RateLimitReset: description: Unix time in seconds when the current window resets. schema: type: integer Cache: description: hit if this result came from the cache, miss if it was fetched live. schema: type: string CacheAge: description: Seconds since the returned result was written to the cache. schema: type: integer RetryAfter: description: Seconds to wait before retrying. schema: type: integer responses: Error: description: The request failed. retryable says whether trying again can help. headers: X-Request-ID: $ref: '#/components/headers/RequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Error: type: object required: - success - error properties: success: const: false error: type: object required: - code - message - retryable - requestId properties: code: type: string enum: - cliSessionCompleted - cliSessionExists - cliSessionNotFound - forbidden - insufficientCredits - internalError - inviteClaimed - inviteDisabled - inviteExpired - inviteUsedUp - invalidCliSession - invalidCliVerifier - invalidRequest - notFound - rateLimited - sourceChanged - sourceRefused - sourceTimeout - sourceUnavailable - tooManyInFlight - unauthorized - unsupportedMediaType message: type: string retryable: type: boolean retryAfterSeconds: type: integer requestId: type: string requiredCredits: type: number availableCredits: type: number billingUrl: type: string const: https://stophy.dev/billing securitySchemes: apiKey: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.