Astrology API Documentation

Welcome to the Astrology API! This guide provides detailed information about the endpoints, parameters, and response formats for interacting with the Astrology API. Please note that all requests to the API require a valid token for authentication.

Astrology Starter App

If you wish to get started fast, checkout our Astrology Starter App in React Native

Astrology Starter App

Base URL

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

Endpoints

1. List Zodiac Signs

This endpoint provides a list of all zodiac signs with their basic metadata.

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

Response Example

[
  {
    "name": "Aries",
    "symbol": "♈",
    "start_date": "March 21",
    "end_date": "April 19",
    "element": "Fire",
    "modality": "Cardinal",
    "image": "https://cdn.roxyapi.com/img/astrology/aries.png"
  },
  {
    "name": "Taurus",
    "symbol": "♉",
    "start_date": "April 20",
    "end_date": "May 20",
    "element": "Earth",
    "modality": "Fixed",
    "image": "https://cdn.roxyapi.com/img/astrology/taurus.png"
  }
]

2. Get Zodiac Sign Details

This endpoint provides detailed information about a specific zodiac sign, including its personality.

https://roxyapi.com/api/v1/data/astro/astrology/zodiac/{sign_name}?token={your_api_token}
  • sign_name (required): string – The name of the zodiac sign (e.g., "Aries").

Response Example

{
  "name": "Aries",
  "symbol": "♈",
  "start_date": "March 21",
  "end_date": "April 19",
  "element": "Fire",
  "modality": "Cardinal",
  "image": "https://cdn.roxyapi.com/img/astrology/aries.png",
  "personality": "Bold, ambitious, and energetic. Aries thrives on competition..."
}

3. Get Personality by Birthdate

This endpoint calculates the zodiac sign of a person based on their birthdate and provides their personality details.

https://roxyapi.com/api/v1/data/astro/astrology/personality?token={your_api_token}
#KeyValueDescription
nameJohn DoeName of the person
birthdate1990-04-15Date of birth in YYYY-MM-DD format
time_of_birth14:30:00Time of birth in HH:MM:SS format

Response Example

{
  "name": "John Doe",
  "zodiac_sign": "Aries",
  "personality": "Bold, ambitious, and energetic. Aries thrives on competition...",
  "symbol": "♈",
  "element": "Fire",
  "modality": "Cardinal",
  "image": "https://cdn.roxyapi.com/img/astrology/aries.png"
}

4. Detailed Birth Chart

This endpoint generates a complete birth chart for an individual based on their name, birthdate, time of birth and location. It includes planetary positions, houses, and other astrological details.

https://roxyapi.com/api/v1/data/astro/astrology/birth-chart?token={your_api_token}
#KeyValueDescription
nameBruce WayneName of the person
birthdate1991-11-21Date of birth in YYYY-MM-DD format
time_of_birth21:55Time of birth in HH:MM format (24-hour clock)
locationUTCOptional IANA time zone location (e.g., Europe/London). Defaults to 'UTC'. For more info, see the [IANA Time Zone Database](https://www.iana.org/time-zones).

Response Example

{
  "name": "Bruce Wayne",
  "birthdate": "1991-11-21",
  "time_of_birth": "21:55:00",
  "sun": {
    "name": "Sun",
    "quality": "Fixed",
    "element": "Water",
    "sign": "Sco",
    "sign_num": 7,
    "position": 28.855784958164463,
    "abs_pos": 238.85578495816446,
    "emoji": "♏️",
    "point_type": "Planet",
    "house": "Sixth_House",
    "retrograde": false
  },
  "moon": {
    "name": "Moon",
    "quality": "Fixed",
    "element": "Earth",
    "sign": "Tau",
    "sign_num": 1,
    "position": 25.18106059952352,
    "abs_pos": 55.18106059952352,
    "emoji": "♉️",
    "point_type": "Planet",
    "house": "Twelfth_House",
    "retrograde": false
  },
  // ... Long List of all planetary and house details...
}

5. Get Horoscope

This endpoint retrieves the daily horoscope for a specific zodiac sign.

https://roxyapi.com/api/v1/data/astro/astrology/horoscope/{sign}?token={your_api_token}
  • sign (required): string – The name of the zodiac sign (e.g., "Aries").

Valid Zodiac Signs

Aries Taurus Gemini Cancer Leo Virgo Libra Scorpio Sagittarius Capricorn Aquarius Pisces

Request Example

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

Response Example

{
  "sign": "Aries",
  "horoscope": "Today is a great day for Aries to take bold steps and..."
}

6. Calculate Compatibility

This endpoint calculates the compatibility between two individuals based on their birthdates and zodiac signs.

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

Request Body

[
  {
    "name": "Alice",
    "birthdate": "1992-03-22",
    "time_of_birth": "08:15:00" # optional
  },
  {
    "name": "Bob",
    "birthdate": "1989-07-15",
    "time_of_birth": "20:45:00" # optional
  }
]

Response Example

{
  "people": [
    {
      "name": "Alice",
      "zodiac_sign": "Aries",
      "personality": "Bold, ambitious, and energetic..."
    },
    {
      "name": "Bob",
      "zodiac_sign": "Cancer",
      "personality": "Emotional, intuitive, and nurturing..."
    }
  ],
  "compatibility": {
    "level": "challenging",
    "points": {
      "love": 6,
      "thinking": 5,
      "goals": 7,
      "family": 6,
      "temper": 5
    },
    "comment": "Aries and Cancer form a complex relationship..."
  }
}

Error Responses

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

Error Response Example

{
  "error": "Invalid zodiac sign."
}