---
title: "Compatibility: bulk matching (1 against up to 100)"
method: POST
path: "/vedic/compatibility/bulk"
tags: ["Vedic"]
---

# Compatibility: bulk matching (1 against up to 100)

`POST /vedic/compatibility/bulk`

## Request

- Base URL: `https://api.astroway.info/v1`
- URL: `https://api.astroway.info/v1/vedic/compatibility/bulk`
- Auth: API key in header `X-Api-Key`
- TypeScript: <https://skmtc.dev/astroway/apis/astroway-calculation-api/docs/vedic/compatibility/bulk/post.ts> (a function with typed inputs; its response is checked against the schema)

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).

## Query parameters

- `fields` string
- `precision` integer

## Headers

- `Idempotency-Key` string

## Request body

- BulkMatchInput: One profile against up to 100 candidates, ranked. Synchronous.
  - `profile` object, required: The one profile matched against every candidate.
    - `date` string, required
    - `time` string, required
    - `timezoneOffset` number, nullable: 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.
    - `timezone` string: 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.
    - `latitude` number, required
    - `longitude` number, required
    - `houseSystem` '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` 'tropical' | 'sidereal'
    - `ayanamsaId` number, nullable
    - `ayanamsa` 'fagan-bradley' | 'lahiri' | 'de-luce' | 'raman' | 'krishnamurti' | 'kp' | 'yukteshwar' | 'jn-bhasin' | 'true-citra' | 'djwhal-khul': Sidereal school by name. Lahiri when omitted. Equivalent to ayanamsaId; send either.
    - `cosmogram` boolean
  - `profileRole` 'groom' | 'bride', required: Whether profile is the groom or the bride. Every candidate takes the other role, since Ashtakoot and Porutham count in one direction.
  - `candidates` object[], required: 1 to 100 candidates.
    - `id` string: Your own reference, returned unchanged. The index is used when omitted.
    - `chart` ChartInput, 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.
      - `date` string, required
      - `time` string, required
      - `timezoneOffset` number, nullable: 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.
      - `timezone` string: 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.
      - `latitude` number, required
      - `longitude` number, required
      - `houseSystem` '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` 'tropical' | 'sidereal'
      - `ayanamsaId` number, nullable
      - `ayanamsa` 'fagan-bradley' | 'lahiri' | 'de-luce' | 'raman' | 'krishnamurti' | 'kp' | 'yukteshwar' | 'jn-bhasin' | 'true-citra' | 'djwhal-khul': Sidereal school by name. Lahiri when omitted. Equivalent to ayanamsaId; send either.
      - `cosmogram` boolean
  - `school` 'tamil' | 'kerala': Porutham school. tamil (default) or kerala; they differ on Dinam, Stree Deergham, Rasi and on which factors are essential.
  - `mangalSchool` 'strict' | 'north' | 'south': 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.
  - `sortBy` 'ashtakoot' | 'porutham': Ranking key. ashtakoot (default): Guna Milan points, ties by Porutham factors passed. porutham: factors passed, ties by points.
  - `minAshtakoot` number, nullable: Leave out candidates below this many Guna Milan points.

## Response `200`

Successful calculation

- object
  - `ok` boolean
  - `data` object
    - `method` string, nullable
    - `profileRole` string, nullable
    - `school` string, nullable
    - `mangalSchool` string, nullable
    - `sortBy` string, nullable
    - `profile` object, nullable
      - `star` number, nullable
      - `sign` number, nullable
    - `candidates` number, nullable
    - `returned` number, nullable
    - `results` object[], nullable
      - `id` string, nullable
      - `index` number, nullable
      - `star` number, nullable
      - `sign` number, nullable
      - `ashtakoot` object, nullable
        - `total` number, nullable
        - `threshold` string, nullable
        - `topKootas` object[], nullable
          - `koota` string, nullable
          - `score` number, nullable
          - `max` number, nullable
        - `doshas` string[], nullable
      - `porutham` object, nullable
        - `passed` number, nullable
        - `max` number, nullable
        - `essentialFailed` unknown[], nullable
          - unknown
        - `verdict` string, nullable
      - `mangal` string, nullable
      - `doshasUncancelled` unknown[], nullable
        - unknown
      - `rank` number, nullable
    - `errors` unknown[], nullable
      - unknown
    - `credits` number, nullable

## Other responses

- `400`: Validation error
- `401`: Missing or invalid API key

## Changes

- **2026-11-07** `e45dc317711a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/astroway/apis/astroway-calculation-api/changes/vedic/compatibility/bulk/post.md)

---

[API](https://skmtc.dev/astroway/apis/astroway-calculation-api.md) - [All operations](https://skmtc.dev/astroway/apis/astroway-calculation-api/llms.txt) - [OpenAPI document](https://skmtc.dev/astroway/apis/astroway-calculation-api/revisions/bf266b2e6703?raw)