About this endpoint
What it does
Calculates business-day results using public-holiday calendars for the supported countries. Depending on mode, it can add business days to a date, count business days in a range, check whether a date is a business day, or return holidays for a year.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| end | String | No | Range end in YYYY-MM-DD, exclusive. Used in count mode. |
| date | String | No | Base date in YYYY-MM-DD. Used in add and is_business_day modes. |
| days | Integer | No | Business days to add. Use a negative value to subtract. Used in add mode. |
| mode | String | No | Operation mode. Allowed values: add, count, is_business_day, holidays. |
| year | Integer | No | Year for holidays mode. |
| start | String | No | Range start in YYYY-MM-DD. Used in count mode. |
| country | String | No | ISO country code for the holiday calendar. Allowed values: US, GB, CA, AU, DE, FR, IN. |
Response
Returns a JSON object with mode, input, result, and country string fields, plus business_days as an integer, result_weekday as a string, and holidays_skipped as an array of objects. Each object in holidays_skipped contains date and name string fields.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| mode | String | No | Operation mode used for the response. |
| input | String | No | Input value associated with the request. |
| result | String | No | Computed result value. |
| country | String | No | ISO country code associated with the holiday calendar. |
| business_days | Integer | No | Number of business days calculated. |
| result_weekday | String | No | Weekday for the computed result. |
| holidays_skipped | Object Array | No | Holidays skipped during the calculation. Each item contains date and name string fields. |