# Trademe Properties Parser Spider (`getdataforme/trademe-properties-parser-spider`) Actor

Extract detailed rental property listings from TradeMe.co.nz effortlessly. This Apify Actor scrapes key data like prices, locations, amenities, and agent info, delivering structured JSON for analysis, monitoring, and integration....

- **URL**: https://apify.com/getdataforme/trademe-properties-parser-spider.md
- **Developed by:** [GetDataForMe](https://apify.com/getdataforme) (community)
- **Categories:** AI, Agents, E-commerce
- **Stats:** 3 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/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — 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

## Apify Template for Scrapy Spiders

This repository serves as a template for deploying Scrapy spiders to Apify. It is automatically updated by a GitHub Actions workflow in the central repository (`getdataforme/central_repo`) when changes are pushed to spider files in `src/spiders/` or `src/custom/`. Below is an overview of the automated tasks performed to keep this repository in sync.

### Automated Tasks

The following tasks are executed by the GitHub Actions workflow when a spider file (e.g., `src/spiders/example/example_parser_spider.py`) is modified in the central repository:

1. **Repository Creation**:
   - Creates a new Apify repository (e.g., `example_apify`) from this template (`apify_template`) using the GitHub API, if it doesn't already exist.
   - Grants push permissions to the `scraping` team in the `getdataforme` organization.

2. **Spider File Sync**:
   - Copies the modified spider file (e.g., `example_parser_spider.py`) from the central repository to `src/spiders/` in this repository.
   - Copies the associated `requirements.txt` (if present) from the spider's directory (e.g., `src/spiders/example/`) to the root of this repository.

3. **Input Schema Generation**:
   - Runs `generate_input_schema.py` to create `.actor/input_schema.json`.
   - Parses the spider's `__init__` method (e.g., `def __init__(self, location:str, item_limit:int=100, county:str="Japan", *args, **kwargs)`) to generate a JSON schema.
   - Supports types: `string`, `integer`, `boolean`, `number` (for Python `str`, `int`, `bool`, `float`).
   - Uses `prefill` for strings and `default` for non-strings, with appropriate `editor` values (`textfield`, `number`, `checkbox`).
   - Marks parameters without defaults (e.g., `location`) as `required`.

4. **Main Script Update**:
   - Runs `update_main.py` to update `src/main.py`.
   - Updates the `actor_input` section to fetch input values matching the spider's `__init__` parameters (e.g., `location`, `item_limit`, `county`).
   - Updates the `process.crawl` call to pass these parameters to the spider (e.g., `process.crawl(Spider, location=location, item_limit=item_limit, county=county)`).
   - Preserves existing settings, comments, and proxy configurations.

5. **Actor Configuration Update**:
   - Updates `.actor/actor.json` to set the `name` field based on the repository name, removing the `_apify` suffix (e.g., `example_apify` → `example`).
   - Uses `jq` to modify the JSON file while preserving other fields (e.g., `title`, `description`, `input`).

6. **Commit and Push**:
   - Commits changes to `src/spiders/$spider_file`, `requirements.txt`, `.actor/input_schema.json`, `src/main.py`, and `.actor/actor.json`.
   - Pushes the changes to the `main` branch of this repository.

### Repository Structure

- `src/spiders/`: Contains the Scrapy spider file (e.g., `example_parser_spider.py`).
- `src/main.py`: Main script to run the spider with Apify Actor integration.
- `.actor/input_schema.json`: JSON schema defining the spider's input parameters.
- `.actor/actor.json`: Actor configuration with the repository name and metadata.
- `requirements.txt`: Python dependencies for the spider.
- `Dockerfile`: Docker configuration for running the Apify Actor.

### Prerequisites

- The central repository (`getdataforme/central_repo`) must contain:
  - `generate_input_schema.py` and `update_main.py` in the root.
  - Spider files in `src/spiders/` or `src/custom/` with a valid `__init__` method.
- The GitHub Actions workflow requires a `GITHUB_TOKEN` with repository creation and write permissions.
- `jq` and `python3` are installed in the workflow environment.

### Testing

To verify the automation:

1. Push a change to a spider file in `src/spiders/` or `src/custom/` in the central repository.
2. Check the generated Apify repository (e.g., `getdataforme/example_apify`) for:
   - Updated `src/spiders/$spider_file`.
   - Correct `input_schema.json` with parameters matching the spider's `__init__`.
   - Updated `src/main.py` with correct `actor_input` and `process.crawl` lines.
   - Updated `.actor/actor.json` with the correct `name` field.

### Notes

> **Warning**: This Apify actor repository is automatically generated and updated by the GitHub Actions workflow in `getdataforme/central_repo`. **Do not edit this repository directly**. To modify the spider, update the corresponding file in `src/spiders/` or `src/custom/` in the central repository, and the workflow will sync changes to this repository, including:
>
> - Copying the spider file to `src/spiders/`.
> - Generating `.actor/input_schema.json` based on the spider’s `__init__` parameters.
> - Updating `src/main.py` with correct input handling and spider execution.
> - Setting the `name` field in `.actor/actor.json` (e.g., `example` for `example_apify`).
>
> **Verification**: After the workflow completes, verify the actor by checking:
>
> - `src/spiders/$spider_file` matches the central repository.
> - `.actor/input_schema.json` includes all `__init__` parameters with correct types and defaults.
> - `src/main.py` has updated `actor_input` and `process.crawl` lines.
> - `.actor/actor.json` has the correct `name`.
> - Optionally, deploy the actor to Apify and test with sample inputs to ensure functionality.

- The workflow supports multiple spider types (`scrapy`, `hrequest`, `playwright`) based on the file path (`src/spiders/`, `src/custom/*/hrequest/`, `src/custom/*/playwright/`).
- Commits with `[apify]` in the message update only Apify repositories; `[internal]` updates only internal repositories; otherwise, both are updated.
- Ensure the spider's `__init__` uses supported types (`str`, `int`, `bool`, `float`) to avoid schema generation errors.

For issues, check the GitHub Actions logs in the central repository or contact the `scraping` team.

# Actor input Schema

## `StartUrl` (type: `array`):

The start url for the spider.

## `Keyword` (type: `array`):

The keyword for the spider.

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

Specifies proxy servers that will be used by the scraper in order to hide its origin.

## `itemLimit` (type: `integer`):

Specifies the maximum number of items to process.

## Actor input object example

```json
{
  "Keyword": [
    "rent"
  ],
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ]
  },
  "itemLimit": 20
}
```

# 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 = {
    "proxyConfiguration": {
        "useApifyProxy": true,
        "apifyProxyGroups": [
            "RESIDENTIAL"
        ]
    },
    "itemLimit": 20
};

// Run the Actor and wait for it to finish
const run = await client.actor("getdataforme/trademe-properties-parser-spider").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 = {
    "proxyConfiguration": {
        "useApifyProxy": True,
        "apifyProxyGroups": ["RESIDENTIAL"],
    },
    "itemLimit": 20,
}

# Run the Actor and wait for it to finish
run = client.actor("getdataforme/trademe-properties-parser-spider").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 '{
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ]
  },
  "itemLimit": 20
}' |
apify call getdataforme/trademe-properties-parser-spider --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,getdataforme/trademe-properties-parser-spider"
        }
    }
}

```

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/ta1w7zP6mmeOay9fL/builds/l5SNtfpSSvbuodR5S/openapi.json