Help center › Data Feed Reference › Reference data

Blackout windows · blackout 1.1

Blackout windows. Trading blackout windows by symbol or issuer (e.g. around earnings or while the firm holds inside information). Every active blackout rule checks them. Key: ref.

Namespace: urn:vestoris:feed:blackout:1.1
Schema: blackout-1.1.xsd
Also accepted: urn:vestoris:feed:blackout:1.0 (blackout-1.0.xsd)
Key (upsert): ref: a record with an existing key updates it; a new key inserts.
Start-of-day step: Calendars
File name: F00012_BLACKOUT_20261023_001.xml
Modes: delta (action="delete" removes a record); full (records not listed are inactivated, up to the feed's safety threshold: H201)

The <feed> root #

Attribute	Use	Type	Meaning
`businessDate`	required	`xs:date`	The business date the data is for (YYYY-MM-DD).
`firm`	required	`xs:string`	Your firm code, shown on Data › Feeds (e.g. F00012).
`source`	optional	`xs:string`	Who produced the file (vendor or system name).
`generated`	required	`xs:dateTime`	When the file was produced (UTC).
`recordCount`	required	`xs:nonNegativeInteger`	The number of record elements. A file whose count does not match is refused (F004): it was probably cut short.
`mode`	optional (default delta)	`xs:string`	delta: only the records in the file change, and action="delete" removes one. full: the file is complete; records it does not list are inactivated, up to the feed's safety threshold.

The <record> elements #

upsert (insert or update by key) or delete (removes the record; a security or account is inactivated, never deleted). Elements may appear in any order; an element that is left out keeps its current value.

Element	Required	Type	Meaning	Codes
`ref` key #	yes	`xs:string` pattern [A-Z0-9][A-Z0-9_.\-]{0,39}	Your reference for the window. The key. A code: letters, digits, "_", "." or "-", up to 40. Part of the key. Example: `BO-2026-014`	`R101` `R111`
`symbol` #	no	`xs:string` pattern [A-Z][A-Z0-9.\-]{0,11}	The security (give a symbol or an issuer). A ticker symbol: letters, digits, "." or "-", up to 12. Example: `AAPL`	`R111`
`issuer` #	no	`xs:string` ≤ 120 chars	The issuer, covering all its share classes (give a symbol or an issuer). Text, up to 120 characters.	`R114`
`dateFrom` #	yes	`xs:date`	First day of the window. An ISO date, YYYY-MM-DD. Example: `2026-10-27`	`R101` `R102`
`dateTo` #	yes	`xs:date`	Last day of the window. An ISO date, YYYY-MM-DD. Example: `2026-10-31`	`R101` `R102`
`reason` #	no	`xs:string` ≤ 200 chars	Why. Text, up to 200 characters. Example: `Earnings`	`R114`

Validation #

No DOCTYPE or entity declaration (F002); well-formed UTF-8 (F001).
The namespace and version are published (F007), and the file matches the XSD (F003).
Header: firm is your firm code (F006), businessDate a business day (F005), recordCount the number of records (F004).
Each record: the field checks in the table above, references to records that exist (R109), no key twice in a file (R110). A rejected record does not stop the rest of the file.

Codes this format can return: F001 F002 F003 F004 F005 F006 F007 F008 H201 R101 R102 R109 R110 R111 R114

Sample #

An annotated file: the comment lines explain the header; drop them or keep them, comments are allowed.

<?xml version="1.0" encoding="UTF-8"?>
<!-- businessDate: the date the data is for. firm: your firm code. recordCount: how many <record> elements follow. -->
<feed xmlns="urn:vestoris:feed:blackout:1.1" businessDate="2026-10-23" firm="F00012" source="ExampleVendor" generated="2026-10-23T22:05:00Z" recordCount="1" mode="delta">
  <record action="upsert">
    <ref>BO-2026-014</ref>
    <symbol>AAPL</symbol>
    <dateFrom>2026-10-27</dateFrom>
    <dateTo>2026-10-31</dateTo>
    <reason>Earnings</reason>
  </record>
</feed>

Download the sample Download the XSD Validate a file

Version history #

1.0 (2026-10-26): First published version.
1.1 (2026-10-26): Adds the optional <udfs> element (up to ten <udf slot="1..10" name="...">value</udf>) to the reference formats that carry user-defined fields: security, issuer, account, accountgroup, broker, model, benchmark and list. Additive: every valid 1.0 file is still accepted under its 1.0 namespace.