{
  "openapi": "3.0.1",
  "info": {
    "title": "Sephora Scraper",
    "description": "Sephora scraper & API: extract real-time Sephora.com data for the US and Canada: product prices, ratings, reviews, ingredients, brands, categories and store locations. Search by keyword, category or brand with price and rating filters. Beauty and cosmetics data, no proxies needed. Ulta alternative.",
    "version": "0.0",
    "x-build-id": "kCBny07jPxdtlWObM"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/happyendpoint~sephora-scrapper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-happyendpoint-sephora-scrapper",
        "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/happyendpoint~sephora-scrapper/runs": {
      "post": {
        "operationId": "runs-sync-happyendpoint-sephora-scrapper",
        "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/happyendpoint~sephora-scrapper/run-sync": {
      "post": {
        "operationId": "run-sync-happyendpoint-sephora-scrapper",
        "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": {
          "endpoint": {
            "title": "Operation",
            "enum": [
              "/status",
              "/search-by-keyword",
              "/search-by-category",
              "/search-by-brand",
              "/product-details",
              "/product-reviews",
              "/auto-complete",
              "/brands-list",
              "/categories-list",
              "/category-data",
              "/store-list"
            ],
            "type": "string",
            "description": "**Health check** (default) only confirms the actor is working and saves one status row. To get data, start with a **Search**, then use the `productId` values it returns for **Product Details** or **Product Reviews**.",
            "default": "/status"
          },
          "query": {
            "title": "Search Keyword",
            "type": "string",
            "description": "**[Search by Keyword, Auto Complete]** What to search for, for example `lipstick`, `vitamin c serum` or `perfume`."
          },
          "categoryId": {
            "title": "Category ID",
            "type": "string",
            "description": "**[Search by Category, Category Data]** A category ID such as `cat140006` (Makeup). Run **Categories List** or **Category Data** to find IDs. Optional for **Search by Keyword** to search inside one category."
          },
          "brandName": {
            "title": "Brand Name",
            "type": "string",
            "description": "**[Search by Brand]** The brand name as it appears in Sephora links, for example `fenty-beauty-rihanna`, `the-ordinary` or `gucci`. Run **Brands List** to find them."
          },
          "sortBy": {
            "title": "Sort By",
            "enum": [
              "BEST_SELLING",
              "TOP_RATED",
              "PRICE_LOW_TO_HIGH",
              "PRICE_HIGH_TO_LOW",
              "NEW",
              "MOST_HELPFUL",
              "HIGHEST_RATING",
              "LOWEST_RATING",
              "OLDEST",
              "NEWEST"
            ],
            "type": "string",
            "description": "Product sorts apply to searches, review sorts apply to **Product Reviews**. If you pick a product sort for reviews, the most helpful reviews come first.",
            "default": "BEST_SELLING"
          },
          "minPrice": {
            "title": "Min Price ($)",
            "minimum": 0,
            "type": "integer",
            "description": "**[Searches]** Lowest price in US dollars."
          },
          "maxPrice": {
            "title": "Max Price ($)",
            "minimum": 0,
            "type": "integer",
            "description": "**[Searches]** Highest price in US dollars."
          },
          "minRating": {
            "title": "Rating",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "**[Search by Keyword, Search by Brand]** Only products rated at least this many stars. **[Product Reviews]** Only reviews with exactly this many stars."
          },
          "isNew": {
            "title": "New Products Only",
            "type": "boolean",
            "description": "**[Search by Keyword]** Only products marked as new at Sephora.",
            "default": false
          },
          "maxItems": {
            "title": "Max Results",
            "minimum": 1,
            "type": "integer",
            "description": "**[Searches, Product Reviews]** Maximum number of products or reviews to save. Pages are fetched automatically until this number or the last result is reached.",
            "default": 100
          },
          "currentPage": {
            "title": "Start Page",
            "minimum": 1,
            "type": "integer",
            "description": "**[Searches, Product Reviews]** Page to start from. Leave at 1 to start from the first result.",
            "default": 1
          },
          "productId": {
            "title": "Product ID",
            "type": "string",
            "description": "**[Product Details, Product Reviews]** A Sephora product ID such as `P427421`. Find it in the `productId` field of a search, or in the product link on sephora.com."
          },
          "skuId": {
            "title": "SKU ID",
            "type": "string",
            "description": "**[Product Details]** Optional. A specific shade or size, for example `2025633`."
          },
          "language": {
            "title": "Language",
            "enum": [
              "en-US",
              "en-CA",
              "fr-CA"
            ],
            "type": "string",
            "description": "**[Product Details, Auto Complete]** Language and region of the text.",
            "default": "en-US"
          },
          "latitude": {
            "title": "Latitude",
            "type": "string",
            "description": "**[Store List]** For example `37.4418834` (Palo Alto)."
          },
          "longitude": {
            "title": "Longitude",
            "type": "string",
            "description": "**[Store List]** For example `-122.1430195` (Palo Alto)."
          },
          "radius": {
            "title": "Radius (miles)",
            "type": "string",
            "description": "**[Store List]** How far around the location to search, in miles. For example `50`."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}