ghPinnedAPI

Get your pinned repositories api

Warning

This project will no longer be updated. All new updates to this API will be made in the MyApis repository, and only security updates will be made in this current repository.

Using the api on your project

If you want to add your pinned repositories to your portfolio or website and can't find an API that works for this, then your problems are over. I've created an API that does exactly that, and its usage is extremely easy. Simply pass your GitHub username as a query parameter.

Example of request

https://api.kremilly.com/github?user=YOUR_USERNAME

Note

Replace YOUR_USERNAME with your GitHub username

Note

We request the use of the new endpoint; however, the old one is still operational.

A simple example of use in JavaScript

// Replace "kremilly" for your GitHub username
fetch('api.kremilly.com/github?user=kremilly').then(
   json => json.json()
).then(callback => { 
   console.log(callback) 
})

Note

The API will return a JSON with all your pinned repositories (if any; otherwise, it will return an empty JSON)

Note

See here others examples in others languages and using Axios.js

Simple output of request:

{
    "description": "Get your pinned repositories api",
    "forks": 0,
    "home": "https://gh-pin.kremilly.com",
    "languages": [
      "Python",
      "HTML"
    ],
    "name": "ghPinnedAPI",
    "stars": 1,
    "tags": [
      "api",
      "github",
      "python",
      "github-pinned-api"
    ],
    "url": "https://github.com/kremilly/ghPinnedAPI"
  }

Queries Parameters

• user Set the username

Data returned by the API

• name Repository name (required)
• description Repository description (optional)
• home Repository home URL (optional)
• url Repository url on GitHub (generated by GitHub)
• stars Repository stars amount (default is 0)
• forks Repository forks amount (default is 0)
• languages Repository languages (generated by GitHub)
• tags Repository topics on GitHub (optional)

Possible messages knowning

• The user does not have any pinned repositores (Status code: 200)
• User does not exist on GitHub (Status code: 404)
• Error fetching pinned repositories (Status code: 500)