{ "openapi": "3.0.1", "info": { "title": "NPM Registry Scraper — Packages, Maintainers, Scores & Tech", "description": "Scrape JavaScript and TypeScript packages from NPM. Extract package metadata, maintainer email addresses, popularity scores, quality ratings, dependencies, and repository links.", "version": "0.1", "x-build-id": "5MEc8gFUbsjMOZCSE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spotless_studios~npm-packages-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spotless_studios-npm-packages-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/spotless_studios~npm-packages-scraper/runs": { "post": { "operationId": "runs-sync-spotless_studios-npm-packages-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/spotless_studios~npm-packages-scraper/run-sync": { "post": { "operationId": "run-sync-spotless_studios-npm-packages-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "searchQuery": { "title": "Search query / keywords", "type": "string", "description": "Search query or NPM qualifiers (e.g. 'mcp server', 'openai sdk', 'keywords:playwright').", "default": "mcp server" }, "searchQueries": { "title": "Multiple search queries", "type": "array", "description": "Optional list of multiple search queries to run sequentially in a single job.", "items": { "type": "string" } }, "author": { "title": "Maintainer / author username", "type": "string", "description": "Filter packages by NPM author or maintainer username (e.g. 'sindresorhus')." }, "scope": { "title": "Package scope", "type": "string", "description": "Filter by NPM organization scope (e.g. '@modelcontextprotocol', '@langchain', '@types')." }, "ranking": { "title": "Search ranking priority", "enum": [ "optimal", "popularity", "quality", "maintenance" ], "type": "string", "description": "Weight search results by optimal balance, popularity, quality, or maintenance.", "default": "optimal" }, "minScore": { "title": "Minimum overall score (0.0 - 1.0)", "type": "number", "description": "Only keep packages with final score at least this value (e.g. 0.4)." }, "minPopularity": { "title": "Minimum popularity score (0.0 - 1.0)", "type": "number", "description": "Minimum popularity sub-score." }, "minQuality": { "title": "Minimum quality score (0.0 - 1.0)", "type": "number", "description": "Minimum quality sub-score." }, "minMaintenance": { "title": "Minimum maintenance score (0.0 - 1.0)", "type": "number", "description": "Minimum maintenance sub-score." }, "updatedAfter": { "title": "Published / updated after", "type": "string", "description": "Only return packages updated after this date (YYYY-MM-DD, ISO, or relative like '30 days' / '6 months')." }, "packageNames": { "title": "Direct package names or URLs", "type": "array", "description": "Scrape specific NPM packages directly by name or URL (e.g. 'axios', '@anthropic-ai/sdk', 'https://www.npmjs.com/package/zod').", "items": { "type": "string" } }, "includeDetails": { "title": "Include weekly downloads, license & dependencies", "type": "boolean", "description": "Fetch each package's latest manifest and download counter to add weeklyDownloads, license, dependenciesCount, dependencies, hasTypes, enginesNode, and unpackedSizeBytes.", "default": false }, "includeKeywords": { "title": "Include keywords", "type": "array", "description": "Keep only packages matching these keywords or /regex/ in name, description, or keywords.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Skip packages matching any of these keywords or /regex/.", "items": { "type": "string" } }, "keywordMatch": { "title": "Include keyword logic", "enum": [ "any", "all" ], "type": "string", "description": "Require any or all includeKeywords to match.", "default": "any" }, "onlyNewItems": { "title": "Only new packages (monitoring mode)", "type": "boolean", "description": "Remember seen package names across runs and emit only newly discovered packages.", "default": false }, "stateKey": { "title": "Monitor state name", "type": "string", "description": "Separate state key per saved search or schedule.", "default": "default" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of packages to save.", "default": 100 }, "outputPreset": { "title": "Data preset", "enum": [ "full", "lean", "contacts" ], "type": "string", "description": "Choose full record, lean summary, or contacts & links only.", "default": "full" }, "outputFields": { "title": "Output fields", "type": "array", "description": "Keep only these specific fields in each saved record.", "items": { "type": "string" } }, "excludeFields": { "title": "Exclude fields", "type": "array", "description": "Remove specific fields from each saved record.", "items": { "type": "string" } }, "includeEmptyFields": { "title": "Keep empty / null fields", "type": "boolean", "description": "When disabled, strips null and empty values from each saved record.", "default": true }, "requiredFields": { "title": "Required non-empty fields", "type": "array", "description": "Only save records where every listed field has a non-empty value (e.g. publisherEmail, repositoryUrl).", "items": { "type": "string" } }, "maxPages": { "title": "Max search pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum search pages per query (100 packages per page).", "default": 15 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 15, "type": "integer", "description": "Parallel requests when fetching direct package names.", "default": 5 }, "maxRequestRetries": { "title": "Max retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retries per failed HTTP request.", "default": 3 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Timeout per HTTP request.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy settings.", "default": { "useApifyProxy": false } }, "proxyEscalation": { "title": "Auto-escalate proxies when blocked", "type": "boolean", "description": "Automatically step up from direct to Apify datacenter/residential proxies if blocked.", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }