Endpoint Playground

Try the Retrieve a GitHub user profile API

Test Crawlora's Retrieve a GitHub user profile API with realistic prefilled parameters. Generate a cURL request, inspect the expected structured JSON response, and open the full docs or pricing page when you are ready to integrate this public web data extraction endpoint into your application.

Endpoint facts

Method: GET
API path: /github/user/{username}
Platform: GitHub
Auth: apiKey
Credits: 3 credits/request
Required params: username

Retrieve a GitHub user profile API documentation GitHub platform page Crawlora API pricing Try GitHub Org Profile API Try GitHub Org Repos API Try Retrieve a GitHub repository API Try List a repository's contributors API Try List a repository's public forks API

Prefilled cURL

curl "https://api.crawlora.net/api/v1/github/user/<username>" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Request parameters visible to crawlers

Parameter	Type	Required	Prefilled value	Description
username (path)	string	Yes		GitHub username

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "login": "torvalds",
    "name": "Linus Torvalds",
    "company": "Linux Foundation",
    "blog": "",
    "location": "Portland, OR",
    "twitter_username": null,
    "public_repos": 7,
    "followers": 228000,
    "social_accounts": [
      {
        "provider": "mastodon",
        "url": "https://social.kernel.org/users/torvalds"
      }
    ]
  }
}

Public Playground

Preview the endpoint before sending a live request

Sample responses, schemas, request previews, and code snippets are visible before sign in. Create an account when you are ready to save an API key and run authenticated requests.

Set up API key Endpoint docs

Endpoint

Choose one catalog endpoint for this request.

16 shown

Group

Method

Auth

Endpoint

GETapiKey3 credits/requestapp.ResponseGitHub

GET /github/user/{username}

Retrieve a GitHub user profile

Returns a public GitHub user's profile plus user-published social links. Email is included only when the user has made it public on their profile.

API key required. Paste a full key or rotate one from the API Keys page.

Set up API key

View docs

API key

API key required for live requests. Your key is only used to send requests from this Playground.

not configured

Active Playground key: not configured

Manage API keys in Console

Path parameters

username

requiredstring

GitHub username

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

View docs

Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "code": 200,
  "msg": "OK",
  "data": {
    "login": "torvalds",
    "name": "Linus Torvalds",
    "company": "Linux Foundation",
    "blog": "",
    "location": "Portland, OR",
    "twitter_username": null,
    "public_repos": 7,
    "followers": 228000,
    "social_accounts": [
      {
        "provider": "mastodon",
        "url": "https://social.kernel.org/users/torvalds"
      }
    ]
  }
}

Endpoint details

Returns a public GitHub user's profile plus user-published social links. Email is included only when the user has made it public on their profile.

Method: GET
Path: /github/user/{username}
Authentication: apiKey
Credit cost: 3 credits/request
Platform: GitHub
Parameters: 2 documented fields

Request parameters

username:pathx-api-key:header

Response schema fields

codedatamsg

Sample response summary

{
  "code": 200,
  "msg": "OK",
  "data": {
    "login": "torvalds",
    "name": "Linus Torvalds",
    "company": "Linux Foundation",
    "blog": "",
    "location": "Portland, OR",
    "twitter_username": null,
    "public_repos": 7,
    "followers": 228000,
    "social_accounts": [
      {
        "provider": "mastodon",
        "url": "https://social.kernel.org/users/torvalds"
      }
    ]
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/github/user/<username>" \
  -H "x-api-key: $CRAWLORA_API_KEY"

View endpoint docs Open platform page Browse all endpoints Pricing Retrieve a GitHub organization profile List a GitHub organization's public repositories Retrieve a GitHub repository List a repository's contributors List a repository's public forks

Try the Retrieve a GitHub user profile API

Request parameters visible to crawlers

Parameter	Type	Required	Prefilled value	Description
username (path)	string	Yes		GitHub username

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "login": "torvalds",
    "name": "Linus Torvalds",
    "company": "Linux Foundation",
    "blog": "",
    "location": "Portland, OR",
    "twitter_username": null,
    "public_repos": 7,
    "followers": 228000,
    "social_accounts": [
      {
        "provider": "mastodon",
        "url": "https://social.kernel.org/users/torvalds"
      }
    ]
  }
}

{ "code": 200, "msg": "OK", "data": { "login": "torvalds", "name": "Linus Torvalds", "company": "Linux Foundation", "blog": "", "location": "Portland, OR", "twitter_username": null, "public_repos": 7, "followers": 228000, "social_accounts": [ { "provider": "mastodon", "url": "https://social.kernel.org/users/torvalds" } ] } }

Endpoint details

Returns a public GitHub user's profile plus user-published social links. Email is included only when the user has made it public on their profile.

Method: GET
Path: /github/user/{username}
Authentication: apiKey
Credit cost: 3 credits/request
Platform: GitHub
Parameters: 2 documented fields

Request parameters

username:pathx-api-key:header

Response schema fields

codedatamsg

Sample response summary

{
  "code": 200,
  "msg": "OK",
  "data": {
    "login": "torvalds",
    "name": "Linus Torvalds",
    "company": "Linux Foundation",
    "blog": "",
    "location": "Portland, OR",
    "twitter_username": null,
    "public_repos": 7,
    "followers": 228000,
    "social_accounts": [
      {
        "provider": "mastodon",
        "url": "https://social.kernel.org/users/torvalds"
      }
    ]
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/github/user/<username>" \
  -H "x-api-key: $CRAWLORA_API_KEY"