Tarot API Documentation

Welcome to the Tarot API! This guide provides an overview of the available endpoints, parameters, and response formats for interacting with the API. Please note that all requests to the API require a token to be included as a query parameter.

Base URL

https://roxyapi.com/api/v1/data/astro/tarot?token={your_api_token}

Endpoints

1. Three-Card Tarot Draw

This endpoint performs a three-card tarot draw and returns detailed information about the cards drawn, including whether the cards are reversed.

https://roxyapi.com/api/v1/data/astro/tarot/three-card-draw?token={your_api_token}
#KeyValueDescription
reversed_probability0.3A value between 0 and 1 indicating the probability that a card will be reversed. Default is 0.2.

Response Example

[
    {
        "name": "The Magician",
        "slug": "the_magician",
        "image": "https://cdn.roxyapi.com/img/tarot/01.jpeg",
        "meaning": "The start of something. Beginner's luck. Having various tools and means...",
        "message": "create a new reality",
        "reversed_meaning": "Trickery, sleight of hand, cheating. Showing off, pretending...",
        "sequence": 1,
        "qabalah": "from Kether to Tiphareth",
        "hebrew_letter": "א",
        "meditation": "The wind blows where it wills, and you hear the sound of it...",
        "card_type": "major",
        "is_reversed": false
    },
    // 2 More Cards
  ]

2. Yes/No Tarot Reading

This endpoint returns a simple yes/no/maybe answer based on a tarot reading.

https://roxyapi.com/api/v1/data/astro/tarot/yes-or-no?token={your_api_token}

Response Example

{
  "answer": "Yes"
}

3. Single-Card Tarot Draw

This endpoint draws a single tarot card and returns its details, including whether the card is reversed.

https://roxyapi.com/api/v1/data/astro/tarot/single-card-draw?token={your_api_token}
#KeyValueDescription
reversed_probability0.5A value between 0 and 1 indicating the probability that a card will be reversed. Default is 0.2.

Response Example

{
    "name": "The Magician",
    "image": "https://cdn.roxyapi.com/img/tarot/01.jpeg",
    "meaning": "The start of something...",
    "reversed_meaning": "Trickery, sleight of hand...",
    "is_reversed": true
  }

4. Full Tarot Deck Listing

This endpoint retrieves the full list of tarot cards in the deck, including their names, sequences, and images.

https://roxyapi.com/api/v1/data/astro/tarot/deck?token={your_api_token}

Response Example

[
	{
		"name": "The Magician",
		"image": "https://cdn.roxyapi.com/img/tarot/01.jpeg",
		"slug": "the_magician",
		"sequence": 1
	},
	{
		"name": "The Popess",
		"image": "https://cdn.roxyapi.com/img/tarot/02.jpeg",
		"slug": "the_popess",
		"sequence": 2
	}
    // More cards...
]

5. Specific Card Details

This endpoint retrieves details of a specific tarot card by name or URL slug.

https://roxyapi.com/api/v1/data/astro/tarot/card/{card_name}?token={your_api_token}
  • card_name (required): string – The name or URL slug of the tarot card.

Request Example

https://roxyapi.com/api/v1/data/astro/tarot/card/the_magician?token={your_api_token}

Response Example

{
  "name": "The Magician",
  "image": "https://cdn.roxyapi.com/img/tarot/01.jpeg",
  "meaning": "The start of something...",
  "reversed_meaning": "Trickery, sleight of hand...",
  "qabalah": "from Kether to Tiphareth",
  "hebrew_letter": "א",
  "meditation": "The wind blows where it wills...",
  "card_type": "major"
}

6. Specific Tarot Spread

This endpoint generates a tarot spread with the specified type (e.g., Three-Card Spread, Celtic Cross).

https://roxyapi.com/api/v1/data/astro/tarot/spread/{spread_type}?token={your_api_token}
#KeyValueDescription
reversed_probability0.2A value between 0 and 1 indicating the probability that a card will be reversed. Default is 0.2.
  • spread_type (required): string – The type of spread to be generated. Supported types include "three_card" and "celtic_cross".

Request Example

https://roxyapi.com/api/v1/data/astro/tarot/spread/celtic_cross?token={your_api_token}
#KeyValueDescription
reversed_probability0.4A value between 0 and 1 indicating the probability that a card will be reversed. Default is 0.2.

Response Example

[
    {
        "name": "Eight of Cups",
        "slug": "eight_of_cups",
        "image": "https://cdn.roxyapi.com/img/tarot/cu08.jpeg",
        "meaning": "Involvement. Developing personal relat...",
        "reversed_meaning": "Interference of the environment in a couple's relationships. Pressures from...",
        "sequence": 62,
        "qabalah": "♄ in ♓︎ (Saturn in Pisces)",
        "card_type": "minor",
        "is_reversed": true
    },
    // More cards in the spread...
  ]

Error Responses

In case of errors, the API will return a JSON response with an error field.

Error Response Example

{
  "error": "Card not found"
}