Suggest search terms for a text start. Each suggestion names its kind (term, category or brand) and carries the category ID, the facet ID or the brand ID it points to. Use the IDs with search, brand_products and deals.
Run this endpoint
Endpoint
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.
string
Required
Text start. Alias: q.
samsung
integer
Optional
Number of suggestions, 1 to 10. Defaults to 10.
5
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
meta
query
brands
success
categories
suggestions
Common brands fields
name
brand_id
{
"meta": {
"duration_ms": 1500,
"upstream_calls": 2
},
"query": "samsung",
"brands": [
{
"name": "Samsung",
"brand_id": "1049"
}
],
"success": true,
"categories": [
{
"name": "Handys & Smartphones",
"category_id": "19116"
}
],
"suggestions": [
{
"kind": "category",
"term": "Samsung",
"label": "Samsung - in Handys & Smartphones",
"brand_id": null,
"location": "in Handys & Smartphones",
"filter_id": "1820730",
"category_id": "19116",
"is_trending": false
}
]
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
Returned when a required parameter is missing or a value is out of range. No credits are charged.
Not Found
Returned when idealo does not know the product, shop or page. No credits are charged.
Service Unavailable
Returned when idealo could not be read after several attempts. Failed requests are not charged. Try again.
Unexpected Response
Returned when idealo answers with a page this API cannot read. Failed requests are not charged.
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.