{ "openapi": "3.0.1", "info": { "title": "GitHub Repository Metadata & README Extractor", "description": "Fetch stars, forks, topics, license, language breakdown and README text for GitHub repositories, by search query or a direct list of repository URLs. An optional personal token raises the request limit.", "version": "1.1", "x-build-id": "amhOs5VaUzW1sK9t5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nimbryxo-studio~github-repository-metadata-and-readme-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nimbryxo-studio-github-repository-metadata-and-readme-extractor", "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/nimbryxo-studio~github-repository-metadata-and-readme-extractor/runs": { "post": { "operationId": "runs-sync-nimbryxo-studio-github-repository-metadata-and-readme-extractor", "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/nimbryxo-studio~github-repository-metadata-and-readme-extractor/run-sync": { "post": { "operationId": "run-sync-nimbryxo-studio-github-repository-metadata-and-readme-extractor", "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": { "mode": { "title": "Mode", "enum": [ "search", "direct", "owner", "topic" ], "type": "string", "description": "How to find repositories. 'search' runs a GitHub search query, 'direct' fetches an explicit list, 'owner' lists a user or organisation's repositories, and 'topic' lists repositories tagged with a topic.", "default": "search" }, "searchQuery": { "title": "Search query", "type": "string", "description": "GitHub search expression (mode=search). Supports qualifiers such as 'stars:>10000', 'language:python', 'topic:llm', 'user:apify', 'pushed:>2025-01-01', and 'in:name,description'. In owner/topic mode it is an optional keyword filter added to the owner or topic.", "default": "" }, "repositoryUrls": { "title": "Repository URLs or slugs", "type": "array", "description": "Repositories to fetch (mode=direct). Accepts https://github.com/owner/repo, a trailing slash, .git, the git@github.com:owner/repo.git SSH form, or a plain owner/repo slug. Duplicates are removed.", "default": [], "items": { "type": "string" } }, "owner": { "title": "Owner", "type": "string", "description": "GitHub user or organisation whose repositories should be listed (mode=owner). Accepts 'apify' or 'https://github.com/apify'.", "default": "" }, "topic": { "title": "Topic", "type": "string", "description": "Topic tag to browse (mode=topic), e.g. 'llm', 'machine-learning', or 'web-scraping'. A leading 'topic:' is accepted and stripped.", "default": "" }, "sortBy": { "title": "Sort by", "enum": [ "stars", "forks", "updated", "help-wanted-issues" ], "type": "string", "description": "Sort key for search, owner, and topic results.", "default": "stars" }, "sortOrder": { "title": "Sort direction", "enum": [ "desc", "asc" ], "type": "string", "description": "Ascending or descending order for the selected sort key.", "default": "desc" }, "language": { "title": "Language", "enum": [ "", "python", "javascript", "typescript", "java", "go", "rust", "c", "c++", "c#", "ruby", "php", "swift", "kotlin", "scala", "r", "julia", "haskell", "elixir", "erlang", "clojure", "dart", "lua", "perl", "shell", "powershell", "html", "css", "scss", "vue", "svelte", "jupyter notebook", "objective-c", "matlab", "assembly", "solidity", "zig", "nim", "crystal", "ocaml", "f#", "elm", "groovy", "visual basic .net", "fortran", "cobol", "delphi", "vhdl", "verilog", "coffeescript", "hcl", "nix" ], "type": "string", "description": "Only repositories whose primary language matches. Pick a common language here, or type any other language in 'Custom language'.", "default": "" }, "languageCustom": { "title": "Custom language", "type": "string", "description": "Any GitHub language name not listed above (e.g. 'Hare', 'Gleam'). Overrides the Language dropdown when non-empty.", "default": "" }, "license": { "title": "License", "enum": [ "", "mit", "apache-2.0", "gpl-3.0", "gpl-2.0", "lgpl-3.0", "lgpl-2.1", "agpl-3.0", "mpl-2.0", "bsd-2-clause", "bsd-3-clause", "unlicense", "cc0-1.0", "cc-by-4.0", "cc-by-sa-4.0", "epl-2.0", "isc", "artistic-2.0", "wtfpl", "zlib", "bsl-1.0", "postgresql", "ofl-1.1", "other" ], "type": "string", "description": "Only repositories released under this license.", "default": "" }, "searchIn": { "title": "Search text in", "enum": [ "", "name,description", "name", "description", "readme", "topics" ], "type": "string", "description": "Where the free-text part of searchQuery must match (mode=search). Applies only when searchQuery contains free text.", "default": "" }, "minStars": { "title": "Minimum stars", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Only repositories with at least this many stars. 0 means no star filter.", "default": 0 }, "minForks": { "title": "Minimum forks", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Only repositories with at least this many forks. 0 means no fork filter.", "default": 0 }, "createdAfter": { "title": "Created after", "type": "string", "description": "Only repositories created on or after this date (YYYY-MM-DD).", "default": "" }, "pushedAfter": { "title": "Pushed after", "type": "string", "description": "Only repositories with a push on or after this date (YYYY-MM-DD). Useful for finding maintained projects.", "default": "" }, "includeForks": { "title": "Include forks", "type": "boolean", "description": "Include fork repositories in search, owner, and topic results. Direct mode always returns the repositories you list.", "default": false }, "includeArchived": { "title": "Include archived repositories", "type": "boolean", "description": "Keep archived repositories in the results. Turn this off to find actively maintained projects only.", "default": true }, "maxResults": { "title": "Maximum repositories", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on repositories returned. GitHub's search API itself is capped at 1,000 results.", "default": 30 }, "includeReadme": { "title": "Include README", "type": "boolean", "description": "Fetch and include the decoded README text (capped at 500 KB).", "default": true }, "includeTopics": { "title": "Include topics", "type": "boolean", "description": "Include the repository's topic tags.", "default": true }, "includeLanguages": { "title": "Include language breakdown", "type": "boolean", "description": "Include the byte count per programming language (one API request per repository).", "default": true }, "includeRepoDetails": { "title": "Include full repository details", "type": "boolean", "description": "Fetch the repository detail endpoint in search, owner, and topic modes to add the real watcher count, network count, and organisation/parent fields (one extra API request per repository). Direct mode always fetches these.", "default": false }, "includeReleases": { "title": "Include releases", "type": "boolean", "description": "Fetch the newest releases, including tag, dates, prerelease flag, and asset count (one request per repository).", "default": false }, "releasesLimit": { "title": "Releases per repository", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many releases to keep when 'Include releases' is on.", "default": 10 }, "includeContributors": { "title": "Include contributors", "type": "boolean", "description": "Fetch the ranked contributor list with contribution counts (one request per repository; GitHub caps this endpoint at 500 contributors).", "default": false }, "contributorsLimit": { "title": "Contributors per repository", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many contributors to keep when 'Include contributors' is on.", "default": 30 }, "includeActivity": { "title": "Include commit activity", "type": "boolean", "description": "Fetch 52 weeks of commit activity and the latest commit (up to two requests per repository; GitHub may need a moment to compute the statistics).", "default": false }, "githubToken": { "title": "GitHub personal access token (optional)", "type": "string", "description": "Optional personal access token. It only raises the request limit from 60 to 5,000 requests per hour and is never required. A classic token with no scopes is enough for public data." } } }, "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 } } } } } } } } } }