Documentation

Base URL

Sample request

Replace api_key and api_pass with your api key and api pass.

You can view your api key and pass here: to api key

http://127.0.0.1:8000/{api_key}&{api_pass}/api

Get Todays Info

Sample request

Get todays info.

GET /today

Sample response (holiday)

	{
		status: "found",
		statusCode: 200,
		today: "Sun Dec 25 2022",
		holiday: true,
		message: "Today is Regular Holiday",
		data: {
			date: {
				from: {
					fullDate: "2022-12-24T16:00:00.000Z",
					month: 12,
					day: 25,
					year: 2022
				},
				to: {
					fullDate: "2022-12-25T16:00:00.000Z",
					month: 12,
					day: 26,
					year: 2022
				}
			},
			en_name: "Christmas Day",
			fil_name: "Araw ng Pasko",
			trans: "Fixed",
			type: "Regular Holiday",
			description: "Birth anniversary of Jesus Christ, main figure of Christianity.",
			rule: {
				inMonth: "",
				inYear: "-1"
			}
		}
	}

Sample response (not holiday)

	{
		status: "found",
		statusCode: 200,
		today: "Mon Dec 12 2022",
		holiday: false,
		message: "Today is not Holiday",
		data: []
	}

Get Per Year

Sample request

Replace year with your query.

Example: 2023

GET /{year}

Sample response

	{
		status: "found",
		statusCode: 200,
		message: "Your request is found!",
		data: [
		{
			date: {
				from: {
					fullDate: "2022-02-10T16:00:00.000Z",
					month: 2,
					day: 11,
					year: 2022
				},
				to: {
					fullDate: "2022-02-11T16:00:00.000Z",
					month: 2,
					day: 12,
					year: 2022
				}
			},
			en_name: "Sample English Name",
			fil_name: "Sample Filipino Name",
			trans: "",
			type: "Locally Observed Holiday",
			description: "Sample description",
			rule: {
				inMonth: "",
				inYear: "-1"
			}
		},
		{
			date: {
				from: {
					fullDate: "2022-08-24T16:00:00.000Z",
					month: 8,
					day: 25,
					year: 2022
				},
				to: {
					fullDate: "2022-08-25T16:00:00.000Z",
					month: 8,
					day: 26,
					year: 2022
				}
			},
			en_name: "Sample English name",
			fil_name: "Sample Filipino name",
			trans: "",
			type: "Locally Observed Holiday",
			description: "Sample description",
			rule: {
				inMonth: "",
				inYear: "-1"
			}
		}
		]
	}

Get Per Month

Sample request

Replace year and month with your query.

Note: Month should be in number format. As for the example, number 2 is February

Example: 2023 and 2

GET /{year}/{month}

Sample response

	{
		status: "found",
		statusCode: 200,
		message: "Your request is found!",
		data: [
		{
			date: {
				from: {
					fullDate: "2022-02-10T16:00:00.000Z",
					month: 2,
					day: 11,
					year: 2022
				},
				to: {
					fullDate: "2022-02-11T16:00:00.000Z",
					month: 2,
					day: 12,
					year: 2022
				}
			},
			en_name: "Sample English Name",
			fil_name: "Sample Filipino Name",
			trans: "",
			type: "Locally Observed Holiday",
			description: "Sample description",
			rule: {
				inMonth: "",
				inYear: "-1"
			}
		},
		{
			date: {
				from: {
					fullDate: "2022-08-24T16:00:00.000Z",
					month: 8,
					day: 25,
					year: 2022
				},
				to: {
					fullDate: "2022-08-25T16:00:00.000Z",
					month: 8,
					day: 26,
					year: 2022
				}
			},
			en_name: "Sample English name",
			fil_name: "Sample Filipino name",
			trans: "",
			type: "Locally Observed Holiday",
			description: "Sample description",
			rule: {
				inMonth: "",
				inYear: "-1"
			}
		}
		]
	}

Get Per Day

Sample request

Replace year, month and day with your query.

Note: Month should be in number format. As for the example, number 12 is December

Example: 2022, 12 and 25

GET /{year}/{month}/{day}

Sample response

	{
		status: "found",
		statusCode: 200,
		today: "Sun Dec 25 2022",
		holiday: true,
		message: "Today is Regular Holiday",
		data: {
			date: {
				from: {
					fullDate: "2022-12-24T16:00:00.000Z",
					month: 12,
					day: 25,
					year: 2022
				},
				to: {
					fullDate: "2022-12-25T16:00:00.000Z",
					month: 12,
					day: 26,
					year: 2022
				}
			},
			en_name: "Christmas Day",
			fil_name: "Araw ng Pasko",
			trans: "Fixed",
			type: "Regular Holiday",
			description: "Birth anniversary of Jesus Christ, main figure of Christianity.",
			rule: {
				inMonth: "",
				inYear: "-1"
			}
		}
	}

Search for keyword

Sample request

Replace sample keyword with your query.

Example: Makati

GET /search/q={sample keyword}

Sample response

	{
		status: "found",
		statusCode: 200,
		message: "Your request is found!",
		data: [
		{
			date: {
				from: {
					fullDate: "2022-02-10T16:00:00.000Z",
					month: 2,
					day: 11,
					year: 2022
				},
				to: {
					fullDate: "2022-02-11T16:00:00.000Z",
					month: 2,
					day: 12,
					year: 2022
				}
			},
			en_name: "Sample English Name",
			fil_name: "Sample Filipino Name",
			trans: "",
			type: "Locally Observed Holiday",
			description: "Sample description",
			rule: {
				inMonth: "",
				inYear: "-1"
			}
		},
		{
			date: {
				from: {
					fullDate: "2022-08-24T16:00:00.000Z",
					month: 8,
					day: 25,
					year: 2022
				},
				to: {
					fullDate: "2022-08-25T16:00:00.000Z",
					month: 8,
					day: 26,
					year: 2022
				}
			},
			en_name: "Sample English name",
			fil_name: "Sample Filipino name",
			trans: "",
			type: "Locally Observed Holiday",
			description: "Sample description",
			rule: {
				inMonth: "",
				inYear: "-1"
			}
		}
		]
	}