Name: SitePulse Website Text Change API | Phoenix Club
Brand: phoenix-club
SKU: api-phoenix-club-sitepulse
Availability: InStock
Author: API Market

Cemil Kasapoğlu

# SitePulse Website Text Change API

## Overview

The SitePulse Website Text Change API stores a normalized text baseline for a public web page and compares later fetches against it. Seven endpoints create, list, read and delete watches, run a check on demand, and read retained change events and webhook delivery status. A check tells you whether the text changed, whether the change met your threshold, which lines were added or removed, and whether the baseline advanced.

It is built for teams watching competitor pricing or policy pages, documentation and compliance monitors, and apps that need a signed webhook when a page changes. Checks run only when you call them, so your application controls the schedule and the number of billable fetches, and CSS selectors focus a watch on the part of the page that matters.

## Features

*   **7 endpoints**: create, list, read and delete watches, check now, events and deliveries.
*   **Text diff**: added and removed lines with `change_percent`.
*   **Thresholds**: `minimum_change_percent` separates small edits from significant changes.
*   **Selectors**: focus on a region and ignore noisy elements.
*   **Signed webhooks**: optional HTTPS callback on significant changes.
*   **Rate limit**: 1 request per second, and one check per watch every 60 seconds.

## Use Cases

*   **Competitor monitoring**: watch pricing and feature pages.
*   **Policy and compliance**: detect edits to terms, shipping or privacy pages.
*   **Documentation tracking**: know when an upstream doc changes.
*   **Alerts**: trigger a webhook when a page changes.

## API Documentation

### Base URL

All requests go through the API.market gateway at this base URL:

```
https://prod.api.market/api/v1/phoenix-club/sitepulse
```

### Authentication

Every request needs your API.market key in the `x-api-market-key` header:

```
x-api-market-key: YOUR_API_KEY
```

Replace `YOUR_API_KEY` with your actual API key.

### Endpoints

#### 1. Create a watch and capture its initial baseline

Create a watch and capture its initial baseline.

**Method:** `POST`

**Endpoint:** `/v1/watches`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| url | body | - | string | Yes | - | 2048 |
| selector | body | - | string | No | - | 256 |
| ignore_selectors | body | - | array of string | No | - | 10 |
| minimum_change_percent | body | - | number | No | 0 | 100 |
| webhook_url | body | - | string | No | - | 2048 |
| webhook_secret | body | - | string | No | - | - |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/phoenix-club/sitepulse/v1/watches' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"url": "https://example.com", "minimum_change_percent": 5}'
```

**Example Response (201 Created):**

```json
{
  "ok": true,
  "created": true,
  "watch": {
    "id": "b6c63de5364b4d7f909f9e2f59da50ee",
    "url": "https://example.com/",
    "ignore_selectors": [],
    "minimum_change_percent": 5.0,
    "created_at": "2026-10-27T07:31:12.250531+00:00",
    "observed_at": "2026-10-27T07:31:12.250531+00:00",
    "baseline_hash": "0a080719be9fbb82a86a45b80dc8c2a430fbe17dc93d23758debac092864d00f",
    "expires_at_unix": 1795678272.2505846,
    "webhook_configured": false,
    "check_mode": "on_demand",
    "minimum_check_interval_seconds": 60
  },
  "request_id": "8cd4443dd18649ecb15aaf9d94da5e7d",
  "usage": {
    "api_units": 1
  },
  "note": "Checks are on demand. Schedule calls from your application; registering a watch does not schedule page fetches."
}
```

#### 2. List this customer’s active watches

List this customer’s active watches.

**Method:** `GET`

**Endpoint:** `/v1/watches`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| offset | query | - | integer | No | 0 | 1000 |
| limit | query | - | integer | No | 20 | 50 |

**Example Request:**

```bash
curl -X GET 'https://prod.api.market/api/v1/phoenix-club/sitepulse/v1/watches' \
  -H 'x-api-market-key: YOUR_API_KEY'
```

**Example Response (200 OK):**

```json
{
  "ok": true,
  "items": [
    {
      "id": "e097bdedbfb546d3a21c6e0f749d8649",
      "url": "https://example.com/",
      "selector": null,
      "ignore_selectors": [],
      "minimum_change_percent": 0.0,
      "created_at": "2026-10-27T07:29:38.614436+00:00",
      "observed_at": "2026-10-27T07:29:38.614436+00:00",
      "baseline_hash": "0a080719be9fbb82a86a45b80dc8c2a430fbe17dc93d23758debac092864d00f",
      "expires_at_unix": 1795678178.6145408,
      "webhook_configured": false,
      "check_mode": "on_demand",
      "minimum_check_interval_seconds": 60
    }
  ],
  "usage": {
    "api_units": 0
  }
}
```

#### 3. Get a watch without its stored page content or secrets

Get a watch without its stored page content or secrets.

**Method:** `GET`

**Endpoint:** `/v1/watches/{watch_id}`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| watch_id | path | - | string | Yes | - | - |

**Example Request:**

```bash
curl -X GET 'https://prod.api.market/api/v1/phoenix-club/sitepulse/v1/watches/WATCH_ID' \
  -H 'x-api-market-key: YOUR_API_KEY'
