https://github.com/gpalleschi/quotes_api

Quote API RESTful Node.js based Multilingual (Italian, English and Spanish) is a free, open source quote api to get random quote. Quotes are loaded on sqlite3 DB.
https://github.com/gpalleschi/quotes_api

api multilingual nodeexpress nodejs quotes quotes-api rest-api restful-api sqlite3 sqlite3-database vercel vercel-serverless

Last synced: 8 months ago
JSON representation

Quote API RESTful Node.js based Multilingual (Italian, English and Spanish) is a free, open source quote api to get random quote. Quotes are loaded on sqlite3 DB.

Host: GitHub
URL: https://github.com/gpalleschi/quotes_api
Owner: gpalleschi
License: gpl-3.0
Created: 2022-04-07T15:06:17.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2025-04-29T17:00:54.000Z (8 months ago)
Last Synced: 2025-05-12T14:25:43.570Z (8 months ago)
Topics: api, multilingual, nodeexpress, nodejs, quotes, quotes-api, rest-api, restful-api, sqlite3, sqlite3-database, vercel, vercel-serverless
Language: JavaScript
Homepage: https://quotes-api-three.vercel.app/api
Size: 4.2 MB
Stars: 3
Watchers: 1
Forks: 1
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# quote_api
Quote API RESTful Node.js based Multilingual (Italian, English and Spanish) is a free, open source quote api to get random quote. Quotes are loaded on sqlite3 DB. Actually is hosted on [Vercel](https://quotes-api-three.vercel.app/api/).

## API Reference

- [Get Random Quote](#Random)
- [Get Random Quote Image](#RandomImage)
- [Info](#Info)
- [Authors](#Authors)
- [Quotes](#Quotes)
- [Error Managment](#Error-Managment)

## Random

```HTTP
GET /api/randomquote
```

Return a random quote.

**Query parameters**

| Param | Type | Description | Mandatory |
| :-------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |---|
| language | `String` | Language Code (ex. en, it, es) | Yes |

**Response**

```ts
{
// Quote
quote: string
// Author name
author: string
// tags
tags: string
}
```
**Examples**

`http://localhost:35907/api/randomquote?language=en`

```
{
"quote": "Three things cannot be long hidden: the sun, the moon, and the truth.",
"author": "Buddha",
"tags": "famous"
}
```

## RandomImage

```HTTP
GET /api/randomimage
```

Return a random image with a quote and its author (To generate random image use pixabay service).

**Query parameters**

**Response**

```ts
{
// url image
url: string
// width image
width : number
// height image
height : number
// Author name
author: string
// Quote
quote: string
}
```

**Examples**

`http://localhost:35907/api/randomimage?language=en`

```
{
"url": "https://pixabay.com/get/g6e739078013913a6cc494f4fa619b28b40d3b74f8d631c9fa8454a20654f6a1cbf45b4117d180dd8ad0789664ca946d5cee9224be3de79b4c620d5bdafbf2179_640.jpg",
"width" : 640,
"height" : 426,
"author": "Frida Kahlo",
"quote": "Nada dura para siempre… por eso quiero que seas mi nada."
}
```

## Info

```HTTP
GET /api/Info
```

Return info about total quotes and authors.

**Query parameters**

**Response**

```ts
{
// version
version: string
// Language code
language: string
// Total quotes loaded
quotes: number
// Total authors loaded
authors: number
}
```
**Examples**

`http://localhost:35907/api/info?language=en`

```
{
"version": "1.7.2",
"language": "en",
"quotes": 1746,
"authors": 717
}
```

## Authors

```HTTP
GET /api/authors
```

Return list of Authors with relative total quotes.

**Query parameters**

**Response**

```ts
{
// Author Name
author: string
// Total quotes loaded
totQuotes: number
}
```
**Examples**

`http://localhost:35907/api/authors?language=it&search=%OSCAR%`

```
[
{
"author": "Oscar Wilde",
"totQuotes": 91
}
]
```

## Quotes

```HTTP
GET /api/quotes
```

Return list of quotes of an author.

**Query parameters**

**Response**

```ts
{
// Total quotes founded
totQuotes: number
quotes: array<{
// Quote
quote: string
// Author name
author: string
// tags
tags: string
}>
}
```
**Examples**

`http://localhost:35907/api/quotes?language=en&author=%Obama%`

```
{
"totQuotes": 6,
"quotes": [
{
"quote": "If you're walking down the right path and you're willing to keep walking, eventually you'll make progress.",
"author": "Barack Obama",
"tags": "famous"
},
{
"quote": "Focusing your life solely on making a buck shows a poverty of ambition. It asks too little of yourself. And it will leave you unfulfilled.",
"author": "Barack Obama",
"tags": "famous"
},
{
"quote": "Change will not come if we wait for some other person or some other time. We are the ones weve been waiting for. We are the change that we seek.",
"author": "Barack Obama",
"tags": "famous"
},
{
"quote": "Change will not come if we wait for some other person or some other time. We are the ones weve been waiting for. We are the change that we seek.",
"author": "Barack Obama",
"tags": "famous"
},
{
"quote": "Focusing your life solely on making a buck shows a poverty of ambition. It asks too little of yourself. And it will leave you unfulfilled.",
"author": "Barack Obama",
"tags": "famous"
},
{
"quote": "If you're walking down the right path and you're willing to keep walking, eventually you'll make progress.",
"author": "Barack Obama",
"tags": "famous"
}
]
}
```

## Error Managment

**Error Response**
```ts
{
// Language code
error: number,
// Function Name
function: string,
// Description error
description: string
}
```

### Prerequisites

* Node v22.14.0 or upper
* npm v11.3.0 or upper

### Built With
* [Visual Code Editor](https://code.visualstudio.com)

### NPM Modules
npm install

### Run
npm start

### Authors

* **Giovanni Palleschi** - [gpalleschi](https://github.com/gpalleschi)

### License

This project is licensed under the GNU GENERAL PUBLIC LICENSE 3.0 License - see the [LICENSE](LICENSE) file for details

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/gpalleschi/quotes_api

Awesome Lists containing this project

README