Bing Suggestions API documentation for developers who need Bing query search suggestions as JSON. Scrappa's GET /api/bing/suggestions endpoint returns the completions Bing offers while a user types.
How to call the endpoint
Send a GET request to /api/bing/suggestions with a required query parameter and your Scrappa API key in the x-api-key header. The q alias is also accepted. Add mkt, cc and setlang to get the search suggestions of another market, for example German suggestions with mkt=de-DE.
Response fields
Each entry in suggestions (also returned as data) has text, type and sk when Bing sends them. The response also echoes query and market.
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.
4 optional filters available.
string
Required
The text to complete.
Example: pizza
coffee shops
string
Optional
Alias for query. Prefer query for new integrations.
coffee shops
string
Optional
Bing market, language and region together, for example de-DE or en-GB. Results, wording and dates follow the market.
Default: en-US
example
string
Optional
Two-letter country code, for example DE. Scrappa sends it together with mkt.
Default: the country of mkt
example
string
Optional
Interface language, for example de. Scrappa sends it together with mkt.
Default: the language of mkt
example
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
query
market
source
suggestions
results_on_page
Common data fields
sk
text
type
{
"data": [
{
"sk": null,
"text": "pizza hut",
"type": "FT"
},
{
"sk": "FT1",
"text": "pizza near me",
"type": "AS"
},
{
"sk": "FT1AS5",
"text": "pizza oven",
"type": "AS"
}
],
"query": "pizza",
"market": {
"cc": "US",
"mkt": "en-US",
"setlang": "en"
},
"source": "bing",
"suggestions": [
{
"sk": null,
"text": "pizza hut",
"type": "FT"
},
{
"sk": "FT1",
"text": "pizza near me",
"type": "AS"
},
{
"sk": "FT1AS5",
"text": "pizza oven",
"type": "AS"
}
],
"results_on_page": 3
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
The query is missing or too long, or mkt, cc or setlang is malformed.
{
"errors": {
"query": [
"The query field is required."
]
},
"message": "The request validation failed"
}Bing Temporarily Unavailable
Bing did not return usable data after the bounded retry on a second route. The request is not billed. Retry shortly.
{
"error": "Bing upstream is temporarily unavailable. Please retry shortly.",
"service": "BingVerticalsService",
"retryable": true,
"error_code": "bing_upstream_unavailable",
"failed_stage": "upstream_request"
}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.