`rig.finance.position`

v1.0.0 · stable maturity: draft 4 fields 4 required

Fields

Field	Type		Meaning
`holder`	entity	required	Person or organisation that holds it
`isin`	string	required	12-character ISIN, no spaces
`quantity`	float	required	Signed count of the instrument
`side`	enumlong · short	required	`long` / `short`

A holding of an instrument. Format when present.

Field meanings follow ISO 6166 ISIN and ISO 20022 SecuritiesBalance. This schema is those position elements - not a trade ticket, and not a live mark-to-market.

holder, isin, quantity, and side are required. isin is uppercase. Do not invent a ticker field from the ISIN.

Authored book value is rig.commerce.price on this entity. A live mark is host cache. A second instrument is another entity.

JSON Schema

Resolves at https://rig.works/schemas/rig.finance.position.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.finance.position.schema.json",
  "title": "rig.finance.position",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "holder": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "isin": {
      "type": "string",
      "pattern": "^[A-Z]{2}[A-Z0-9]{9}[0-9]$",
      "description": "ISO 6166 ISIN, 12 characters, uppercase."
    },
    "quantity": {
      "$ref": "./_defs.schema.json#/$defs/float"
    },
    "side": {
      "type": "string",
      "enum": [
        "long",
        "short"
      ]
    }
  },
  "required": [
    "holder",
    "isin",
    "quantity",
    "side"
  ],
  "description": "A holding of an instrument. Book value composes rig.commerce.price. A live mark is host cache.",
  "x-rig-maturity": "draft"
}

Seen in

record-bank.json