---
title: "Walk compact company ads"
method: POST
path: "/v1/facebook/ad-library/companies/ads"
tags: ["Meta Ads Library"]
---

# Walk compact company ads

`POST /v1/facebook/ad-library/companies/ads`

## Request

- Base URL: `https://api.scrapeatlas.com`
- URL: `https://api.scrapeatlas.com/v1/facebook/ad-library/companies/ads`
- Auth: API key in header `x-api-key`

Retrieve a page of advertiser archive records as a normalized ads array with compact records and continuation. Each successful request costs 1 account credit, including partial results. Failed requests cost 0 credits.

## Request body

- MetaAdsCompanyAdsRequestSchema
  - `pageId` string
  - `companyName` string
  - `country` string
  - `status` 'ALL' | 'ACTIVE' | 'INACTIVE'
  - `media_type` 'ALL' | 'IMAGE' | 'VIDEO' | 'MEME' | 'IMAGE_AND_MEME' | 'NONE'
  - `sort_by` 'total_impressions' | 'relevancy_monthly_grouped'
  - `language` string
  - `start_date` string
  - `end_date` string
  - `trim` 'true' | 'false'
  - `cursor` string

## Response `200`

Inspect the response status and failure or coverage fields.

- union
  - object
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `requestId` string, required
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_browser', required
      - `complete` boolean, required
      - `warnings` string[], required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `data` object, required
      - `lookupStatus` 'found', required
      - `query` string
      - `pageId` string
      - `companyName` string
      - `ads` object[], required
        - `id` string, required
        - `adId` string, nullable, required
        - `url` string, uri, required
        - `page` object, required
          - `id` string, nullable, required
          - `name` string, nullable, required
          - `url` string, nullable, required
          - `isDeleted` boolean, nullable, required
          - `profilePictureUrl` string, nullable, required
          - `likeCount` number, nullable, required
          - `categories` unknown[], required
            - unknown
        - `campaign` object, required
          - `collationId` string, nullable, required
          - `collationCount` number, nullable, required
        - `isActive` boolean, nullable, required
        - `publisherPlatforms` unknown[], required
          - unknown
        - `startedAt` string, date-time, nullable, required
        - `endedAt` string, date-time, nullable, required
        - `categories` unknown[], required
          - unknown
        - `countries` unknown[], required
          - unknown
        - `impressions` object, nullable, required
          - `text` string, nullable, required
          - `index` number, nullable, required
        - `spend` object, nullable, required
          - `amount` string, nullable, required
          - `currency` string, nullable, required
        - `creative` object, required
          - `bodyText` string, nullable, required
          - `title` string, nullable, required
          - `caption` string, nullable, required
          - `linkUrl` string, nullable, required
          - `linkDescription` string, nullable, required
          - `callToAction` string, nullable, required
          - `callToActionType` string, nullable, required
          - `displayFormat` string, nullable, required
          - `images` object[], required
            - `url` string, nullable, required
            - `resizedUrl` string, nullable, required
            - `watermarkedResizedUrl` string, nullable, required
          - `videos` object[], required
            - `hdUrl` string, nullable, required
            - `sdUrl` string, nullable, required
            - `previewImageUrl` string, nullable, required
          - `cards` object[], required
            - `title` string, nullable, required
            - `body` string, nullable, required
            - `caption` string, nullable, required
            - `linkUrl` string, nullable, required
            - `imageUrl` string, nullable, required
            - `videoUrl` string, nullable, required
      - `page` object, required
        - `nextCursor` string, nullable, required
        - `hasMore` boolean, required
        - `totalResultsEstimate` number, nullable, required
  - object
    - `success` false, required
    - `status` 'failed' | 'challenged', required
    - `requestId` string, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `failure` object, required
      - `code` 'invalid_request' | 'unauthorized' | 'not_found' | 'upstream_challenged' | 'upstream_rate_limited' | 'upstream_error' | 'unsupported_page' | 'restricted_page' | 'response_too_large' | 'unsafe_redirect' | 'request_limit' | 'timeout' | 'payload_too_complex' | 'busy' | 'transcription_unavailable' | 'transcription_failed' | 'transcription_too_long', required
      - `message` string, required

## Other responses

- `400`: Request could not complete; inspect error or failure.code.
- `401`: Request could not complete; inspect error or failure.code.
- `402`: Request could not complete; inspect error or failure.code.
- `403`: Request could not complete; inspect error or failure.code.
- `404`: Request could not complete; inspect error or failure.code.
- `408`: Request could not complete; inspect error or failure.code.
- `413`: Request could not complete; inspect error or failure.code.
- `429`: Request could not complete; inspect error or failure.code.
- `500`: Request could not complete; inspect error or failure.code.
- `502`: Request could not complete; inspect error or failure.code.
- `503`: Request could not complete; inspect error or failure.code.
- `504`: Request could not complete; inspect error or failure.code.

---

[API](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api.md) · [All operations](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/revisions/9ba049316894?raw)