FakerAPI · Schema

Response Envelope

Shared response envelope returned by every FakerAPI endpoint.

Test DataFake DataMockingDeveloper ToolsOpen-SourcePublic APIs

Properties

Name Type Description
status string Always 'OK' on success.
code integer HTTP-style status code.
locale string Locale used to generate the payload.
seed stringintegernull Seed echoed from the request, or null.
total integer Number of records returned in data.
data array Generated resource collection.
View JSON Schema on GitHub

JSON Schema

fakerapi-envelope-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://fakerapi.it/schemas/envelope.json",
  "title": "Response Envelope",
  "description": "Shared response envelope returned by every FakerAPI endpoint.",
  "type": "object",
  "properties": {
    "status": { "type": "string", "description": "Always 'OK' on success.", "example": "OK" },
    "code": { "type": "integer", "description": "HTTP-style status code.", "example": 200 },
    "locale": { "type": "string", "description": "Locale used to generate the payload.", "example": "en_US" },
    "seed": { "type": ["string", "integer", "null"], "description": "Seed echoed from the request, or null.", "example": "42" },
    "total": { "type": "integer", "description": "Number of records returned in data.", "example": 10 },
    "data": { "type": "array", "description": "Generated resource collection." }
  },
  "required": ["status", "code", "locale", "total", "data"]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema 
curl "https://apis.io/api/v1/json-schemas/fakerapi-envelope"
All schemas 
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.