API Reference
Use Crawlora's Shop.app Scraper API endpoints to extract supported public Shop.app data as structured JSON. This documentation covers 16 active endpoints including Analyze Shop.app query results, List Shop.app categories, Get Shop.app product, List Shop.app related products, and related APIs. Developers can use these endpoints for monitoring, enrichment, research dashboards, internal data pipelines, and agent-native workflows without maintaining platform-specific scraping code. Each endpoint page documents authentication, request parameters such as query, id, handle, collection_id, cURL examples, response examples, response schemas, errors, credit cost, and Playground testing. Send requests to the Crawlora API with an x-api-key header, review usage and plan limits on pricing, and test safe sample requests in Playground before moving the workflow into production.
Choose an endpoint, send an authenticated request with the x-api-key header, and inspect the normalized JSON response. The examples below use the public Crawlora API base URL and the same endpoint catalog used by Playground.
curl -X GET "https://api.crawlora.net/api/v1/shop-app/search?query=sneakers&limit=20&in_stock=true&on_sale=false&deep_search=false" \
-H "x-api-key: $CRAWLORA_API_KEY"These endpoint cards are generated from the active Crawlora endpoint catalog, including method, path, auth mode, credit cost, parameter summary, docs, and Playground links.
/shop-app/analysisapiKey5 credits/requestReturns a market snapshot derived from Shop.app search results, including price ranges, currencies, sale counts, discounts, and top shops. Limit defaults to 20 and accepts values up to 50.
Required params: query:query
/shop-app/categoriesapiKey3 credits/requestReturns public Shop.app product categories.
Required params: None
/shop-app/products/{id}apiKey5 credits/requestReturns normalized public product details from Shop.app.
Required params: id:path
/shop-app/products/{id}/relatedapiKey5 credits/requestReturns related product cards from a public Shop.app product page.
Required params: id:path
/shop-app/products/{id}/reviewsapiKey5 credits/requestReturns public product reviews from a Shop.app product page.
Required params: id:path
/shop-app/products/{id}/shopapiKey5 credits/requestResolves the public Shop.app merchant profile for a product id.
Required params: id:path
/shop-app/products/{id}/variantapiKey5 credits/requestReturns the exact public product variant matching selected options. selected_options must be a JSON object when provided. Repeated option filters may also be sent as option.Name=value or option[Name]=value.
Required params: id:path
/shop-app/products/{id}/variantsapiKey5 credits/requestReturns adjacent variants for a Shop.app product. selected_options must be a JSON object when provided. Repeated option filters may also be sent as option.Name=value or option[Name]=value.
Required params: id:path
/shop-app/searchapiKey5 credits/requestSearches Shop.app product results using the credential-free public web search flow. Limit defaults to 20 and accepts values up to 50.
Required params: query:query
/shop-app/shops/{handle}apiKey5 credits/requestReturns public Shop.app merchant profile details.
Required params: handle:path
/shop-app/shops/{handle}/collections/{collection_id}/productsapiKey5 credits/requestReturns public product cards from a Shop.app merchant collection. sort_by allowed values: MOST_SALES, PRICE_LOW_TO_HIGH, PRICE_HIGH_TO_LOW, RELEVANCE.
Required params: handle:path, collection_id:path
/shop-app/shops/{handle}/locationsapiKey5 credits/requestReturns public retail locations for a Shop.app merchant profile.
Required params: handle:path
/shop-app/shops/{handle}/productsapiKey5 credits/requestReturns public product cards from a Shop.app merchant profile. sort_by allowed values: MOST_SALES, PRICE_LOW_TO_HIGH, PRICE_HIGH_TO_LOW, RELEVANCE.
Required params: handle:path
/shop-app/shops/{handle}/reviewsapiKey5 credits/requestReturns public reviews for a Shop.app merchant profile.
Required params: handle:path
/shop-app/shops/{handle}/typeaheadapiKey2 credits/requestReturns public store typeahead suggestions for a Shop.app merchant profile.
Required params: handle:path, query:query
/shop-app/suggestionsapiKey2 credits/requestReturns Shop.app autocomplete suggestions. Limit defaults to 10 and supports up to 20.
Required params: query:query
| Endpoint | API path | Method | Credits | Required params | Docs | Playground |
|---|---|---|---|---|---|---|
| Analyze Shop.app query results | /shop-app/analysis | GET | 5 credits/request | query:query | View docs | Try endpoint |
| List Shop.app categories | /shop-app/categories | GET | 3 credits/request | None | View docs | Try endpoint |
| Get Shop.app product | /shop-app/products/{id} | GET | 5 credits/request | id:path | View docs | Try endpoint |
| List Shop.app related products | /shop-app/products/{id}/related | GET | 5 credits/request | id:path | View docs | Try endpoint |
| List Shop.app product reviews | /shop-app/products/{id}/reviews | GET | 5 credits/request | id:path | View docs | Try endpoint |
| Get the Shop.app shop for a product | /shop-app/products/{id}/shop | GET | 5 credits/request | id:path | View docs | Try endpoint |
| Get a Shop.app product variant by selected options | /shop-app/products/{id}/variant | GET | 5 credits/request | id:path | View docs | Try endpoint |
| List Shop.app product variants | /shop-app/products/{id}/variants | GET | 5 credits/request | id:path | View docs | Try endpoint |
| Search Shop.app products | /shop-app/search | GET | 5 credits/request | query:query | View docs | Try endpoint |
| Get Shop.app shop | /shop-app/shops/{handle} | GET | 5 credits/request | handle:path | View docs | Try endpoint |
| List Shop.app collection products | /shop-app/shops/{handle}/collections/{collection_id}/products | GET | 5 credits/request | handle:path, collection_id:path | View docs | Try endpoint |
| List Shop.app shop locations | /shop-app/shops/{handle}/locations | GET | 5 credits/request | handle:path | View docs | Try endpoint |
| List Shop.app shop products | /shop-app/shops/{handle}/products | GET | 5 credits/request | handle:path | View docs | Try endpoint |
| List Shop.app shop reviews | /shop-app/shops/{handle}/reviews | GET | 5 credits/request | handle:path | View docs | Try endpoint |
| Suggest products and collections inside a Shop.app shop | /shop-app/shops/{handle}/typeahead | GET | 2 credits/request | handle:path, query:query | View docs | Try endpoint |
| Suggest Shop.app searches | /shop-app/suggestions | GET | 2 credits/request | query:query | View docs | Try endpoint |