{ "openapi": "3.0.1", "info": { "title": "GitHub Scraper: Repos, Releases, Issues, PRs & Contributors", "description": "Export GitHub repository stats, releases with asset download counts, issues, pull requests, contributors, commits and repository search results. Official REST API, no HTML parsing. Works without a token; add one to lift the rate limit.", "version": "0.0", "x-build-id": "B26OggP9ZkvSxZBzd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/winterlock~github-repo-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-winterlock-github-repo-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/winterlock~github-repo-scraper/runs": { "post": { "operationId": "runs-sync-winterlock-github-repo-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/winterlock~github-repo-scraper/run-sync": { "post": { "operationId": "run-sync-winterlock-github-repo-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", "required": [ "mode" ], "properties": { "mode": { "title": "What to scrape", "enum": [ "repoDetails", "releases", "issues", "pullRequests", "contributors", "commits", "searchRepos" ], "type": "string", "description": "Repository facts, releases and their download counts, issues, pull requests, contributors, commits, or a repository search.", "default": "repoDetails" }, "repositories": { "title": "Repositories", "type": "array", "description": "Use owner/name (apify/crawlee) or paste a GitHub link. Needed by every mode except Repository search.", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "For Repository search. Full GitHub search syntax works, for example: language:python stars:>1000 pushed:>2026-01-01", "items": { "type": "string" } }, "searchSort": { "title": "Sort search results by", "enum": [ "bestMatch", "stars", "forks", "updated" ], "type": "string", "description": "Best match is GitHub's own relevance ranking.", "default": "bestMatch" }, "githubToken": { "title": "GitHub token (strongly recommended)", "type": "string", "description": "Without a token GitHub allows only 60 requests an hour from one IP address, which is enough for a handful of repositories at most. A free personal access token with no scopes raises that to 5,000 an hour. Create one at github.com/settings/tokens. It is stored encrypted and is never written to the dataset." }, "issueState": { "title": "Issue and pull request state", "enum": [ "open", "closed", "all" ], "type": "string", "description": "For Issues and Pull requests. Open is what most people want; All returns closed ones too and uses more of the request budget.", "default": "open" }, "labels": { "title": "Labels (issues only)", "type": "array", "description": "Keep only issues carrying all of these labels, for example bug, help wanted.", "items": { "type": "string" } }, "includePullRequestsInIssues": { "title": "Include pull requests in Issues mode", "type": "boolean", "description": "GitHub treats pull requests as issues. They are filtered out by default so Issues mode returns only real issues.", "default": false }, "branch": { "title": "Branch (commits only)", "type": "string", "description": "Leave empty for the repository's default branch." }, "since": { "title": "Only commits after (ISO date)", "type": "string", "description": "For example 2026-01-01T00:00:00Z. Leave empty for no limit." }, "includeAuthorEmails": { "title": "Include commit author emails", "type": "boolean", "description": "For Commits. Off by default: author emails are personal data. Turn on only if you have a lawful reason to process them.", "default": false }, "maxResultsPerRepo": { "title": "Max results per repository or query", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Each 100 results costs one API request against your rate limit.", "default": 100 }, "maxItems": { "title": "Max items in total", "minimum": 1, "type": "integer", "description": "Stop the run after saving this many items. Leave empty for no limit." }, "maxConcurrency": { "title": "Max parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "GitHub counts every request against your hourly limit, so raising this spends the budget faster.", "default": 4 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Anonymous rate limits are counted per IP address, so a proxy can help when running without a token. A token is the better fix.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }