# Developer Docs & API Finder (`bmiller1009/developer-docs-api-finder`) Actor

Discover a domain's likely developer portal, API documentation, OpenAPI/Swagger spec, SDK docs, GitHub, and status page.

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

## Pricing

from $80.00 / 1,000 completed developer docs 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

## Developer Docs & API Finder

Given a domain, discover its likely developer portal, API documentation, OpenAPI/Swagger specification, SDK documentation, GitHub presence, status page, and other reference docs.

### What it finds

- Developer portal / documentation site
- OpenAPI/Swagger API descriptions
- SDK documentation
- GitHub organization or repository presence
- Status pages and reference documentation

Each discovered result includes a type label, its URL, and a confidence score. The Actor performs a live discovery scan through Sentinel Verify — it never requires the domain to already be registered anywhere.

### Pricing

**This is a paid, pay-per-event Actor: $0.08 per completed scan.**

Exactly one `docs-finder-scan` 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 search, e.g. `example.com`.

Example input:

```json
{
  "domain": "example.com"
}
```

### Output

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

Representative abbreviated output:

```json
{
  "status": "success",
  "target": {"identifier": "example.com"},
  "result": {
    "domain": "example.com",
    "documentationFound": true,
    "results": [
      {"type": "developer_docs", "url": "https://docs.example.com", "confidence": 0.96},
      {"type": "openapi", "url": "https://api.example.com/openapi.json", "confidence": 0.88}
    ]
  }
}
```

`restricted` means API-IFY rejected the target locally before calling Verify. `unreachable` means the domain could not be reached. `dependency_unavailable` means Verify was temporarily unavailable.

### How it works

This Actor is a thin wrapper around Sentinel Verify's `POST /v1/utilities/detect-docs` endpoint. Each domain is checked locally against API-IFY's public-network policy before being sent to Verify.

### Limitations

- Public HTTPS domains only; private, loopback, link-local, metadata, reserved, and CGNAT targets are rejected.
- This reports discovered documentation surfaces and a confidence score, not a guarantee any given link is current or complete.
- Scan availability depends on Sentinel Verify.

### Privacy and security

The target domain is sent to Sentinel's live Utility API (`/v1/utilities/detect-docs`) for analysis after local public-network validation. Results are stored in the customer's Apify run dataset and summary store. `VERIFY_API_KEY` is an operator-managed Actor secret — a scoped `utilities:read` Intelligence API key sent as a bearer token on every request, the same credential mechanism used by any other Utility API consumer; `VERIFY_BASE_URL` is an operator setting, not an Actor input.

### 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 search for developer docs, API specs, and SDK references, e.g. example.com.

## Actor input object example

```json
{}
```

# 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/developer-docs-api-finder").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/developer-docs-api-finder").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/developer-docs-api-finder --silent --output-dataset

```

## MCP server setup

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

```

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/NRgthTDjbW7XIlbIc/builds/gWATDn9aJMS0ALs3D/openapi.json
