Compatibility: bulk matching (1 against up to 100)

POST

/vedic/compatibility/bulk

curl -X POST https://api.astroway.info/v1/vedic/compatibility/bulk \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "profile": { "date": "1990-05-15", "time": "15:30:00", "timezone": "Europe/Kyiv", "latitude": 50.45, "longitude": 30.52 }, "profileRole": "groom", "candidates": [ { "id": "c-101", "chart": { "date": "1985-11-03", "time": "09:15:00", "timezone": "Europe/Kyiv", "latitude": 48.46, "longitude": 35.04 } }, { "id": "c-102", "chart": { "date": "1992-03-22", "time": "08:15:00", "timezone": "Europe/Kyiv", "latitude": 49.84, "longitude": 24.03 } } ] }'

const res = await fetch('https://api.astroway.info/v1/vedic/compatibility/bulk', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "profile": {
      "date": "1990-05-15",
      "time": "15:30:00",
      "timezone": "Europe/Kyiv",
      "latitude": 50.45,
      "longitude": 30.52
    },
    "profileRole": "groom",
    "candidates": [
      {
        "id": "c-101",
        "chart": {
          "date": "1985-11-03",
          "time": "09:15:00",
          "timezone": "Europe/Kyiv",
          "latitude": 48.46,
          "longitude": 35.04
        }
      },
      {
        "id": "c-102",
        "chart": {
          "date": "1992-03-22",
          "time": "08:15:00",
          "timezone": "Europe/Kyiv",
          "latitude": 49.84,
          "longitude": 24.03
        }
      }
    ]
  }),
});
const { ok, data, error } = await res.json();
if (!ok) throw new Error(error.message);
console.log(data);

import os, requests

r = requests.post(
    'https://api.astroway.info/v1/vedic/compatibility/bulk',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
    json={
      'profile': {
        'date': "1990-05-15",
        'time': "15:30:00",
        'timezone': "Europe/Kyiv",
        'latitude': 50.45,
        'longitude': 30.52
      },
      'profileRole': "groom",
      'candidates': [
        {
          'id': "c-101",
          'chart': {
            'date': "1985-11-03",
            'time': "09:15:00",
            'timezone': "Europe/Kyiv",
            'latitude': 48.46,
            'longitude': 35.04
          }
        },
        {
          'id': "c-102",
          'chart': {
            'date': "1992-03-22",
            'time': "08:15:00",
            'timezone': "Europe/Kyiv",
            'latitude': 49.84,
            'longitude': 24.03
          }
        }
      ]
    },
)
result = r.json()
if not result['ok']:
    raise RuntimeError(result['error']['message'])
print(result['data'])

<?php
use GuzzleHttp\Client;

$client = new Client(['base_uri' => 'https://api.astroway.info/v1/']);
$r = $client->post('vedic/compatibility/bulk', [
    'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')],
    'json' => [
        'profile' => [
            'date' => '1990-05-15',
            'time' => '15:30:00',
            'timezone' => 'Europe/Kyiv',
            'latitude' => 50.45,
            'longitude' => 30.52,
        ],
        'profileRole' => 'groom',
        'candidates' => [[
            'id' => 'c-101',
            'chart' => [
                'date' => '1985-11-03',
                'time' => '09:15:00',
                'timezone' => 'Europe/Kyiv',
                'latitude' => 48.46,
                'longitude' => 35.04,
            ],
        ], [
            'id' => 'c-102',
            'chart' => [
                'date' => '1992-03-22',
                'time' => '08:15:00',
                'timezone' => 'Europe/Kyiv',
                'latitude' => 49.84,
                'longitude' => 24.03,
            ],
        ]],
    ],
]);
$result = json_decode($r->getBody(), true);
if (!$result['ok']) throw new \RuntimeException($result['error']['message']);
print_r($result['data']);

One profile (profileRole groom or bride) against up to 100 candidates, ranked by Ashtakoot points (or Porutham with sortBy), each with its top kootas, Porutham count, Mangal verdict and uncancelled doshas. Synchronous. Billed 50 for the first candidate and 20 for each further one (X-Credits-Used).

Authorizations

ApiKeyAuth

Parameters

Query Parameters

fields

string

Comma-separated dotted paths, relative to data, to keep in the response. A path is applied to every element of an array, so planets.name means the name of each planet. Paths that match nothing come back in _fields_unmatched; a list where nothing matches at all is a 400, because an empty object would be a confident wrong answer.

Example

planets.name,planets.longitude

precision

integer

<= 15

