Documentation

Reference docs designed to work with the playground.

Browse every Fake API for Devs domain, inspect real routes, copy language-specific examples, and deep-link teammates into the same selected endpoint.

Quick start

Use the shared base URL

Every route hangs off the canonical Fake API for Devs host, so examples stay copy-pasteable across docs and the playground.

https://fakeapifordevs.vercel.app

Quick start

Skip auth during prototyping

Routes are public by design, so frontend teams can focus on flows and state instead of access tokens.

No authentication required

Quick start

Test realistic behavior

Dial in pagination and synthetic latency to verify skeleton states, empty states, and longer lists.

page / per_page / delay

Sandbox

Enable your personal sandbox

Generate a free session key and include it as a header. Your POST, PATCH, and DELETE calls persist for 12 hours in an isolated namespace.

X-Demo-Key: dk_your_key_here
Generate a key

Docs powered by caffeine

Back the reference work with a coffee

If these docs helped your team move faster, help us keep code samples, route coverage, and deep links accurate.

  • Funds docs QA
  • Keeps examples current

All domains

Choose the API surface that matches your product.

Each card is generated from the same domain source of truth that powers the playground and route validation.

/api/auth

Authentication

User management, login, refresh, logout, profile, and batch auth flows

POST/api/auth/register
POST/api/auth/login
POST/api/auth/refresh
/api/ecommerce

E-commerce

Products, orders, cart, customers, and richer catalog payloads

GET/api/ecommerce/products
GET/api/ecommerce/products?category=Electronics
GET/api/ecommerce/products?minPrice=50&maxPrice=150
/api/realestate

Real Estate

Property listings, agents, photos, and city market data

GET/api/realestate/listings
GET/api/realestate/listings?type=sale&city=austin
GET/api/realestate/listings?beds_min=3&price_max=650000
/api/social

Social Media

Posts, profiles, feeds, comments, trending hashtags, and social inboxes

GET/api/social/posts
GET/api/social/posts?userId=usr_123456
GET/api/social/posts?limit=10
/api/food

Food Delivery

Restaurants, menus, cuisine categories, and delivery tracking

GET/api/food/restaurants
GET/api/food/restaurants?q=burger&open_now=true
GET/api/food/restaurants/rest_001
/api/saas

SaaS

Subscriptions, billing, workspaces, and usage tracking endpoints

GET/api/saas/subscriptions
GET/api/saas/subscriptions?page=2
GET/api/saas/subscriptions?per_page=2
/api/logistics

Logistics

Shipments, tracking, carrier rates, and delivery flows

GET/api/logistics/shipments
GET/api/logistics/shipments?id=TRK-2025-001234
GET/api/logistics/shipments?page=2
/api/payments

Payments

Charges, refunds, subscriptions, invoices, payment methods, and webhook-ready billing flows

GET/api/payments/stripe?customer_id=cus_123
GET/api/payments/stripe?customer_id=cus_enterprise&per_page=5
POST/api/payments/stripe
/api/weather

Weather

Weather data, forecasts, and location-based endpoints

GET/api/weather/current
GET/api/weather/current?city=seattle
GET/api/weather/forecast?city=san-francisco
/api/analytics

Analytics

Events, metrics, timeseries, funnels, cohorts, and realtime analytics streams

GET/api/analytics/events?user_id=user_123
POST/api/analytics/events
GET/api/analytics/metrics?range=7d
/api/notifications

Notifications

Inbox, templates, sends, preferences, and bulk notification workflows

GET/api/notifications?user_id=user_123
GET/api/notifications?user_id=user_123&unread_only=true
POST/api/notifications
/api/search

Search

Full-text search and indexing across multiple resources

GET/api/search
GET/api/search?q=mock+api
GET/api/search?q=john&domains=auth,crm,hrm
/api/dms

Document Management

Documents, folders, and content workflow endpoints

GET/api/dms/documents
GET/api/dms/documents?limit=20
POST/api/dms/documents
/api/hospital

Hospital Management

Patient records, appointments, doctors, and department workflows

GET/api/hospital/patients
GET/api/hospital/patients?limit=25
POST/api/hospital/patients
/api/hrm

Human Resources

Employee records, payroll, attendance, reviews, and leave workflows

GET/api/hrm/employees
GET/api/hrm/employees?limit=25
POST/api/hrm/employees
/api/news

News & Publishing

Articles, categories, authors, and editorial workflows

GET/api/news/articles
GET/api/news/articles?category=Technology
GET/api/news/articles?limit=5
/api/llm

LLM & AI

OpenAI-style and Anthropic-style mock endpoints for AI integrations

