Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drewthoennes/Bored-API
A simple and free API to find things to do when you're bored
https://github.com/drewthoennes/Bored-API
api bored expressjs heroku mongodb nodejs public-api
Last synced: about 2 months ago
JSON representation
A simple and free API to find things to do when you're bored
- Host: GitHub
- URL: https://github.com/drewthoennes/Bored-API
- Owner: drewthoennes
- License: mit
- Created: 2018-07-30T04:17:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T20:08:09.000Z (8 months ago)
- Last Synced: 2024-08-01T12:30:00.377Z (5 months ago)
- Topics: api, bored, expressjs, heroku, mongodb, nodejs, public-api
- Language: JavaScript
- Homepage: https://www.boredapi.com/
- Size: 1.83 MB
- Stars: 222
- Watchers: 5
- Forks: 46
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
# Bored API
A free and simple API to help you find something better to do
## About
This project is an MEVN (MongoDB, Express.js, Vue.js, and Node.js) web app that has a goal of creating a simple way to find things to do. You do not need an API key to use this API, just query the endpoint to get data. All activities served by the API can be found [here](./activities.json).
---
## Endpoints
The full documentation can be found [here](https://www.boredapi.com/documentation), but listed below are a few of the endpoints.
#### Random event
Gets a random event
```
/api/activity/
```
Response:
```
{
"activity": "Learn Express.js",
"accessibility": 0.25,
"type": "education",
"participants": 1,
"price": 0.1,
"link": "https://expressjs.com/",
"key": "3943506"
}
```
#### Get by type
Query for events by a certain type
```
/api/activity?type=:type
```
Response:
```
{
"activity": "Learn how to play a new sport",
"accessibility": 0.2,
"type": "sports",
"participants": 1,
"price": 0.1,
"key": "5808228"
}
```
---
## Using
To set up your own Bored API, clone the app, start your MongoDB instance, and run:
```bash
npm install
npm start
# Started on port 8080
```
---
## Contributing
All help is welcome! A pull request or a new issue would be very appreciated. If you want to add more activities, I've created a UI on the [website](https://www.boredapi.com/contributing) to make suggesting easy.
---
## Usage
The Bored API has been used in many other applications and projects:
* [I'm Bored Alexa skill](https://www.amazon.com/gp/product/B07GDL9MP4?ie=UTF8&ref-suffix=ss_rw)
* [Python wrapper](https://pypi.org/project/bored/)
* [Kotlin wrapper](https://gitlab.com/CMDR_Tvis/bored-api)
* [React app](https://github.com/CDAracena/Im-Bored)
* [Vue app](https://github.com/emilsgulbis/BoredApp)
* [iOS app](https://apps.apple.com/us/app/bored-find-what-to-do/id1475656469)