Round every non-integer number in the response to this many decimal places. Integers are left alone, because an id is not a measurement. Ecliptic longitudes ship with fourteen decimals by default; 2 is about a tenth of an arcminute.

Example

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters /^[\x21-\x7E]+$/

Unique per logical operation, kept across retries. For 24 hours from the first request, a repeat with the same key, method, path, body and query string returns the stored response with Idempotent-Replayed: true and costs 0 credits. The same key with a different body or query string is a 409 IDEMPOTENCY_KEY_REUSED; a repeat while the first is still running is a 409 IDEMPOTENCY_IN_PROGRESS. Only 2xx responses are kept. See /idempotency/.

Example

01HXY2A7ZM0ABCDEF

Request Body^required

application/json

One profile against up to 100 candidates, ranked. Synchronous.

object

profile required

object

date required

string

/^\d{4}-\d{2}-\d{2}$/

time required

string

/^\d{2}:\d{2}(:\d{2})?$/

timezoneOffset

Hours from UTC at the given moment, not minutes. Fractional zones are hours too: 5.5 for India, 5.75 for Nepal, -3.5 for Newfoundland. Defaults to 0, meaning UTC. Ignored when timezone is sent.

number

0 nullable >= -14 <= 14

timezone

IANA zone name such as Europe/Kyiv, or auto to look the zone up from latitude and longitude. The server takes the offset that zone kept at this local date and time, summer time included, and uses it in place of timezoneOffset. A clock time that happened twice takes the first occurrence; one skipped when clocks went forward takes the offset from before the change. Abbreviations such as EST are refused. Before 1970 the tz database is not reliable for every place, so send timezoneOffset when the local clock is known.

string

latitude required

number

>= -90 <= 90

longitude required

number

>= -180 <= 180

houseSystem

string

default: P

Allowed values: P K R C E W B M O A T V D F G H I i L N Q S U X Y

name

string

city

string

zodiacType

string

Allowed values: tropical sidereal

ayanamsaId

number

nullable

ayanamsa

Sidereal school by name. Lahiri when omitted. Equivalent to ayanamsaId; send either.

string

Allowed values: fagan-bradley lahiri de-luce raman krishnamurti kp yukteshwar jn-bhasin true-citra djwhal-khul

cosmogram

boolean

profileRole required

Whether profile is the groom or the bride. Every candidate takes the other role, since Ashtakoot and Porutham count in one direction.

string

Allowed values: groom bride

candidates required

1 to 100 candidates.

Array<object>

>= 1 items <= 100 items

object

Your own reference, returned unchanged. The index is used when omitted.

string

<= 128 characters

chart required

Birth data for a single natal chart. Required: date (YYYY-MM-DD), time (HH:mm:ss), latitude and longitude in decimal degrees. The short forms lat, lon, lng and tz are rejected with 400 INVALID_FIELD; pass the full names. timezoneOffset is hours from UTC and defaults to 0, meaning UTC; send timezone instead (an IANA name such as Europe/Kyiv, or auto) and the offset for that date is worked out, summer time included. city is a display label only: nothing here geocodes it, so it never stands in for coordinates. houseSystem is a single house-system letter, P by default; a name such as “Placidus” is refused, and the case matters because I and i are two different Sunshine systems.

object

date required

string

/^\d{4}-\d{2}-\d{2}$/

time required

string

/^\d{2}:\d{2}(:\d{2})?$/

timezoneOffset

Hours from UTC at the given moment, not minutes. Fractional zones are hours too: 5.5 for India, 5.75 for Nepal, -3.5 for Newfoundland. Defaults to 0, meaning UTC. Ignored when timezone is sent.

number

0 nullable >= -14 <= 14

timezone

string

latitude required

number

>= -90 <= 90

longitude required

number

>= -180 <= 180

houseSystem

string

default: P

Allowed values: P K R C E W B M O A T V D F G H I i L N Q S U X Y

name

string

city

string

zodiacType

string

Allowed values: tropical sidereal

ayanamsaId

number

nullable

ayanamsa

Sidereal school by name. Lahiri when omitted. Equivalent to ayanamsaId; send either.

string

Allowed values: fagan-bradley lahiri de-luce raman krishnamurti kp yukteshwar jn-bhasin true-citra djwhal-khul

cosmogram

boolean

key additional

nullable

school

Porutham school. tamil (default) or kerala; they differ on Dinam, Stree Deergham, Rasi and on which factors are essential.

string

Allowed values: tamil kerala

mangalSchool

Houses and reference points for Kuja dosha. south (default): 1, 2, 4, 7, 8, 12 from Lagna, Moon and Venus. north: the same houses from Lagna and Moon. strict: 1, 4, 7, 8, 12 from Lagna only.

