🔌 API Documentation

RESTful API for programmatic Lorem Ipsum generation

Base URL:https://lipsumx.neisterse.com

Overview

LipsumX provides a free, fast, and reliable RESTful API for generating Lorem Ipsum placeholder text in over 30 languages. The API is designed to be simple to use with minimal configuration required.

🚀

Fast & Free

No API key required. Instant responses with no setup.

🌍

30+ Languages

Generate text in Latin, Turkish, German, Japanese, and more.

📦

Multiple Formats

Get output as plain text, HTML, Markdown, or JSON.

⚡

CORS Enabled

Use directly from browser JavaScript without proxy.

Quick Start

Generate Lorem Ipsum text with a simple HTTP request:

GET/api/generate

curl "https://lipsumx.neisterse.com/api/generate?p=3&locale=tr"

Authentication

✅

No Authentication Required

The LipsumX API is completely free and open. No API keys or tokens are needed.

Rate Limits

To ensure fair usage and availability for all users, the following rate limits apply:

Limit Type	Value	Window
Requests per IP	`100`	Per minute
Max count	`100`	Per request

⚠️

Rate Limit Exceeded

If you exceed the rate limit, you'll receive a 429 Too Many Requests response. Wait a minute and try again.

GET /api/generate

Generate Lorem Ipsum text with query parameters. Returns text in the specified format.

Query Parameters

Parameter	Type	Default	Description
`p` / `paragraphs` / `count`	number	`1`	Number of items to generate (1-100)
`type`	string	`paragraph`	Type of content: `paragraph`, `sentence`, `word`
`locale` / `l`	string	`la`	Language code (see Supported Languages)
`format` / `f`	string	`text`	Output format: `text`, `html`, `markdown`, `json`
`start`	boolean	`true`	Start with traditional "Lorem ipsum dolor sit amet..."

Response

Returns plain text by default, or structured data based on the format parameter.

200 OKtext/plain

Lorem ipsum dolor sit amet, consectetur adipiscing elit. 
Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

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

5 paragraphs without "Lorem ipsum" start

GET /api/generate?p=5&start=false

POST /api/generate

Generate Lorem Ipsum with a JSON request body. Returns all format variants in a single response.

Request Body

Field	Type	Required	Description
`count`	number	No	Number of items to generate (default: 1)
`type`	string	No	Content type: paragraph, sentence, word
`locale`	string	No	Language code (default: "la")
`format`	string	No	Preferred format in response
`startWithLorem`	boolean	No	Start with "Lorem ipsum..." (default: true)

POST/api/generate

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

Response

200 OKapplication/json

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

🌍 Supported Languages

LipsumX supports 30+ languages for Lorem Ipsum generation. Each language provides authentic placeholder text in that language's natural style.

laLatina(Latin)

trTürkçe(Turkish)

enEnglish(English)

deDeutsch(German)

frFrançais(French)

esEspañol(Spanish)

itItaliano(Italian)

ptPortuguês(Portuguese)

nlNederlands(Dutch)

plPolski(Polish)

ruРусский(Russian)

elΕλληνικά(Greek)

arالعربية(Arabic)

heעברית(Hebrew)

ja日本語(Japanese)

zh中文(Chinese)

ko한국어(Korean)

hiहिन्दी(Hindi)

thไทย(Thai)

viTiếng Việt(Vietnamese)

idIndonesia(Indonesian)

csČeština(Czech)

svSvenska(Swedish)

daDansk(Danish)

fiSuomi(Finnish)

noNorsk(Norwegian)

ukУкраїнська(Ukrainian)

roRomână(Romanian)

huMagyar(Hungarian)

bgБългарски(Bulgarian)

📦 NPM Package

Use LipsumX directly in your JavaScript/TypeScript projects with our official npm package.

Installation

npm install @bturkis/lipsumx

yarn add @bturkis/lipsumx

pnpm add @bturkis/lipsumx

Basic Usage

TypeScript

import { lorem } from '@bturkis/lipsumx'

// Generate paragraphs
const paragraphs = lorem.paragraphs(3)

// Generate sentences in Turkish
const sentences = lorem.sentences(5, { locale: 'tr' })

// Generate words as HTML
const words = lorem.words(50, { format: 'html' })

Advanced Usage

import { lorem, getAvailableLocales } from '@bturkis/lipsumx'

// Full control with options
const result = lorem.generate({
  count: 3,
  type: 'paragraph',
  format: 'json',
  locale: 'de',
  startWithLorem: true
})

// Get all available languages
const languages = getAvailableLocales()
console.log(languages) // [{ code: 'la', name: 'Latin', ... }, ...]

⌨️ CLI Tool

Generate Lorem Ipsum text directly from your terminal with our command-line tool.

Installation

npm install -g @bturkis/lipsumx-cli

Commands

Command	Description
`lorem` / `lipsum` / `lipsumx`	Generate 1 paragraph (default)
`lorem -p <n>`	Generate n paragraphs
`lorem -s <n>`	Generate n sentences
`lorem -w <n>`	Generate n words
`lorem -l <code>`	Set language (e.g., tr, de, ja)
`lorem -f <format>`	Output format (text, html, json, md)
`lorem --copy`	Copy result to clipboard
`lorem --list-locales`	Show all available languages

Examples

# Generate 5 paragraphs
lorem -p 5

# Generate 10 Turkish sentences
lorem -s 10 -l tr

# Generate 100 words and copy to clipboard
lorem -w 100 --copy

# Generate JSON output
lorem -p 3 -f json

# List all available languages
lorem --list-locales

JavaScript Examples

Using Fetch API

// GET request
const response = await fetch('https://lipsumx.neisterse.com/api/generate?p=3&locale=tr')
const text = await response.text()
console.log(text)

// POST request
const result = await fetch('https://lipsumx.neisterse.com/api/generate', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    count: 5,
    type: 'paragraph',
    locale: 'de',
    format: 'json'
  })
})
const data = await result.json()
console.log(data)

Using Axios

import axios from 'axios'

// GET request
const { data } = await axios.get('https://lipsumx.neisterse.com/api/generate', {
  params: { p: 3, locale: 'tr', format: 'json' }
})
console.log(data)

Python Examples

import requests

# GET request
response = requests.get('https://lipsumx.neisterse.com/api/generate', params={
    'p': 3,
    'locale': 'tr',
    'format': 'json'
})
data = response.json()
print(data)

# POST request
response = requests.post('https://lipsumx.neisterse.com/api/generate', json={
    'count': 5,
    'type': 'paragraph',
    'locale': 'de'
})
data = response.json()
print(data)

cURL Examples

# Basic GET request
curl "https://lipsumx.neisterse.com/api/generate?p=3"

# With locale and format
curl "https://lipsumx.neisterse.com/api/generate?p=3&locale=tr&format=json"

# POST request
curl -X POST https://lipsumx.neisterse.com/api/generate \
  -H "Content-Type: application/json" \
  -d '{"count":5,"type":"paragraph","locale":"de"}'