Skip to main content

Expiry Calendar Service

Contains all the public and private expiry calendars

Expiry Calendar REST API

The Expiry Calendar REST API is a full CRUD API allowing you to search and filter expiry calendars as well as update, version and delete them. It is accessed through the following URL:

The API consists of the following calls:

GETGet the build information for this service
GET{release}/{source}'v1/public' 'v1/private'List public or private expiry calendars
GET{release}/{source}/{key}v1/private/TESTRetrieve a single expiry calendar using it’s unique id
GET{release}/{source}/{key}/{version}v1/private/TEST/1Retrieve a version of a single expiry calendar
GET{release}/{source}/{key}/*v1/private/TEST/*Get a list of versions for a specific expiry calendar
PUT{release}/{source}/{key}/{version}/{tag}v1/private/TEST/1/PRODTag a version with a name (which can be used instead of the version number when retrieving it)
POST{release}v1Create or update an expiry calendar, the expiry calendar is the JSON body of the POST request
DELETE{release}/{source}/{key}v1/private/TESTRollback to the previous version of an expiry calendar, if it is the only version then the expiry calendar will be deleted
DELETE{release}/{source}/{key}/{version}v1/private/TEST/1Delete a specific version of an expiry calendar
DELETE{release}/{source}/{key}/*v1/private/TEST/*Fully delete an expiry calendar, including all versions


Expiry Calendar Entity

The expiry calendar entity contains the following information:

_idUnique id for the expiry calendar (or object id if this is not the latest version of the expiry calendar)String
_typeThe type of the entity - always VarExpiryCalendarString
calendarThe definition of the expiry calendarCalendar Entity
_oidThe id of the expiry calendar - will match _id if this is the latest version of the expiry calendarString
_timestampTimestamp of when this expiry calendar version was createdString(DateTime)
_userThe user id (email) of the user that created this expiry calendar verisionString
_tagA list of version tag names for this expiry calendar versionString[]
_versionThe version number of this expiry calendar versionint

Calendar Entity

_idUnique id for the expiry calendarString
_typeEntity Type - always ExpiryCalendarString
tradingCalendarCodeThe code for the calendar that represents the tradable daysString
rulesAn object representing expiry rules that map to either ALL contract types or a specific typeLimited Expiry Rule Map

Limited Expiry Rule Entity

beforeUsed in combination with the date property to represent whether we are time limiting this rule to before or after the dateString
dateIf this is a time-limited expiry rule, this is the date when it comes into effect, otherwise it is null or undefinedString(DateTime)
ruleThe expiry rule objectExpiryRule

Expiry Rule Entity

ruleThe expiry rule type - usually GrammarExpiryRuleString
codeThe grammar code for the expiry ruleString