Board

Type: object

Collection of information about a bridge board including the auction, play and details about the context it was played in

No Additional Properties

Type: object

The hands of the four players

Type: array

The cards held by the north player

Each item of this array must be:

Type: object

A playing card

Type: enum (of string)

The suit of the card

Must be one of:

  • "spades"
  • "hearts"
  • "diamonds"
  • "clubs"
  • "nt"

Type: enum (of string)

The rank of the card

Must be one of:

  • "2"
  • "3"
  • "4"
  • "5"
  • "6"
  • "7"
  • "8"
  • "9"
  • "T"
  • "J"
  • "Q"
  • "K"
  • "A"

Type: array

The cards held by the south player

Each item of this array must be:

Type: object

A playing card

Same definition as Card

Type: array

The cards held by the east player

Each item of this array must be:

Type: object

A playing card

Same definition as Card

Type: array

The cards held by the west player

Each item of this array must be:

Type: object

A playing card

Same definition as Card

Type: enum (of string) Default: "north"

The first player to play to the current trick

Must be one of:

  • "north"
  • "east"
  • "south"
  • "west"

Type: enum (of string) Default: "nt"

The trump suit the deal is being played in

Same definition as suit

Type: array Default: []

The cards played to the current trick

Must contain a maximum of 3 items

Each item of this array must be:

Type: object

A playing card

Same definition as Card

Type: array

The sequence of bids made at the auction in the order they were made

Each item of this array must be:


Type: object

A bid of a suit or notrumps bid at a given level, e.g. 3NT

Type: integer

Level of the named bid

Value must be greater or equal to 1 and lesser or equal to 7

Type: enum (of string)

Strain of the named bid

Same definition as suit

Type: boolean Default: false

Denotes whether the bid is alertable

Type: string Default: ""

The spoken announcement made to describe the bid

Type: object

A bid of a pass, double or redouble

Type: enum (of string)

Penalty of the named bid

Must be one of:

  • "pass"
  • "double"
  • "redouble"

Type: boolean Default: false

Denotes whether the bid is alertable

Type: string Default: ""

The spoken announcement made to describe the bid

Type: array

The sequence of cards played a the table in the order they were played

Each item of this array must be:

Type: object

A playing card

Same definition as Card

Type: integer

The board number, used to define dealer and vulnerability if not otherwise specified

Value must be greater or equal to 1

Type: enum (of string)

The vulnerability of the board

Must be one of:

  • "none"
  • "both"
  • "ns"
  • "ew"

Type: enum (of string)

The dealer of the board

Same definition as first

Type: object

The contract the board was played in

Type: integer

The level of the contract

Value must be greater or equal to 1 and lesser or equal to 7

Type: enum (of string)

The strain of the contract

Same definition as suit

Type: enum (of string)

The declarer of the contract

Same definition as first

Type: enum (of string) Default: "pass"

The penalty of the contract

Same definition as penalty

Type: integer Default: 0

The number of tricks made by declarer in relation to the level of the contract

Value must be greater or equal to -13 and lesser or equal to 6

Type: boolean

Whether the play ended due to a claim

Type: object

Additional meta-information about the board in the form of arbitrary key-value pairs

All property whose name matches the following regular expression must respect the following conditions

Property name regular expression: Table$
Type: object

Type: array

Each item of this array must be:


Type: string

The column name

Type: object

Type: string

The column name

Type: enum (of string)

Whether the table is ordered by this column in ascending (+) or descending (-) value

Must be one of:

  • "+"
  • "-"

Type: integer

The minimum width that values in this column should be padded to

Value must be greater or equal to 1

Type: enum (of string)

Whether the column should be left (L) or right (R) aligned. Ignored unless minwidth is defined

Must be one of:

  • "L"
  • "R"

Type: array of string

The rows of the table

Each item of this array must be:

Type: string

Each additional property must conform to the following schema

Type: string