Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theriturajps/quotes-api
Quotes API: A free and open API providing a rich collection of motivational quotes to inspire and uplift users in your applications.
https://github.com/theriturajps/quotes-api
api apigateway apis free-api github javascript quotes-api theriturajps vercel
Last synced: 10 days ago
JSON representation
Quotes API: A free and open API providing a rich collection of motivational quotes to inspire and uplift users in your applications.
- Host: GitHub
- URL: https://github.com/theriturajps/quotes-api
- Owner: theriturajps
- License: mit
- Created: 2024-10-10T16:18:40.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-10-24T02:56:40.000Z (21 days ago)
- Last Synced: 2024-11-04T14:03:40.666Z (10 days ago)
- Topics: api, apigateway, apis, free-api, github, javascript, quotes-api, theriturajps, vercel
- Language: HTML
- Homepage: https://qapi.vercel.app
- Size: 74.2 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Quotes API
 
Welcome to the Quotes API! Access a vast collection of motivational quotes designed to enhance your applications. This free and open API is easy to integrate into your projects, helping you inspire and motivate your users effectively.
## Technologies Used
- **Language**: JavaScript
- **Backend**: Express.js
- **Hosting**: Vercel
## Getting Started
To get started with the API, you can make requests to the following endpoints to get quotes:
### Get a Random Quote
```
GET https://qapi.vercel.app/api/random
```
This will return a JSON response with a random quote and its author.
### Get All Quotes
```
GET https://qapi.vercel.app/api/quotes
```
This will return a JSON response with all quotes in the collection.
### Get Quote by ID
```
GET https://qapi.vercel.app/api/quotes/{id}
```
Replace `{id}` with the specific ID of the quote you want to fetch. This will return a JSON response with the quote and its author.
## Example Responses
### Random Quote
```json
{
"id" : 1,
"quote": "Success is not the key to happiness. Happiness is the key to success. If you love what you are doing, you will be successful.",
"author": "Albert Schweitzer"
}
```
### All Quotes
```json
[
{
"id": 1,
"quote": "The best way to get started is to quit talking and begin doing.",
"author": "Walt Disney"
},
{
"id": 2,
"quote": "The pessimist sees difficulty in every opportunity. The optimist sees opportunity in every difficulty.",
"author": "Winston Churchill"
},
{
"id": 3,
"quote": "Don’t let yesterday take up too much of today.",
"author": "Will Rogers"
}
]
```
### Quote by ID
```json
{
"id": 1,
"quote": "The best way to get started is to quit talking and begin doing.",
"author": "Walt Disney"
}
```
## Rate Limiting
- **Window Duration**: 15 minutes
- **Maximum Requests**: 200 requests per IP within the window duration
- **Response on Limit Exceed**: A 429 Too Many Requests status code with the following JSON response
```json
{
"message": "Too many requests from this IP, please try again after 15 minutes"
}
```
## Usage
You can use the API to display quotes on your website or application to motivate your users. Here are some examples of how you can use the API with JavaScript:
### Get Random Quote
```javascript
fetch('https://qapi.vercel.app/api/random')
.then(response => response.json())
.then(data => {
console.log(data.quote);
console.log("- " + data.author);
});
```
### Get All Quotes
```javascript
fetch('https://qapi.vercel.app/api/quotes')
.then(response => response.json())
.then(data => {
data.forEach(quote => {
console.log(quote.quote);
console.log("- " + quote.author);
});
});
```
### Get Quote by ID
```javascript
const quoteId = 1; // Example ID
fetch(`https://qapi.vercel.app/api/quotes/${quoteId}`)
.then(response => response.json())
.then(data => {
console.log(data.quote);
console.log("- " + data.author);
});
```
## Installation
1. Clone this repository:
```
git clone https://github.com/theriturajps/quotes-api.git
```
2. Go inside Folder
```
cd quotes-api
```
3. Install the dependencies:
```
npm install
```
3.Start the server:
```
npm start
```
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## More Details
  
- **Developer :-** @theriturajps
- **Fork :-** [Fork this Repo](https://github.com/theriturajps/Quotes-API/fork)