FIX Monitor API

Note

Version: v1
Base URL: https://next.itrslab.com/fixmonitor/api

The FIX Monitor API provides endpoints for managing session schedules and holiday calendars in the FIX Monitor system. This API allows you to configure and maintain scheduling information for FIX sessions, including daily and weekly recurrence patterns, and manage holiday calendars that affect session schedules.

Calendars Copied

The Calendars endpoints allow you to manage holiday calendars that can be associated with session schedules to exclude specific dates from normal scheduling.

Get Holiday Calendars Copied

Retrieves one or all holiday calendars from the system.

Endpoint: GET /v1/holiday-calendars

Parameters Copied

Example Request Copied

GET /v1/holiday-calendars?name=TestCalendar

Example Response Copied

{
  "calendars": {
    "calendars": [
      {
        "name": "TestCalendar",
        "timezone": "UTC",
        "dates": [
          {
            "year": 2024,
            "month": 1,
            "day": 1
          },
          {
            "year": 2024,
            "month": 12,
            "day": 25
          }
        ]
      }
    ]
  }
}

Create/Update Holiday Calendars Copied

Creates or updates specified holiday calendars. Pre-existing calendars with names not matching any of the provided calendars remain in place.

Endpoint: POST /v1/holiday-calendars

Request Body Copied

Example Request Copied

{
  "calendars": {
    "calendars": [
      {
        "name": "TestCalendar",
        "dates": [
          {
            "year": 2024,
            "month": 1,
            "day": 1
          }
        ]
      }
    ]
  }
}

Example Response Copied

{}

Delete Holiday Calendar Copied

Deletes a holiday calendar by name. Note that an attempt to clear a calendar referenced by a session schedule will fail.

Endpoint: DELETE /v1/holiday-calendars

Parameters Copied

Example Request Copied

DELETE /v1/holiday-calendars?name=TestCalendar

Example Response Copied

{}

Schedules Copied

The Schedules endpoints allow you to manage session schedules, including default schedules and session-specific schedules.

Get Default Session Schedule Copied

Returns the default session schedule used by sessions when no specific schedule is set.

Endpoint: GET /v1/session-schedule-default

Example Request Copied

GET /v1/session-schedule-default

Example Response Copied

{
  "schedule": {
    "events": {
      "timezone": "UTC",
      "dailyEvents": {
        "logonTime": {
          "hour": 8,
          "minute": 0,
          "second": 0
        },
        "logoutTime": {
          "hour": 17,
          "minute": 0,
          "second": 0
        },
        "recurrence": {
          "weekdays": {}
        }
      }
    },
    "isDefaultSchedule": true
  }
}

Get Session Schedules Copied

Retrieves one or all session schedules from the system.

Endpoint: GET /v1/session-schedules

Parameters Copied

Example Request Copied

GET /v1/session-schedules?id=SESSION123

Example Response Copied

{
  "schedules": {
    "schedules": [
      {
        "id": "SESSION123",
        "sessionAddress": {
          "senderCompId": "SENDER123",
          "targetCompId": "TARGET123"
        },
        "schedule": {
          "events": {
            "timezone": "America/New_York",
            "dailyEvents": {
              "logonTime": {
                "hour": 9,
                "minute": 0,
                "second": 0
              },
              "logoutTime": {
                "hour": 16,
                "minute": 0,
                "second": 0
              },
              "endOfDayTime": {
                "hour": 16,
                "minute": 30,
                "second": 0
              },
              "recurrence": {
                "weekdays": {}
              }
            }
          },
          "holidayCalendarName": "NYSE_HOLIDAYS",
          "isDefaultSchedule": false
        }
      }
    ]
  }
}

Create/Update Session Schedules Copied

Creates or updates specified session schedules. Pre-existing schedules with sessionIds not matching any of the provided schedules remain in place.

Endpoint: POST /v1/session-schedules

Request Body Copied

Schedule Events Types Copied

Daily Events:

• dailyEvents.logonTime - Expected logon time
• dailyEvents.logoutTime - Expected logout time
• dailyEvents.endOfDayTime - End of day processing time
• dailyEvents.recurrence - Recurrence pattern (weekdays or specific days)

Weekly Events:

• weeklyEvents.logonDay - Day of week for logon
• weeklyEvents.logonTime - Time for logon
• weeklyEvents.logoutDay - Day of week for logout
• weeklyEvents.logoutTime - Time for logout
• weeklyEvents.endOfWeekDay - End of week day
• weeklyEvents.endOfWeekTime - End of week time

Example Request Copied

{
  "schedules": {
    "schedules": [
      {
        "id": "SESSION123",
        "sessionAddress": {
          "senderCompId": "SENDER123",
          "targetCompId": "TARGET123"
        },
        "schedule": {
          "events": {
            "timezone": "America/New_York",
            "dailyEvents": {
              "logonTime": {
                "hour": 9,
                "minute": 0,
                "second": 0
              },
              "logoutTime": {
                "hour": 16,
                "minute": 0,
                "second": 0
              },
              "recurrence": {
                "weekdays": {}
              }
            }
          },
          "holidayCalendarName": "NYSE_HOLIDAYS",
          "isDefaultSchedule": false
        }
      }
    ]
  }
}

Example Response Copied

{}

Delete Session Schedule Copied

Deletes a session schedule by sessionId.

Endpoint: DELETE /v1/session-schedules

Parameters Copied

Example Request Copied

DELETE /v1/session-schedules?id=SESSION123

Example Response Copied

{}

Data Models Copied

DailyRecurrence_Days Object Copied

DailyRecurrence_Weekdays Object Copied

Empty object that indicates recurrence on weekdays (MONDAY through FRIDAY).

DailyScheduleEvents_DailyRecurrence Object Copied

Contains one of the following recurrence patterns:

Date Object Copied

DeleteHolidayCalendarResponse Object Copied

Empty response object that indicates successful deletion operation.

DeleteSessionScheduleResponse Object Copied

Empty response object that indicates successful deletion operation.

GetHolidayCalendarsResponse Object Copied

GetSessionDefaultScheduleResponse Object Copied

GetSessionSchedulesResponse Object Copied

HolidayCalendar Object Copied

HolidayCalendars Object Copied

PutHolidayCalendarsRequest Object Copied

PutHolidayCalendarsResponse Object Copied

Empty response object that indicates successful operation.

PutSessionSchedulesRequest Object Copied

PutSessionSchedulesResponse Object Copied

Empty response object that indicates successful operation.

Schedule Object Copied

The schedule defines the timing of expected session logon/logout events. Schedules may be used to generate signals representing session non-conformance to an expected schedule and are recommended where possible.

ScheduleEvents Object Copied

ScheduleEvents_DailyScheduleEvents Object Copied

ScheduleEvents_WeeklyScheduleEvents Object Copied

SessionAddress Object Copied

SessionSchedule Object Copied

SessionSchedules Object Copied

Time Object Copied

Enums Copied

Day Enum Values Copied

• UNKNOWN
• SUNDAY
• MONDAY
• TUESDAY
• WEDNESDAY
• THURSDAY
• FRIDAY
• SATURDAY