CVS

Browse a CVS OTC category page

Returns one page of a CVS.com OTC (over-the-counter) retail category, subcategory, or brand page's product grid: products with title, brand, image, current/original price, and sponsored/featured/new-product flags; the total result count; and the facets (brand, color, size, price range, and other category-specific attributes, each with its selectable values and result counts) available to filter the page further. Covers the non-prescription retail catalog only. path is the segment of a page URL after "/shop/", e.g. "beauty" (top-level category), "health-medicine/allergy-sinus" (subcategory), or "brand-shop/s/safe-home" (brand page); a full https://www.cvs.com/shop/... URL or a "/shop/..." path is also accepted. Any of these can also carry an optional facet-filter suffix in the site's own URL shape, e.g. "beauty/makeup/eyes/q/CoverGirl/Black/brpc" to filter to brand CoverGirl and color Black -- see the response's facets field for which values/type codes a given category supports; filter values are case-sensitive exactly as the site renders them. page is a 1-indexed page number (default 1). sort is an optional result order matching the site's own Sort By control. CVS.com is only available from US and US-territory locations; a request served from an unsupported region returns an upstream error rather than an empty result.

get/cvs/category

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/cvs/category
  • Auth: API key in header x-api-key

Query parameters

pathstring required

CVS category, subcategory, or brand-page URL path, optionally with a /q/{value}/{typeCode} facet-filter suffix, e.g. \

pageinteger

1-indexed page number, default 1

sort'pa' | 'pd' | 'tr' | 'rc' | 'az' | 'za'

Result sort order, default the site's own relevance order. One of pa (Price Low to High), pd (Price High to Low), tr (Top Rated), rc (Most Reviewed), az (Name A-Z), za (Name Z-A)

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "facets": [
      {
        "key": "brand",
        "label": "Brand",
        "values": [
          {
            "count": 37,
            "name": "CoverGirl"
          }
        ]
      }
    ],
    "page": 1,
    "products": [
      {
        "brand": "Crest",
        "currency": "USD",
        "id": "478253",
        "list_price": 4.99,
        "sale_price": 4.99,
        "title": "Crest Pro-Health Breath Mist, Clean Mint, 0.44 OZ, 2 PK"
      }
    ],
    "total_count": 8766
  },
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.