# GitHub Users Search API (`automly/github-users-search-api`) Actor

Search GitHub users and organizations by keyword, location, company, followers, and repository count using the public GitHub Search API.

- **URL**: https://apify.com/automly/github-users-search-api.md
- **Developed by:** [Automly](https://apify.com/automly) (community)
- **Categories:** Developer tools, Lead generation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$0.50 / 1,000 result item produceds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## GitHub Users Search API

Find GitHub users and organizations by keyword, location, company, follower count and repository count, and export the matching profiles: username, profile link, avatar, account type and GitHub ID. No GitHub account or token needed. Export to JSON, CSV or Excel, or call it from your own code.

### What does GitHub Users Search API do?

- Searches GitHub accounts by words in their username, name or email
- Narrows the search by location (`Berlin`, `San Francisco`, `India`), company, minimum followers and minimum public repositories
- Returns people, organizations, or both
- Sorts by best match, most followers, most repositories or join date
- Up to 100 profiles per run

### What people use it for

- Recruiting: developers in a city with a following, for example Python developers in Berlin with 100+ followers
- Developer relations and community building: finding active people around a technology
- Sales and partnerships: organizations on GitHub in a market
- Research on developer communities by region or company

### How to use it

1. Click **Try for free** to open the Actor in Apify Console
2. Type a **Query**, for example `python`
3. Add filters: **Location**, **Company**, **Minimum followers**, **Minimum repositories**, **Account type**
4. Choose the **Sort** and **Order**, set **Max results** and click **Start**
5. Open the **Output** tab: the **Profiles** view shows avatar, username, type and profile link

### Input example

```json
{
  "query": "python",
  "location": "Berlin",
  "minFollowers": 100,
  "sort": "followers",
  "order": "desc",
  "maxResults": 50
}
```

| Field | What it does |
|---|---|
| `query` | Words to match in usernames, names and emails (required) |
| `location` | Only accounts whose profile location matches |
| `company` | Only accounts whose profile company matches |
| `minFollowers` | Only accounts with at least this many followers |
| `minRepos` | Only accounts with at least this many public repositories |
| `accountType` | `user`, `org`, or empty for both |
| `sort` | `best-match`, `followers`, `repositories` or `joined` |
| `order` | `desc` or `asc` |
| `maxResults` | 1 to 100 profiles |
| `token` | Optional. Not needed; the Actor works without one |

### Output example

```json
{
  "recordType": "user_search_result",
  "query": "scraping",
  "location": "Berlin",
  "company": "",
  "minFollowers": 0,
  "minRepos": 0,
  "accountType": "User",
  "login": "jfilter",
  "htmlUrl": "https://github.com/jfilter",
  "avatarUrl": "https://avatars.githubusercontent.com/u/3450307?v=4",
  "apiUrl": "https://api.github.com/users/jfilter",
  "nodeId": "MDQ6VXNlcjM0NTAzMDc=",
  "userId": 3450307,
  "score": 1,
  "userViewType": "public",
  "followersUrl": "https://api.github.com/users/jfilter/followers",
  "subscriptionsUrl": "https://api.github.com/users/jfilter/subscriptions",
  "organizationsUrl": "https://api.github.com/users/jfilter/orgs",
  "reposUrl": "https://api.github.com/users/jfilter/repos",
  "receivedEventsUrl": "https://api.github.com/users/jfilter/received_events"
}
```

### Pricing

You pay **$0.50 per 1,000 profiles** ($0.0005 per profile) plus the small Apify platform usage of the run. 100 profiles cost $0.05 in profile charges.

### FAQ

**Do I need a GitHub token?**
No. The Actor works without one. You can add your own token if you prefer.

**Why did I get fewer profiles than Max results?**
Only that many accounts match the query and filters. Try a broader query or fewer filters.

**Does it return email addresses, bios or follower counts?**
No. It returns what GitHub's user search gives for each match: username, profile link, avatar, type and ID. The follower and repository filters are applied by GitHub during the search.

**Can I search organizations only?**
Yes. Set **Account type** to `org`.

**Is private data included?**
No. Only public profiles that GitHub search shows to anyone.

# Actor input Schema

## `query` (type: `string`):

Words to match in usernames, names and emails, such as 'python' or 'data scientist'. Combine with the filters below.

## `maxResults` (type: `integer`):

Maximum number of user records to return. Values above 100 are clamped.

## `sort` (type: `string`):

Search sort order. Use 'best-match', 'followers', 'repositories', or 'joined'.

## `order` (type: `string`):

Sort direction. Use 'desc' or 'asc'.

## `location` (type: `string`):

Optional GitHub location qualifier, such as 'Tokyo' or 'San Francisco'.

## `company` (type: `string`):

Optional GitHub company qualifier, such as 'Apify' or 'Microsoft'.

## `minFollowers` (type: `integer`):

Optional minimum follower count filter.

## `minRepos` (type: `integer`):

Optional minimum public repository count filter.

## `accountType` (type: `string`):

Optional account type filter. Use 'user' or 'org'.

## `token` (type: `string`):

Optional. Not needed: the actor works without a token. Add your own GitHub token if you prefer.

## Actor input object example

```json
{
  "query": "python",
  "maxResults": 20,
  "sort": "best-match",
  "order": "desc",
  "location": "Berlin",
  "company": "",
  "minFollowers": 0,
  "minRepos": 0,
  "accountType": ""
}
```

# Actor output Schema

## `results` (type: `string`):

Every profile with all fields.

## `overview` (type: `string`):

Matching users and organizations with avatar, username, type and profile link.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "query": "python",
    "location": "Berlin"
};

// Run the Actor and wait for it to finish
const run = await client.actor("automly/github-users-search-api").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "query": "python",
    "location": "Berlin",
}

# Run the Actor and wait for it to finish
run = client.actor("automly/github-users-search-api").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "query": "python",
  "location": "Berlin"
}' |
apify call automly/github-users-search-api --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,automly/github-users-search-api"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/0a90auaqm6Yxp1Ldd/builds/2vY19eoso6adwHpln/openapi.json