Files
namegen/API_DOCS.md
T
2025-08-01 00:34:03 +01:00

5.3 KiB

NameGen API Documentation

Base URL

http://localhost:8080/v1

Fantasy Name Endpoints

Race/Type Endpoint Query Parameters
Elf /fantasy/elf-names gender=male
Dwarf /fantasy/dwarf-names gender=male
Arakocra /fantasy/arakocra-names -
Aasimar /fantasy/aasimar-names gender=male
Bugbear /fantasy/bugbear-names -
Centaur /fantasy/centaur-names gender=male
Changeling /fantasy/changeling-names -
Deep Gnome /fantasy/deep-gnome-names gender=male
Deva /fantasy/deva-names gender=male
Dragonborn /fantasy/dragonborn-names gender=male
Drow /fantasy/drow-names gender=male
Duergar /fantasy/duergar-names gender=male
Eladrin /fantasy/eladrin-names gender=male
Fairy /fantasy/fairy-names gender=male
Firbolg /fantasy/firbolg-names gender=male
Genasi /fantasy/genasi-names -
Githyanki /fantasy/githyanki-names gender=male
Githzerai /fantasy/githzerai-names gender=male
Gnome /fantasy/gnome-names gender=male
Goblin /fantasy/goblin-names gender=male
Goliath /fantasy/goliath-names gender=male
Grung /fantasy/grung-names -
Half-Elf /fantasy/half-elf-names gender=male
Half-Orc /fantasy/half-orc-names gender=male
Halfling /fantasy/halfling-names gender=male
Harengon /fantasy/harengon-names gender=male
Hobgoblin /fantasy/hobgoblin-names -
Human /fantasy/human-names gender=male
Kalashtar /fantasy/kalashtar-names -
Kenku /fantasy/kenku-names -
Kobold /fantasy/kobold-names -
Leonin /fantasy/leonin-names gender=male
Lizardfolk /fantasy/lizardfolk-names gender=male
Locathah /fantasy/locathah-names -
Loxodon /fantasy/loxodon-names gender=male
Minotaur /fantasy/minotaur-names gender=male
Orc /fantasy/orc-names gender=male
Satyr /fantasy/satyr-names gender=male
Shadar-Kai /fantasy/shadar-kai-names gender=male
Shardmind /fantasy/shardmind-names -
Shifter /fantasy/shifter-names gender=male
Simic Hybrid /fantasy/simic-hybrid-names gender=male
Tabaxi /fantasy/tabaxi-names gender=male
Tiefling /fantasy/tiefling-names gender=male
Tortle /fantasy/tortle-names -
Triton /fantasy/triton-names gender=male
Vedalken /fantasy/vedalken-names gender=male
Verdan /fantasy/verdan-names -
Warforged /fantasy/warforged-names -
Wilden /fantasy/wilden-names gender=male
Yuan-Ti /fantasy/yuan-ti-names -

Modern Name Endpoints

Language/Type Endpoint Query Parameters
Modern English /modern/english gender=male
Modern Portuguese (EU) /modern/portuguese gender=male

How to Query the API

  • All endpoints return a JSON object with a names array.
  • Use the gender query parameter where supported (e.g., ?gender=female).
  • Example request:
GET http://localhost:8080/v1/fantasy/elf-names?gender=female
GET http://localhost:8080/v1/modern/english?gender=unisex

Example Response

{
  "names": [
    "Aelene Galanodel",
    "Lia Siannodel",
    ...
  ]
}