Facebook API Capability

Search Ads Library

Searches the Facebook Ads Library for active and inactive ads by advertiser or keyword.

Capability ID facebook.ads-library.search

Cost 1 credit per request

Maximum runtime 120 seconds

# Search Ads Library

Searches the Facebook Ads Library for active and inactive ads by advertiser or keyword.

- Platform: [Facebook](https://docs.upscrape.com/docs/platforms/facebook)
- Capability ID: `facebook.ads-library.search`
- Cost: 1 credit per request
- Maximum runtime: 120 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl -X POST https://data.upscrape.com/execute \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":{"query":"Meta AI"},"capability":"facebook.ads-library.search"}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `cursor` | `string` | No | Pagination cursor from previous response |
| `limit` | `integer` | No | Maximum number of results to return |
| `query` | `string` | Yes | Search query string |

### Example input

```json
{
  "query": "Meta AI"
}
```

## Response

Successful output is returned in `results[0].data`. Raw platform output is intentionally open-ended and may evolve with the upstream source.

No committed sample output is available for this capability.


## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

See [jobs and results](https://docs.upscrape.com/docs/api/jobs), [errors and retries](https://docs.upscrape.com/docs/api/errors), and [idempotency](https://docs.upscrape.com/docs/api/idempotency).

## Machine-readable contract

- [Capability OpenAPI 3.1](https://docs.upscrape.com/docs/platforms/facebook/facebook.ads-library.search/openapi.json)
- [Platform OpenAPI 3.1](https://upscrape.com/scrapers/facebook/openapi.json)
- [Focused coding-agent prompt](https://upscrape.com/scrapers/facebook/capabilities/facebook.ads-library.search/llm.md)

POST /execute Shared execution endpoint

Input parameters

Field	Type	Required	Description
`cursor`	`string`	Optional	Pagination cursor from previous response
`limit`	`integer`	Optional	Maximum number of results to return
`query`	`string`	Required	Search query string

Response

Successful output is returned in results[0].data. Raw platform output is intentionally open-ended and may evolve with the upstream source.

No committed sample output is available for this capability yet.

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

Resources

OpenAPI 3.1 Markdown Platform OpenAPI

curl -X POST https://data.upscrape.com/execute \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"input":{"query":"Meta AI"},"capability":"facebook.ads-library.search"}'

const response = await fetch("https://data.upscrape.com/execute", { method: "POST", headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", }, body: JSON.stringify({"input":{"query":"Meta AI"},"capability":"facebook.ads-library.search"}), }); console.log(await response.json());

import requests response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", }, json={"input":{"query":"Meta AI"},"capability":"facebook.ads-library.search"}, ) print(response.json())