GitHub Profile API

Get a GitHub user's public profile by username: name, bio, company, location, website, X handle, follower and repository counts, join date and pinned repositories.

Endpoint: POST /github/get-profile
Price: 1 credit per request
SDK: client.github.getProfile()
MCP tool: github_get_profile

Start free with 100 credits Read docs →

Terminal

$curl -X POST "https://api.bridgly.app/github/get-profile" \
  -H "Authorization: Bearer $BRIDGLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "username": "torvalds"
}'

request.py

import os
import requests
response = requests.post(
    "https://api.bridgly.app/github/get-profile",
    headers={"Authorization": f"Bearer {os.environ['BRIDGLY_KEY']}"},
    json={
        "username": "torvalds",
    },
)
data = response.json()

request.js

const response = await fetch("https://api.bridgly.app/github/get-profile", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIDGLY_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "username": "torvalds"
  }),
});
const data = await response.json();

request.ts

import { Bridgly } from "@bridgly/sdk";
const client = new Bridgly({ apiKey: "bgly_YOUR_KEY" });
const res = await client.github.getProfile({
  username: "torvalds"
});
if (res.type === "success") {
  console.log(res.data);
}

[ REQUEST AND RESPONSE ]

What does the GitHub Profile API return?

GitHub user API: get any GitHub profile by username as JSON, with name, bio, company, location, website, followers, repo count and pinned repositories. Every response has the same envelope: the result in data, plus timeMs and the creditsCost of the call.

Request body

usernamestringrequired: GitHub username (login), or the profile link, e.g. "torvalds" or "https://github.com/torvalds".

Example response

200 OK · application/json

{
  "timeMs": 1840,
  "creditsCost": 1,
  "data": {
    "id": "string",
    "databaseId": 0,
    "username": "string",
    "name": "string",
    "bio": "string",
    "company": "string",
    "location": "string",
    "email": "string",
    "websiteUrl": "string",
    "twitterUsername": "string",
    "avatarUrl": "string",
    "url": "string",
    "isHireable": true,
    "followersCount": 0,
    "followingCount": 0,
    "publicRepositoriesCount": 0,
    "createdAt": "string",
    "updatedAt": "string",
    "pinnedRepos": [
      {
        "id": "string",
        "databaseId": 0,
        "name": "string",
        "nameWithOwner": "string",
        "owner": {
          "username": "string",
          "id": "string",
          "url": "string",
          "avatarUrl": "string"
        },
        "description": "string",
        "url": "string",
        "homepageUrl": "string",
        "isPrivate": true,
        "isFork": true,
        "isArchived": true,
        "isTemplate": true,
        "primaryLanguage": {
          "name": "string",
          "color": "string"
        },
        "stargazerCount": 0,
        "forkCount": 0,
        "watcherCount": 0,
        "openIssuesCount": 0,
        "diskUsage": 0,
        "license": {
          "key": "string",
          "name": "string",
          "spdxId": "string",
          "url": "string"
        },
        "topics": [
          "string"
        ],
        "createdAt": "string",
        "updatedAt": "string",
        "pushedAt": "string"
      }
    ]
  }
}

[ USE CASES ]

What can you build with the GitHub Profile API?

Screen engineers

See what a candidate builds and pins before an interview.

Enrich developer leads

Add company, location and follower count to a GitHub username.

Show profiles in your app

Display a user’s bio and pinned work on a portfolio or team page.

[ FAQ ]

GitHub Profile API questions

How do I get a GitHub user’s profile data?

Send the username. You get the name, bio, company, location, website, X handle, follower and repository counts, join date and pinned repositories in one call.

Can I get a GitHub user’s pinned repositories?

Yes. They come with the profile, which GitHub’s REST API does not return.

Can I use GitHub profiles for technical recruiting?

Yes. The profile shows a developer’s company, location, website and the projects they chose to pin, and the GitHub Contributions API shows how active they are.

How do I use the GitHub Profile API?

Send a POST request to https://api.bridgly.app/github/get-profile with username in the JSON body and your API key in the Authorization header. In the TypeScript SDK, call client.github.getProfile(). AI agents connected to Bridgly over MCP can call the github_get_profile tool.

How much does the GitHub Profile API cost?

Costs 1 credit per request. Credits cost $2.00 per 1,000 on pay-as-you-go and as low as $1.00 per 1,000 at volume. New accounts on a business email start with 100 free credits, and failed requests are never charged.

[ MORE ENDPOINTS ]

More GitHub endpoints

The same API key works on every endpoint. See all GitHub API endpoints.

Try the GitHub Profile API

100 free credits on business email, no card. Your first call takes a minute.

APIMCPSDKCLI

free credits

On business email signup. No credit card required.

Start free with 100 credits

Book a demo Read the docs