# Dollar General Scraper Clean (`dromb/dollar-general-scraper-clean`) Actor

Dollar General product listings, product details, filters, categories, store details, and store directory results.

- **URL**: https://apify.com/dromb/dollar-general-scraper-clean.md
- **Developed by:** [Dmitriy Gyrbu](https://apify.com/dromb) (community)
- **Categories:** Automation, Developer tools, E-commerce
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.40 / 1,000 results

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

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

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
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.
Actors are written with capital "A".

## 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.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## Dollar General Product Store Scraper

This unofficial actor extracts Dollar General product listings, product details, filters, categories, store details, and store directory results. It is useful for price monitoring, product research, store-aware availability checks, and retail data workflows.

This actor is not affiliated with, endorsed by, or sponsored by Dollar General.

### Quick Start

```json
{
  "operation": "search",
  "query": "milk",
  "store_id": 1,
  "page": 1,
  "limit": 5
}
````

### Supported Operations

| Operation | Purpose | Required Input | Example |
| --- | --- | --- | --- |
| `probe` | Check basic storefront/API connectivity with a one-item milk search. | `store_id` optional | `{"operation":"probe","store_id":1}` |
| `categories` | Extract top-level navigation categories. | None | `{"operation":"categories"}` |
| `store` | Resolve one store by store number. | `store_id` | `{"operation":"store","store_id":1}` |
| `stores` | Search store directory by `City, ST` or exact store number. | `query` | `{"operation":"stores","query":"Ada, OK","limit":5}` |
| `search_filters` | Return search/category filters and sort options. | `query` or category identifier, plus `store_id` | `{"operation":"search_filters","query":"milk","store_id":1}` |
| `search` | Search products by keyword in a store context. | `query`, `store_id` | `{"operation":"search","query":"milk","store_id":1,"limit":5}` |
| `category` | Browse products in one category. | `category_id`, `category_slug`, or `category_url`; plus `store_id` | `{"operation":"category","category_id":"639","store_id":1,"limit":5}` |
| `item` | Resolve one product detail page by UPC or product URL. | `upc` or `item_url`; plus `store_id` | `{"operation":"item","upc":"014800002294","store_id":1}` |

### Input Fields

`operation` selects the endpoint. `query` is used for product search, filters, and store lookup. `store_id` controls store-aware pricing and availability. `page` and `limit` paginate product and store result operations. `category_id`, `category_slug`, and `category_url` identify category pages. `upc` and `item_url` identify item detail pages. `include_reviews` is accepted for item compatibility, but review rows may be empty if Dollar General does not expose review data in the product payload.

`sort` accepts `recommended`, `price_asc`, `price_desc`, and `highest_rated`.

### Output

Dataset rows are pushed as individual records. Product rows commonly include `operation`, `record_type`, `id`, `upc`, `barcode`, `name`, `price`, `discount_price`, `effective_price`, `currency`, `image`, `source_url`, `breadcrumbs`, `store_id`, `in_stock`, `available_quantity`, `rating`, and `review_count`.

Store rows commonly include `operation`, `record_type`, `store_id`, `name`, `address1`, `city`, `state`, `postal_code`, `phone`, `latitude`, `longitude`, `hours`, `pickup`, and `delivery`.

Category and filter rows include `operation`, `record_type`, identifiers, names/titles, URLs or slugs when available, counts, options, and selection metadata.

### Limitations

Store directory lookup is most reliable with `City, ST` values or exact numeric store IDs. A zero-item store lookup should not be treated as validation of the stores operation; retest with another known valid location. Product and category availability is store-aware, so prices and inventory can change by `store_id`.

### Troubleshooting

Use `probe` first if product operations fail. If `category` cannot resolve a URL or slug, call `categories` or `search_filters` to discover a fresh category ID. If `item` fails, derive `upc` from a fresh `search` or `category` result.

### Privacy And Publication

This actor is intended to remain private until the owner publishes it manually. No publication or visibility changes are required for normal testing.

# Actor input Schema

## `operation` (type: `string`):

The operation to perform.

## `query` (type: `string`):

Product search keyword for search/search\_filters, or a store lookup query such as 'Ada, OK' for stores.

## `store_id` (type: `integer`):

Dollar General store number used for product pricing, inventory, store details, and item detail.

## `page` (type: `integer`):

1-based page number.

## `limit` (type: `integer`):

Maximum product, store, or filter rows to retrieve.

## `category_id` (type: `string`):

Dollar General category ID for category browsing or category-based filters. Example 639 is Food & Beverage > Beverages.

## `category_url` (type: `string`):

Full Dollar General category URL for category browsing or category-based filters.

## `category_slug` (type: `string`):

Relative Dollar General category path.

## `upc` (type: `string`):

Product UPC for item operation. Derive a current UPC from search or category results when possible.

## `item_url` (type: `string`):

Full Dollar General product URL. A UPC in the URL is used for item operation.

## `include_reviews` (type: `boolean`):

Include review list for items.

## `sort` (type: `string`):

recommended, price\_asc, price\_desc, highest\_rated

## Actor input object example

```json
{
  "operation": "search",
  "query": "milk",
  "store_id": 1,
  "page": 1,
  "limit": 5,
  "include_reviews": false,
  "sort": "recommended"
}
```

# Actor output Schema

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

Dataset items returned by the selected operation.

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

Run summary JSON stored under the OUTPUT key when available.

# 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 = {};

// Run the Actor and wait for it to finish
const run = await client.actor("dromb/dollar-general-scraper-clean").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 = {}

# Run the Actor and wait for it to finish
run = client.actor("dromb/dollar-general-scraper-clean").call(run_input=run_input)

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

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

```

## CLI example

```bash
echo '{}' |
apify call dromb/dollar-general-scraper-clean --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=dromb/dollar-general-scraper-clean",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Dollar General Scraper Clean",
        "description": "Dollar General product listings, product details, filters, categories, store details, and store directory results.",
        "version": "0.1",
        "x-build-id": "cCkjkAFqwHewKbeYr"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/dromb~dollar-general-scraper-clean/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-dromb-dollar-general-scraper-clean",
                "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/dromb~dollar-general-scraper-clean/runs": {
            "post": {
                "operationId": "runs-sync-dromb-dollar-general-scraper-clean",
                "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/dromb~dollar-general-scraper-clean/run-sync": {
            "post": {
                "operationId": "run-sync-dromb-dollar-general-scraper-clean",
                "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",
                "required": [
                    "operation"
                ],
                "properties": {
                    "operation": {
                        "title": "Operation",
                        "enum": [
                            "probe",
                            "categories",
                            "store",
                            "stores",
                            "search_filters",
                            "search",
                            "category",
                            "item"
                        ],
                        "type": "string",
                        "description": "The operation to perform.",
                        "default": "search"
                    },
                    "query": {
                        "title": "Query",
                        "type": "string",
                        "description": "Product search keyword for search/search_filters, or a store lookup query such as 'Ada, OK' for stores.",
                        "default": "milk"
                    },
                    "store_id": {
                        "title": "Store ID",
                        "type": "integer",
                        "description": "Dollar General store number used for product pricing, inventory, store details, and item detail.",
                        "default": 1
                    },
                    "page": {
                        "title": "Page",
                        "type": "integer",
                        "description": "1-based page number.",
                        "default": 1
                    },
                    "limit": {
                        "title": "Limit",
                        "minimum": 1,
                        "maximum": 100,
                        "type": "integer",
                        "description": "Maximum product, store, or filter rows to retrieve.",
                        "default": 5
                    },
                    "category_id": {
                        "title": "Category ID",
                        "type": "string",
                        "description": "Dollar General category ID for category browsing or category-based filters. Example 639 is Food & Beverage > Beverages."
                    },
                    "category_url": {
                        "title": "Category URL",
                        "type": "string",
                        "description": "Full Dollar General category URL for category browsing or category-based filters."
                    },
                    "category_slug": {
                        "title": "Category Slug",
                        "type": "string",
                        "description": "Relative Dollar General category path."
                    },
                    "upc": {
                        "title": "UPC",
                        "type": "string",
                        "description": "Product UPC for item operation. Derive a current UPC from search or category results when possible."
                    },
                    "item_url": {
                        "title": "Item URL",
                        "type": "string",
                        "description": "Full Dollar General product URL. A UPC in the URL is used for item operation."
                    },
                    "include_reviews": {
                        "title": "Include Reviews",
                        "type": "boolean",
                        "description": "Include review list for items.",
                        "default": false
                    },
                    "sort": {
                        "title": "Sort",
                        "type": "string",
                        "description": "recommended, price_asc, price_desc, highest_rated",
                        "default": "recommended"
                    }
                }
            },
            "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
                                    }
                                }
                            },
                            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
