Shop.app API endpoint
Use Crawlora's Suggest products and collections inside a Shop.app shop API to extract supported public Shop.app data as structured JSON. This page includes request parameters, cURL examples, response schema, error behavior, credit cost, and a Playground link for testing before integration.
/shop-app/shops/{handle}/typeaheadReturns public store typeahead suggestions for a Shop.app merchant profile. Developers commonly use this endpoint for data enrichment, monitoring, research dashboards, internal automation, and agent-native workflows that need repeatable structured public web data. Authentication uses the documented Crawlora headers, and usage is metered with the credit cost shown on this page.
Request parameters are generated from the active endpoint catalog. Required values must be sent before Crawlora can call the upstream public web data source.
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| handle (path) | string | Yes | Shop handle | marcnolan | |
| query | string | Yes | Typeahead query | loafer | |
| limit | integer | No | 20 and supports up to 20 | Maximum suggestions, defaults to 20 and supports up to 20 | 20 |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/shop-app/shops/marcnolan/typeahead?query=loafer&limit=20" \ -H "x-api-key: $CRAWLORA_API_KEY"
Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
| Plan | Price | Included credits | Daily cap | Rate limit | Overage |
|---|---|---|---|---|---|
| Free | $0/mo | 2,000 | 500 daily credits | 5/min | No overage |
| Starter | $9/mo | 20,000 | 5,000 daily credits | 15/min | $0.75/1,000 overage credits when enabled |
| Growth | $29/mo | 100,000 | 25,000 daily credits | 45/min | $0.45/1,000 overage credits when enabled |
| Pro | $79/mo | 400,000 | No daily cap | 120/min | $0.30/1,000 overage credits |
| Business | $199/mo | 1,200,000 | No daily cap | 300/min | $0.20/1,000 overage credits |
| Enterprise | $499/mo | 5,000,000 | No daily cap | 1,000/min | $0.12/1,000 overage credits |
This endpoint is executed through Crawlora's managed scraping infrastructure.
- Suggestions can include terms, products, and collections. - Unknown shops return not-found errors. - Blocked pages, malformed JSON, and responses with no parsed suggestions return an upstream error. Example response: ```json { "code": 200, "msg": "OK", "data": { "shop_handle": "marcnolan", "query": "loafer", "suggestions": [ {"type": "term", "text": "loafer", "position": 1}, {"type": "product", "text": "Odell White Leather Belgian Loafer Sneakers", "id": "7438827651151", "position": 2} ] } } ```
Crawlora does not silently return bad data when the upstream page cannot be used.
| Status | Common failure case |
|---|---|
| 400 | Invalid input or missing required parameter |
| 429 | Plan or endpoint rate limit exceeded |
| 500 | Internal execution error |
| 502 | Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved |
When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 404 | Not Found | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
{
"code": 200,
"msg": "OK",
"data": {
"shop_handle": "marcnolan",
"query": "loafer",
"suggestions": [
{
"type": "term",
"text": "loafer",
"position": 1
},
{
"type": "product",
"text": "Odell White Leather Belgian Loafer Sneakers",
"id": "7438827651151",
"position": 2
}
]
}
}Request schema
No body schema
Response schema
#/definitions/shopapp.shopTypeaheadResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | shopapp.ShopTypeaheadResponse | No | ||||
| data.limit | integer | No | 20 | |||
| data.query | string | No | loafer | |||
| data.shop_handle | string | No | marcnolan | |||
| data.shop_id | string | No | 186720 | |||
| data.suggestions | array | No | ||||
| data.suggestions[].collection | shopapp.ShopCollection | No | ||||
| data.suggestions[].collection.id | string | No | 292518002767 | |||
| data.suggestions[].collection.slug | string | No | mens-dress-shoes | |||
| data.suggestions[].collection.title | string | No | Mens Dress Shoes | |||
| data.suggestions[].collection.url | string | No | ||||
| data.suggestions[].id | string | No | 7438827651151 | |||
| data.suggestions[].position | integer | No | 1 | |||
| data.suggestions[].product | shopapp.ProductItem | No | ||||
| data.suggestions[].product.currency | string | No | USD | |||
| data.suggestions[].product.group_query | string | No | kids' athletic sneakers | |||
| data.suggestions[].product.group_title | string | No | kids' athletic sneakers | |||
| data.suggestions[].product.id | string | No | 8075903107261 | |||
| data.suggestions[].product.image | string | No | https://cdn.shopify.com/s/files/1/1145/5784/files/example.jpg | |||
| data.suggestions[].product.image_alt | string | No | Black sneaker side view | |||
| data.suggestions[].product.on_sale | boolean | No | ||||
| data.suggestions[].product.original_price | number | No | 120 | |||
| data.suggestions[].product.position | integer | No | 1 | |||
| data.suggestions[].product.price | number | No | 100 | |||
| data.suggestions[].product.shop_id | string | No | 62696 | |||
| data.suggestions[].product.shop_name | string | No | BILLY Footwear | |||
| data.suggestions[].product.title | string | No | Black/Black/Gum BILLY Sport Inclusion DZ1 | |||
| data.suggestions[].product.url | string | No | https://billyfootwear.com/products/black-black-gum-billy-sport-inclusion-dz1-zipper-shoes?utm_source=shop_app | |||
| data.suggestions[].product.variant_id | string | No | 46242960965821 | |||
| data.suggestions[].text | string | No | loafer | |||
| data.suggestions[].type | string | No | product | |||
| data.suggestions[].url | string | No | ||||
| msg | string | No | OK |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/shop-app/shops/marcnolan/typeahead?query=loafer&limit=20" \
-H "x-api-key: $CRAWLORA_API_KEY"Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.
Read Crawlora terms