Credits: Illustration by unDraw
:octocat: A simple API that returns number of Github trending repositories and developers.
## 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](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'
}
}
...
]
```
## 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