{ "openapi": "3.0.1", "info": { "title": "GitHub Scraper", "description": "Scrape GitHub repositories, users, organizations, and repository search results without a login. Pull a repo's full metadata by owner/repo, a user's or org's profile and repositories, or repository search results. Walks pagination up to your chosen limit.", "version": "0.1", "x-build-id": "noNDrQWeZ3NXB9rCB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/goat255~github-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-goat255-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/goat255~github-scraper/runs": { "post": { "operationId": "runs-sync-goat255-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/goat255~github-scraper/run-sync": { "post": { "operationId": "run-sync-goat255-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": { "repos": { "title": "Repositories (repo mode)", "type": "array", "description": "Repositories to fetch full metadata for. Use owner/repo or a full repo link. Example: apify/crawlee, https://github.com/example_user/example-repo.", "default": [ "apify/crawlee" ], "items": { "type": "string" } }, "users": { "title": "Users or organizations (user mode)", "type": "array", "description": "User or organization logins to fetch profiles for, optionally with their repositories. With or without the @ prefix, or a full profile link. Example: example_user, @example_user, https://github.com/example_user.", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries (search mode)", "type": "array", "description": "Repository search queries. Supports the standard search syntax, for example: web scraping language:python stars:>1000. Each query returns up to 1000 results.", "items": { "type": "string" } }, "maxItemsPerSource": { "title": "Max items per source", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Cap on items returned per user (repositories) or per search query. Pagination is walked across multiple pages until this is reached or the source is exhausted. Search is capped at 1000 by the source.", "default": 100 }, "includeUserRepos": { "title": "Include a user's repositories", "type": "boolean", "description": "When on, each user or organization also emits its public repositories (up to the max per source) after its profile row.", "default": true }, "searchSort": { "title": "Search sort", "enum": [ "", "stars", "forks", "updated" ], "type": "string", "description": "Sort order for search results. Best match (relevance), or by stars, forks, or recent updates.", "default": "" }, "githubToken": { "title": "Access token (optional)", "type": "string", "description": "Optional personal access token. Not required. When provided it raises the request budget for large runs. A read-only token with public access is sufficient." }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many sources to process in parallel.", "default": 5 }, "proxyConfig": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy. The public read endpoints do not require a proxy, but you may route through one if you wish.", "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 } } }, "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 } } } } } } } } } }