Attribute | Type | Description |
|---|---|---|
title | string | Word to explain |
forbiddenWords | string[] | Five words that can't be used to explain the title |
difficulty | string | "easy", "medium", or "hard" |
There are currently two endpoints. The first endpoint returns all of the cards stored in the database. The response is the array of card objects.
/api/cardsThe second endpoint randomly chooses one card and returns it. The response is a single card object:
/api/cards/randomIn both of the above endpoints, you can attach the following language and difficulty query parameters.
language query parameter
Attach the language query parameter to get cards only in the provided language (either en or pl):
/api/cards?language=en/api/cards?language=pl
Not providing the language query parameter is equal to providing language=en, so
the following endpoints are equal:
/api/cards/api/cards?language=enIn both of the above cases, array of cards in English will be returned.
difficulty query parameter
Attach the difficulty query parameter to get cards only with the provided difficulty (easy, medium, or hard):
/api/cards?difficulty=easy/api/cards?difficulty=medium/api/cards?difficulty=hard
When the difficulty query parameter is not provided, the response will be:
/api/cardsAll cards with mixed difficulties.
/api/cards/randomOne card with any difficulty.
The base URL is the prefix for the API:
https://www.taboocardsapi.com/api/This prefix is skipped in the whole documentation. It should always be prepended when communicating with the API.
There is a 10000 requests per day API limit to prevent any malicious action. If you were to make more requests than this, you will get an error response with 429 status response (Too Many Requests).