Endpoint Playground

Try the Analyze Shop.app query results API

Test Crawlora's Analyze Shop.app query results API with realistic prefilled parameters. Generate a cURL request, inspect the expected structured JSON response, and open the full docs or pricing page when you are ready to integrate this public web data extraction endpoint into your application.

Endpoint facts

Method: GET
API path: /shop-app/analysis
Platform: Shop.app
Auth: apiKey
Credits: 5 credits/request
Required params: query
Common optional params: limit, in_stock, on_sale, deep_search

Analyze Shop.app query results API documentation Shop.app platform page Crawlora API pricing Try List Shop.app categories API Try Get Shop.app product API Try List Shop.app related products API Try List Shop.app product reviews API Try Get the Shop.app shop for a product API

Prefilled cURL

curl "https://api.crawlora.net/api/v1/shop-app/analysis?query=sneakers&limit=20&in_stock=true&on_sale=false&deep_search=false" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Request parameters visible to crawlers

Parameter	Type	Required	Prefilled value	Description
query	string	Yes	sneakers	Search query
limit	integer	No	20	Maximum products to analyze, defaults to 20 and supports up to 50
in_stock	boolean	No	true	Request in-stock products
on_sale	boolean	No	false	Request sale products
deep_search	boolean	No	false	Enable Shop.app deep search mode

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "query": "sneakers",
    "products_count": 5,
    "groups_count": 2,
    "shops_count": 3,
    "currencies": [
      "USD"
    ],
    "prices_by_currency": [
      {
        "currency": "USD",
        "count": 5,
        "min": 40,
        "max": 100,
        "average": 67.5
      }
    ],
    "sale_count": 2,
    "discounts": {
      "min_percent": 20,
      "max_percent": 50,
      "average_percent": 35
    },
    "top_shops": [
      {
        "shop_id": "62696",
        "shop_name": "BILLY Footwear",
        "count": 2
      }
    ],
    "sampled_product_ids": [
      "8075903107261",
      "7093164834901"
    ]
  }
}

Public Playground

Preview the endpoint before sending a live request

Sample responses, schemas, request previews, and code snippets are visible before sign in. Create an account when you are ready to save an API key and run authenticated requests.

Set up API key Endpoint docs

Endpoint

Choose one catalog endpoint for this request.

16 shown

Group

Method

Auth

Endpoint

GETapiKey5 credits/requestshopapp.analysisResponseDocShop.app

GET /shop-app/analysis

Analyze Shop.app query results

Returns 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.

API key required. Paste a full key or rotate one from the API Keys page.

Set up API key

View docs

API key

API key required for live requests. Your key is only used to send requests from this Playground.

not configured

Active Playground key: not configured

Manage API keys in Console

Required query parameters

query

requiredstring

Search query

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

View docs

Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "code": 200,
  "msg": "OK",
  "data": {
    "query": "sneakers",
    "products_count": 5,
    "groups_count": 2,
    "shops_count": 3,
    "currencies": [
      "USD"
    ],
    "prices_by_currency": [
      {
        "currency": "USD",
        "count": 5,
        "min": 40,
        "max": 100,
        "average": 67.5
      }
    ],
    "sale_count": 2,
    "discounts": {
      "min_percent": 20,
      "max_percent": 50,
      "average_percent": 35
    },
    "top_shops": [
      {
        "shop_id": "62696",
        "shop_name": "BILLY Footwear",
        "count": 2
      }
    ],
    "sampled_product_ids": [
      "8075903107261",
      "7093164834901"
    ]
  }
}

Endpoint details

Returns 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.

Method: GET
Path: /shop-app/analysis
Authentication: apiKey
Credit cost: 5 credits/request
Platform: Shop.app
Parameters: 6 documented fields

Request parameters

query:querylimit:queryin_stock:queryon_sale:querydeep_search:queryx-api-key:header

Response schema fields

codedatadata.currenciesdata.discountsdata.discounts.average_percentdata.discounts.max_percentdata.discounts.min_percentdata.groups_countdata.prices_by_currencydata.prices_by_currency[].averagedata.prices_by_currency[].countdata.prices_by_currency[].currency

