Overall Structure

This document describes the FinSpec v5.2 JSON format for authors writing or consuming FinSpec specification files. It assumes familiarity with the FIX Protocol; the focus is on how to express FIX specifications in the FinSpec schema rather than on FIX concepts themselves.

A FinSpec document is a single JSON object validated against a JSON Schema (draft-07). The schema is strict: every object in the document sets additionalProperties: false, so a document may only use the keys described in this reference (plus vendor extensions). Any property tooling encounters that isn’t documented here is not part of the format.

The following top-level keys are required: finspec, metadata, info, protocol. All other top-level keys are optional. A minimal valid document looks like:

json
{
    "finspec": "5.2",
    "metadata": {
        "issuer": "Acme Exchange"
    },
    "info": {
        "title": "Acme FIX Specification",
        "version": "1.0.0"
    },
    "protocol": {
        "name": "FIX",
        "version": "4.4"
    }
}

The full shape of the top-level document — every key, its type, and whether it’s required — is below.

Vendor Extensions

Any property at any level whose key begins with x- is a vendor extension. Extensions are permitted wherever you see the green “vendor extensions” marker (see below), and may contain arbitrary data.

Figure: Vendor extension marker
Figure: Vendor extension marker

Vendor extensions should be ignored by any application that isn’t configured to use them.

json
"metadata": {
  "issuer": "Acme Exchange",
  "x-internal-id": "AE-FIX44-PROD",
  "x-owner-team": "connectivity-engineering"
}