# Facebook Page Search (`facebook.search_pages`)

Search Facebook pages by keyword, optionally near a place, and get page profiles with category, followers and contact fields.

Docs: https://primaryapi.com/docs/api-reference/facebook/search_pages

- Endpoint: `POST https://api.primaryapi.com/v1/run/facebook.search_pages`
- Category: Social · Platform: `facebook` · Kind: search · Status: live
- Price: 6.25 credits per result, at least 8 credits a call. Every call costs the same, including calls that were retried automatically.
- Billing unit: per result returned, rounded up to whole credits per call (a call that returns nothing costs nothing)
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=facebook.search_pages`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `query` | string | yes |  | max 500 chars | Keyword or category to search Facebook pages for (e.g. "coffee roasters"). |
| `location` | string | no |  | max 100 chars | Optional free-text place to narrow the search: a city, region or country (e.g. "Berlin"). |
| `limit` | integer | no | 10 | 1–10 | Maximum number of pages to return (1-10, default 10). Billed per page returned, so a lower limit costs less. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `items` | object[] |  |
| `items[].id` | string \| null | Facebook page id |
| `items[].title` | string \| null | Page name |
| `items[].url` | string \| null |  |
| `items[].image` | string \| null | Profile picture URL |
| `items[].category` | string \| null | Primary category |
| `items[].categories` | string[] |  |
| `items[].about` | string \| null | Intro / description text |
| `items[].followers` | integer \| null |  |
| `items[].likes` | integer \| null |  |
| `items[].phone` | string \| null |  |
| `items[].website` | string \| null |  |
| `items[].owner` | string \| null | Owner name when the source shows it |
| `items[].pageAlias` | string \| null | Vanity alias from the page URL |
| `items[].adLibraryPageId` | string \| null |  |
| `items[].adStatus` | string \| null | Ad status sentence, e.g. "This Page is not currently running ads." |
| `items[].coverPhotoUrl` | string \| null |  |
| `items[].createdUtc` | integer \| null | Page creation date, Unix seconds (UTC midnight) |
| `items[].verified` | boolean \| null |  |
| `nextCursor` | string \| null |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/facebook.search_pages" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"coffee roasters","location":"Berlin","limit":3}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "items": [
        {
          "id": "string",
          "title": "string",
          "url": "https://example.com",
          "image": "string",
          "category": "string",
          "categories": [
            "string"
          ],
          "about": "string",
          "followers": 0,
          "likes": 0,
          "phone": "string",
          "website": "string",
          "owner": "string",
          "pageAlias": "string",
          "adLibraryPageId": "string",
          "adStatus": "string",
          "coverPhotoUrl": "https://example.com",
          "createdUtc": 0,
          "verified": true
        }
      ],
      "nextCursor": null
    }
  },
  "provider": "PrimaryAPI",
  "credits": 8,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
  "nextCursor": null
}
```

## Pricing and reliability

- Usual price: 6.25 credits per result, at least 8 credits a call
- Price ceiling: the usual price, even when a call is retried. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=facebook.search_pages`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

Priced per page returned plus a small per-call base fee that covers the actor start event.

