LIVE

FNaF API Docs

A REST API for Five Nights at Freddy's data — 335 characters and 48 books, fully filterable and searchable. Built on Cloudflare Workers.

No auth required

JSON responses

GET only

CORS enabled

Base URL & Conventions

How the API is structured

Base URL

https://fnaf-api.gsarvente.workers.dev

Format

All responses are application/json. Trailing slashes are stripped automatically.

Slug convention

Name/title URL params are slugified: lowercased, spaces -> -, special chars removed.
e.g. Freddy Fazbear -> freddy-fazbear

Pagination

All list endpoints support ?limit= and ?offset= for cursor-style pagination.

ℹ All endpoints are read-only (GET). No API key is required. The root endpoint GET / returns a live summary of all available routes and values.

⚠

Error Handling

How errors are returned

Status	Meaning	Example body
200	Success	{ ... data ... }
400	Bad request (e.g. non-numeric ID, missing `?q=`)	{ "error": "ID deve ser um número" }
404	Not found (unknown route or resource)	{ "error": "Personagem \"...\" não encontrado" }

Characters

335 animatronics, with 25 types and 55 animal categories

Character object

idnumber

namestring

animalstring

typestring

colorstring[]

eyeColorstring[]

yearnumber|"Unknown"

imgstring

Available types

GET

/characters

List all characters — filterable and paginated

▾

Query parameters

Parameter	Type	Description
typeoptional	string	Filter by type (e.g. `Classic`)
animaloptional	string	Filter by animal (e.g. `Bear`)
coloroptional	string	Filter by body color (e.g. `Purple`)
eyeColoroptional	string	Filter by eye color
yearoptional	number	Filter by origin year (e.g. `1987`)
limitoptional	number	Max results to return
offsetoptional	number	Results to skip (for pagination)

Response

{
  "total": 335,
  "count": 2,
  "offset": 0,
  "limit": 2,
  "characters": [
    {
      "id": 1,
      "name": "Freddy Fazbear",
      "animal": "Bear",
      "type": "Classic",
      "color": ["Brown"],
      "eyeColor": ["Blue"],
      "year": 1993,
      "img": "images/chars/classic/freddy.png"
    }, ...
  ]
}
          

GET

/characters/random

Returns a single random character

▾

No parameters. Returns a single character object chosen at random from all 335.

Response

{
  "id": 42,
  "name": "Nightmare Bonnie",
  "animal": "Rabbit",
  "type": "Nightmare",
  "color": ["Dark Blue"],
  "eyeColor": ["Red"],
  "year": 2015,
  "img": "images/chars/nightmare/nightmare_bonnie.png"
}
          

GET

/characters/:id

Fetch a character by numeric ID

▾

Parameter	Type	Description
idrequired	number	Numeric character ID (1-based, sequential)

{ /* single character object */ }

GET

/characters/name/:name

Fetch a character by slugified name

▾

Parameter	Type	Description
namerequired	string	Slugified name (e.g. `freddy-fazbear`)

GET /characters/name/golden-freddy

GET

/search?q=

Full-text search across name, type, animal, color and eyeColor

▾

Parameter	Type	Description
qrequired	string	Search query (case-insensitive, partial match)

Response

{
  "query": "purple",
  "total": 5,
  "characters": [ /* ... */ ]
}
          

GET

/types & /types/:type

List all types, or get characters of a specific type

▾

GET /types returns all types with their slug and character count.
GET /types/nightmare returns all characters of that type.

{
  "total": 25,
  "types": [
    { "name": "Classic", "slug": "classic", "count": 14 },
    ...
  ]
}
          

GET

/animals & /animals/:animal

List all animals, or get characters of a specific animal

▾

Identical structure to /types. 55 animal categories total, including Bear, Fox, Rabbit, and more exotic ones like Blob, Rainbow, or Slime.

GET /animals/fox -> returns all fox-type characters

Books

48 titles across 10 series

Book object

idnumber

titlestring

seriesstring

yearnumber

numbernumber

imgstring

Available series

GET

/books

List all books — filterable and paginated

▾

Parameter	Type	Description
seriesoptional	string	Filter by series name
yearoptional	number	Filter by release year
limitoptional	number	Max results
offsetoptional	number	Skip N results

Response

{
  "total": 48,
  "count": 3,
  "offset": 0,
  "limit": 3,
  "books": [ /* book objects */ ]
}
          

GET

/books/random

Returns a single random book

▾

No parameters. Returns one book object at random.

GET

/books/:id

Fetch a book by numeric ID

▾

Parameter	Type	Description
idrequired	number	Numeric book ID

GET

/books/title/:title

Fetch a book by slugified title

▾

Parameter	Type	Description
titlerequired	string	Slugified title (e.g. `the-silver-eyes`)

GET /books/title/the-silver-eyes

GET

/books/search?q=

Search books by title, series or year

▾

Parameter	Type	Description
qrequired	string	Case-insensitive partial match on title, series name, or year

Response

{
  "query": "pizzaplex",
  "total": 9,
  "books": [ /* ... */ ]
}
          

GET

/books/series & /books/series/:series

List all series, or get books from a specific series

▾

GET /books/series -> all series with slug + count.
GET /books/series/trilogy -> all books in the Trilogy.

{
  "total": 10,
  "series": [
    { "name": "Trilogy", "slug": "trilogy", "count": 3 },
    ...
  ]
}
          

Images

Redirects to GitHub raw content

GET

/images/:category/:type/:filename

Redirects (302) to GitHub raw image

▾

The API proxies image requests via a 302 redirect to the GitHub repository's raw content at raw.githubusercontent.com/emilia-gomes2008/fnaf-api/main/…

Image paths from the database

GET /images/chars/classic/freddy.png
-> 302 -> https://raw.githubusercontent.com/emilia-gomes2008/fnaf-api/main/images/chars/classic/freddy.png