GitHub API endpoint
Searches public GitHub user accounts with the required GitHub search query `q`. Order with `sort` (`followers`, `repositories` or `joined`) and `order`, and page with `page` and `per_page` (max 100). The response has `total_count` and items with login, id, profile URL, account type and match score.
/github/search/usersSearches public GitHub user accounts. Unauthenticated search is rate limited to about 10 requests per minute.
Query parameters:
q: required. GitHub user search query.sort: optional. Field to sort by. Allowed values: followers, repositories, joined.order: optional. Sort order. Allowed values: asc, desc.page: optional. Page number (integer).per_page: optional. Results per page (integer, max 100).| Field | Filled in, of 20 checked | Values in the sample |
|---|---|---|
| login | 20 | |
| id | 20 | |
| html_url | 20 | github.com |
| type | 20 | |
| score | 20 | 1 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| q | string | Yes | GitHub user search query | torvalds | |
| sort | string | No | Sort field Allowed values: followers, repositories, joined. | ||
| order | string | No | Sort order Allowed values: asc, desc. | ||
| page | integer | No | Page number | ||
| per_page | integer | No | Results per page (max 100) | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/github/search/users?q=torvalds&sort=followers&order=asc&page=1" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"total_count": 4213,
"items": [
{
"login": "torvalds",
"id": 1024025,
"html_url": "https://github.com/torvalds",
"type": "User",
"score": 1
}
]
}
}Request schema
No body schema
Response schema
#/definitions/app.Response
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | Code is the HTTP status code or a custom code used to indicate the result of the request @example 200 | |||
| data | unknown | No | Data is the response data (can be any object or null) @example {"id": 1, "name": "John Doe"} | |||
| msg | unknown | No | Msg is the message that describes the result of the request @example "Request successful" |
| Status | Description | Schema |
|---|---|---|
| 400 | Missing or invalid parameters | #/definitions/app.Response |
| 503 | Upstream error or rate limit | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/github/search/users?q=torvalds&sort=followers&order=asc&page=1" \
-H "x-api-key: $CRAWLORA_API_KEY"