# Squaup Discovery Extractor (`getdataforme/squaup-discovery-extractor`) Actor

The Squaup Discovery Extractor is a web scraping tool for extracting detailed information from Square's product and service pages....

- **URL**: https://apify.com/getdataforme/squaup-discovery-extractor.md
- **Developed by:** [GetDataForMe](https://apify.com/getdataforme) (community)
- **Categories:** AI, Automation, E-commerce
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $9.00 / 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/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

---

## README.md

### Squaup Discovery Extractor

#### Introduction

The **Squaup Discovery Extractor** is a powerful web scraping tool designed to extract detailed information from Square's product and service pages. It enables users to gather data efficiently for market research, competitive analysis, and business intelligence.

#### Features

- **Comprehensive Data Extraction**: Captures essential details such as URLs, titles, categories, descriptions, and meta descriptions.
- **Customizable Search Parameters**: Allows configuration of search keys and specific URLs to target relevant content.
- **Flexible Item Limiting**: Users can set a maximum number of items to scrape per run or opt for unlimited extraction.
- **High-Quality Data Output**: Ensures reliable and structured data output suitable for various applications.
- **User-Friendly Configuration**: Simple setup with clear input parameters, making it accessible even for non-technical users.

#### Input Parameters Table

| Parameter   | Type    | Required | Description                                                                 | Example                  |
|-------------|---------|----------|-----------------------------------------------------------------------------|--------------------------|
| SearchKeys  | Array   | No       | The search keys for the spider.                                             | `["software"]`           |
| Urls        | Array   | Yes      | URLs to scrape, must be valid HTTP/HTTPS links.                              | `["https://squareup.com/us/en/"]` |
| item_limit  | Integer | No       | Maximum items to scrape per actor run; set to 0 for no limit.                | `10`                     |

#### Example Usage

##### Input JSON
```json
{
  "SearchKeys": ["software"],
  "Urls": ["https://squareup.com/us/en/"],
  "item_limit": 10
}
````

##### Output JSON

```json
[
  {
    "url": "https://squareup.com/us/en/software",
    "uid": "1098546686",
    "title": "Business Software & Tools | Square Products & Features",
    "name": "Business Software & Tools | Square Products & Features",
    "category": "Products",
    "meta_description": "Explore Square's robust software and solutions for revenue growth, efficient operation and impactful customer interactions.",
    "description": "... See how Square stacks up against other business software solutions Explore our pricing plans to get everything you need at once FAQ What is business software? Business software is the programs, solutions, and tools that allow businesses to perform specific functions. Business software improves efficiency, accuracy, and helps remove the ...",
    "actor_id": "21n5aTICrjRGxLKQG",
    "run_id": "xk5hKGrlzOwg1hmX4"
  },
  {
    "url": "https://squareup.com/us/en/point-of-sale/restaurants/kiosk-software",
    "uid": "1098546500",
    "title": "Kiosk Software | Restaurant Kiosk | Square",
    "name": "Kiosk Software | Restaurant Kiosk | Square",
    "category": "Business Types",
    "meta_description": "Square Kiosk software is a self-service ordering solution built for restaurants. Get Square Kiosk software today.",
    "description": "... includes integrated payments and flexible placement options. Order yours today Easy-to-use software The Square Kiosk app keeps your FOH and BOH in sync with instant menu updates and real-time sales data. No third-party software needed. Get the app Flexible payments Customers can tap or dip their ...",
    "actor_id": "21n5aTICrjRGxLKQG",
    "run_id": "xk5hKGrlzOwg1hmX4"
  },
  {
    "url": "https://squareup.com/us/en/solutions/nail-salon",
    "uid": "1098546332",
    "title": "Nail Salon Software by Square Your AllIn One Solution",
    "name": "Nail Salon Software by Square Your AllIn One Solution",
    "category": "Business Types",
    "meta_description": "Automate scheduling, payments, online bookings, and team management with Square's all-in one solution for your nail salon.",
    "description": "... with a personalized onboarding experience.Talk to an expertNail salon software built to help you see the big picture.Square Appointments makes growing and managing your nail salon simple so you can focus on your clients.Stay in the knowAccess your nail salon software anywhere with reports, low-stock alerts, and time tracking ...",
    "actor_id": "21n5aTICrjRGxLKQG",
    "run_id": "xk5hKGrlzOwg1hmX4"
  }
]
```

#### Use Cases

- **Market Research and Analysis**: Gather data on Square's product offerings to understand market trends.
- **Competitive Intelligence**: Monitor competitor products and services for strategic insights.
- **Price Monitoring**: Track pricing changes across different Square solutions.
- **Content Aggregation**: Compile information for content creation or marketing purposes.
- **Academic Research**: Use structured data for studies related to e-commerce platforms.
- **Business Automation**: Integrate extracted data into business processes for enhanced decision-making.

#### Installation and Usage

1. Search for "Squaup Discovery Extractor" in the Apify Store.
2. Click "Try for free" or "Run".
3. Configure input parameters as needed.
4. Click "Start" to begin extraction.
5. Monitor progress in the log.
6. Export results in your preferred format (JSON, CSV, Excel).

#### Output Format

The output is a JSON array containing objects with the following fields:

- `url`: The URL of the extracted page.
- `uid`: A unique identifier for the item.
- `title`: The title of the product or service.
- `name`: An alternative name or description.
- `category`: The category under which the item falls.
- `meta_description`: A brief summary used in search engine results.
- `description`: Detailed information about the product or service.
- `actor_id`: Identifier for the actor instance.
- `run_id`: Identifier for the specific run.

#### Error Handling

The extractor is designed to handle common web scraping errors such as invalid URLs, network issues, and rate limiting. If an error occurs, it will be logged in the Apify console, allowing users to troubleshoot and adjust their configurations accordingly.

#### Rate Limiting and Best Practices

- **Respectful Scraping**: Ensure compliance with Square's terms of service by avoiding excessive requests.
- **Rate Limits**: Implement delays between requests if necessary to prevent being blocked.
- **Efficient Configuration**: Use specific URLs and search keys to minimize unnecessary data extraction.

#### Limitations and Considerations

- The extractor relies on the structure of Square's web pages, which may change over time.
- Users should verify extracted data for accuracy and completeness.
- Custom configurations may be required for complex scraping needs.

### Support

For custom/simplified outputs or bug reports, please contact:

- Email: support@getdataforme.com
- Subject line: "custom support"
- Contact form: [Contact Us](https://getdataforme.com/contact/)

We're here to help you get the most out of this Actor!

# Actor input Schema

## `SearchKeys` (type: `array`):

The search keys for the spider.

## `Urls` (type: `array`):

The urls for the spider.

## `item_limit` (type: `integer`):

Maximum items to scrape per actor run. Set to 0 for no limit.

## Actor input object example

```json
{
  "SearchKeys": [
    "software"
  ],
  "Urls": [
    "https://squareup.com/us/en/"
  ],
  "item_limit": 10
}
```

# Actor output Schema

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

Scraped data items from dataset

# 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("getdataforme/squaup-discovery-extractor").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("getdataforme/squaup-discovery-extractor").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 getdataforme/squaup-discovery-extractor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=getdataforme/squaup-discovery-extractor",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Squaup Discovery Extractor",
        "description": "The Squaup Discovery Extractor is a web scraping tool for extracting detailed information from Square's product and service pages....",
        "version": "0.0",
        "x-build-id": "EgZEFAyG4GtnEGl6C"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/getdataforme~squaup-discovery-extractor/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-getdataforme-squaup-discovery-extractor",
                "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/getdataforme~squaup-discovery-extractor/runs": {
            "post": {
                "operationId": "runs-sync-getdataforme-squaup-discovery-extractor",
                "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/getdataforme~squaup-discovery-extractor/run-sync": {
            "post": {
                "operationId": "run-sync-getdataforme-squaup-discovery-extractor",
                "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": {
                    "SearchKeys": {
                        "title": "Search Keys",
                        "type": "array",
                        "description": "The search keys for the spider.",
                        "default": [
                            "software"
                        ],
                        "items": {
                            "type": "string"
                        }
                    },
                    "Urls": {
                        "title": "Urls",
                        "minItems": 1,
                        "type": "array",
                        "description": "The urls for the spider.",
                        "default": [
                            "https://squareup.com/us/en/"
                        ],
                        "items": {
                            "type": "string"
                        }
                    },
                    "item_limit": {
                        "title": "Item limit",
                        "minimum": 0,
                        "type": "integer",
                        "description": "Maximum items to scrape per actor run. Set to 0 for no limit.",
                        "default": 10
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
