# Nykaa Catalogue by Category (`ikmal_suzali_atr/nykaa-catalog`) Actor

Every product on a Nykaa (India) category listing: id, name, brand, price, MRP, discount, rating, stock and sponsored (AD) flag, page by page in popularity order, optionally with subcategories. No browser, no login. Dual-mode: the same code runs as an ATR BullMQ worker.

- **URL**: https://apify.com/ikmal\_suzali\_atr/nykaa-catalog.md
- **Developed by:** [AtTheRate AI](https://apify.com/ikmal_suzali_atr) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $2.50 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Nykaa Catalogue by Category

Pulls every product on a Nykaa (India) category listing in popularity order, page by page, with prices, MRP, discount, ratings, stock and the sponsored (AD) tiles marked. Use it to mirror a beauty or personal-care category, watch competitor pricing, or measure who is buying the paid tiles.

### What you get

- One row per product: `id`, `name`, `brand`, `price`, `original_price`, `mrp`, `discount_pct`, `currency` and `product_url`.
- `is_sponsored` on paid tiles, detected from Nykaa's AD tag and its paid-placement metadata. `pla_score` carries the placement score when Nykaa exposes it.
- `featured` is separate and marks an editorial pin, not an ad. Do not count it as paid inventory.
- `page` and `position` for exact rank inside the category, plus `popularity`.
- Ratings as `rating` and `rating_count`, stock as `in_stock`.
- Nykaa's own taxonomy on every row: `category_l1`, `category_l2` and `category_l3`, plus `pack_size` and `option_text` for the variant, and optional subcategory crawling from the mega-menu.

### Input

Give one or more category ids, `/c/<id>` URLs, or mega-menu names.

```json
{
  "categories": ["233"],
  "locale": "in",
  "maxPages": 2,
  "concurrency": 2,
  "expandSubcategories": false,
  "delayMs": 1200,
  "callsPerSession": 60,
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": ["RESIDENTIAL"],
    "apifyProxyCountry": "IN"
  }
}
```

- `categories` (required): `"233"`, `"https://www.nykaa.com/makeup/face/face-primer/c/233"` or a name such as `"face primer"`. Names resolve through Nykaa's navigation.
- `maxPages`: pages per category. `0` means every page. Nykaa serves 20 products a page.
- `concurrency`: pages fetched in parallel within one category, 1 to 4. 2 is safe.
- `expandSubcategories`: also crawl the children of each category.
- `proxyConfiguration`: egress for the run. An Indian residential proxy is the default.

### Output

One dataset row per product per page.

```json
{
  "platform": "nykaa",
  "locale": "in",
  "category": "233",
  "category_title": "Face Primer",
  "breadcrumbs": "Makeup > Face > Face Primer",
  "page": 1,
  "position": 1,
  "id": "1234567",
  "name": "Maybelline New York Fit Me Matte Primer",
  "brand": "Maybelline New York",
  "price": 449,
  "original_price": 550,
  "mrp": 550,
  "discount_pct": 18,
  "currency": "INR",
  "rating": 4.3,
  "rating_count": 1204,
  "in_stock": true,
  "is_sponsored": true,
  "featured": false,
  "category_l3": "Face Primer",
  "pack_size": "30 ml",
  "product_url": "https://www.nykaa.com/maybelline-fit-me-matte-primer/p/1234567",
  "fetched_at": "2026-09-12T03:35:09.757Z"
}
```

`seller` is always null: Nykaa sells its own inventory and does not name a seller on listings. `original_price` is only set when the MRP is above the selling price, while `mrp` is always the listed MRP.

### Use cases

- Price and discount tracking across a category from `price`, `mrp` and `discount_pct`.
- Share of search and share of shelf by counting your `brand` at each `position`.
- Ad-slot share: how much of the first page carries `is_sponsored` true, and which brands hold it.
- Out-of-stock monitoring from `in_stock`, broken down by `category_l2` and `category_l3`.
- Variant and pack-size coverage against competitors from `pack_size` and `option_text`.

### Notes and limits

- 20 products a page, fixed by Nykaa. Page size cannot be increased.
- Nykaa is a pure JSON catalogue here, so runs are fast and no browser is started.
- A category name that matches nothing in the mega-menu is reported as not found and skipped. The rest of the run continues.
- Only the India storefront exists.
- An Indian residential proxy is needed. Other egress is answered with an access-denied page.
- `featured` is an editorial pin. Only `is_sponsored` means paid.

### FAQ

**Do I need a proxy?** Yes. An Indian residential proxy, which is the actor default.

**How many results can I get?** Everything Nykaa lists for the category, 20 rows a page. Use `maxPages` to cap it, `0` means no cap.

**Does it need a login or an API key?** No.

**How is the sponsored flag detected?** From the AD tag Nykaa attaches to paid tiles, plus the paid-placement fields that ride with them. Editorial pins carry `featured` instead and stay `is_sponsored: false`.

**Can I pass a category name instead of an id?** Yes. Names and `/c/<id>` URLs both resolve through Nykaa's mega-menu, and the id is written back into the `category` column.

# Actor input Schema

## `categories` (type: `array`):

Nykaa category ids, /c/<id> URLs or mega-menu names, e.g. "233", "https://www.nykaa.com/makeup/face/face-primer/c/233" or "face primer". Enable "Include subcategories" to crawl children from Nykaa's navigation tree.

## `locale` (type: `string`):

Which storefront / locale.

## `maxPages` (type: `integer`):

0 = all pages.

## `concurrency` (type: `integer`):

Pages fetched in parallel within a category (1-4). 2 is safe.

## `expandSubcategories` (type: `boolean`):

Also crawl each category's subcategories when the site exposes them.

## `delayMs` (type: `integer`):

Pause between page fetches.

## `callsPerSession` (type: `integer`):

Re-mint the session after this many page fetches.

## `proxyConfiguration` (type: `object`):

On the Apify platform this decides egress. A residential proxy in the storefront's country is recommended (IN for the default). On our own servers it is ignored and our residential proxy is used.

## Actor input object example

```json
{
  "categories": [
    "233"
  ],
  "locale": "in",
  "maxPages": 0,
  "concurrency": 2,
  "expandSubcategories": false,
  "delayMs": 1200,
  "callsPerSession": 60,
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ],
    "apifyProxyCountry": "IN"
  }
}
```

# Actor output Schema

## `results` (type: `string`):

One row per product.

## `summary` (type: `string`):

Counts for the run: what was requested, captured, skipped and failed.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "categories": [
        "233"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("ikmal_suzali_atr/nykaa-catalog").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "categories": ["233"] }

# Run the Actor and wait for it to finish
run = client.actor("ikmal_suzali_atr/nykaa-catalog").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "categories": [
    "233"
  ]
}' |
apify call ikmal_suzali_atr/nykaa-catalog --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,ikmal_suzali_atr/nykaa-catalog"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/dGUP0dhrFQEjgtW2W/builds/CpAuOurMPx6oNK7Z1/openapi.json