Numerology API Documentation

Welcome to the Numerology API! This guide provides an overview of the available endpoints, parameters, and response formats for interacting with the API.

Base URL

bash

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

Endpoints

1. Key Numerology Figures

This endpoint retrieves key numerology figures such as Life Path, Destiny, and Soul Urge based on the user's name and birthdate. The birthdate is optional.

POST

https://roxyapi.com/api/v1/data/astro/numerology/key-figures?token={your_api_token}

Body

Key	Value	Description
first_name	Jason	First name of the user
last_name	Doe	Last name of the user
birthdate	1979-08-01	Birthdate of the user in YYYY-MM-DD format

Response Example

json

{
	"first_name": "Jason",
	"last_name": "Doe",
	"hearth_desire_number": 2,
	"personality_number": 6,
	"destiny_number": 8,
	"expression_number": 8,
	"active_number": 5,
	"legacy_number": 3,
	"full_name_numbers": {
		"1": 4,
		"6": 3,
		"4": 2,
		"5": 1
	},
	"full_name_missing_numbers": [
		2,
		3,
		7,
		8,
		9
	],
	"birthdate": "1979-08-01",
	"life_path_number": 8,
	"life_path_number_alternative": 8,
	"birthdate_day_num": 1,
	"birthdate_month_num": 8,
	"birthdate_year_num": 8,
	"birthdate_year_num_alternative": 7,
	"power_number": 7,
	"power_number_alternative": 7
}

2. Detailed Numerology Interpretations

This endpoint retrieves detailed numerology interpretations based on the full name and birthdate of the user.

POST

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

Body

Key	Value	Description
first_name	Jane	First name of the user
last_name	Doe	Last name of the user
birthdate	1985-07-12	Birthdate of the user in YYYY-MM-DD format

Response Example

json

{
	"title": "Life of ambitious achievements and material acquisitions",
	"description": "This life path favors ambitions and large-scale achievements. It symbolizes power, money and materiality. It is difficult because it involves risks and trials but it can lead to extraordinary success. It is not free from accidents and health problems. Requirements: The qualities needed to take on this path of life are: courage, endurance and a sense of balance.Challenges: This path is difficult for those who have 8 as the missing number, and the expression numbers 4 and 7. The 2s and 9s are not always at ease."
}

3. Calculate Life Path Number

This endpoint calculates the Life Path Number based on the user's birthdate.

GET

https://roxyapi.com/api/v1/data/astro/numerology/life-path-number?birthdate={birth_date}&token={your_api_token}

birth_date (required): string – The birthdate of the user in YYYY-MM-DD format.

Response Example

json

{
	"life_path_number": 3
}

4. Calculate Soul Urge Number

This endpoint calculates the Soul Urge Number based on the user's full name.

GET

https://roxyapi.com/api/v1/data/astro/numerology/soul-urge-number?full_name={full_name}&token={your_api_token}

full_name (required): string – The full name of the user.

Response Example

json

{
	"soul_urge_number": 8
}

5. Compatibility Analysis

This endpoint analyzes compatibility between multiple individuals based on their numerology figures, such as Life Path Numbers.

POST

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

Request Parameters

The request body must be an array of objects representing two individuals. Each object must have the following fields:

first_name (required): string – The first name of the person.
last_name (required): string – The last name of the person.
birthdate (required): string – The birthdate of the person in YYYY-MM-DD format.

Request Body Example

json

[
  {
    "first_name": "Alice",
    "last_name": "Smith",
    "birthdate": "1990-01-01"
  },
  {
    "first_name": "Bob",
    "last_name": "Johnson",
    "birthdate": "1988-05-15"
  }
]

Response Example

json

[
    {
      "pair": "Alice & Bob",
      "compatibility_score": 80,
      "description": "High Compatibility",
      "details": {
        "person1_life_path": 3,
        "person2_life_path": 5
      }
    }
  ]

Error Responses

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

Error Response Example

json

{
  "error": "Invalid birthdate format. Use YYYY-MM-DD."
}