{ "openapi": "3.0.1", "info": { "title": "GitHub Scraper | Repositories, Issues & Profiles", "description": "Extract public GitHub repositories, issues, pull requests, users and topic or organization listings. Export metadata and available public profile details. Pay per delivered row plus a start fee. Unofficial; not affiliated with GitHub.", "version": "0.1", "x-build-id": "1LCqwe7Ju1Ku73rnv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~github-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-github-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/lentic_clockss~github-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-github-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/lentic_clockss~github-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-github-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": { "query": { "title": "Search query", "type": "string", "description": "Search text with GitHub qualifiers, such as language:python crawler. For Topic repositories, enter a topic slug; leave empty when supplying detail URLs or identifiers." }, "searchType": { "title": "Search type", "enum": [ "repositories", "issues", "code", "pullrequests", "discussions", "users", "repo", "issue", "orgRepos", "topic", "issuesList", "explore", "dashboard", "login", "pull", "orgPeople", "githubJapan" ], "type": "string", "description": "Choose the kind of data to collect. Set this explicitly when using an organization, repository identifiers or a topic; discussion search may return no rows, and options marked not available are not supported for public runs.", "default": "repositories" }, "detailUrls": { "title": "Detail URLs", "type": "array", "description": "Supported GitHub repository, issue, organization-repository or topic links, with or without https://. The link path selects the page type; pull-request details and issue-list URLs are not supported." }, "owner": { "title": "Owner", "type": "string", "description": "Repository owner login. Fill this together with Repository for One repository, One issue or Repository issue list." }, "repo": { "title": "Repository", "type": "string", "description": "Repository name without its owner. Fill this together with Owner for One repository, One issue or Repository issue list." }, "issueNumber": { "title": "Issue number", "type": "integer", "description": "Existing positive issue number for One issue. Copy it from a GitHub issue URL and supply Owner and Repository." }, "org": { "title": "Organization", "type": "string", "description": "Organization login for Organization repositories. Use an organization rather than a personal account, and select the matching search type." }, "language": { "title": "Language", "type": "string", "description": "Optional programming-language filter for searches, such as Python. Leave empty for no language filter.", "default": "" }, "repoType": { "title": "Org repo type filter", "enum": [ "", "all", "public", "source", "fork", "archived", "template" ], "type": "string", "description": "Filter Organization repositories to all public repositories, original repositories, forks, archived repositories or templates. Leave empty to include all available public repositories.", "default": "" }, "sort": { "title": "Sort", "type": "string", "description": "Optional search sort supported by the chosen search type, such as stars, comments or followers. Leave empty to keep the default order.", "default": "" }, "order": { "title": "Order", "type": "string", "description": "Optional search direction: asc for ascending or desc for descending. Leave empty to keep the default direction.", "default": "" }, "maxResults": { "title": "Max results per input", "minimum": 1, "maximum": 200, "type": "integer", "description": "Most rows for each detail URL, or for the single query, topic, organization, repository, or issue input. Default 70; larger numbers are collected in parts of 70 when the input supports continuation. All row types count together. The whole run stops at your maximum total charge. Free Apify plan: up to 200 rows per run and 10 runs of this Actor.", "default": 70 }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum pages to read, from 1 to 100. Source pagination may end earlier; this does not guarantee that every match is collected.", "default": 1 }, "enrichDetails": { "title": "Add public profile details", "type": "boolean", "description": "Add available public profile names, location text, websites, social links and published emails to existing rows. Enabled by default; private contact details stay unavailable.", "default": true }, "workerBaseUrl": { "title": "Developer test setting", "type": "string", "description": "Leave empty. Used only by the developer for testing." } } }, "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 } } } } } } } } } }