# GraphQL Introspection Extractor (`junipr/graphql-introspection-extractor`) Actor

Extract GraphQL introspection/schema metadata into clean datasets for documentation, QA, comparison, and downstream tooling.

- **URL**: https://apify.com/junipr/graphql-introspection-extractor.md
- **Developed by:** [junipr](https://apify.com/junipr) (community)
- **Categories:** SEO tools, Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $6.50 / 1,000 schema validateds

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 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

## GraphQL Introspection Extractor

### Store Positioning

**Store title:** GraphQL Introspection Extractor

**Short description:** Extract GraphQL introspection/schema metadata into clean datasets for documentation, QA, comparison, and downstream tooling.

**SEO title:** GraphQL Introspection Extractor — API, schema, and developer QA

**SEO description:** Extract GraphQL introspection/schema metadata into clean datasets for documentation, QA, comparison, and downstream tooling. Use it to catch contract drift, schema mistakes, unsafe endpoint assumptions, and developer-tool quality issues before release.

**Categories:** SEO\_TOOLS, DEVELOPER\_TOOLS

**Keywords:** graphql, introspection, extractor, schema, data qa, dataset qa, api/developer qa

### Pay-Per-Event Pricing

This actor uses pay-per-event pricing. Event prices include Apify platform usage; users are not expected to pay a separate platform-usage pass-through charge for the configured pricing model.

- Tier: A1 — API/developer QA
- Primary event: `schema-validated` at $0.00650 base
- Default max charge: $10.00
- Store discounts: FREE/BRONZE base, SILVER discounted, GOLD deepest approved discount

Event set:

- `actor-start`: base $0.00500, GOLD $0.00400. Graphql Introspection Extractor: charged when actor start is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `schema-validated`: base $0.00650, GOLD $0.00520. Graphql Introspection Extractor: charged when schema validated is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `contract-rule-checked`: base $0.00390, GOLD $0.00312. Graphql Introspection Extractor: charged when contract rule checked is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `report-generated`: base $0.05000, GOLD $0.04000. Graphql Introspection Extractor: charged when report generated is completed. The price includes Apify platform usage; no separate usage pass-through is intended.

The actor accepts `actor-start` before work, accepts the primary event before each dataset row, and accepts `report-generated` before writing report files. If `maxChargeUsd` or the live PPE limit blocks a charge, the corresponding row or report is not written.

### Public Task Concepts

- Audit GraphQL Introspection controls on a capped public sample
- Find high-priority GraphQL Introspection issues before release
- Validate GraphQL Introspection evidence from supplied pages
- Prioritize GraphQL Introspection fixes with severity and proof
- Export GraphQL Introspection QA rows for client review
  Convert GraphQL introspection JSON into structured rows.

### What It Does

Extracts types, fields, arguments, enum values, interfaces, directives, descriptions, and deprecation metadata from introspection JSON or an adapter-fetched endpoint.

### Inputs

This actor exposes these input fields in `.actor/input_schema.json`:

- `introspectionJson`
- `endpointUrl`
- `headers`
- `includeDeprecated`
- `includeDescriptions`
- `includeDirectives`
- `maxTypes`
- `timeoutMs`
- `maxChargeUsd`

The exact default sends the standard read-only introspection query to the public Countries GraphQL API and caps extraction to three schema types; the endpoint was verified at 2026-07-12T05:30:00Z.

### Outputs

Dataset rows contain:

- `typeName`
- `typeKind`
- `fieldName`
- `argumentName`
- `returnType`
- `isDeprecated`
- `deprecationReason`
- `descriptionPresent`
- `directiveName`
- `source`

Sample outputs in `examples/output.sample.json` and `output.sample.json` were generated from `examples/input.tiny.json` through actor logic.

### Reports

After the `report-generated` charge is accepted, the actor writes its Markdown, JSON, or CSV reports to the key-value store. A rejected report charge leaves those files unwritten.

### Public Task Concepts

- Validate GraphQL Introspection Extractor before release
- Run a bounded GraphQL Introspection Extractor QA check
- Generate developer QA evidence for GraphQL Introspection Extractor

### Safe use

Use small capped runs first. Network paths are bounded; review output quality and costs before increasing limits.

# Actor input Schema

## `introspectionJson` (type: `object`):

Inline introspection JSON object used by GraphQL Introspection Extractor.

## `endpointUrl` (type: `string`):

Public endpoint URL to fetch or inspect for GraphQL Introspection Extractor.

## `headers` (type: `object`):

Optional request headers for authorized endpoints. Avoid secrets in shared examples and public tasks.

## `includeDeprecated` (type: `boolean`):

Include deprecated in output rows or reports when available.

## `includeDescriptions` (type: `boolean`):

Include descriptions in output rows or reports when available.

## `includeDirectives` (type: `boolean`):

Include directives in output rows or reports when available.

## `maxTypes` (type: `number`):

Maximum types to process in one run; keep defaults low for safe first runs.

## `timeoutMs` (type: `number`):

Maximum time in milliseconds allowed for the GraphQL Introspection Extractor operation before it is treated as timed out.

## `maxChargeUsd` (type: `number`):

Maximum estimated PPE charge allowed for the run before the actor stops gracefully.

## Actor input object example

```json
{
  "endpointUrl": "https://countries.trevorblades.com/",
  "headers": {},
  "includeDeprecated": true,
  "includeDescriptions": true,
  "includeDirectives": true,
  "maxTypes": 3,
  "timeoutMs": 10000,
  "maxChargeUsd": 1
}
```

# 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("junipr/graphql-introspection-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("junipr/graphql-introspection-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 junipr/graphql-introspection-extractor --silent --output-dataset

```

## MCP server setup

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

```

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/JZdNaVRPgpmWm4iFx/builds/XgHbEMTetY6NBFYxG/openapi.json