API reference
Sephora Product API
One product: brand, price, rating and review count, loves, description, usage, images and its shade or size variants.
Endpoint
/v1/sephora/productlive · proven3 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
id | yes | Product id (P-number), or the product URL | P427414 |
sku_id | no | A shade or size sku id | 2025633 |
language | no | en-US, en-CA or fr-CA | en-US |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/sephora/product?id=P427414" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/sephora/product?id=P427414",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/sephora/product?id=P427414",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "sephora",
"endpoint": "/v1/sephora/product",
"data": {
"brand": "example",
"brand_id": "example",
"brand_url": "https://example.com/example",
"currency": "example",
"description": "example",
"id": "example",
"image": "https://example.com/example",
"images": [
"example"
],
"loves": 0,
"out_of_stock": false,
"platform": "example",
"price": 0,
"rating": {
"max": 0,
"value": 0,
"votes": 0
},
"reviews_count": 0,
"short_description": "example",
"size": "example",
"sku_id": "example",
"title": "example",
"type": "example",
"url": "https://example.com/example",
"usage": "example",
"variants": [
{
"image": "https://example.com/example",
"out_of_stock": false,
"price": 0,
"sku_id": "example",
"url": "https://example.com/example",
"variation": "example"
}
],
"variation": "example"
},
"credits_used": 3,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
brand | string | null | Optional brand supplied by this operation. Null means unknown. |
brand_id | string | null | Optional brand id supplied by this operation. Null means unknown. |
brand_url | string | null | Optional brand url supplied by this operation. Null means unknown. |
currency | string | null | Optional currency supplied by this operation. Null means unknown. |
description | string | null | Source description; null or absent means not supplied. |
id | string | null | Source identifier. Preserve the supplied type and exact value. |
image | string | null | Optional image supplied by this operation. Null means unknown. |
images | array | null | Optional images supplied by this operation. Null means unknown. |
loves | number | null | Optional loves supplied by this operation. Null means unknown. |
out_of_stock | boolean | null | Optional out of stock supplied by this operation. Null means unknown. |
platform | string | null | Optional platform supplied by this operation. Null means unknown. |
price | number | null | Source price. Currency, taxes and availability depend on the listing. |
rating | object | null | Source rating; read its accompanying scale and vote count. |
rating.max | number | null | Optional max supplied by this operation. Null means unknown. |
rating.value | number | null | Optional value supplied by this operation. Null means unknown. |
rating.votes | number | null | Optional votes supplied by this operation. Null means unknown. |
reviews_count | number | null | Optional reviews count supplied by this operation. Null means unknown. |
short_description | string | null | Optional short description supplied by this operation. Null means unknown. |
size | string | null | Optional size supplied by this operation. Null means unknown. |
sku_id | string | null | Optional sku id supplied by this operation. Null means unknown. |
title | string | null | Source title when supplied. |
type | string | null | Optional type supplied by this operation. Null means unknown. |
url | string | null | Original source URL when supplied. |
usage | string | null | Optional usage supplied by this operation. Null means unknown. |
variants | array | null | Optional variants supplied by this operation. Null means unknown. |
variants[].image | string | null | Optional image supplied by this operation. Null means unknown. |
variants[].out_of_stock | boolean | null | Optional out of stock supplied by this operation. Null means unknown. |
variants[].price | number | null | Source price. Currency, taxes and availability depend on the listing. |
variants[].sku_id | string | null | Optional sku id supplied by this operation. Null means unknown. |
variants[].url | string | null | Original source URL when supplied. |
variants[].variation | string | null | Optional variation supplied by this operation. Null means unknown. |
variation | string | null | Optional variation supplied by this operation. Null means unknown. |
Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.
The example is invented and illustrates types only; zero and empty values are not claims about a real result.
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference