ForgeAPI Documentation
ForgeAPI allows you to create and serve fake APIs for development, testing, and prototyping.
Generate realistic data instantly with customizable schemas.
Authentication
All API requests require authentication using an API key. You can find your API key in the API Keys section of your dashboard.
API Key Usage
Include your API key as a path parameter in all requests. Never expose your API key in client-side code.
Request Format
GET /api/dynamicApi/serveFakeApi/{API_KEY}/{ENDPOINT}/{COUNT}Parameters
| Parameter | Type | Description |
|---|---|---|
| API_KEY | string | Your unique API key |
| ENDPOINT | string | The schema endpoint name |
| COUNT | integer | Number of records to return (1-100) |
Example Request
GET https://fogeapi-backend.onrender.com/api/dynamicApi/serveFakeApi/{YOUR_TOKEN_HERE}/users/{count}Creating Schemas
Schemas define the structure of your API responses. Use the Schema Builder to create custom endpoints with specific data types and field configurations.
Schema Components
Endpoint Name
Define the URL path for your API endpoint (e.g., "users", "products", "orders")
Response Fields
Add fields with specific data types to customize the structure of returned data
Schema Limitations
Each schema can contain up to 50 fields. Field names must be alphanumeric and cannot contain spaces.
Quick Start Guide
Get started with ForgeAPI in under 5 minutes. Follow these simple steps to create your first API endpoint.
Get API Key
Sign up and get your API key from the dashboard
Create Schema
Define your data structure using our visual builder
Make Requests
Start fetching data from your new API endpoint
Rate Limiting
ForgeAPI implements rate limiting to ensure fair usage and optimal performance for all users.
| Plan | Requests/Month | Rate Limit |
|---|---|---|
| Free | 1,000 | 10/minute |
| Pro ($9/month) | 100,000 | 1000/minute |
Available Data Types
Identifiers
uuid
Universally unique identifier
id
Sequential numeric identifier
Contact
Valid email address
username
Unique username string
phone
Phone number
Personal
name
Full name
firstName
First name only
lastName
Last name only
Numeric
number
Integer number
float
Decimal number
price
Currency amount
Product
productName
Product name
productDescription
Product description
category
Product category
Media
image
Image URL
avatar
Avatar image URL
Location
address
Street address
city
City name
country
Country name
zip
Postal code
Logic
boolean
True/false value
Time
date
Date string
timestamp
Unix timestamp
Text
paragraph
Lorem ipsum paragraph
sentence
Single sentence
slug
URL-friendly string
Web
url
Valid URL
ip
IP address
mac
MAC address
color
Hex color code
Error Handling
ForgeAPI uses standard HTTP status codes to indicate the success or failure of API requests.
Request successful, data returned
Invalid or missing API key
Rate limit exceeded
Server error occurred
Example Response
Here's an example of what a response looks like for a "users" schema with common fields:
Sample Response
[
{
"id": "e3f42f5a-3c2f-4b91-bc9a-4f21caa33c9d",
"email": "john.doe@example.com",
"username": "johndoe_user",
"firstName": "John",
"lastName": "Doe",
"phone": "+1-555-0123",
"avatar": "https://api.dicebear.com/7.x/avataaars/svg?seed=John",
"address": "123 Main St, Suite 100",
"city": "New York",
"country": "United States",
"zip": "10001"
},
{
"id": "f8d21c7b-9e4f-4a82-bd6c-8f31dbb44e8f",
"email": "jane.smith@example.com",
"username": "janesmith_pro",
"firstName": "Jane",
"lastName": "Smith",
"phone": "+1-555-0456",
"avatar": "https://api.dicebear.com/7.x/avataaars/svg?seed=Jane",
"address": "456 Oak Ave, Floor 2",
"city": "Los Angeles",
"country": "United States",
"zip": "90210"
}
]Pro Tip
Use tools like Postman, Insomnia, or curl to test your APIs. Data is generated in real-time based on your schema configuration.
cURL Examples
Here are some practical examples using cURL to interact with ForgeAPI endpoints.
Basic Request
curl -X GET \ "https://fogeapi-backend.onrender.com/api/dynamicApi/serveFakeApi/YOUR_API_KEY/users/5" \ -H "Accept: application/json"
With Headers
curl -X GET \ "https://fogeapi-backend.onrender.com/api/dynamicApi/serveFakeApi/YOUR_API_KEY/products/10" \ -H "Accept: application/json" \ -H "User-Agent: MyApp/1.0"