Skip to main content
All v2 endpoints return a consistent JSON envelope. This makes parsing predictable — every response has the same top-level structure regardless of success or failure.

​
Envelope Fields

FieldTypeDescription
timestampstringISO 8601 timestamp of response generation
successbooleantrue if the request succeeded, false on error
messagestringHuman-readable status message
errorCodestringMachine-readable error code — empty string "" on success
typestringData type name of the object in data — empty string "" on error
dataobject | nullThe response payload — null on error

​
Success Response

{
  "timestamp": "2026-03-24T12:00:00.000Z",
  "success": true,
  "message": "Chart generated",
  "errorCode": "",
  "type": "ChartSimpleResult",
  "data": {
    "type": "Generator",
    "profile": "6/2",
    "gates": ["20", "34", "10", "57"],
    "channelsShort": ["20-34", "10-57"],
    "centers": ["G", "Sacral", "Spleen", "Throat"]
  }
}

​
Error Response

{
  "timestamp": "2026-03-24T12:00:01.000Z",
  "success": false,
  "message": "Birthdate must be in YYYY-MM-DD format",
  "errorCode": "INVALID_BIRTHDATE",
  "type": "",
  "data": null
}

​
Data Types

The type field tells you what shape the data object has:
Type ValueReturned ByDescription
ChartResult/v2/charts, /v2/charts/coordinatesFull chart with all properties (type, profile, channels, centers, strategy, authority, incarnation cross, activations, and more)
ChartSimpleResult/v2/charts/simpleSimplified chart (type, profile, gates, channels, centers)

​
Parsing Guidelines

  1. Check success first — determines whether data is populated or null
  2. Use errorCode for logic — never parse message for error handling. Messages are human-readable and may change without notice.
  3. data is always a single object — v2 chart endpoints return one chart per request, never an array

​
v1 Response Format

v1 endpoints return the chart data directly as a flat JSON object — no envelope. Field names use snake_case (e.g., channels_short, incarnation_cross). See the migration guide for differences.