string

Allowed values: strict north south

sortBy

Ranking key. ashtakoot (default): Guna Milan points, ties by Porutham factors passed. porutham: factors passed, ties by points.

string

Allowed values: ashtakoot porutham

minAshtakoot

Leave out candidates below this many Guna Milan points.

number

nullable <= 36

Example

{
  "profile": {
    "date": "1990-05-15",
    "time": "15:30:00",
    "timezone": "Europe/Kyiv",
    "latitude": 50.45,
    "longitude": 30.52
  },
  "profileRole": "groom",
  "candidates": [
    {
      "id": "c-101",
      "chart": {
        "date": "1985-11-03",
        "time": "09:15:00",
        "timezone": "Europe/Kyiv",
        "latitude": 48.46,
        "longitude": 35.04
      }
    },
    {
      "id": "c-102",
      "chart": {
        "date": "1992-03-22",
        "time": "08:15:00",
        "timezone": "Europe/Kyiv",
        "latitude": 49.84,
        "longitude": 24.03
      }
    }
  ]
}

Responses

200

Successful calculation

application/json

object

boolean

data

object

method

string

nullable

profileRole

string

nullable

school

string

nullable

mangalSchool

string

nullable

sortBy

string

nullable

profile

object

star

number

nullable

sign

number

nullable

candidates

number

nullable

returned

number

nullable

results

Array<object>

nullable

object

string

nullable

index

number

nullable

star

number

nullable

sign

number

nullable

ashtakoot

object

total

number

nullable

threshold

string

nullable

topKootas

Array<object>

nullable

object

koota

string

nullable

score

number

nullable

max

number

nullable

doshas

Array<string>

nullable

porutham

object

passed

number

nullable

max

number

nullable

essentialFailed

Array

nullable

verdict

string

nullable

mangal

string

nullable

doshasUncancelled

Array

nullable

rank

number

nullable

errors

Array

nullable

credits

number

nullable

Example

{
  "ok": true,
  "data": {
    "method": "bulk-match",
    "profileRole": "groom",
    "school": "tamil",
    "mangalSchool": "south",
    "sortBy": "ashtakoot",
    "profile": {
      "star": 21,
      "sign": 9
    },
    "candidates": 2,
    "returned": 2,
    "results": [
      {
        "id": "c-101",
        "index": 0,
        "star": 6,
        "sign": 2,
        "ashtakoot": {
          "total": 24,
          "threshold": "good",
          "topKootas": [
            {
              "koota": "nadi",
              "score": 8,
              "max": 8
            },
            {
              "koota": "gana",
              "score": 6,
              "max": 6
            },
            {
              "koota": "varna",
              "score": 1,
              "max": 1
            }
          ],
          "doshas": [
            "Bhakoot Dosha: 6-8"
          ]
        },
        "porutham": {
          "passed": 7,
          "max": 10,
          "essentialFailed": [],
          "verdict": "agreeable"
        },
        "mangal": "cancelled",
        "doshasUncancelled": [],
        "rank": 1
      },
      {
        "id": "c-102",
        "index": 1,
        "star": 16,
        "sign": 6,
        "ashtakoot": {
          "total": 19,
          "threshold": "acceptable",
          "topKootas": [
            {
              "koota": "bhakoot",
              "score": 7,
              "max": 7
            },
            {
              "koota": "grahaMaitri",
              "score": 5,
              "max": 5
            },
            {
              "koota": "varna",
              "score": 1,
              "max": 1
            }
          ],
          "doshas": [
            "Nadi Dosha: same-nadi (antya)"
          ]
        },
        "porutham": {
          "passed": 5,
          "max": 10,
          "essentialFailed": [
            "rajju"
          ],
          "verdict": "not-agreeable"
        },
        "mangal": "cancelled",
        "doshasUncancelled": [],
        "rank": 2
      }
    ],
    "errors": [],
    "credits": 70
  }
}

400

Validation error

application/json

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "Validation failed: date: Date must be YYYY-MM-DD",
    "details": [
      {
        "path": "date",
        "message": "Date must be YYYY-MM-DD"
      }
    ]
  }
}

401

Missing or invalid API key

application/json

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API key"
  }
}

Suggest an edit

// Previous

Compatibility: unified couple report

Next //

Life-area timing: marriage

Compatibility: bulk matching (1 against up to 100)

Authorizations

Parameters

Query Parameters

Example

Example

Header Parameters

Example

Request Body required

Example

Responses

200

Example

400

Example

401

Example

Request Body^required