/citadel-paints-api

RESTful API providing basic information about the range of Citadel paints from Games Workshop

Primary LanguageTypeScript

Citadel Paints API

API to access basic information about paints in the Citadel range

I'll do my best to keep the data updated with the current paint range, but please use a Github issue to let me know if there are any missing.

URI: https://citadel-paints-api.onrender.com/paints

Results are returned as an array of paint objects. Example of paint object:

{
    "_id": "63ea823b30b5f2d4d900caf0",
    "name": "Runelord Brass ",
    "type": "layer",
    "colorGroup": "metallic",
    "__v": 0
}

API Reference

View full documentation with examples here.

Get all paints

  GET /paints

Get paint by id

  GET /paints/${id}

GET paints by name

  GET /paints?name=[name]

GET paints by type

  GET /paints?type=[type]

GET paints by color group

  GET /paint?colorGroup=[colorGroup]

GET paints by type and color group

  GET /paints?type=[type]&colorGroup=[colorGroup]

Acknowledgements