Skip to main content
POST
ads.library.search

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
platform
enum<string>
required

Which public ad archive to search.

Available options:
meta,
linkedin,
google
query
string

Keywords, in the ads' own language. Needed unless advertiser or domain is given.

Required string length: 1 - 100
advertiser
string

Professional-network archive only: the advertiser (page) name.

Required string length: 1 - 100
domain
string

The advertiser's website domain, e.g. figma.com, to search by who runs the ads.

Required string length: 1 - 253
countries
string[]

Two-letter country codes of the markets the ads reached, like DE. Up to 50.

Maximum array length: 50
Pattern: ^[A-Za-z]{2}$
accountId
string

Professional-network archive only, and required there unless domain is given: a connected account from social.accounts.list.

Required string length: 1 - 256
limit
number

How many ads to return, 1 to 25. Default 10.

Required range: x >= 1
cursor
string

The nextCursor of the previous page, to get the next one.

Required string length: 1 - 1024

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.