Wingfield Logo
Wingfield Partner API

Overview

Welcome to the Wingfield Partner API docs.

API conventions

Forward compatibility

We may add new fields to any response at any time. Your client must ignore fields it does not know. We never remove or rename documented fields without notice.

Absent fields vs. null values

Stat-carrying responses (for example session details) come in sport-specific shapes:

  • A field that is absent from a shape does not apply to that sport. For example, pickleball has no second serve, so pickleball sessions carry no numSecondServes field.
  • A field that is present with value null applies to the sport, but was not measured for that particular session (for example, older recordings).

A documented field of a shape is always present in the response — it is never omitted just because its value is unknown.

On this page