DEVELOPER TOOLS

Get GitHub User API

Fetch a GitHub user or organization's public profile: name, bio, company, location, follower/repo counts, avatar, Twitter handle, hireable flag. Plus the rate-limit headers. Works without a token; pass your own for 5,000 req/h.

githubuserprofilepython

Try it free Get an API key

How to call it

Send one POST to api.upapi.io/github-user.get with your key in the X-Api-Key header and the parameters below as a JSON body. Each call spends 1 weighted unit of your monthly quota. The operation times out after 15 seconds. Identical requests are served from cache for 300 seconds, unbilled.

endpoint

POST https://api.upapi.io/github-user.get

Get GitHub User API reference

Request parameters

token: string — Optional GitHub token: 5,000 req/h instead of 60, and sees the email field when the profile allows it
proxyUrl: string — Optional exit to send from (direct otherwise)
username: stringrequired — GitHub login (user or org)

Response fields

id: integerrequired
bio: stringrequired
blog: stringrequired
name: stringrequired
type: stringrequired
email: stringrequired
login: stringrequired
company: stringrequired
htmlUrl: stringrequired
hireable: booleanrequired
location: stringrequired
avatarUrl: stringrequired
createdAt: stringrequired
fetchedAt: stringrequired
followers: integerrequired
following: integerrequired
rateLimit: objectrequired — The rate-limit headers GitHub returned on THIS response, surfaced so the caller can pace itself instead of the operation sleeping on its behalf.
rateLimit.limit: integerrequired — X-RateLimit-Limit: requests allowed per window
rateLimit.resetAt: stringrequired — X-RateLimit-Reset as an ISO-8601 UTC timestamp
rateLimit.resource: stringrequired — X-RateLimit-Resource: which bucket (core, search, graphql, ...)
rateLimit.remaining: integerrequired — X-RateLimit-Remaining: requests left
rateLimit.resetEpoch: integerrequired — X-RateLimit-Reset as unix seconds
updatedAt: stringrequired
publicGists: integerrequired
publicRepos: integerrequired
twitterHandle: stringrequired

Example request and response

The example response is generated from this operation’s published output schema — it shows the shape and field names, not values from a recorded call.

json — example request body

{
  "username": "torvalds"
}

json — example response shape

{
  "id": 1,
  "bio": "example",
  "blog": "example",
  "name": "example",
  "type": "example",
  "email": "test@example.com",
  "login": "example",
  "company": "example",
  "htmlUrl": "example",
  "hireable": false,
  "location": "example",
  "avatarUrl": "example",
  "createdAt": "example",
  "fetchedAt": "example",
  "followers": 1,
  "following": 1,
  "rateLimit": {
    "limit": 5,
    "resetAt": "example",
    "resource": "example",
    "remaining": 1,
    "resetEpoch": 1
  },
  "updatedAt": "example",
  "publicGists": 1,
  "publicRepos": 1,
  "twitterHandle": "example"
}

Code snippets

cURL

curl

curl -X POST https://api.upapi.io/github-user.get \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -d '{ "username": "torvalds" }'

JavaScript

javascript

const response = await fetch('https://api.upapi.io/github-user.get', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'YOUR_API_KEY',
  },
  body: JSON.stringify({
  "username": "torvalds"
}),
});

const data = await response.json();
console.log(data);

Python

python

import requests

response = requests.post(
    'https://api.upapi.io/github-user.get',
    headers={
        'Content-Type': 'application/json',
        'x-api-key': 'YOUR_API_KEY',
    },
    json={
  "username": "torvalds"
},
)

print(response.json())

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io"
	"net/http"
)

func main() {
	payload := []byte(`{ "username": "torvalds" }`)

	req, _ := http.NewRequest("POST", "https://api.upapi.io/github-user.get", bytes.NewBuffer(payload))
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("x-api-key", "YOUR_API_KEY")

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	var result map[string]any
	json.Unmarshal(body, &result)
	fmt.Println(result)
}

PHP

php

<?php

$payload = json_encode([
    'username' => 'torvalds',
]);

$ch = curl_init('https://api.upapi.io/github-user.get');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => $payload,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json',
        'x-api-key: YOUR_API_KEY',
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
var_dump($data);

Ruby

ruby

require 'net/http'
require 'uri'
require 'json'

uri = URI('https://api.upapi.io/github-user.get')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Post.new(uri.path)
request['Content-Type'] = 'application/json'
request['x-api-key'] = 'YOUR_API_KEY'
request.body = { "username": "torvalds" }.to_json

response = http.request(request)
puts JSON.parse(response.body)

Java

java

import okhttp3.*;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;

OkHttpClient client = new OkHttpClient();
ObjectMapper mapper = new ObjectMapper();

String json = "{ \"username\": \"torvalds\" }";

RequestBody body = RequestBody.create(json, MediaType.get("application/json"));
Request request = new Request.Builder()
    .url("https://api.upapi.io/github-user.get")
    .post(body)
    .addHeader("Content-Type", "application/json")
    .addHeader("x-api-key", "YOUR_API_KEY")
    .build();

try (Response response = client.newCall(request).execute()) {
    Map<?, ?> result = mapper.readValue(response.body().string(), Map.class);
    System.out.println(result);
}

csharp

using System.Net.Http;
using System.Net.Http.Json;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");

var payload = JsonSerializer.Deserialize<object>("{ \"username\": \"torvalds\" }");
var response = await client.PostAsJsonAsync("https://api.upapi.io/github-user.get", payload);

var result = await response.Content.ReadFromJsonAsync<JsonElement>();
Console.WriteLine(result);

Frequently asked questions

How much does the Get GitHub User API cost per call?

Each call spends 1 weighted unit of your plan's monthly quota. Full pricing is at https://upapi.io/pricing.

How do I authenticate to the Get GitHub User API?

Send your key in the X-Api-Key header. A free guest key is available without creating an account.

Are Get GitHub User API responses cached?

Yes — identical requests are served from cache for 300 seconds, and a cache hit is not billed.

More Developer Tools APIs

Get GitHub User Commit Emails Get GitHub Repository List GitHub Issue Comments List GitHub Repository Contributors List GitHub Repository Issues Search GitHub Discussions Search GitHub Issues Search GitHub Repositories

Browse every Developer Tools API →