Overview
Random User Generator works by generating random user data based on predefined rules and providing it in a structured format. The algorithm ensures that the generated data is realistic and diverse.
Endpoint
One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.
curl "https://api.apiverve.com/v1/randomusergenerator?count=1&includeAvatar=true" \
-H "x-api-key: your_api_key_here"const res = await fetch('https://api.apiverve.com/v1/randomusergenerator?count=1&includeAvatar=true', {
headers: { 'x-api-key': 'your_api_key_here' },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.get(
"https://api.apiverve.com/v1/randomusergenerator?count=1&includeAvatar=true",
headers={"x-api-key": "your_api_key_here"},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/randomusergenerator?count=1&includeAvatar=true", nil)
req.Header.Set("x-api-key", "your_api_key_here")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.
Authentication
Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent in the query string. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
countOptionalPremium | integer | The number of users to generate default 1 · range 1–100 |
includeAvatarOptionalPremium | boolean | Include an AI-generated face avatar matching user's gender and age |
Response
Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.
{
"status": "ok",
"error": null,
"data": [
{
"id": "967e4d46-963e-4108-a0c5-ded8f630dcc8",
"name": "Jennifer Hoppe V",
"gender": "Male",
"username": "Olen_Kihn88",
"email": "Juwan5@gmail.com",
"password": "f0VIWRnbXFvW9Tf",
"registered": "2025-06-29T22:00:36.084Z",
"phone": "1-716-677-4155",
"cell": "1-353-721-7455 x2081",
"birthdate": "1972-01-24T19:55:15.208Z",
"avatar": "https://storage.googleapis.com/apiverve/APIResources/faces/Male/40-50/87654321.jpg?X-Goog-Signature=..."
}
]
}Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
0 | array[1] | ||
id | string | "967e4d46-963e-4108-a0c5-ded8f630dcc8" | Unique identifier for the generated user |
name | string | "Jennifer Hoppe V" | Full name of the randomly generated user |
gender | string | "Male" | Gender designation for the random user |
username | string | "Olen_Kihn88" | Randomly generated username for the user |
email | string | "Juwan5@gmail.com" | Randomly generated email address for user |
passwordPremium | string | "f0VIWRnbXFvW9Tf" | Randomly generated password for the user |
registered | string | "2025-06-29T22:00:36.084Z" | ISO 8601 date when user registered account |
phone | string | "1-716-677-4155" | Randomly generated phone number for user |
cell | string | "1-353-721-7455 x2081" | Randomly generated cell phone number for user |
birthdate | string | "1972-01-24T19:55:15.208Z" | ISO 8601 date representing user's birth date |
avatarPremium | string | "https://storage.googleapis.com/apiverve/APIResources/faces/Male/40-50/87654321.jpg?X-Goog-Signature=..." | URL to AI-generated face avatar matching gender and age |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Use cases
- Testing Environments
- Use the Random User Generator API to generate random user data for testing environments. Use the data to create test accounts and simulate user interactions
- Mockup Designs
- Create mockup designs by using the Random User Generator API to generate random user data. Use the data to populate user profiles and showcase design concepts
- Load Testing
- Perform load testing by using the Random User Generator API to generate random user data. Use the data to simulate user traffic and analyze system performance
- Example Data
- Generate example data by using the Random User Generator API to generate random user data. Use the data to provide sample information for tutorials, demos, and presentations
Other ways to use Random User Generator
Set up Random User Generator on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.
Related
More in Data Generation: