GitHub – Nextra

🐙 Github

All routes for github start with /github

Find a user by Username

Retrieves public profile information for a specific GitHub user.

URL: /user/:username
Method: GET
URL Parameters:
- username (required): The GitHub username.
Response: Returns a JSON object with the user's profile information.

{
    "profile": {
        "login": "dagmawibabi",
        "id": 44819176,
        "node_id": "MDQ6VXNlcjQ0ODE5MTc2",
        "avatar_url": "https://avatars.githubusercontent.com/u/44819176?v=4",
        "gravatar_id": "",
        "url": "https://api.github.com/users/dagmawibabi",
        "html_url": "https://github.com/dagmawibabi",
        "followers_url": "https://api.github.com/users/dagmawibabi/followers",
        "following_url": "https://api.github.com/users/dagmawibabi/following{/other_user}",
       ...
    },
    "repos": [
        {
            "id": 657986676,
            "node_id": "R_kgDOJzgUdA",
            "name": "AASTUECSF",
            "full_name": "dagmawibabi/AASTUECSF",
            "private": false,
            ...
        }
    ]
    ...
}

Repository by Username and Repository Name

Retrieves public repository information for a specific GitHub user and repository.

URL: /repo/:username/:repository
Method: GET
URL Parameters:
- username (required): The GitHub username.
- repository (required): The name of the repository.
Response: Returns a JSON object with the repository information.

{
    "id": 762519042,
    "node_id": "R_kgDOLXMeAg",
    "name": "apihub",
    "full_name": "dagmawibabi/apihub",
    "private": false,
    "owner": {
        "login": "dagmawibabi",
        "id": 44819176,
        "node_id": "MDQ6VXNlcjQ0ODE5MTc2",
        "avatar_url": "https://avatars.githubusercontent.com/u/44819176?v=4",
        "gravatar_id": "",
        "url": "https://api.github.com/users/dagmawibabi",
      ...
    },
    "html_url": "https://github.com/dagmawibabi/apihub",
    "description": null,
    "fork": false,
    "url": "https://api.github.com/repos/dagmawibabi/apihub",
    "forks_url": "https://api.github.com/repos/dagmawibabi/apihub/forks",
    "keys_url": "https://api.github.com/repos/dagmawibabi/apihub/keys{/key_id}",
    ...
}

Search Users by Username

Searches for GitHub users based on the provided username.

URL: /search/users/:username
Method: GET
URL Parameters:
- username (required): The username to search for.
Response: Returns a JSON object with the search results for GitHub users.

{
    "total_count": 268911,
    "incomplete_results": false,
    "items": [
        {
            "login": "john",
            "id": 1668,
            "node_id": "MDQ6VXNlcjE2Njg=",
            "avatar_url": "https://avatars.githubusercontent.com/u/1668?v=4",
           ...
        },
        {
            "login": "john-smilga",
            "id": 42133389,
            "node_id": "MDQ6VXNlcjQyMTMzMzg5",
            "avatar_url": "https://avatars.githubusercontent.com/u/42133389?v=4",
          ...
        },
        ...
    ]
    ...
}

Search Repositories by Repository Name

Searches for GitHub repositories based on the provided repository name.

URL: /search/repos/:repository
Method: GET
URL Parameters:
- repository (required): The repository name to search for.
Response: Returns a JSON object with the search results for GitHub repositories.

{
    "total_count": 49874,
    "incomplete_results": false,
    "items": [
        {
            "id": 74293321,
            "node_id": "MDEwOlJlcG9zaXRvcnk3NDI5MzMyMQ==",
            "name": "svelte",
            "full_name": "sveltejs/svelte",
            "private": false,
            "owner": {
                "login": "sveltejs",
                "id": 23617963,
                "node_id": "MDEyOk9yZ2FuaXphdGlvbjIzNjE3OTYz",
                "avatar_url": "https://avatars.githubusercontent.com/u/23617963?v=4",
                "gravatar_id": "",
                ...
            },
            "html_url": "https://github.com/sveltejs/svelte",
            "description": "Cybernetically enhanced web apps",
            "fork": false,
            "url": "https://api.github.com/repos/sveltejs/svelte",
            "forks_url": "https://api.github.com/repos/sveltejs/svelte/forks",
            "keys_url": "https://api.github.com/repos/sveltejs/svelte/keys{/key_id}",
            "collaborators_url": "https://api.github.com/repos/sveltejs/svelte/collaborators{/collaborator}",
            "teams_url": "https://api.github.com/repos/sveltejs/svelte/teams",
            "hooks_url": "https://api.github.com/repos/sveltejs/svelte/hooks",
            "issue_events_url": "https://api.github.com/repos/sveltejs/svelte/issues/events{/number}",
            "events_url": "https://api.github.com/repos/sveltejs/svelte/events",
            "assignees_url": "https://api.github.com/repos/sveltejs/svelte/assignees{/user}",
            "branches_url": "https://api.github.com/repos/sveltejs/svelte/branches{/branch}",
            "tags_url": "https://api.github.com/repos/sveltejs/svelte/tags",
            "blobs_url": "https://api.github.com/repos/sveltejs/svelte/git/blobs{/sha}",
            "git_tags_url": "https://api.github.com/repos/sveltejs/svelte/git/tags{/sha}",
            "git_refs_url": "https://api.github.com/repos/sveltejs/svelte/git/refs{/sha}",
            "trees_url": "https://api.github.com/repos/sveltejs/svelte/git/trees{/sha}",
            "statuses_url": "https://api.github.com/repos/sveltejs/svelte/statuses/{sha}",
            "languages_url": "https://api.github.com/repos/sveltejs/svelte/languages",
            "stargazers_url": "https://api.github.com/repos/sveltejs/svelte/stargazers",
            "contributors_url": "https://api.github.com/repos/sveltejs/svelte/contributors",
           ...
        },
}

Crypto Hacker News