# Officeworks Suggest API Documentation

<p><strong>Officeworks Suggest API Documentation</strong> Get public query suggestions for partial search text, with popularity, word count, hit counts and category facets. 1 credit per request. Failed requests are never billed.</p>

- **Documentation:** [https://scrappa.co/docs/officeworks-api/officeworks_suggest](https://scrappa.co/docs/officeworks-api/officeworks_suggest)
- **API group:** Officeworks API
- **Endpoint:** `GET https://scrappa.co/api/officeworks/suggest`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `query` | string | Yes | Partial search text, e.g. lap |
| `hitsPerPage` | integer | No | Suggestions to return, default 11 |

## Example response

```json
{
    "data": {
        "query": "lap",
        "nbHits": 10,
        "suggestions": [
            {
                "query": "laptop",
                "hitCount": 1200,
                "wordCount": 1,
                "categories": [],
                "popularity": 900
            }
        ]
    },
    "meta": {
        "credits": 1,
        "billable": true,
        "endpoint_family": "algolia_suggest"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | Supply a query. Failed requests are not billed. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)
