Getting Started

Getting started is easy.
Currently, No API key is needed to get started. Simply make a request to the API and you're good to go!

API Endpoints

Introduction

Welcome to the ChristmasJoy API, your go-to source for all things related to Christmas! Our API offers a wide range of information, including a Christmas countdown, jokes, images, songs, and interesting facts to get you in the holiday spirit.
This guide will walk you through the basics of using our API to access this festive data.
However, please keep in mind that this is a free API that is currently in development.

Quick Start

To get started, simply make a request to the API using the base URL and endpoint of your choice.
For example, to get all Christmas jokes, you would make a request to https://christmasjoy.dev/api/jokes.
However to get a random Christmas Joke, you'd add ?random to the end of the URL, like so: https://christmasjoy.dev/api/jokes?random.


Please note that the API is currently in development, and some endpoints may not be available.

Making Your First Request

1. No API Key Required: Our API is open and does not require an API key. This means you can start making requests right away!
2. Base URL: All API requests are made to the base URL: https://christmasjoy.dev/api.

To get started, let's make a simple request to get a random Christmas fact.

Endpoint: /facts?random

Request Type: GET

Example Request: https://christmasjoy.dev/api/facts?random

Example Expected Response: {"fact": "The first Christmas was celebrated on December 25, AD 336 in Rome."}

Rate Limits

The API is currently in development, and as such, there are no rate limits. This may change in the future.
However, please be respectful of the API and do not spam requests.

Why

This API was originally created because one of my colleagues from university wanted to create a Christmas-themed app, but couldn't find any Christmas APIs that offered the data he was looking for.
So, I decided to create one myself!
I hope you enjoy using this API as much as I enjoy creating it.

Merry Christmas🎄 and Happy Holidays! ❤️