> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scrapio.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a GitHub user

> Get a GitHub user's public profile by username.



## OpenAPI

````yaml get /v1/github/user
openapi: 3.1.0
info:
  title: Scrapio
  version: 1.0.0
  description: >-
    Turn any URL into structured data. Fetch raw HTML, crawl sites, extract
    structured content, interact with dynamic pages, and search the web through
    one API.
  contact:
    name: Scrapio Support
    url: https://scrapio.dev
  license:
    name: Proprietary
servers:
  - url: https://api.scrapio.dev
    description: Production
security:
  - bearerAuth: []
tags:
  - name: System
  - name: Fetch
  - name: Crawl
  - name: Map
  - name: Interact
  - name: Search
  - name: Google
  - name: Fast Search
  - name: Jobs
  - name: YouTube
  - name: Amazon
  - name: Walmart
  - name: Booking
  - name: Agoda
  - name: Airbnb
  - name: AutoTrader
  - name: ChatGPT
  - name: Perplexity
  - name: Gemini
  - name: Bing
  - name: Reddit
  - name: Instagram
  - name: Twitter
  - name: Facebook
  - name: Hacker News
  - name: GitHub
  - name: TikTok
  - name: Apple App Store
  - name: Target
  - name: Monitors
paths:
  /v1/github/user:
    get:
      tags:
        - GitHub
      summary: Get a GitHub user's public profile
      description: >-
        Retrieves a GitHub user's public profile via GitHub's REST API: bio,
        company, location, follower/following counts, and public repo count.
        Requires a Starter plan or higher.
      operationId: getGithubUser
      parameters:
        - name: username
          in: query
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: The resolved GitHub user profile.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GithubUserResponse'
        '400':
          description: Missing or invalid username.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: GitHub dedicated endpoints require a Starter plan or higher.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The requested user could not be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Daily credit cap exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: GitHub upstream failed or returned an unusable response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: GitHub upstream unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-codeSamples:
        - lang: cURL
          label: cURL
          source: |-
            curl "https://api.scrapio.dev/v1/github/user?username=torvalds" \
              -H "Authorization: Bearer $SCRAPIO_API_KEY"
components:
  schemas:
    GithubUserResponse:
      type: object
      properties:
        provider:
          type: string
          enum:
            - github
        request_id:
          type: string
        user:
          type: object
          properties:
            username:
              type: string
            name:
              anyOf:
                - type: string
                - type: 'null'
            bio:
              anyOf:
                - type: string
                - type: 'null'
            avatar_url:
              type: string
            company:
              anyOf:
                - type: string
                - type: 'null'
            location:
              anyOf:
                - type: string
                - type: 'null'
            blog:
              anyOf:
                - type: string
                - type: 'null'
            counts:
              type: object
              properties:
                followers:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                following:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                public_repos:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
              required:
                - followers
                - following
                - public_repos
              additionalProperties: false
            created_at:
              type: string
          required:
            - username
            - name
            - bio
            - avatar_url
            - company
            - location
            - blog
            - counts
            - created_at
          additionalProperties: false
      required:
        - provider
        - request_id
        - user
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        request_id:
          type: string
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
        diagnostics:
          type: object
          properties:
            outcome:
              type: string
              enum:
                - failed
            retryable:
              type: boolean
            blocked:
              type: boolean
            timed_out:
              type: boolean
          required:
            - outcome
            - retryable
          additionalProperties: false
      required:
        - request_id
        - error
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````