Social Fetch
GitHub

Get GitHub profile

Get a GitHub profile for a user or organization.

GET/v1/github/profiles/{handle}
1credit
x-api-key*stringheader

API key (`sfk_...`)

Parameters
1
handle*stringpath

GitHub username to look up, with or without a leading @.

min 1 chars · max 39 chars

Response fields
29

Endpoint-specific response payload.

datalookupStatus
string

Whether the profile was found.

one of: found, not_found

Profile details when available.

dataprofileplatform
string

Social platform for this profile.

one of: github

dataprofilehandle
string

GitHub username (login).

dataprofiledisplayName
stringnullable

Public display name when set on the profile.

dataprofilebio
stringnullable

Profile biography text.

dataprofileavatarUrl
stringnullable

Avatar image URL when available.

dataprofileprofileUrl
string

Canonical public GitHub profile URL.

min 1 chars

dataprofileplatformUserId
stringoptional

GitHub user or organization id as a string.

dataprofilenodeId
stringoptional

GitHub node id when available.

dataprofileaccountType
string

Whether this profile is a user or organization account.

one of: User, Organization

dataprofilecompany
stringnullableoptional

Company shown on the profile when available.

dataprofilelocation
stringnullableoptional

Location shown on the profile when available.

dataprofileblog
stringnullableoptional

Blog or website URL from the profile when available.

dataprofileemail
stringnullableoptional

Public email when exposed by GitHub.

dataprofiletwitterUsername
stringnullableoptional

Linked X (Twitter) username when set on the profile.

dataprofilesiteAdmin
booleanoptional

Whether the account is a GitHub site administrator.

dataprofileaccountCreatedAt
stringoptional

Account creation timestamp (ISO 8601) when available.

dataprofileaccountUpdatedAt
stringoptional

Profile last-updated timestamp (ISO 8601) when available.

Profile metrics when available.

datametricsfollowers
integernullable

Follower count when available.

≥ 0

datametricsfollowing
integernullable

Following count when available.

≥ 0

datametricspublicRepos
integernullable

Public repository count when available.

≥ 0

datametricspublicGists
integernullable

Public gist count when available.

≥ 0

Metadata describing the request and billing outcome.

metarequestId
string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integer

Credits charged for this request.

≥ 0

metaversion
string

Public API version that served the response.

one of: v1

Code example

curl "https://api.socialfetch.dev/v1/github/profiles/torvalds" \
  -H "x-api-key: YOUR_API_KEY"

Responses

Lookup result. Check `data.lookupStatus` for `found` or `not_found`.

On this page

No Headings