Get Exchange Holidays

GET 
/v1.2/master-data/exchange/holidays

This endpoint provides information about exchange holidays.

For customer tokens, the exchange list is required. When using server tokens, the exchange list is optional. If you do not provide an exchange list with a server token, it will return all holiday details for the institution's assigned exchanges.

Request

Query Parameters

exchangeList string

This is optional for server token and required for customer token. There should not be any space in the string.

Example: NSDQ,DFM,ADSM

year integer
pageNo integer

Default value: 1

pageWidth integer

Default value: 100

Header Parameters

Throttle-Key string

Responses

200

OK

application/json

Schema

Schema

status stringrequired

Possible values: [SUCCESS, FAILED]

reason string
rejectCode number

Find error codes here

pageNo number
pageWidth number
isNextPageAvailable boolean
totalNoOfRecords number
holidays object[]
Array [
exchange string
date string
Possible values: Value must match regular expression yyyy/MM/dd
holidayDescription string
settleEnabled number
Possible values: [1-Enabled, 0-Disabled]
tradeEnabled number
Possible values: [1-Enabled, 0-Disabled]
]

Example (from schema)

{
  "status": "SUCCESS",
  "reason": "string",
  "rejectCode": 0,
  "pageNo": 0,
  "pageWidth": 0,
  "isNextPageAvailable": true,
  "totalNoOfRecords": 0,
  "holidays": [
    {
      "exchange": "string",
      "date": "string",
      "holidayDescription": "string",
      "settleEnabled": "1-Enabled",
      "tradeEnabled": "1-Enabled"
    }
  ]
}

SUCCESS

{
  "status": "SUCCESS",
  "rejectCode": 0,
  "holidays": [
    {
      "exchange": "DFM",
      "date": "2023/01/01",
      "holidayDescription": "NEW YEAR HOLIDAY",
      "settleEnabled": 0,
      "tradeEnabled": 0
    },
    {
      "exchange": "AMEX",
      "date": "2023/02/04",
      "holidayDescription": "NATIONAL DAY",
      "settleEnabled": 0,
      "tradeEnabled": 0
    }
  ],
  "totalNoOfRecords": 2,
  "pageNo": 1,
  "pageWidth": 100,
  "isNextPageAvailable": false
}

401

Unauthorized

application/json

Schema

Schema

timestamp string
status string
error string
message string
path string
rejectCode string

Example (from schema)

{
  "timestamp": "string",
  "status": "string",
  "error": "string",
  "message": "string",
  "path": "string",
  "rejectCode": "string"
}

Invalid Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Invalid Token",
  "path": "/api/v1.2/customer/register/validate-username",
  "rejectCode": "1008"
}

Expired Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Expired Token",
  "path": "/api/v1.2/customer/register/validate-username",
  "rejectCode": "1007"
}

Loading...