{
  "openapi": "3.0.1",
  "info": {
    "title": "Sephora Scraper & API - Products, Prices, Shades & Stock",
    "description": "Sephora scraper and API: Sephora US and Canada beauty products by keyword, category, brand or URL. One result = one product: brand, name, price, sale price, rating, reviews, badges, shades / sizes with stock, ingredients, images, URL. $0.85 per 1,000, no start fee.",
    "version": "1.0",
    "x-build-id": "VMvEjgYEqcajnPG2h"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/rel8ble~sephora-products-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-rel8ble-sephora-products-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/rel8ble~sephora-products-scraper/runs": {
      "post": {
        "operationId": "runs-sync-rel8ble-sephora-products-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/rel8ble~sephora-products-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-rel8ble-sephora-products-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "searchQueries": {
            "title": "Search keywords",
            "type": "array",
            "description": "What to search for on Sephora, one search per line: \"vitamin c serum\", \"tubing mascara\", \"sunscreen spf 50\", a brand name or a product name. Each line is one search; results are merged. Typical: 1-50 lines.",
            "items": {
              "type": "string"
            }
          },
          "categories": {
            "title": "Categories",
            "type": "array",
            "description": "Optional. Sephora category slugs or ids, one per line: \"mascara\", \"foundation-makeup\", \"face-serum\", \"cat60026\", or a sephora.com/shop/<slug> URL. The whole category is listed (paged), filters and sort apply.",
            "items": {
              "type": "string"
            }
          },
          "brands": {
            "title": "Brands",
            "type": "array",
            "description": "Optional. Brand slugs as in sephora.com/brand/<slug>, one per line: \"fenty-beauty-rihanna\", \"rare-beauty-selena-gomez\", \"the-ordinary\", or the brand page URL. Every product of the brand is listed.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Sephora URLs",
            "type": "array",
            "description": "Optional. Any sephora.com link, one per line: a product page (\"https://www.sephora.com/product/...-P515709\", one full row each), a /shop/<category> page, a /brand/<slug> page or a /search?keyword=... page.",
            "items": {
              "type": "string"
            }
          },
          "country": {
            "title": "Store",
            "enum": [
              "us",
              "ca"
            ],
            "type": "string",
            "description": "\"us\" (default) = sephora.com, prices in USD. \"ca\" = Sephora Canada, prices in CAD and the Canadian assortment.",
            "default": "us"
          },
          "includeDetails": {
            "title": "Include product details",
            "type": "boolean",
            "description": "Default false: one row per product from the listing (brand, name, price, sale price, rating, reviews, badges, variant count, image, URL) - about 100 products per request. True: also open every product page (one request each, about 1 MB) and add the description, ingredients, suggested usage, loves count, highlights, category path, all images and every variant (shade / size) with its own price, size and stock flags.",
            "default": false
          },
          "sortBy": {
            "title": "Sort",
            "enum": [
              "relevance",
              "bestSelling",
              "topRated",
              "newest",
              "priceLowToHigh",
              "priceHighToLow"
            ],
            "type": "string",
            "description": "Order of the results, same options as the site: relevance (default), best selling, top rated, new, price low to high, price high to low. Useful with \"Max results per query\" (e.g. top 50 best sellers in a category).",
            "default": "relevance"
          },
          "minPrice": {
            "title": "Minimum price",
            "type": "string",
            "description": "Optional. Keep only products priced at or above this (in the store currency), e.g. \"25\"."
          },
          "maxPrice": {
            "title": "Maximum price",
            "type": "string",
            "description": "Optional. Keep only products priced at or below this, e.g. \"50\"."
          },
          "minRating": {
            "title": "Minimum rating",
            "type": "string",
            "description": "Optional. \"4\" = 4 stars and up, \"3\" = 3 stars and up (whole numbers 1-5)."
          },
          "brandFilter": {
            "title": "Only these brands",
            "type": "array",
            "description": "Optional. Restrict a search or category to these brand names exactly as Sephora spells them, one per line: \"Lancôme\", \"Benefit Cosmetics\", \"SEPHORA COLLECTION\".",
            "items": {
              "type": "string"
            }
          },
          "onSaleOnly": {
            "title": "On sale only",
            "type": "boolean",
            "description": "Keep only products with a sale price.",
            "default": false
          },
          "newOnly": {
            "title": "New arrivals only",
            "type": "boolean",
            "description": "Keep only products Sephora flags as new.",
            "default": false
          },
          "maxItemsPerQuery": {
            "title": "Max results per query",
            "minimum": 0,
            "type": "integer",
            "description": "Stop each search / category / brand after this many products. 0 = everything Sephora lists. Default 100.",
            "default": 100
          },
          "maxItems": {
            "title": "Max results in total",
            "minimum": 0,
            "type": "integer",
            "description": "Stop the whole run after this many products. 0 = no limit. Default 1000 (= $0.85). The run also stops cleanly at the \"Maximum cost per run\" you set.",
            "default": 1000
          },
          "maxConcurrency": {
            "title": "Parallel requests",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "How many requests to run at once. Default 2. Sephora (Akamai) blocks IPs that send bursts, so higher values mostly mean more retries.",
            "default": 2
          },
          "maxRequestRetries": {
            "title": "Retries per request",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "How often a failed request is retried on a new session / IP before it is given up. Default 5.",
            "default": 5
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Used for the listing requests (search, category, brand). Default: Apify Proxy (datacenter), which Sephora's catalog API serves. Each session makes a limited number of requests on one IP.",
            "default": {
              "useApifyProxy": true
            }
          },
          "detailsUseProxy": {
            "title": "Send product pages through the proxy too",
            "type": "boolean",
            "description": "Default false: product pages (details) are fetched without a proxy, because Sephora answers most datacenter proxy IPs with 403 on those pages while serving them to Apify's own IPs. Set true only together with a RESIDENTIAL proxy in \"Proxy\".",
            "default": false
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}