Skip to content
Scrappa Get API key
Officeworks API 1 credit / request

Officeworks Suggest API Documentation

GET https://scrappa.co/api/officeworks/suggest

Officeworks Suggest API Documentation 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.

Officeworks Suggest API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/officeworks/suggest
Auth header
x-api-key
Cost
1 credit / request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "query": "lap",
        "nbHits": 10,
        "suggestions": [
            {
                "query": "laptop",
                "hitCount": 1200,
                "wordCount": 1,
                "categories": [],
                "popularity": 900
            }
        ]
    },
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

1 optional filter available.

query string Required

Partial search text, e.g. lap

Example value coffee shops
hitsPerPage integer Optional

Suggestions to return, default 11

Example value 10

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "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

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

Supply a query. Failed requests are not billed.

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.