```

**Example Response (200 OK):**

```json
{
  "ok": true,
  "watch": {
    "id": "b6c63de5364b4d7f909f9e2f59da50ee",
    "url": "https://example.com/",
    "selector": null,
    "ignore_selectors": [],
    "minimum_change_percent": 5.0,
    "created_at": "2026-10-27T07:31:12.250531+00:00",
    "observed_at": "2026-10-27T07:31:12.250531+00:00",
    "baseline_hash": "0a080719be9fbb82a86a45b80dc8c2a430fbe17dc93d23758debac092864d00f",
    "expires_at_unix": 1795678272.2505846,
    "webhook_configured": false,
    "check_mode": "on_demand",
    "minimum_check_interval_seconds": 60
  },
  "usage": {
    "api_units": 0
  }
}
```

#### 4. Delete a watch and its event/delivery history

Delete a watch and its event/delivery history.

**Method:** `DELETE`

**Endpoint:** `/v1/watches/{watch_id}`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| watch_id | path | - | string | Yes | - | - |

**Example Request:**

```bash
curl -X DELETE 'https://prod.api.market/api/v1/phoenix-club/sitepulse/v1/watches/WATCH_ID' \
  -H 'x-api-market-key: YOUR_API_KEY'
```

**Example Response (200 OK):**

```json
{
  "ok": true,
  "deleted": true,
  "usage": {
    "api_units": 0
  }
}
```

#### 5. Fetch the page now and compare with the baseline

Fetch the page now and compare with the baseline.

**Method:** `POST`

**Endpoint:** `/v1/watches/{watch_id}/check`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| watch_id | path | - | string | Yes | - | - |

**Example Request:**

```bash
curl -X POST 'https://prod.api.market/api/v1/phoenix-club/sitepulse/v1/watches/WATCH_ID/check' \
  -H 'x-api-market-key: YOUR_API_KEY'
```

**Example Response (200 OK):**

```json
{
  "ok": true,
  "watch_id": "e097bdedbfb546d3a21c6e0f749d8649",
  "changed": false,
  "significant": false,
  "current_hash": "0a080719be9fbb82a86a45b80dc8c2a430fbe17dc93d23758debac092864d00f",
  "checked_at": "2026-10-27T07:30:43.340404+00:00",
  "final_url": "https://example.com/",
  "event": null,
  "baseline_advanced": true,
  "baseline_hash": "0a080719be9fbb82a86a45b80dc8c2a430fbe17dc93d23758debac092864d00f",
  "observed_at": "2026-10-27T07:30:43.323468+00:00",
  "change": {
    "change_percent": 0.0,
    "added_lines": [],
    "removed_lines": [],
    "diff_truncated": false,
    "metric": "SequenceMatcher ratio over normalized static text lines; not a visual pixel percentage."
  },
  "usage": {
    "api_units": 1
  },
  "request_id": "22f9060c877e47f79e06f13d24ce2943"
}
```

#### 6. Read up to ten retained change events

Read up to ten retained change events.

**Method:** `GET`

**Endpoint:** `/v1/watches/{watch_id}/events`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| watch_id | path | - | string | Yes | - | - |

**Example Request:**

```bash
curl -X GET 'https://prod.api.market/api/v1/phoenix-club/sitepulse/v1/watches/WATCH_ID/events' \
  -H 'x-api-market-key: YOUR_API_KEY'
```

**Example Response (200 OK):**

```json
{
  "ok": true,
  "items": [],
  "usage": {
    "api_units": 0
  }
}
```

#### 7. Read callback delivery status without callback URLs or secrets

Read callback delivery status without callback URLs or secrets.

**Method:** `GET`

**Endpoint:** `/v1/watches/{watch_id}/deliveries`

**Parameters:**

| Name | In | Description | Type | Required | Default | Max Value |
|---|---|---|---|---|---|---|
| watch_id | path | - | string | Yes | - | - |

**Example Request:**

```bash
curl -X GET 'https://prod.api.market/api/v1/phoenix-club/sitepulse/v1/watches/WATCH_ID/deliveries' \
  -H 'x-api-market-key: YOUR_API_KEY'
```

**Example Response (200 OK):**

```json
{
  "ok": true,
  "items": [],
  "usage": {
    "api_units": 0
  }
}
```

## Status Codes

| Code | Status | Description |
|---|---|---|
| 200 | OK | The request succeeded and the body holds the result. |
| 400 | Bad Request | The body is not valid JSON, `url` is missing or not public, or a selector is not supported. |
| 401 | Unauthorized | The `x-api-market-key` header is missing, invalid or expired. |
| 403 | Forbidden | Your subscription does not include this endpoint. |
| 404 | Not Found | The path, or the item you asked for, does not exist. |
| 429 | Too Many Requests | You sent more than 1 request per second, or you used all 25 calls of the Trial plan. |
| 500 | Internal Server Error | Something failed on the provider side. Retry after a short delay. |
| 503 | Service Unavailable | The service or its data source is temporarily unavailable. Retry with backoff. |

## Rate Limits

You can send up to 1 request per second. Free includes 25 calls (a 7-day trial), Starter includes 1,000 calls a month for $9.99 and Pro includes 5,000 calls a month for $24.99. Requests above the limit return `429 Too Many Requests`; throttle your requests, back off before retrying, and honour the `Retry-After` header when it is present.

## FAQ

*   **Does SitePulse check pages automatically?**
    No. Checks run when you call `POST /v1/watches/{watch_id}/check`; schedule those calls in your application.

*   **What is the difference between `changed` and `significant`?**
    `changed` means any text difference; `significant` means it met `minimum_change_percent`. Small changes do not advance the baseline.

*   **How often can I check a watch?**
    Once every 60 seconds per watch.

*   **Where is the webhook secret?**
    If SitePulse generates one, it is returned once when you create the watch; store it then.

## Contact Us

If you have any questions or need assistance, you can reach out to us through the embedded chat on the bottom right corner of the page or send an email to hello@magicapi.com.


On-demand website text comparisons with persistent baselines, CSS selectors, change history and signed webhook delivery. Your application schedules checks.

SitePulse Website Text Change API | Phoenix Club