> ## 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.
# LinkedIn search ads API
> Search ads in the LinkedIn ad library. Call the LinkedIn search ads API and get JSON back in one request. 1 credit per call. Failed calls cost nothing.
Searches ads in the LinkedIn ad library.
## Request
This method has no required parameters.
```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.linkedin.ads.search({ query: "software" });
console.log(result.data.results);
```
```python Python icon="python" theme={null}
from stophy import Stophy
stophy = Stophy() # reads STOPHY_API_KEY
result = stophy.linkedin.ads.search(query="software")
print(result["data"]["results"])
```
```bash cURL icon="terminal" theme={null}
curl -X POST https://api.stophy.dev/v1/linkedin/ads/search \
-H "Authorization: Bearer $STOPHY_API_KEY" \
-H "content-type: application/json" \
-d '{"query":"software"}'
```
```bash CLI icon="square-terminal" theme={null}
stophy linkedin ads search software
```
## Response
If successful, the response body contains the standard envelope. `data.results[]` contains the ads, each with its advertiser, text and images.
The following example is a real response, truncated: each list shows one item and long strings are cut.
```json theme={null}
{
"success": true,
"data": {
"results": [
{
"adId": "1585529084",
"adUrl": "https://www.linkedin.com/ad-library/detail/1585529084",
"creativeType": "SPONSORED_STATUS_UPDATE",
"format": "Single Image Ad",
"advertiserName": "SiteChief",
"advertiserAvatarUrl": "https://media.licdn.com/dms/image/v2/D560BAQH_lWh0hAuxAA/company-logo_100_100/B56aDOxwFkIQAI-/0/1790175543945/lifesafet…",
"text": "We’ve rebranded, LifeSafety.AI is now SiteChief.\nSame team. Same UK-built platform.\nA name that matches what customers …",
"headline": "AI Health & Safety Software for Workplace | SiteChief UK",
"imageUrls": ["https://media.licdn.com/dms/image/sync/v2/D4E27AQGrtnvrN16TKA/articleshare-shrink_1280_800/B4EaDEgSaVJoAg-/0/1790003193…"]
}
],
"total": 1418027,
"cursor": "1572358723-1791061893145"
},
"creditsUsed": 1,
"requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}
```
| Field | Type | Description |
| - | - | - |
| `cursor` | string | The pagination token. Pass it as `cursor` to retrieve the next page. Omitted on the last page. |
| `total` | integer | The total number of matching results, across all pages. |
For every field, see the response schema on this page.
Run dates, impressions and the paying entity are returned only by [LinkedIn ad details](/api-reference/endpoint/linkedin-ads-ad), and only for ads shown in the EU. To retrieve them, set an EU country.
## Optional parameters
| Parameter | Type | Description |
| - | - | - |
| `query` | string | Words to search for. |
| `advertiser` | string | Restricts results to ads from this advertiser. |
| `country` | string | The country to query, as a two-letter ISO 3166-1 code such as `us`. |
| `within` | string | Restricts results by recency. Acceptable values are `month`, `year` and `all`. If unset, defaults to `all`. |
| `cursor` | string | The pagination token from the previous response. |
## 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
Results are paginated. To retrieve the next page, pass the value of `data.cursor` as `cursor` in a subsequent request. A response that omits `cursor` is the last page.
## Related methods
* [LinkedIn ad details](/api-reference/endpoint/linkedin-ads-ad): Accepts `adUrl`. Returns a LinkedIn ad's details.
## OpenAPI
````yaml api-reference/openapi.json POST /v1/linkedin/ads/search
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/linkedin/ads/search:
post:
summary: Search ads in the LinkedIn ad library
description: Costs 1 credit per call. Pages with cursor.
operationId: linkedinAdsSearch
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
query:
type: string
maxLength: 500
advertiser:
type: string
maxLength: 500
country:
type: string
pattern: ^[A-Za-z]{2}$
description: >-
ISO 3166-1 alpha-2 country code, e.g. us. Any case is
accepted.
within:
default: all
type: string
enum:
- month
- year
- all
cursor:
type: string
minLength: 1
description: The cursor from the previous response. Send it as is.
additionalProperties: false
example:
query: software
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:
total:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
results:
type: array
items:
type: object
additionalProperties: false
properties:
adId:
type: string
adUrl:
type: string
format: uri
creativeType:
type: string
format:
type: string
advertiserName:
type: string
advertiserUrl:
type: string
format: uri
advertiserAvatarUrl:
type: string
format: uri
postedBy:
type: string
text:
type: string
headline:
type: string
imageUrls:
type: array
items:
type: string
format: uri
required:
- adUrl
cursor:
type: string
required:
- results
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.