GitHub User Info
Retrieve public GitHub user profile data including bio, company, location, follower count, repositories, and associated email addresses.
Status: Degraded
Credit cost: 1 credit per call
Authorization
ApiKeyAuth x-api-key<token>
Your API key. Include it in the x-api-key header for every request.
In: header
Query Parameters
query*string
A GitHub user identifier. Multiple formats are accepted:
- GitHub profile URL:
https://github.com/torvalds - Username:
torvalds - Email address:
name@company.com
Examples:
https://github.com/torvaldsNote: When using an email address, the lookup resolves the associated GitHub account if one is linked publicly.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.piloterr.com/v2/github/user/info?query=string"{
"id": 1024025,
"name": "Linus Torvalds",
"email": [
"torvalds@linux-foundation.org"
],
"login": "torvalds",
"company": "Linux Foundation",
"location": "Portland, OR",
"ssh_keys": "https://github.com/torvalds.keys",
"followers": 199164,
"following": 0,
"avatar_url": "https://avatars.githubusercontent.com/u/1024025?v=4",
"created_at": "2011-09-03T15:26:22Z",
"updated_at": "2023-11-12T20:08:30Z",
"public_gists": "https://gist.github.com/torvalds",
"public_repos": 7
}{
"error": "Bad Request"
}{
"error": "Invalid API Key"
}{
"error": "Payment required"
}{
"error": "Rate limit exceeded for the API key: quota monthly"
}{
"error": "Internal Error"
}