Piloterr GitHub API

The Github API from Piloterr — 1 operation(s) for github.

GitHub OpenAPI

Operations 2

GET /v2/github/user/info GitHub User Info #
POST /v2/github/user/info GitHub User Info #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/piloterr-com:piloterr-com-github-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

piloterr-com-github-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Piloterr API Reference GitHub API
  description: Complete API reference documentation.
  version: 1.0.0
servers:
- url: https://api.piloterr.com
  description: API Server
tags:
- name: Github
paths:
  /v2/github/user/info:
    get:
      summary: GitHub User Info
      description: 'Retrieve public GitHub user profile data including bio, company, location, follower count, repositories, and associated email addresses.


        **Credit cost:** 1 credit per call'
      operationId: get-github-user-info
      security:
      - ApiKeyAuth: []
      parameters:
      - name: query
        in: query
        required: true
        description: "A GitHub user identifier. Multiple formats are accepted:\n\n- **GitHub profile URL:** `https://github.com/example-user`\n- **Username:** `example-user`\n- **Email address:** `name@company.com`\n\n**Examples:**\n\n    https://github.com/example-user\n\n**Note:** When using an email address, the lookup resolves the associated GitHub account if one is linked publicly."
        schema:
          type: string
          description: "A GitHub user identifier. Multiple formats are accepted:\n\n- **GitHub profile URL:** `https://github.com/example-user`\n- **Username:** `example-user`\n- **Email address:** `name@company.com`\n\n**Examples:**\n\n    https://github.com/example-user\n\n**Note:** When using an email address, the lookup resolves the associated GitHub account if one is linked publicly."
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/is_async'
      - $ref: '#/components/parameters/soft_fail'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  email:
                    type: array
                    items:
                      type: string
                  login:
                    type: string
                  company:
                    type: string
                  gist_url:
                    type: string
                  gpg_keys:
                    type: string
                  location:
                    type: string
                  ssh_keys:
                    type: string
                  followers:
                    type: integer
                  following:
                    type: integer
                  avatar_url:
                    type: string
                  created_at:
                    type: string
                  updated_at:
                    type: string
                  public_gists:
                    type: integer
                  public_repos:
                    type: integer
              examples:
                Lookup example-user GitHub profile:
                  value:
                    id: 1024025
                    name: Alex Martin
                    email:
                    - name@example.com
                    login: example-user
                    company: Linux Foundation
                    gist_url: https://gist.github.com/example-user
                    gpg_keys: https://github.com/example-user.gpg
                    location: Portland, OR
                    ssh_keys: https://github.com/example-user.keys
                    followers: 329840
                    following: 0
                    avatar_url: https://avatars.githubusercontent.com/placeholder/example-user.jpg
                    created_at: '2011-09-03T15:26:22Z'
                    updated_at: '2026-10-16T15:33:53Z'
                    public_gists: 1
                    public_repos: 12
        '400':
          description: Bad Request — missing or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
        '401':
          description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidKey:
                  value:
                    error: Invalid API Key
                planRateLimit:
                  value:
                    error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
                keyQuota:
                  value:
                    error: 'Rate limit exceeded for the API key: quota monthly'
        '402':
          description: Payment Required — your subscription or credit balance is insufficient.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Payment required
        '500':
          description: Internal Server Error — something went wrong on our side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Error
      tags:
      - Github
    post:
      summary: GitHub User Info
      description: 'Retrieve public GitHub user profile data including bio, company, location, follower count, repositories, and associated email addresses.


        **Credit cost:** 1 credit per call'
      operationId: post-github-user-info
      security:
      - ApiKeyAuth: []
      parameters:
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/is_async'
      - $ref: '#/components/parameters/soft_fail'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
                  description: "A GitHub user identifier. Multiple formats are accepted:\n\n- **GitHub profile URL:** `https://github.com/example-user`\n- **Username:** `example-user`\n- **Email address:** `name@company.com`\n\n**Examples:**\n\n    https://github.com/example-user\n\n**Note:** When using an email address, the lookup resolves the associated GitHub account if one is linked publicly."
              required:
              - query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  email:
                    type: array
                    items:
                      type: string
                  login:
                    type: string
                  company:
                    type: string
                  gist_url:
                    type: string
                  gpg_keys:
                    type: string
                  location:
                    type: string
                  ssh_keys:
                    type: string
                  followers:
                    type: integer
                  following:
                    type: integer
                  avatar_url:
                    type: string
                  created_at:
                    type: string
                  updated_at:
                    type: string
                  public_gists:
                    type: integer
                  public_repos:
                    type: integer
              examples:
                Lookup example-user GitHub profile:
                  value:
                    id: 1024025
                    name: Alex Martin
                    email:
                    - name@example.com
                    login: example-user
                    company: Linux Foundation
                    gist_url: https://gist.github.com/example-user
                    gpg_keys: https://github.com/example-user.gpg
                    location: Portland, OR
                    ssh_keys: https://github.com/example-user.keys
                    followers: 329840
                    following: 0
                    avatar_url: https://avatars.githubusercontent.com/placeholder/example-user.jpg
                    created_at: '2011-09-03T15:26:22Z'
                    updated_at: '2026-10-16T15:33:53Z'
                    public_gists: 1
                    public_repos: 12
        '400':
          description: Bad Request — missing or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
        '401':
          description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidKey:
                  value:
                    error: Invalid API Key
                planRateLimit:
                  value:
                    error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
                keyQuota:
                  value:
                    error: 'Rate limit exceeded for the API key: quota monthly'
        '402':
          description: Payment Required — your subscription or credit balance is insufficient.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Payment required
        '500':
          description: Internal Server Error — something went wrong on our side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Error
      tags:
      - Github
components:
  parameters:
    fields:
      name: fields
      in: query
      required: false
      description: Comma-separated list of response fields to return, with dot notation for nested fields (e.g. `name,location.city`).
      schema:
        type: string
    is_async:
      name: is_async
      in: query
      required: false
      description: 'Run the request as a background job: the API answers `202` with a `job_id` to poll on `GET /v1/jobs/{id}`.'
      schema:
        type: boolean
        default: false
    soft_fail:
      name: soft_fail
      in: query
      required: false
      description: Return HTTP 200 even when the request fails; the error is in the `error` field of the body.
      schema:
        type: boolean
        default: false
  schemas:
    ErrorResponse:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          description: Human-readable error message.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Your API key. Include it in the x-api-key header for every request.