Skip to main content
POST
time.business-day.check

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
countryCode
string
required

ISO 2-letter country code. Country-level calendars may include regional holidays; GB includes Scotland.

Required string length: 1 - 20000
date
string
required

Date to check (YYYY-MM-DD).

Required string length: 1 - 512

Response

The result

countryCode
string
required

Country code.

date
string

Date, ISO 8601.

isBusinessDay
boolean

True when business day.

nextBusinessDay
string

Next business day, ISO 8601.

previousBusinessDay
string

Previous business day, ISO 8601.

reason
string

Reason.