New Numerology API
Docs menu
Download

Numerology compatibility API reference

Updated

The numerology compatibility endpoint of API for Astrology (apiforastrology.com), POST /v1/compatibility, compares two people from their birth dates alone. The endpoint reads each person's mulank and bhagyank against the other's, both ways. You get a plain outcome (good, mixed, difficult or neutral) and a short reading, with no score.

Call POST /v1/compatibility with two people, a and b, each with a birth date. The friendship of numbers is one-sided, so the answer lists each link with the way it reads. In the sample answer, Jane Doe and John Doe come out mixed. Why a numerology match is read both ways walks through the idea.

Two people's numbers, read both ways.

1 endpoint. Paths are relative to https://apiforastrology.com/api/numerology. Send your API key in the Authorization: Bearer header (see authentication). No key yet? Get a key. To send test requests from the browser, open the interactive reference.

Overview: Compatibility.

Two people

POST /v1/compatibility

How two people's numbers get along: each one's mulank and bhagyank, read both ways, since the friendship of numbers is one-sided. outcome uses the same rule as the name checker over all four relations. Nothing is scored.

Uses 1 reading credit. On live keys a successful response uses them from your monthly reading credits, and no calls. Test keys answer for the sample people only, and it counts as 1 test call. What reading credits buy.

Cost: 1 reading credit on a live key, 1 test call on a test key.

Required inputs

NameInWhat it is
abodyobject
bbodyobject
Optional inputs (2), with their defaults
NameInWhat it does
langqueryLanguage of the readings and names: en, hi. Codes stay in English.
detailqueryLength of the readings: standard (the default, short, for app cards) or expanded (about three times longer, for reading in full). A passage with no long form yet comes back at standard length and is listed in localization.fell_back_to_standard.

Main response fields

  • a (object): holds birth_date, mulank, bhagyank, mulank_planet.
  • b (object): holds birth_date, mulank, bhagyank, mulank_planet.
  • links (array of objects): each item holds from, from_number, to_number, relation, via, who, from_name, relation_name.
  • outcome (string)
  • outcome_name (string)
  • reading (string)
  • not_claimed (string)
  • localization (object): holds lang, detail, fell_back_to_en, fell_back_to_standard.
# John Doe, born Aug 15, 1990, and Jane Doe, born Mar 22, 1992
curl -X POST "https://apiforastrology.com/api/numerology/v1/compatibility" \
  -H "Authorization: Bearer $ASTROLOGY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"a":{"birth_date":"1990-08-15"},"b":{"birth_date":"1992-03-22"}}'
Sample response
{
  "a": {
    "birth_date": "1990-08-15",
    "mulank": 6,
    "bhagyank": 6,
    "mulank_planet": "Venus"
  },
  "b": {
    "birth_date": "1992-03-22",
    "mulank": 4,
    "bhagyank": 1,
    "mulank_planet": "Rahu"
  },
  "links": [
    {
      "from": "mulank",
      "from_number": 6,
      "to_number": 4,
      "relation": "friend",
      "via": [
        "Rahu"
      ],
      "who": "a_to_b",
      "from_name": "mulank",
      "relation_name": "friendly"
    },
    {
      "from": "mulank",
      "from_number": 4,
      "to_number": 6,
      "relation": "friend",
      "via": [
        "Rahu"
      ],
      "who": "b_to_a",
      "from_name": "mulank",
      "relation_name": "friendly"
    }
  ],
  "outcome": "mixed",
  "outcome_name": "Mixed",
  "reading": "Your numbers pull both ways. Some things come easily between you and some need patience.",
  "not_claimed": "Numbers describe tendencies, not fixed events. Use them as a guide, not a rule.",
  "localization": {
    "lang": "en",
    "detail": "standard",
    "fell_back_to_en": [],
    "fell_back_to_standard": []
  }
}

Example from a real call for John Doe, born Aug 15, 1990, and Jane Doe, born Mar 22, 1992. Long lists and texts are shortened.

Parameters, schemas and a test request in the interactive reference. Feature: Compatibility.

How the pair is read

The mulank is the birth day number, also called the driver number. The bhagyank is the destiny number, also called the conductor number, added up from the whole birth date. No birth time, place or name is needed. Each number from 1 to 9 has a ruling planet, and the mulank's planet comes back in mulank_planet.

Two numbers are friendly when their planets are friends. Planet friendship can be one-sided, so each item in links says which way it reads in who: a_to_b or b_to_a. Rahu and Ketu are read as Saturn and Mars, and via names them when they are used.

The outcome follows the same rule as every fit in the API, with no weights. The pair is good with at least one friend and no enemy, and difficult with at least one enemy and no friend. The pair is mixed with one of each, and neutral with neither. In the sample answer, Jane Doe and John Doe come out mixed.

Numerology compatibility is not kundli matching. Kundli matching on the Astrology API needs both birth times and places, and it scores a couple out of 36. The compatibility endpoint needs only two birth dates. So it suits dating and matrimony apps whose users do not know their birth time.

Where the rules come from

The mulank (birth day number) is the day of birth, added down to one digit. The 1st, 10th, 19th and 28th all give 1, as in Cheiro's Book of Numbers (1926). Numerology turns a person's name and date of birth into numbers, as described by Encyclopaedia Britannica.

Related pages

Get a free API key

Terms in this group