/twitter/ads/search

POST /api/twitter/ads/search

Price: 5 credits

Search X (Twitter) Ads Repository promoted tweets by advertiser, EU/EEA country and date range

How to use it

Search the X (Twitter) Ads Repository (EU/EEA ad transparency) for an advertiser's promoted tweets. Provide the advertiser handle (e.g. 'coinbase'), one or more EU/EEA countries, and a date range (start_date/end_date as YYYY-MM-DD). Each result is a promoted tweet shown in one country: tweet_id, line_item_id, account_id, country, advertiser, funding_instrument, approval_status, impression_count, reach_count and targeting. Coverage is limited to EU/EEA, as mandated by the DSA.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• advertiser string required — Advertiser handle (screen name) (examples: "coinbase", "Shopify"; minLength: 1)
• countries array — EU/EEA countries where the ads were shown (default: ["FR"]; one of: "AX", "AL", "AD", "AT", "BY", "BE", "BA", "BG", "HR", "CY", "CZ", "DK", "EE", "FO", "FI", "FR", "DE", "GI", "GR", "GG", "HU", "IS", "IE", "IM", "IT", "JE", "XK", "LV", "LI", "LT", "LU", "MK", "MT", "MD", "MC", "ME", "NL", "NO", "PL", "PT", "RO", "SM", "RS", "SK", "SI", "ES", "SJ", "SE", "CH", "UA", "GB", "VA"; minItems: 1)
• start_date string required — Start of the delivery range (YYYY-MM-DD) (examples: "2025-01-01")
• end_date string required — End of the delivery range (YYYY-MM-DD) (examples: "2026-06-22")
• count integer required — Max number of results (min: 1)

Response

• @type string (default: "TwitterAd")
• tweet_id string required
• line_item_id string nullable
• account_id string nullable
• country string nullable
• advertiser object nullable
  • @type string (default: "TwitterAdAccount")
  • name string nullable
  • is_deleted boolean (default: false)
• funding_instrument object nullable
  • @type string (default: "TwitterAdFundingInstrument")
  • type string nullable
  • currency string nullable
• approval_status string nullable
• impression_count integer nullable
• reach_count integer nullable
• targeting array (default: [])
  • @type string (default: "TwitterAdTargeting")
  • name string nullable
  • type string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Advertiser not found. Verify the handle. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.