DOCUMENTATION
Overview
SimData is a hosted synthetic records sampler. Seeded, constrained, and dictionary-backed for engineering, QA, and load tests.
Core principles
SimData is built around ancestral sampling. Rather than generating unrelated records in isolation, fields are drawn from distributions and sequences defined in your workspace dictionary:
- Deterministic joins: With the same seed,
person_idmatches across related tables. - High throughput: Avro OCF streaming allows generating millions of coherent rows directly into data pipelines without memory exhaustion.
- Zero real PII: Every record is purely synthetic. Do not submit real customer or confidential personal data.
Data flow
The standard development loop is:
- Sign in and review your dictionary under Dictionary.
- Create an API key in API Keys.
- Call
GET /v1/random/person?seed=42&count=100with your Bearer token. - Use the sampled JSON or Avro files in your automated test fixtures or data warehouses.
Endpoints summary
| Method & Path | Description | Auth |
|---|---|---|
| GET /v1/random/{record} | Sample coherent synthetic records (JSON or Avro) | Bearer API key |
| GET /v1/catalog | List all sets, records, distributions, and sequences | Bearer token |
| GET /v1/stats/records | Platform-wide public generation counter | Public |