GitHub API endpoint
Returns the repositories a GitHub user has pinned on their profile, identified by the required `username`. Each has its owner, name, URL, description, language, stars and forks. The list is empty when the user has pinned nothing.
/github/user/{username}/pinnedReturns the repositories pinned on a user's public profile page. Returns an empty list if the user pinned nothing.
Path parameters:
username: required. GitHub username.| Field | Filled in, of 6 checked | Values in the sample |
|---|---|---|
| owner | 6 | |
| repo | 6 | |
| full_name | 6 | |
| url | 6 | github.com |
| description | 6 | |
| language | 4 | |
| stars | 6 | 2 to 519, median 6 |
| forks | 6 | 37 to 744, median 252 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| username (path) | string | Yes | GitHub username | torvalds | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/github/user/torvalds/pinned" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": [
{
"owner": "torvalds",
"repo": "linux",
"full_name": "torvalds/linux",
"url": "https://github.com/torvalds/linux",
"description": "Linux kernel source tree",
"language": "C",
"stars": 180000,
"forks": 53000
}
]
}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/user/torvalds/pinned" \
-H "x-api-key: $CRAWLORA_API_KEY"