POST/api/llm/openai/v1/chat/completions
POST/api/llm/openai/v1/embeddings
GET/api/llm/openai/v1/models
/api/crm

CRM & Sales

Contacts, deals, activities, pipeline, and company account flows

GET/api/crm/contacts
GET/api/crm/contacts/contact_001
POST/api/crm/contacts
/api/gaming

Gaming

Leaderboards, players, matches, achievements, and inventories

GET/api/gaming/leaderboard?game_id=arena_quest&period=weekly
GET/api/gaming/players
GET/api/gaming/players/player_001
/api/crypto

Crypto & DeFi

Token prices, wallets, markets, transactions, and portfolio snapshots

GET/api/crypto/prices
GET/api/crypto/prices/ETH
GET/api/crypto/wallet/0x1234abcd5678ef90
/api/travel

Travel

Flights, hotels, airports, and booking confirmation flows

GET/api/travel/flights/search?origin=JFK&destination=LAX
GET/api/travel/flights/flt_001
GET/api/travel/hotels/search?city=New+York
/api/education

Education & LMS

Courses, lessons, students, enrollments, assignments, grades, and certificates

GET/api/education/courses
GET/api/education/courses/course_001
GET/api/education/courses/course_001/lessons
/api/iot

IoT & Sensors

Devices, alerts, readings, commands, and live telemetry streams

GET/api/iot/devices
GET/api/iot/devices/dev_001
GET/api/iot/devices/dev_001/readings
/api/fitness

Fitness

Activities, stats, goals, nutrition logs, and exercise libraries

GET/api/fitness/users/user_fit_001/activities
POST/api/fitness/activities
GET/api/fitness/activities/activity_001
/api/events

Event Management

Event listings, registrations, attendees, and category discovery

GET/api/events
GET/api/events/evt_001
POST/api/events/evt_001/register
/api/stream

Streaming SSE

Chat, event, notification, and sensor streams for real-time UI testing

GET/api/stream/chat
GET/api/stream/events
GET/api/stream/notifications
/api/maps

Maps & Geocoding

Geocoding, reverse lookup, places, directions, and autocomplete

GET/api/maps/geocode?address=742+Evergreen+Terrace+Springfield+IL
GET/api/maps/reverse?lat=39.7817&lng=-89.6501
GET/api/maps/places/search?q=coffee+shops&lat=40.7128&lng=-74.006
/api/github

GitHub Mimic

Users, repos, commits, issues, pulls, link pagination, and rate-limit headers

GET/api/github/users/mockdev
GET/api/github/users/mockdev/repos
GET/api/github/repos/mockdev/fake-api-for-devs
/api/oauth

OAuth & OIDC

Authorize, token, userinfo, discovery, and JWKS endpoints for auth flows

GET/api/oauth/authorize?client_id=demo-app&redirect_uri=https://example.com/callback&response_type=code&scope=openid+profile+email
POST/api/oauth/token
GET/api/oauth/userinfo
/api/twilio

Twilio SMS

Send SMS, fetch message history, and inspect single-message payloads

GET/api/twilio/2010-04-01/Accounts/ACmock/Messages.json
POST/api/twilio/2010-04-01/Accounts/ACmock/Messages.json
GET/api/twilio/2010-04-01/Accounts/ACmock/Messages/SMmock0000000000000000000000000001.json
/api/slack

Slack API

Chat posting, channel listing, user listing, and auth-test envelopes

GET/api/slack/api/auth.test
GET/api/slack/api/conversations.list
GET/api/slack/api/users.list
/api/sendgrid

SendGrid Email

Email send, delivery stats, and bounce suppression lists

POST/api/sendgrid/v3/mail/send
GET/api/sendgrid/v3/stats
GET/api/sendgrid/v3/suppression/bounces
/api/webhooks

Webhooks

Webhook registration, listing, and test-event dispatch simulation

POST/api/webhooks/register
GET/api/webhooks/registrations
POST/api/webhooks/test/payment_intent.succeeded

Working principles

A calmer docs experience for technical work.

Check status codes deliberately

Treat the APIs like production services and handle error states cleanly instead of assuming a happy-path 200 every time.

Keep examples executable

Use the generated snippets as your source of truth so routes, headers, and payload shapes stay synchronized.

Deep-link the exact route

Share docs and playground links that already contain the selected method and path when you need aligned debugging.

Sponsor new endpoints

Help fund the next batch of routes

We reinvest support directly into deeper domain coverage, more examples, and clearer docs for the routes teams actually use.

  • More sample payloads
  • Better niche-domain coverage