GET /api/mydealz/mydealz.suggestions Returns public search suggestion sections and items from a partial query. Use it as a public source of deal ids before calling detail or comments.
Credits
A successful request costs 1 credit. Errors and challenges cost nothing. Clients are never rate limited.
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.
string
Required
Partial search query, 2 to 100 characters. Required.
iph
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
messages
validation
additional_data
{
"data": [],
"messages": [],
"validation": [],
"additional_data": {
"billable": true,
"credits_charged": 1,
"endpoint_family": "suggestions"
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Not Found
The deal does not exist. Non-billable.
{
"data": null,
"messages": [
"The deal was not found."
],
"additional_data": {
"billable": false,
"credits_charged": 0,
"endpoint_family": "suggestions"
}
}Validation Error
A query parameter is missing, unknown or invalid. Unknown parameters are rejected, never ignored. Non-billable.
{
"errors": {
"id": [
"The id field is required."
]
},
"message": "The request validation failed"
}Upstream Unavailable
The public source could not be reached or answered with a challenge. Retryable and never billed. Clients are never rate limited.
{
"data": null,
"messages": [
"MyDealz request failed."
],
"additional_data": {
"billable": false,
"credits_charged": 0,
"endpoint_family": "suggestions"
}
}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.