Pepperfry API Capability

Category

Fetch category listing pages from category URLs and return normalized listing rows.

Capability ID pepperfry.catalog.category

Cost From $1.25 per 1,000 requests · 1 credit

Maximum runtime 45 seconds

# Category

Fetch category listing pages from category URLs and return normalized listing rows.

- Platform: [Pepperfry](https://docs.upscrape.com/docs/platforms/pepperfry)
- Capability ID: `pepperfry.catalog.category`
- Cost: 1 credit per request
- Maximum runtime: 45 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer $UPSCRAPE_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "category_path": "/category/sofas.html",
    "max_pages": 1,
    "page": 1
  },
  "capability": "pepperfry.catalog.category"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `category_path` | `string` | Yes |  |
| `max_pages` | `integer` | No | Maximum number of result pages to fetch. From 1 to 25. |
| `page` | `integer` | No | One-based result page to fetch. From 1 to 200. |

### Example input

```json
{
  "category_path": "/category/sofas.html",
  "max_pages": 1,
  "page": 1
}
```

## Response

Successful output is returned in `results[0].data`. Raw platform output is intentionally open-ended and may evolve with the upstream source.

### Illustrative sample output

This redacted fixture is an example, not a fixed response schema.

```json
{
  "category_path": "/category/sofas.html",
  "end_page": 1,
  "has_more": true,
  "listings": [
    {
      "currency": "INR",
      "page": 1,
      "position": 1,
      "product_id": "2195300",
      "title": "Cresco Fabric 3 Seater Sofa In Camel Brown Colour",
      "url": "https://www.pepperfry.com/product/[redacted:token].html"
    },
    {
      "currency": "INR",
      "page": 1,
      "position": 2,
      "product_id": "2315175",
      "title": "Moss 3 Seater Sofa In White Colour",
      "url": "https://www.pepperfry.com/product/[redacted:token].html"
    },
    {
      "currency": "INR",
      "page": 1,
      "position": 3,
      "product_id": "2191642",
      "title": "Frejol Velvet 3 Seater Sofa In Cream Colour",
      "url": "https://www.pepperfry.com/product/[redacted:token].html"
    }
  ],
  "pages_fetched": 1,
  "start_page": 1
}
```
### Illustrative output fields

Derived from the sample above for orientation only. These fields are not a fixed response schema.

| Path | Observed type | Example |
| --- | --- | --- |
| `category_path` | `string` | /category/sofas.html |
| `end_page` | `integer` | 1 |
| `has_more` | `boolean` | true |
| `listings` | `array` | 3 items |
| `listings` | `array` | 3 items |
| `pages_fetched` | `integer` | 1 |
| `start_page` | `integer` | 1 |

## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)

POST /execute Shared execution endpoint

Input parameters

category_path string required

Example /category/sofas.html

max_pages integer optional

Maximum number of result pages to fetch. From 1 to 25.

Example 1

page integer optional

One-based result page to fetch. From 1 to 200.

Example 1

Response

Successful output is returned in results[0].data. Raw platform output is intentionally open-ended and may evolve with the upstream source.

Illustrative sample The full redacted fixture is shown in the response panel.

Illustrative output fields

Derived from the sample above for orientation only. These observed fields are not a fixed response schema.

Path	Observed type	Example
`category_path`	`string`	/category/sofas.html
`end_page`	`integer`	1
`has_more`	`boolean`	true
`listings`	`array`	3 items
`listings`	`array`	3 items
`pages_fetched`	`integer`	1
`start_page`	`integer`	1

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer $UPSCRAPE_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "category_path": "/category/sofas.html", "max_pages": 1, "page": 1 }, "capability": "pepperfry.catalog.category" }'

import json import os import requests payload = json.loads(r'''{ "input": { "category_path": "/category/sofas.html", "max_pages": 1, "page": 1 }, "capability": "pepperfry.catalog.category" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": f"Bearer {os.environ['UPSCRAPE_API_KEY']}", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))

{ "category_path": "/category/sofas.html", "end_page": 1, "has_more": true, "listings": [ { "currency": "INR", "page": 1, "position": 1, "product_id": "2195300", "title": "Cresco Fabric 3 Seater Sofa In Camel Brown Colour", "url": "https://www.pepperfry.com/product/[redacted:token].html" }, { "currency": "INR", "page": 1, "position": 2, "product_id": "2315175", "title": "Moss 3 Seater Sofa In White Colour", "url": "https://www.pepperfry.com/product/[redacted:token].html" }, { "currency": "INR", "page": 1, "position": 3, "product_id": "2191642", "title": "Frejol Velvet 3 Seater Sofa In Cream Colour", "url": "https://www.pepperfry.com/product/[redacted:token].html" } ], "pages_fetched": 1, "start_page": 1 }