{"_id":"11holidays","_rev":"1-7d87e551695f38a0e0d992dbcba14525","name":"11holidays","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"11holidays","version":"1.0.0","description":"Global holidays API for public holidays, bank holidays and observances from 230+ countries","main":"dist/index.js","module":"dist/index.m.js","unpkg":"dist/index.umd.js","types":"dist/index.d.ts","scripts":{"build":"rimraf ./dist && microbundle --tsconfig tsconfig.json --no-sourcemap","dev":"ts-node-dev lib/index.ts","test":"npx playwright test","dev-test":"ts-node-dev lib/test.ts"},"exports":{"require":"./dist/index.js","default":"./dist/index.modern.js"},"repository":{"type":"git","url":"git+https://github.com/dayschedule/11holidays.git"},"keywords":["holiday","holidays","calendar","holidaysapi","holidays-api","bank-holidays","national-holidays","observances"],"author":{"name":"https://github.com/vickyRathee"},"license":"MIT","bugs":{"url":"https://github.com/dayschedule/11holidays/issues"},"homepage":"https://github.com/dayschedule/11holidays","dependencies":{"axios":"^1.5.1"},"devDependencies":{"@playwright/test":"^1.38.1","@types/node":"^20.8.3","dotenv":"^16.3.1","microbundle":"^0.15.1","rimraf":"^5.0.5","ts-node":"^10.9.1","ts-node-dev":"^2.0.0","typescript":"^5.2.2"},"_id":"11holidays@1.0.0","gitHead":"53117aa1f08266050fabd2bf977b92f8902038ed","_nodeVersion":"18.17.1","_npmVersion":"10.1.0","dist":{"integrity":"sha512-vyDLQKYQVfeG5hCsVJ0WrnIG0dlFnWb5FJSjd2oPY8wurOhxpibwSVjXOBSpbKSwuFaBHsbxiO57dMaobxAObQ==","shasum":"b2366954c468d863b4eb0f0ec2faedc7a1384cf6","tarball":"https://registry.npmjs.org/11holidays/-/11holidays-1.0.0.tgz","fileCount":13,"unpackedSize":12822,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCdCepVtPAgThebq0MJkm/I88BC2dAe49xISTfXs4g54QIhAKufG+mwL0T8Hhdr3MctY4pdjQjDrR+ps2ScbRgA9mxx"}]},"_npmUser":{"name":"vickyrathee","email":"support@dayschedule.com"},"directories":{},"maintainers":[{"name":"vickyrathee","email":"support@dayschedule.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/11holidays_1.0.0_1699162963477_0.7530797784618675"},"_hasShrinkwrap":false},"1.0.1":{"name":"11holidays","version":"1.0.1","description":"Global holidays API for public holidays, bank holidays and observances from 230+ countries","main":"dist/index.js","module":"dist/index.m.js","unpkg":"dist/index.umd.js","types":"dist/index.d.ts","scripts":{"build":"rimraf ./dist && microbundle --tsconfig tsconfig.json --no-sourcemap","dev":"ts-node-dev lib/index.ts","test":"npx playwright test","dev-test":"ts-node-dev lib/test.ts"},"exports":{"require":"./dist/index.js","default":"./dist/index.modern.js"},"repository":{"type":"git","url":"git+https://github.com/dayschedule/11holidays.git"},"keywords":["holiday","holidays","calendar","holidaysapi","holidays-api","bank-holidays","national-holidays","observances"],"author":{"name":"https://github.com/vickyRathee"},"license":"MIT","bugs":{"url":"https://github.com/dayschedule/11holidays/issues"},"homepage":"https://github.com/dayschedule/11holidays","dependencies":{"axios":"^1.5.1"},"devDependencies":{"@playwright/test":"^1.38.1","@types/node":"^20.8.3","dotenv":"^16.3.1","microbundle":"^0.15.1","rimraf":"^5.0.5","ts-node":"^10.9.1","ts-node-dev":"^2.0.0","typescript":"^5.2.2"},"_id":"11holidays@1.0.1","gitHead":"de06dbc190b6295bc18145be849bb7602e4a3934","_nodeVersion":"18.17.1","_npmVersion":"10.1.0","dist":{"integrity":"sha512-VGb2PsdO+9fbRNDUyS7PYVF6ablipP+N2Kb7eWySzfBJVgA0m8rE8AFcTPON+eesOISH77iwIqLfX/d7ltzaBw==","shasum":"1ecb670919ac5a758aa527bba31718fa9a405de6","tarball":"https://registry.npmjs.org/11holidays/-/11holidays-1.0.1.tgz","fileCount":13,"unpackedSize":13315,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBsjSE4TbM3e4GyJuIl1R+hK7bjCS4J1VAP3kea4rnwlAiEAg07UpthcM2NbT6FU6VYX4xstlpziEQSTvICm41KwT0c="}]},"_npmUser":{"name":"vickyrathee","email":"support@dayschedule.com"},"directories":{},"maintainers":[{"name":"vickyrathee","email":"support@dayschedule.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/11holidays_1.0.1_1699163519181_0.6046673015015405"},"_hasShrinkwrap":false}},"time":{"created":"2023-11-05T05:42:43.476Z","1.0.0":"2023-11-05T05:42:43.706Z","modified":"2023-11-05T05:51:59.619Z","1.0.1":"2023-11-05T05:51:59.437Z"},"maintainers":[{"name":"vickyrathee","email":"support@dayschedule.com"}],"description":"Global holidays API for public holidays, bank holidays and observances from 230+ countries","homepage":"https://github.com/dayschedule/11holidays","keywords":["holiday","holidays","calendar","holidaysapi","holidays-api","bank-holidays","national-holidays","observances"],"repository":{"type":"git","url":"git+https://github.com/dayschedule/11holidays.git"},"author":{"name":"https://github.com/vickyRathee"},"bugs":{"url":"https://github.com/dayschedule/11holidays/issues"},"license":"MIT","readme":"# 11holidays\r\n\r\nGlobal [holidays API](https://11holidays.com/) for public holidays, bank holidays and observances from 230+ countries.\r\n\r\n## Installation\r\n\r\n```\r\nnpm i 11holidays\r\n```\r\n\r\n## Api Key\r\n\r\nYou can use the SDK without API key to access past holidays(Free plan) or for testing.\r\n\r\n- Signup to [get your api key](https://11holidays.com/pricing) for full access to fetch holidays by country, year etc.\r\n\r\n## Holidays API\r\n\r\nTo retrieve the complete holidays list by specific country code and year\r\n\r\n```\r\nconst instance = new HolidaysApi(API_KEY);\r\nconst holidays = await instance.holidays.list({country: 'US', year: '2023'});\r\n\r\nconsole.log(holidays);\r\n\r\n[\r\n  {\r\n    \"holiday_id\": 6093,\r\n    \"name\": \"New Year's Day\",\r\n    \"date\": \"2023-01-01\",\r\n    \"description\": \"...\",\r\n    \"occasion_id\": 6220,\r\n    \"country\": \"US\",\r\n    \"type\": \"State Holiday\",\r\n    \"created_at\": \"2023-10-28 15:10:10\",\r\n    \"updated_at\": null\r\n  },\r\n  {\r\n    \"holiday_id\": 6094,\r\n    \"name\": \"New Year's Day\",\r\n    \"date\": \"2023-01-01\",\r\n    \"description\": \"...\",\r\n    \"occasion_id\": 6220,\r\n    \"country\": \"US\",\r\n    \"type\": \"Federal Holiday\",\r\n    \"created_at\": \"2023-10-28 15:10:10\",\r\n    \"updated_at\": null\r\n  },\r\n  ...\r\n]\r\n\r\n```\r\n\r\n### Parameters\r\n\r\ncountry (2 char) - Required. 2 character ISO country code.\r\nyear (integer) - Required. Year in 4 digit format.\r\n\r\n## Countries API\r\n\r\nTo retrieve the complete list of countries\r\n\r\n```\r\nconst instance = new HolidaysApi(API_KEY);\r\nconst countries = await instance.countries.list();\r\n\r\nconsole.log(countries);\r\n\r\n[\r\n   {\"country\":\"US\",\"name\":\"United States\"},\r\n   {\"country\":\"IN\",\"name\":\"India\"}\r\n]\r\n```\r\n\r\n## Support\r\n\r\n- If you have any question related to API key, access etc. [contact support](https://11holidays.com/contact).\r\n- Open an issue on Github for question related to SDK\r\n","readmeFilename":"README.md"}