NepaliDate

NepaliDate: Nepali Calendar & Bikram Sambat API

A comprehensive API for Bikram Sambat (BS) to Gregorian (AD) date conversions and Nepali calendar event data. Provides detailed daily information, including Nepali holidays, festivals, tithis (lunar days), and auspicious dates for marriage (vivah) and bratabandha for a given BS month or entire BS year. Ideal for integrating Nepali Patro data into your applications. Requires API Key authentication via 'X-API-Key' header.

Version: 1.3.0
Status: Operational

Contact: contact@sevenx.com.np

Authentication
All API endpoints require an API key for access. If you don't have one, you can request an API key here.

Type:

API Key

Header Name: X-API-Key

A valid API key must be provided in the 'X-API-Key' request header for all /api/calendar/* endpoints.

Nepali Calendar API Endpoints
Detailed information about each available API endpoint for accessing Bikram Sambat (BS) calendar data, Nepali holidays, and events. All endpoints require API Key authentication.

API Data Structures (BS Calendar)
Explanation of the JSON data structures, such as `BsMonthData` and `BsDayData`, returned by the Bikram Sambat Calendar API.

BsMonthData

Represents all calendar data for a specific Bikram Sambat (BS) month, including metadata, daily entries, Nepali holidays, and other events.

Field NameTypeDescription
bs_yearintegerThe Bikram Sambat year.
bs_monthintegerThe Bikram Sambat month (1 for Baishakh to 12 for Chaitra).
metadataobjectMetadata about the BS month, including its Gregorian (AD) equivalent.

Nested fields for metadata:

Field NameTypeDescription
enstringEnglish representation of the AD month(s) and year(s) this BS month spans (e.g., 'Apr/May 2023').
npstringNepali representation of the BS month and year (e.g., 'बैशाख २०८०').
ad_year_startintegerThe Gregorian year in which the BS month begins.
ad_month_startintegerThe Gregorian month (1-12) in which the BS month begins.
ad_year_endintegerThe Gregorian year in which the BS month ends.
ad_month_endintegerThe Gregorian month (1-12) in which the BS month ends.
daysarray<BsDayData>An array of day objects for the month, detailing daily Nepali calendar information.
holiFestarray<string>List of Nepali holidays and festivals. Format: 'Day_::_Description'. 'Day' is BS day (Nepali numeral or '•'). Multiple events comma-separated after '::_::'.
marriagearray<string>List of auspicious marriage (vivah) dates in the Bikram Sambat month or a message if none.
bratabandhaarray<string>List of auspicious bratabandha dates in the BS month or a message if none.

BsDayData

Represents data for a single day in the Bikram Sambat calendar, including AD equivalent and event details.

Field NameTypeDescription
nstringNepali date numeral (e.g., '१', '३२').
nestringNepali date in English numerals (e.g., '1', '32'). Can be '•' for special, non-day-specific entries in `holiFest`.
estringCorresponding Gregorian day of the month (e.g., '14'). May be empty for special '•' entries.
tstringTithi (lunar day, e.g., 'नवमी'). May be empty.
fstringFestivals or events occurring on this day for the Nepali Patro. Multiple events may be comma-separated. Can be empty.
hbooleanIndicates if the day is a public holiday (true) or not (false) in the Nepali calendar.
dintegerDay of the week (1 for Sunday, 2 for Monday, ..., 7 for Saturday). Can be 0 if not applicable (e.g., special '•' entries).
Data Coverage & Notes (Nepali Patro)
Information about the Bikram Sambat data coverage for our Nepali Patro API, including available years and data sourcing.

Available Bikram Sambat Years in Data:

1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024, 2025, 2026, 2027, 2028, 2029, 2030, 2031, 2032, 2033, 2034, 2035, 2036, 2037, 2038, 2039, 2040, 2041, 2042, 2043, 2044, 2045, 2046, 2047, 2048, 2049, 2050, 2051, 2052, 2053, 2054, 2055, 2056, 2057, 2058, 2059, 2060, 2061, 2062, 2063, 2064, 2065, 2066, 2067, 2068, 2069, 2070, 2071, 2072, 2073, 2074, 2075, 2076, 2077, 2078, 2079, 2080, 2081, 2082, 2083, 2084, 2085, 2086, 2087, 2088, 2089, 2090, 2091, 2092, 2093, 2094, 2095, 2096, 2097, 2098, 2099, 2100, 2101, 2102, 2103, 2104, 2105, 2106, 2107, 2108, 2109, 2110

Important Notes for API Users:

  • The API serves data based on pre-scraped JSON files from the 'data' directory within the project. This forms the basis of our Bikram Sambat data.
  • The `holiFest` array uses 'Day_::_Description' format. Multiple descriptions for the same day are comma-separated after the delimiter. 'Day' can be '•' for month-wide notes.
  • The `ne` field in `BsDayData` provides the Nepali day as an English numeral string, useful for programmatic access to BS dates.
  • Always check the `h` field in `BsDayData` to determine if a specific day is a Nepali holiday.
  • To access any of the /api/calendar/* endpoints, you must include your API key in the X-API-Key request header. If you need a key, please request one here.

Nepali Calendar API Documentation last updated: 12 June 2025.