Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/huchenme/github-trending-api

:octocat: The missing APIs for GitHub trending projects and developers 📈
https://github.com/huchenme/github-trending-api
expressjs github github-api trending trending-repositories zeit
Last synced: about 4 hours ago
JSON representation
:octocat: The missing APIs for GitHub trending projects and developers 📈
Host: GitHub
URL: https://github.com/huchenme/github-trending-api
Owner: huchenme
License: mit
Created: 2018-05-04T06:39:16.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2023-01-06T01:41:27.000Z (almost 2 years ago)
Last Synced: 2024-10-29T17:11:40.872Z (about 2 months ago)
Topics: expressjs, github, github-api, trending, trending-repositories, zeit
Language: JavaScript
Homepage: https://ghapi.huchen.dev/
Size: 3.81 MB
Stars: 757
Watchers: 8
Forks: 107
Open Issues: 40
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project

README

        
Github Unofficial Trending API


:octocat: A simple API that returns number of Github trending repositories and developers.




  

  


  

    Credits: Illustration by unDraw

  






[![Financial Contributors on Open Collective](https://opencollective.com/github-trending-api/all/badge.svg?label=financial+contributors)](https://opencollective.com/github-trending-api) [![GitHub closed issues](https://img.shields.io/github/issues-closed/huchenme/github-trending-api.svg)](https://github.com/huchenme/github-trending-api/issues)

[![Travis](https://img.shields.io/travis/huchenme/github-trending-api.svg)](https://travis-ci.org/huchenme/github-trending-api)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![coverage](https://img.shields.io/codecov/c/github/huchenme/github-trending-api.svg)](https://codecov.io/github/huchenme/github-trending-api)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/huchenme/github-trending-api/blob/master/LICENSE)

[![Code of Conduct](https://img.shields.io/badge/code%20of-conduct-ff69b4.svg)](CODE_OF_CONDUCT.md)

[![npm (scoped)](https://img.shields.io/npm/v/@huchenme/github-trending.svg)](https://www.npmjs.com/package/@huchenme/github-trending)

[![module formats: cjs, es](https://img.shields.io/badge/module%20formats-cjs%2C%20esm-green.svg)](https://unpkg.com/@huchenme/github-trending/dist/)

---

## Table of Contents

Expand Table of Contents

- [Projects using github-trending-api](#projects-using-github-trending-api)

- [Backers](#backers)

- [API Status](#api-status)

- [REST API](#rest-api)

- [Tutorial](#tutorial)

  - [Trending Repositories](#trending-repositories)

  - [Trending Developers](#trending-developers)

  - [List Languages](#list-languages)

  - [List Spoken Languages](#list-spoken-languages)

- [NPM Package](#npm-package)

  - [Install](#install)

  - [Usage](#usage)

  - [API](#api)

    - [languages](#languages)

    - [spokenLanguages](#spokenlanguages)

    - [fetchRepositories(params)](#fetchrepositoriesparams)

    - [fetchDevelopers(params)](#fetchdevelopersparams)

- [docker](#docker)

- [Contributors](#contributors)

  - [Code Contributors](#code-contributors)

  - [Financial Contributors](#financial-contributors)

    - [Individuals](#individuals)

    - [Organizations](#organizations)

- [License](#license)

## Projects using github-trending-api

- **[Hacker Tab](https://github.com/huchenme/hacker-tab-extension)** ([Chrome Store](https://chrome.google.com/webstore/detail/hacker-tab/ibomigipadcieapbemkegkmadbbanbgm)): Chrome extension to view GitHub trending projects on new tab.

- **[github-trending-plus](https://github.com/zircleUI/github-trending-plus)** ([Live](https://github-trending-plus.surge.sh/)): ✨ Experimental Github trending UI.

- **[HitUp](https://github.com/wonderbeyond/HitUP)** ([Chrome Store](https://chrome.google.com/webstore/detail/hitup/eiokaohkigpbonodjcbjpecbnccijkjb)) ([Website](https://hitup.wondertools.top/)): Help you find top things, including GitHub Trending Repositories.

- **[Gitter](https://github.com/huangjianke/Gitter)**: Gitter for GitHub - 可能是目前颜值最高的 GitHub 小程序客户端.

- **[flutter_wanandroid](https://github.com/Sky24n/flutter_wanandroid)**:

  Flutter 完整项目，WanAndroid 客户端，BLoC、RxDart 、国际化、主题色、启动页、引导页，拥有较好的项目结构&比较规范的代码！

- **[vsc-github-trending](https://github.com/4gray/vsc-github-trending)**: ([VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=4gray.vsc-github-trending#overview)): Explore Github Trending repositories directly from Visual Studio Code

- **[GiTiny](https://github.com/k-lpmg/GiTiny)**([AppStore](https://itunes.apple.com/app/tiny-github/id1461424565)): iOS app for GitHub with exploring trending.

- **[SwiftHub](https://github.com/khoren93/SwiftHub)**: GitHub iOS client written in RxSwift and MVVM clean architecture.

- **[GitNews](https://git.news)**: Trending repositories from GitHub, HackerNews & Reddit (Mobile & Desktop).

- **[mini-github](https://github.com/kezhenxu94/mini-github)**: GitHub WeChat Mini Program (可能是全网功能最全的 GitHub 微信小程序).

- **[StarGit](https://github.com/theArgex/stargit2.0)** ([Website](https://stargit.xyz)): Find trending repositories from GitHub. Built with Angular.

- **[GitTouch](https://github.com/pd4d10/git-touch)** ([App Store](https://itunes.apple.com/us/app/gittouch/id1452042346), [Google Play](https://play.google.com/store/apps/details?id=io.github.pd4d10.gittouch)): Open source GitHub App built with Flutter.

- **[lazyhub](https://github.com/ryo-ma/lazyhub)**: :octocat: lazyhub - Terminal UI Client for GitHub using gocui.

- **[Gitrepos](https://github.com/Hyraze/gitrepos)** ([Website](https://gitrepos.now.sh)): :octocat: A simple PWA app that returns Trending Repositories & Developers from GitHub, Gitlab & HackerNews.

- **[Trendzz](https://github.com/omarryhan/trendzz)** ([Website](https://trendzz.netlify.app)): Github trending PWA focusing on usability.

- **[Ceelog](https://mp.weixin.qq.com/s?__biz=MzAwOTMxMzgxMA==&mid=2647972345&idx=1&sn=8b316d6b89b9aae2454f89144ffafa61&chksm=8341f284b4367b9227901a69bcb49be191a4c1e4054a2df464a58b073745e225a943ad808db4&token=1659362714&lang=zh_CN#rd)** Github trending in WeChat Official Account Platform.

## Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/github-trending-api#backer)]





## API Status

API status is available at [uptimerobot](https://stats.uptimerobot.com/K6yKjcKlM).

## REST API

See the full API documentation in [Apiary](https://githubtrendingapi.docs.apiary.io/#).

## Tutorial

[How to scrape any website and build an API using cheerio.js](https://medium.com/@chen/how-to-scrape-any-website-and-build-an-api-using-cheerio-js-6a3f0c651d2e?source=friends_link&sk=7b76d9abf0b6c572042238906e281228)

### Trending Repositories

Receive an array of trending repositories.

**URL Endpoint:**

https://ghapi.huchen.dev/repositories?language=javascript&since=weekly

**Parameters:**

- `language`: **optional**, list trending repositories of certain programming languages, possible values are listed [here](./src/languages.json).

- `since`: **optional**, default to `daily`, possible values: `daily`, `weekly` and `monthly`.

- `spoken_language_code`: **optional**, list trending repositories of certain spoken languages (e.g English, Chinese), possible values are listed [here](./src/spoken-languages.json).

**Response:**

```json

[

  ...

  {

    "author": "google",

    "name": "gvisor",

    "avatar": "https://github.com/google.png",

    "url": "https://github.com/google/gvisor",

    "description": "Container Runtime Sandbox",

    "language": "Go",

    "languageColor": "#3572A5",

    "stars": 3320,

    "forks": 118,

    "currentPeriodStars": 1624,

    "builtBy": [

      {

        "href": "https://github.com/viatsko",

        "avatar": "https://avatars0.githubusercontent.com/u/376065",

        "username": "viatsko"

      }

    ]

  }

  ...

]

```

> Note that [GitHub trending page](http://github.com/trending) sometimes is empty, in that case this API returns `[]` in response, your application should be able to handle it or read from previous cache.

### Trending Developers

Receive an array of trending developers.

**URL Endpoint:**

https://ghapi.huchen.dev/developers?language=javascript&since=weekly

**Parameters:**

- `language`: **optional**, list trending repositories of certain programming languages, possible values are listed [here](./src/languages.json).

- `since`: **optional**, default to `daily`, possible values: `daily`, `weekly` and `monthly`.

**Response:**

```json

[

  {

    "username": "google",

    "name": "Google",

    "type": "organization",

    "url": "https://github.com/google",

    "avatar": "https://avatars0.githubusercontent.com/u/1342004",

    "repo": {

      "name": "traceur-compiler",

      "description": "Traceur is a JavaScript.next-to-JavaScript-of-today compiler",

      "url": "https://github.com/google/traceur-compiler"

    }

  }

]

```

> `type` could be `organization` or `user`.

### List Languages

**URL Endpoint:**

https://ghapi.huchen.dev/languages

**Response:**

```json

[

  {

    "urlParam": "1c-enterprise",

    "name": "1C Enterprise"

  },

  {

    "urlParam": "abap",

    "name": "ABAP"

  },

  {

    "urlParam": "abnf",

    "name": "ABNF"

  },

  {

    "urlParam": "actionscript",

    "name": "ActionScript"

  }

]

```

### List Spoken Languages

**URL Endpoint:**

https://ghapi.huchen.dev/spoken_languages

**Response:**

```json

[

  {

    "urlParam": "ab",

    "name": "Abkhazian"

  },

  {

    "urlParam": "aa",

    "name": "Afar"

  },

  {

    "urlParam": "af",

    "name": "Afrikaans"

  },

  {

    "urlParam": "ak",

    "name": "Akan"

  }

]

```

## NPM Package

You could also use the API as a NPM package.

### Install

```sh

$ npm install --save @huchenme/github-trending

```

### Usage

```js

import {

  languages,

  spokenLanguages,

  fetchRepositories,

  fetchDevelopers,

} from '@huchenme/github-trending';

fetchRepositories({ language: 'ruby', since: 'monthly' }).then(

  (repositories) => {

    console.log(repositories);

  }

);

fetchDevelopers({ language: 'javascript' }).then((developers) => {

  console.log(developers);

});

console.log(languages);

console.log(spokenLanguages);

```

### API

#### languages

List all languages

```js

[

  {

    urlParam: '1c-enterprise',

    name: '1C Enterprise',

  },

  {

    urlParam: 'abap',

    name: 'ABAP',

  },

  {

    urlParam: 'abnf',

    name: 'ABNF',

  },

  {

    urlParam: 'actionscript',

    name: 'ActionScript',

  },

];

```

#### spokenLanguages

List all spoken languages

```js

[

  {

    urlParam: 'ab',

    name: 'Abkhazian',

  },

  {

    urlParam: 'aa',

    name: 'Afar',

  },

  {

    urlParam: 'af',

    name: 'Afrikaans',

  },

  {

    urlParam: 'ak',

    name: 'Akan',

  },

];

```

#### fetchRepositories(params)

Receive an array of trending repositories.

**params**:

- `language`: possible values are the the ones from `languages` or [just find here](./src/languages.json).

- `since`: `daily`, `weekly` or `monthly`, default to `daily`.

- `spokenLanguageCode`: possible values are the the ones from `spokenLanguages` or [just find here](./src/spoken-languages.json).

```js

[

  ...

  {

    author: 'google',

    name: 'gvisor',

    avatar: 'https://github.com/google.png',

    url: 'https://github.com/google/gvisor',

    description: 'Container Runtime Sandbox',

    language: 'Go',

    languageColor: '#3572A5',

    stars: 3320,

    forks: 118,

    currentPeriodStars: 1624,

    "builtBy": [

      {

        "href": "https://github.com/viatsko",

        "avatar": "https://avatars0.githubusercontent.com/u/376065",

        "username": "viatsko"

      }

    ]

  }

  ...

]

```

#### fetchDevelopers(params)

Receive an array of trending developers.

**params**:

- `language`: possible values are the the ones from `languages` or [just find here](languages.json).

- `since`: `daily`, `weekly` or `monthly`, default to `daily`.

```js

[

  ...

  {

    username: 'google',

    name: 'Google',

    type: 'organization',

    url: 'https://github.com/google',

    avatar: 'https://avatars0.githubusercontent.com/u/1342004',

    repo: {

      name: 'traceur-compiler',

      description:

        'Traceur is a JavaScript.next-to-JavaScript-of-today compiler',

      url: 'https://github.com/google/traceur-compiler'

    }

  }

  ...

]

```

## docker

You can develop by using docker.

```

$ docker build -t github-trending-api .

$ docker run -d --rm -p 8000:8888 github-trending-api:latest

```

## Contributors

### Code Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].



### Financial Contributors

Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/github-trending-api/contribute)]

#### Individuals



#### Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/github-trending-api/contribute)]





















## License

MIT