API Documentation

Quick Start

Generate a Bitwarden vault with 50 login items:

curl -X POST /api/vault/generate \
  -H "Content-Type: application/json" \
  -d '{"format": "bitwarden", "loginCount": 50}'

Endpoints

GET/api/vault

API overview. Returns supported formats, endpoint info, and rate limit details.

GET/api/vault/formats

Detailed format capabilities. Returns each format's supported vault types, item types, organizational features, and output format.

POST/api/vault/generate

Generate vault data. Accepts JSON body with generation parameters. Returns the vault file as a download (JSON, CSV, or XML depending on format).

GET/api/config

Application configuration. Returns hosting provider info.

Generation Parameters

All parameters for POST /api/vault/generate. Only format is required.

Core

Parameter	Type	Default	Description
format	string	required	One of: bitwarden, lastpass, keeper, edge, keepassx, keepass2, password-depot
vaultType	string	"individual"	"individual" or "org" (org is Bitwarden only)
loginCount	number	50	Number of login items (0 - 10,000)
secureNoteCount	number	0	Number of secure notes (Bitwarden only, 0 - 10,000)
creditCardCount	number	0	Number of credit cards (Bitwarden only, 0 - 10,000)
identityCount	number	0	Number of identity items (Bitwarden only, 0 - 10,000)
language	string	"en"	Locale for generated data (see Supported Languages)

URL Options

Parameter	Type	Default	Description
useRealUrls	boolean	false	Use real website URLs instead of generated ones
useEnterpriseUrls	boolean	false	Use enterprise/corporate URLs
enterpriseUrls	string[]	-	Custom list of enterprise URLs to use

Password Options

Parameter	Type	Default	Description
useWeakPasswords	boolean	false	Include weak/common passwords in generated data
weakPasswordPercentage	number	20	Percentage of passwords that are weak (0 - 100)
reusePasswords	boolean	false	Simulate password reuse across entries
passwordReusePercentage	number	10	Percentage of passwords that are reused (0 - 100)

Collection Options (Bitwarden org vaults only)

Parameter	Type	Default	Description
useCollections	boolean	false	Enable collections in the vault
collectionCount	number	5	Number of flat collections (max 100)
distributeItems	boolean	true	Distribute items across collections
useNestedCollections	boolean	false	Enable hierarchical nested collections
topLevelCollectionCount	number	5	Number of top-level collections when nested
collectionNestingDepth	number	3	Maximum nesting depth (max 10)
totalCollectionCount	number	15	Total number of collections when nested (max 100)

Format Capabilities

Format	Output	Vault Types	Item Types	Features
bitwarden	JSON	individual, org	login, secureNote, creditCard, identity	Folders, collections, nested collections
lastpass	CSV	individual	login	-
keeper	CSV	individual	login	Folders
edge	CSV	individual	login	-
keepassx	CSV	individual	login	-
keepass2	XML	individual	login	Predefined groups
password-depot	CSV	individual	login	-

Rate Limits & Constraints

Rate Limits

Endpoint	Limit
POST /api/vault/generate	10 requests per minute
All other endpoints (GET)	60 requests per minute

Rate limit headers are included in all responses:

X-RateLimit-Limit – maximum requests allowed
X-RateLimit-Remaining – requests remaining in window
X-RateLimit-Reset – window reset time (Unix seconds)

Item Constraints

Maximum 10,000 items per type
Maximum 15,000 total items across all types
At least 1 item must be generated

Collection Constraints

Maximum 100 collections
Maximum nesting depth of 10

Request Constraints

Maximum request body size: 1 MB

Supported Languages

The language parameter controls the locale used for generating names, addresses, and other fake data.

Code	Language
en	English
es	Spanish
de	German
fr	French
it	Italian
pt	Portuguese
ru	Russian
ja	Japanese
zh	Chinese

Examples

Basic Bitwarden vault

curl -X POST /api/vault/generate \
  -H "Content-Type: application/json" \
  -d '{
    "format": "bitwarden",
    "loginCount": 100,
    "secureNoteCount": 10,
    "creditCardCount": 5,
    "identityCount": 5
  }'

LastPass CSV export

curl -X POST /api/vault/generate \
  -H "Content-Type: application/json" \
  -d '{
    "format": "lastpass",
    "loginCount": 200,
    "useRealUrls": true
  }' -o lastpass_export.csv

Bitwarden org vault with nested collections

curl -X POST /api/vault/generate \
  -H "Content-Type: application/json" \
  -d '{
    "format": "bitwarden",
    "vaultType": "org",
    "loginCount": 500,
    "secureNoteCount": 50,
    "useCollections": true,
    "useNestedCollections": true,
    "topLevelCollectionCount": 5,
    "collectionNestingDepth": 3,
    "totalCollectionCount": 30,
    "distributeItems": true,
    "useWeakPasswords": true,
    "weakPasswordPercentage": 15,
    "reusePasswords": true,
    "passwordReusePercentage": 25,
    "language": "de"
  }'

Error Handling

Errors are returned as JSON with an error field:

{
  "error": "Description of what went wrong"
}

HTTP Status Codes

Status	Meaning
200	Success – vault data returned
400	Validation error – invalid parameters, unsupported format, or constraint violation
429	Rate limit exceeded – wait and retry
500	Internal server error – unexpected failure during generation