GitHub API endpoint
Returns the public profile of a GitHub organization by its required `org` login, with fields such as name, description, blog URL, location, public repository count, followers and whether the organization is verified.
/github/org/{org}Returns public profile details for a GitHub organization.
Path parameters:
org: required. GitHub organization login.| Field | In the sample | Value in the sample |
|---|---|---|
| login | Has a value | |
| id | Has a value | |
| name | Has a value | |
| description | Has a value | |
| blog | Has a value | github.com |
| location | Has a value | |
| is_verified | Has a value | true |
| public_repos | Has a value | 566 |
| followers | Has a value | 90,234 |
| following | Has a value | 0 |
| html_url | Has a value | github.com |
| avatar_url | Has a value | avatars.githubusercontent.com |
| created_at | Has a value | 2008-05-11 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| org (path) | string | Yes | GitHub organization login | github | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/github/org/github" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"login": "github",
"name": "GitHub",
"description": "How people build software.",
"blog": "https://github.com/about",
"location": "San Francisco, CA",
"public_repos": 484,
"followers": 41000,
"is_verified": true
}
}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 |
| 404 | Organization not found | #/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/org/github" \
-H "x-api-key: $CRAWLORA_API_KEY"