Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jesseokeya/forbes-list
npm package that interfaces with the forbes400 api and returns a list of the richest people in the world
https://github.com/jesseokeya/forbes-list
axios billionaires forbes forbes400 javascript node-module npm-package
Last synced: about 14 hours ago
JSON representation
npm package that interfaces with the forbes400 api and returns a list of the richest people in the world
- Host: GitHub
- URL: https://github.com/jesseokeya/forbes-list
- Owner: jesseokeya
- License: mit
- Created: 2019-03-13T03:43:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T18:25:53.000Z (almost 2 years ago)
- Last Synced: 2024-04-25T05:40:27.997Z (7 months ago)
- Topics: axios, billionaires, forbes, forbes400, javascript, node-module, npm-package
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/forbes-list
- Size: 897 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# forbes-list
Npm package that interfaces with the forbes400 api and returns a list of the world richest people
## Installing
```
npm install forbes-list --save
```
## Documentation
Install and require the library to begin
```js
const forbes = require('forbes-list')
forbes.list(options)
```
| Options | Type | Value(s) | Default | Description |
| ------------- | ------------- | ------------- | ------------- | ------------- |
| | {null} | null | null | Retrieves and returns a lis of all billionaires |
| limit | {Number} or {String} | Any valid integer | 2153 | Limits the length of the returning array |
| filter | {String} | `youngest`, `oldest`, `women or female`, `men or male`, `real-time` | null | Filters down the list based on the parameters passed down |
| filter | {Object} | Any valid american state i.e ` state: 'texas' ` | null | Any valid state in the usa |
| filter | {Object} | Any valid industry i.e `industry: 'technology'`, valid indusries: `technology`, `fashion`, `finance`, `investments etc..` | null | Valid industries include technology, fashion, finance, investments etc.. |
## Usage examples
### Payload Sample
```js
[{ position: 1,
rank: 1,
name: 'Jeff Bezos',
lastName: 'Bezos',
uri: 'jeff-bezos',
imageUri: 'jeff-bezos',
worth: 131000,
worthChange: 1342.991,
age: 55,
source: 'Amazon',
industry: 'Technology',
gender: 'M',
country: 'United States',
title: 'CEO and Founder, Amazon',
timestamp: 1552490101279,
headquarters: 'WA',
state: 'Washington',
realTimeWorth: 139428.694,
realTimeRank: 1,
realTimePosition: 1,
government: false,
squareImage: '//specials-images.forbesimg.com/imageserve/5bb22ae84bbe6f67d2e82e05/416x416.jpg?background=000000&cropX1=904&cropX2=1403&cropY1=262&cropY2=761' }]
```
### Retrieves all billionaires
```js
const forbes = require('forbes-list')
forbes.list().then(response => {
console.log(response)
})
```
### Limits the length of the returning array
```js
const forbes = require('forbes-list')
forbes.list({ limit: 5 }).then(response => {
console.log(response)
})
```
### Limits the length of the returning array
### Valid parameters for filter -> youngest, oldest, women or female, men or male, real-time
```js
const forbes = require('forbes-list')
forbes.list({ limit: 5, filter: 'real-time' }).then(response => {
console.log(response)
})
```
### Limits the length of the returning array
### Any valid state in the usa
```js
const forbes = require('forbes-list')
forbes.list({ limit: 5, filter: { state: 'texas' } }).then(response => {
console.log(response)
})
```
### Limits the length of the returning array
### Valid industries include -> technology, fashion, finance, investments etc..
```js
const forbes = require('forbes-list')
forbes.list({ limit: 5, filter: { industry: 'fashion' } }).then(response => {
console.log(response)
})
```
## Built With
* [axios](https://github.com/axios/axios) - Promise based HTTP client for the browser and node.js
* [forbesApi](https://forbes400.herokuapp.com) - JSON Api Of The Forbes 400 Richest People List
## Authors
* **Jesse Okeya** - *Initial work* - [website](http://jesseokeya.com)
See also the list of [contributors](https://github.com/jesseokeya/forbes-list/graphs/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details