Sample response summary

{
  "code": 200,
  "msg": "OK",
  "data": {
    "query": "sneakers",
    "products_count": 5,
    "groups_count": 2,
    "shops_count": 3,
    "currencies": [
      "USD"
    ],
    "prices_by_currency": [
      {
        "currency": "USD",
        "count": 5,
        "min": 40,
        "max": 100,
        "average": 67.5
      }
    ],
    "sale_count": 2,
    "discounts": {
      "min_percent": 20,
      "max_percent": 50,
      "average_percent": 35
    },
    "top_shops": [
      {
        "shop_id": "62696",
        "shop_name": "BILLY Footwear",
        "count": 2
      }
    ],
    "sampled_product_ids": [
      "8075903107261",
      "7093164834901"
    ]
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/shop-app/analysis?query=<query>" \
  -H "x-api-key: $CRAWLORA_API_KEY"

View endpoint docs Open platform page Browse all endpoints Pricing List Shop.app categories Get Shop.app product List Shop.app related products List Shop.app product reviews Get the Shop.app shop for a product

Try the Analyze Shop.app query results API

Request parameters visible to crawlers

Parameter	Type	Required	Prefilled value	Description
query	string	Yes	sneakers	Search query
limit	integer	No	20	Maximum products to analyze, defaults to 20 and supports up to 50
in_stock	boolean	No	true	Request in-stock products
on_sale	boolean	No	false	Request sale products
deep_search	boolean	No	false	Enable Shop.app deep search mode

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "query": "sneakers",
    "products_count": 5,
    "groups_count": 2,
    "shops_count": 3,
    "currencies": [
      "USD"
    ],
    "prices_by_currency": [
      {
        "currency": "USD",
        "count": 5,
        "min": 40,
        "max": 100,
        "average": 67.5
      }
    ],
    "sale_count": 2,
    "discounts": {
      "min_percent": 20,
      "max_percent": 50,
      "average_percent": 35
    },
    "top_shops": [
      {
        "shop_id": "62696",
        "shop_name": "BILLY Footwear",
        "count": 2
      }
    ],
    "sampled_product_ids": [
      "8075903107261",
      "7093164834901"
    ]
  }
}

Analyze Shop.app query results

Returns 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.

API key required. Paste a full key or rotate one from the API Keys page.

Set up API key

{ "code": 200, "msg": "OK", "data": { "query": "sneakers", "products_count": 5, "groups_count": 2, "shops_count": 3, "currencies": [ "USD" ], "prices_by_currency": [ { "currency": "USD", "count": 5, "min": 40, "max": 100, "average": 67.5 } ], "sale_count": 2, "discounts": { "min_percent": 20, "max_percent": 50, "average_percent": 35 }, "top_shops": [ { "shop_id": "62696", "shop_name": "BILLY Footwear", "count": 2 } ], "sampled_product_ids": [ "8075903107261", "7093164834901" ] } }

Endpoint details

Returns 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.

Method: GET
Path: /shop-app/analysis
Authentication: apiKey
Credit cost: 5 credits/request
Platform: Shop.app
Parameters: 6 documented fields

Request parameters

query:querylimit:queryin_stock:queryon_sale:querydeep_search:queryx-api-key:header

Response schema fields

Sample response summary

{
  "code": 200,
  "msg": "OK",
  "data": {
    "query": "sneakers",
    "products_count": 5,
    "groups_count": 2,
    "shops_count": 3,
    "currencies": [
      "USD"
    ],
    "prices_by_currency": [
      {
        "currency": "USD",
        "count": 5,
        "min": 40,
        "max": 100,
        "average": 67.5
      }
    ],
    "sale_count": 2,
    "discounts": {
      "min_percent": 20,
      "max_percent": 50,
      "average_percent": 35
    },
    "top_shops": [
      {
        "shop_id": "62696",
        "shop_name": "BILLY Footwear",
        "count": 2
      }
    ],
    "sampled_product_ids": [
      "8075903107261",
      "7093164834901"
    ]
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/shop-app/analysis?query=<query>" \
  -H "x-api-key: $CRAWLORA_API_KEY"