Shopify Search API reference
Your first 10 calls are free, no card needed. Pricing and FAQ
Get a free API keycurl "https://api.insightsocial.app/v1/shopify/search?store=<store>&query=<query>" \ -H "x-api-key: $INSIGHTSOCIAL_API_KEY"
Search a Shopify store's products, articles and pages, with the store's facets and result count.
Beta. The source's own structure under our naming rules (snake_case keys, string ids, ISO times where the source gives a timestamp), not one of the schema-2 entities. Fields may change. See Beta endpoints.
20 credits per call.
Paginates by cursor: see Pagination.
Authorization
apiKey Your key from the dashboard. It starts with isk_.
In: header
Query Parameters
The store's domain, for example allbirds.com, www.allbirds.com or weareallbirds.myshopify.com. A full URL is accepted and reduced to its host. Only public storefront hosts are accepted.
What to search for in the store.
Restrict the search to product, article or page. Default: all three.
Value in
- "product"
- "article"
- "page"
Only products with an available variant.
Lowest product price to include.
0 <= value <= 1000000000Highest product price to include.
0 <= value <= 1000000000Rows per page, 1 to 250. Default: 50.
1 <= value <= 250ISO 3166-1 alpha-2 country used for prices, currency and language, e.g. GB. Default: the store's own market.
Two-letter language code, e.g. EN. Default: the store's own language.
Pass pagination.next_cursor from the previous response to get the next page. Keep the other parameters the same.
Set to 1 to get the price of this call without making it: data.dry_run carries credits_min and credits_max. Nothing is charged.
Value in
- "1"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.insightsocial.app/v1/shopify/search?store=string&query=string"{ "success": true, "platform": "string", "endpoint": "string", "schema_version": "2", "pagination": { "next_cursor": "string", "has_more": true, "page_size": 0, "stopped_at": "since" }, "unavailable": [ "string" ], "credits_used": 0, "credits_remaining": 0, "request_id": "string", "cached": true, "idempotent_replay": true, "charge_reason": "string", "free_call": true, "data": { "property1": null, "property2": null }}