Username Generator API Documentation

📖 Overview

The Username Generator API creates unique usernames by combining words from various themed categories. Perfect for user registration systems, game character names, or any application requiring creative username suggestions.

🎭 6 Themed Categories

Animals, Colors, Nature, Tech, Space, and Fantasy themed word sets

🔄 Cross-Theme Combinations

Mix words from different themes for creative combinations

📚 Rich Word Database

100+ general adjectives plus hundreds of themed words

📊 Bulk Generation

Generate multiple username suggestions in a single request

🎨 Available Themes

🐾 Animals

Wildlife and domestic animals

🌈 Colors

Colors and color variations

🌿 Nature

Natural elements and phenomena

💻 Technology

Tech terms and digital concepts

🚀 Space

Celestial bodies and space terms

🧙 Fantasy

Mythical creatures and magical elements

🌐 Base URL

https://api.lorwongam.com/api/username-generator/

🔐 Authentication

No authentication required. This is a public API that can be accessed without any API keys or tokens.

📡 API Endpoints

POST / Generate Username

Generate unique usernames based on specified themes and options.

Request Parameters

Parameter	Type	Required	Default	Description
`theme`	string	Optional	"gaming"	Theme: "gaming", "professional", "fun", "nature", "tech", "space", "devops"
`use_case`	string	Optional	"gaming"	Use case context
`min_length`	integer	Optional	6	Minimum username length (3-50)
`max_length`	integer	Optional	20	Maximum username length (3-50)
`count`	integer	Optional	10	Number of usernames to generate (1-50)
`include_numbers`	boolean	Optional	false	Add random numbers to usernames
`include_symbols`	boolean	Optional	false	Add symbols like _, -, .
`capitalize`	boolean	Optional	true	Capitalize words
`avoid_repetition`	boolean	Optional	true	Avoid duplicate word combinations
`use_all_adjectives`	boolean	Optional	false	Use adjectives from all themes
`use_general_adjectives`	boolean	Optional	false	Add general adjectives (colors, shapes, sizes, etc.)
`custom_words`	string	Optional	""	Comma-separated custom words
integer	Optional	null	Maximum username length (excludes numbers)

Example Request - Simple Username

curl -X POST "https://api.lorwongam.com/api/username-generator/" \
  -H "Content-Type: application/json" \
  -d '{
    "theme": "nature",
    "min_length": 8,
    "max_length": 15,
    "count": 5
  }'
                    

Example Request - Gaming Username

curl -X POST "https://api.lorwongam.com/api/username-generator/" \
  -H "Content-Type: application/json" \
  -d '{
    "theme": "gaming",
    "min_length": 10,
    "max_length": 18,
    "include_numbers": true,
    "capitalize": true,
    "count": 5
  }'
                    

Example Request - Professional Username

curl -X POST "https://api.lorwongam.com/api/username-generator/" \
  -H "Content-Type: application/json" \
  -d '{
    "theme": "professional",
    "min_length": 8,
    "max_length": 15,
    "capitalize": true,
    "avoid_repetition": true,
    "use_general_adjectives": true
  }'
                    

📊 Response Format

Success Response

Single Username Response

{
  "success": true,
  "data": {
    "username": "swift_panther",
    "theme": "animals",
    "format": "adjective_noun",
    "length": 13,
    "components": {
      "adjective": "swift",
      "noun": "panther"
    },
    "settings": {
      "separator": "_",
      "case_style": "lowercase",
      "numbers": false
    }
  },
  "message": "Username generated successfully",
  "timestamp": "2025-09-09T12:00:00Z"
}
                    

Multiple Usernames Response

{
  "success": true,
  "data": {
    "usernames": [
      {
        "username": "MysticDragon99",
        "theme": "fantasy",
        "length": 13,
        "components": {
          "adjective": "mystic",
          "noun": "dragon"
        }
      },
      {
        "username": "AncientWizard42",
        "theme": "fantasy",
        "length": 15,
        "components": {
          "adjective": "ancient",
          "noun": "wizard"
        }
      }
    ],
    "count": 2,
    "settings": {
      "theme": "fantasy",
      "format": "adjective_noun",
      "separator": "",
      "case_style": "title",
      "numbers": true
    }
  },
  "message": "Usernames generated successfully",
  "timestamp": "2025-09-09T12:00:00Z"
}
                    

Error Response

{
  "success": false,
  "error": "Invalid theme specified. Must be one of: animals, colors, nature, tech, space, fantasy, random",
  "code": "INVALID_THEME",
  "timestamp": "2025-09-09T12:00:00Z"
}
                    

🎯 Format Options

Format	Structure	Example
`adjective_noun`	Adjective + Noun	swift_panther
`noun_adjective`	Noun + Adjective	panther_swift
`noun_only`	Noun only	panther

Case Style Options

Style	Description	Example
`lowercase`	All lowercase	swift_panther
`uppercase`	All uppercase	SWIFT_PANTHER
`title`	First letter of each word capitalized	Swift_Panther
`camel`	CamelCase (no separators)	SwiftPanther

⚠️ Error Codes

Code	Description
`INVALID_THEME`	Theme parameter is not valid
`INVALID_FORMAT`	Format parameter is not valid
`INVALID_CASE_STYLE`	Case style parameter is not valid
`INVALID_COUNT`	Count is outside the valid range (1-20)
`GENERATION_ERROR`	Error occurred during username generation

🚦 Rate Limits

Currently, there are no rate limits imposed on this API. However, please use it responsibly and avoid excessive requests that might impact service availability for other users.

👤 Username Generator API