Scribd
Upload
23 views2 pages

API Documentation

The API generates random data based on user-defined fields and volume through a POST request. Users can specify various data types such as name, email, and address, and the API will return the requested number of records. Error handling is included for invalid requests, and a list of available fields is provided.

Uploaded by

unknown.personalfiles
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
23 views2 pages

API Documentation

The API generates random data based on user-defined fields and volume through a POST request. Users can specify various data types such as name, email, and address, and the API will return the requested number of records. Error handling is included for invalid requests, and a list of available fields is provided.

Uploaded by

unknown.personalfiles
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

API Overview

This API generates random data based on the fields requested in the API request.

How It Works

●​ The frontend sends a POST request to


[Link] (Note:
Please don’t share this api with anyone at any cost… )with two things:
1.​ Fields – A list of data types they want (e.g., name, email, city, etc.).
2.​ Volume – The number of records they need.

Example Request

If the frontend sends this request:

{
"fields": ["street", "ip", "sentence", "uuid", "date"],
"volume": 15
}

It means they want 15 records, each containing:

●​ A random street address


●​ A random IP address
●​ A random sentence
●​ A unique UUID
●​ A random date

Example Response

The API will return something like this:

{
"street": "123 Main St",
"ip": "[Link]",
"sentence": "ZENDCODERS",
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"date": "2023-01-15T[Link].000Z"
}
}

Error Response:
Status Code: `400 Bad Request`

Response Body:
{
"error": "Invalid request payload. Fields must be an array, and volume must be a positive
integer."
}

The following fields can be requested:

|​ Field Name ​ ​ |​ ​ Description ​ ​ |


|--------------------------------------|-------------------------------------------------|
| `name`​ ​ ​ | Full name ​ ​ ​ ​ |
| `firstName` ​ ​ ​ | First name ​ ​ ​ ​ |
| `lastName` ​ ​ ​ | Last name ​ ​ ​ ​ |
| `gender` ​ ​ ​ | Gender (Male/Female) ​ ​ |
| `jobTitle` ​ ​ ​ | Job title ​ ​ ​ ​ |
| `username` ​ ​ ​ | Internet username ​ ​ ​ |
| `password` ​ ​ ​ | Random password ​ ​ ​ |
| `email` ​ ​ ​ | Email address ​ ​ ​ |
| `phone` ​ ​ ​ | Phone number ​ ​ ​ |
| `address` ​ ​ ​ | Full street address ​ ​ ​ |
| `street` ​ ​ ​ | Street name ​​ ​ ​ |
| `city` ​​ ​ ​ | City name ​ ​ ​ ​ |
| `state` ​ ​ ​ | State name ​ ​ ​ ​ |
| `country` ​ ​ ​ | Country name ​ ​ ​ |
| `zipcode` ​ ​ ​ | Zip code ​ ​ ​ ​ |
| `companyName` ​ ​ | Company name​ ​ ​ |
| `companyCatchPhrase` ​ | Company tagline ​ ​ ​ |
| `iban` ​ ​ ​ | International bank account number |
| `creditCardNumber` ​​ | Random credit card number ​ |
| `url` ​ ​ ​ ​ | Random URL ​ ​ ​ |
| `ip` ​ ​ ​ ​ | Random IP address ​​ ​ |
| `domain` ​ ​ ​ | Random domain name ​ ​ |
| `uuid` ​ ​ ​ | Unique identifier (UUID) ​ ​ |
| `date` ​ ​ ​ | Random past date (ISO format) ​ |
| `sentence` ​ ​ ​ | Random sentence ​ ​ ​ |
| `paragraph` ​ ​ ​ | Random paragraph ​ ​ ​ |

You might also like