# API Exposure Diff (`bmiller1009/api-exposure-diff`) Actor

Discover public API surfaces on a domain and diff them against a prior snapshot to detect meaningful exposure changes.

- **URL**: https://apify.com/bmiller1009/api-exposure-diff.md
- **Developed by:** [Sentinel Signal](https://apify.com/bmiller1009) (community)
- **Categories:** Developer tools
- **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $100.00 / 1,000 completed api surface scans

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

## API Exposure Diff

Discover public API surfaces on a domain — OpenAPI/Swagger documents, GraphQL endpoints, Swagger UI/Redoc pages, REST documentation pages — and, given a prior snapshot, produce a severity-scored diff of what changed.

### What it checks

- Crawls the domain for API surface signals: OpenAPI/Swagger JSON and YAML documents, GraphQL endpoints, Swagger UI and Redoc pages, and linked REST documentation.
- Normalizes and fingerprints every discovered surface into a stable snapshot.
- When a prior snapshot is supplied as `baseline`, diffs the current snapshot against it and reports each meaningful change with a severity.

### Pricing

**This is a paid, pay-per-event Actor: $0.10 per completed run.**

A scan-only run (no `baseline` supplied) charges one `api-surface-scan` event; a run with a `baseline` charges one `api-surface-diff` event instead. Exactly one event is charged per run, only after a real result exists (`success` or a useful `partial`). There is no charge for invalid input, a target blocked by the public-network policy, or a run that fails before a result is produced.

### Input

- `domain` (required): a public domain or HTTPS origin to crawl, e.g. `example.com`.
- `baseline` (optional): the `normalizedSnapshot`-shaped `snapshot` object returned by a prior run of this Actor. When supplied, the run also produces a severity-scored diff against it.
- `maxCrawlPages` (optional, default 40): upper bound on pages/resources fetched while discovering API surfaces.

Example input — first scan:

```json
{"domain": "example.com", "maxCrawlPages": 40}
```

Example input — diff against a prior snapshot:

```json
{"domain": "example.com", "baseline": {"...": "the snapshot object from a prior run's result"}}
```

### Output

The default dataset receives one result envelope per run; `RUN_SUMMARY` in the default key-value store records processing, delivery, billing, dependency, and budget totals.

Representative scan-only output (produced through the Actor's real service path):

```json
{
  "status": "success",
  "target": {"type": "domain", "identifier": "example.com"},
  "result": {
    "domain": "example.com",
    "snapshot": {
      "schemaVersion": "api-surface-snapshot/1",
      "domain": "example.com",
      "surfaces": [],
      "snapshotFingerprint": "4f53cda18c2baa0c0354bb5f9a3ecbe5ed12ab4d8e11ba873c2f11161202b945"
    },
    "diff": null,
    "pagesFetched": 12,
    "partial": false
  }
}
```

Representative diff output, re-run with the snapshot above as `baseline` against an unchanged domain:

```json
{
  "diff": {
    "schemaVersion": "api-surface-diff/1",
    "baselineSnapshotFingerprint": "4f53cda18c2baa0c0354bb5f9a3ecbe5ed12ab4d8e11ba873c2f11161202b945",
    "currentSnapshotFingerprint": "4f53cda18c2baa0c0354bb5f9a3ecbe5ed12ab4d8e11ba873c2f11161202b945",
    "entries": [],
    "summaryCounts": {}
  }
}
```

`restricted` means the target resolved to a non-public address and was rejected locally, with zero outbound requests and no charge. Failures are isolated per target.

### Limitations

- Public HTTPS domains only; private, loopback, link-local, metadata, reserved, and CGNAT targets are rejected before any request is made.
- Discovery only — the Actor never calls or executes any discovered API operation.

### Privacy and security

The target domain is crawled directly by this Actor after local public-network validation (no external analysis dependency). Results are stored in the customer's Apify run dataset and summary store. Do not place credentials in target domains.

### Support

For a reproducible support request, provide the Apify run ID, result `itemId`, and status. Contact Sentinel Signal Systems through the support link on the Actor page.

# Actor input Schema

## `domain` (type: `string`):

A public domain or HTTPS origin to crawl for API surfaces, e.g. example.com.

## `baseline` (type: `object`):

The normalizedSnapshot result from a prior run of this Actor. When supplied, the run also produces a severity-scored diff against it.

## `maxCrawlPages` (type: `integer`):

Upper bound on the number of pages/resources fetched while discovering API surfaces.

## Actor input object example

```json
{
  "maxCrawlPages": 40
}
```

# Actor output Schema

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

No description

## `runSummary` (type: `string`):

No description

# 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("bmiller1009/api-exposure-diff").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("bmiller1009/api-exposure-diff").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 '{}' |
apify call bmiller1009/api-exposure-diff --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,bmiller1009/api-exposure-diff"
        }
    }
}

```

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/TCeWHZcIarhfknQh2/builds/JXyp9JSPpSaeyHSiS/openapi.json