Figlet-API Documentation

This is the documentation for the Figlet-API. It is a simple API that allows you to generate ASCII art from text.

---

API

This is the link of the API:

https://figlet-api.onrender.com/

---

Usage

The API is very simple to use.

---

GET /

This endpoint returns a list of all the fonts available.

Endpoint

GET /?text={text}&font={font}

the text parameter is required, and the font parameter is optional (defaults to standard). So this is correct too

GET /?text={text}

Example

GET https://figlet-api.onrender.com/?text=Hello%20World

{
  "text": "Hello World",
  "font": "standard",
  "ascii": " _   _      _ _        __        __         _     _ \r\n| | | | ___| | | ___   \\ \\      / /__  _ __| | __| |\r\n| |_| |/ _ \\ | |/ _ \\   \\ \\ /\\ / / _ \\| '__| |/ _` |\r\n|  _  |  __/ | | (_) |   \\ V  V / (_) | |  | | (_| |\r\n|_| |_|\\___|_|_|\\___/     \\_/\\_/ \\___/|_|  |_|\\__,_|\r\n"
}

the ASCII will look something like this:

 _   _      _ _        __        __         _     _
| | | | ___| | | ___   \ \      / /__  _ __| | __| |
| |_| |/ _ \ | |/ _ \   \ \ /\ / / _ \| '__| |/ _` |
|  _  |  __/ | | (_) |   \ V  V / (_) | |  | | (_| |
|_| |_|\___|_|_|\___/     \_/\_/ \___/|_|  |_|\__,_|

---

GET /fonts

This endpoint returns a list of all the fonts available.

Endpoint

GET /fonts

Example

GET https://figlet-api.onrender.com/fonts

[
  "3-d",
  "3x5",
  "5lineoblique",
  "acrobatic",
  "alligator",
  "alligator2",
  "alphabet",
  "avatar",
  "banner",
  "banner3-D",
  "banner3",
  "banner4",
  "barbwire",
  "basic",
  ...
]