🔌 API Documentation

RESTful API for programmatic Lorem Ipsum generation

🚀 Quick Start

Generate Lorem Ipsum text with a simple HTTP request:

GET https://loremipsum.neisterse.com/api/generate?p=3&locale=tr

📥 GET /api/generate

Generate Lorem Ipsum text with query parameters.

Parameters

Parameter	Type	Default	Description
`p` / `paragraphs`	number	1	Number of paragraphs
`type`	string	paragraph	Type: paragraph, sentence, word
`locale` / `l`	string	la	Language code (see below)
`format`	string	text	Output: text, html, markdown, json
`start`	boolean	true	Start with "Lorem ipsum..."

Examples

3 paragraphs in Turkish:

GET /api/generate?p=3&locale=tr

10 sentences as HTML:

GET /api/generate?type=sentence&count=10&format=html

50 words as JSON:

GET /api/generate?type=word&count=50&format=json

📤 POST /api/generate

Generate Lorem Ipsum with JSON body. Returns all format variants.

Request Body

{
  "count": 3,
  "type": "paragraph",
  "locale": "tr",
  "format": "json",
  "startWithLorem": true
}

Response

{
  "text": "Lorem ipsum dolor sit amet...",
  "html": "<p>Lorem ipsum dolor sit amet...</p>",
  "markdown": "Lorem ipsum dolor sit amet...",
  "json": { "paragraphs": [...], "count": 3 },
  "locale": "la",
  "count": 3,
  "type": "paragraph"
}

🌍 Supported Languages

30+ languages available for Lorem Ipsum generation:

laLatina

trTürkçe

enEnglish

deDeutsch

frFrançais

esEspañol

itItaliano

ptPortuguês

nlNederlands

plPolski

ruРусский

elΕλληνικά

arالعربية

heעברית

ja日本語

zh中文

ko한국어

hiहिन्दी

thไทย

viTiếng Việt

idIndonesia

csČeština

svSvenska

daDansk

fiSuomi

noNorsk

ukУкраїнська

roRomână

huMagyar

bgБългарски

📦 NPM Package

Use in your JavaScript/TypeScript projects:

npm install @bturkis/loremipsum

import { lorem } from '@bturkis/loremipsum'

// Simple usage
lorem.paragraphs(3)
lorem.sentences(5, { locale: 'tr' })
lorem.words(50, { format: 'html' })

// Advanced usage
lorem.generate({
  count: 3,
  type: 'paragraph',
  format: 'json',
  locale: 'de',
  startWithLorem: true
})

⌨️ CLI Tool

Generate Lorem Ipsum from your terminal:

npm install -g @bturkis/loremipsum-cli

# Basic usage
lorem                     # 1 paragraph
lorem -p 5                # 5 paragraphs
lorem -s 10               # 10 sentences
lorem -w 100              # 100 words

# With options
lorem -p 3 -l tr          # 3 Turkish paragraphs
lorem -w 50 -f json       # 50 words as JSON
lorem -p 2 --copy         # Copy to clipboard
lorem --list-locales      # Show all languages