Match Birth Details

Endpoint POST https://starsapi.com/api/v3/vedic/matchmaking/match-birth-details

Returns the resolved birth context for both persons — parsed dates, weekday, location, timezone, and the ayanamsa applied to each birth moment. This is the couple version of /vedic/birth-details: every matchmaking endpoint accepts the same person1/person2 input shown here, and none of them echo birth input back — call this endpoint when you need to display or verify the interpreted input.

Authentication

Method	Example
Header (recommended)	`X-Api-Key: am_live_xxxxxxxxxxxx`
Bearer	`Authorization: Bearer am_live_xxxxxxxxxxxx`
Query	`?api_key=am_live_xxxxxxxxxxxx`

Request body

Field	Type	Required	Description
`person1`	object	Yes	First person’s birth data (see fields below).
`person2`	object	Yes	Second person’s birth data (same fields).
Each person object:
`name`	string	No	Echoed at the top of the person block.
`gender`	string	No	`male` or `female` — determines bride/groom role assignment.
`year`	integer	Yes	Birth year.
`month`	integer	Yes	Birth month, 1–12.
`day`	integer	Yes	Day of month.
`hour`	integer	Yes	Hour, 24-hour.
`minute`	integer	Yes	Minute.
`second`	integer	No	Default `0`.
`latitude`	number	Yes	Decimal degrees.
`longitude`	number	Yes	Decimal degrees.
`timezone`	string	Yes	IANA timezone.
`place`	string	No	Place label — echoed inside `location` when provided.
Optional (top-level):
`ayanamsa`	string	No	Default `lahiri`. The resolved ayanamsa appears inside each person block.
`node_type`	string	No	`mean` (default) or `true`.

Response shape

person1 / person2

Field	Type	Description
`name`	string	Echoed when provided.
`birth_details`	object	`date`, `time`, `day` (weekday), `gender`.
`location`	object	`latitude`, `longitude`, and `place` when provided.
`timezone`	string	IANA timezone echoed.
`ayanamsa`	object	`name`, `value`, `value_dms` — computed for this person’s birth moment. Both persons use the same ayanamsa system; the value differs slightly because the birth dates differ.

Top-level

Field	Type	Description
`roles`	object	Bride/groom role per person (gender-derived; defaults to person1 = bride).
`node_type`	string	Node calculation in effect: `mean` or `true`.

Errors

HTTP	Code	Cause
400	`MISSING_FIELD`	Required field absent.
400	`INVALID_DATE`	Bad calendar date.
400	`INVALID_TIME`	Hour/minute/second out of range.
400	`INVALID_TIMEZONE`	Non-IANA timezone.
400	`INVALID_COORDINATE`	Lat/lon out of range.
400	`INVALID_GENDER`	Gender not male/female/m/f.
405	`METHOD_NOT_ALLOWED`	Non-POST request.

# Replace YOUR_API_KEY with the key from your dashboard
curl -X POST "https://starsapi.com/api/v3/vedic/matchmaking/match-birth-details" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "person1": {
            "name": "Priya",
            "gender": "female",
            "year": 1990,
            "month": 5,
            "day": 20,
            "hour": 14,
            "minute": 30,
            "second": 0,
            "latitude": 28.6139,
            "longitude": 77.209,
            "timezone": "Asia/Kolkata"
        },
        "person2": {
            "name": "Rahul",
            "gender": "male",
            "year": 1992,
            "month": 8,
            "day": 15,
            "hour": 10,
            "minute": 0,
            "second": 0,
            "latitude": 19.076,
            "longitude": 72.8777,
            "timezone": "Asia/Kolkata"
        }
    }'

const response = await fetch(
  'https://starsapi.com/api/v3/vedic/matchmaking/match-birth-details',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      person1: 'Array',
      person2: 'Array'
    })
  }
);
const result = await response.json();

if (result.success) {
  console.log(result.data);
}

import requests
import os

response = requests.post(
    'https://starsapi.com/api/v3/vedic/matchmaking/match-birth-details',
    headers={'X-Api-Key': os.environ['STARSAPI_KEY']},
    json={
        'person1': 'Array',
        'person2': 'Array'
    }
)
result = response.json()

if result['success']:
    print(result['data'])

<?php
$payload = [
    'person1' => 'Array',
    'person2' => 'Array',
];

$ch = curl_init('https://starsapi.com/api/v3/vedic/matchmaking/match-birth-details');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-Api-Key: ' . getenv('STARSAPI_KEY'),
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
$data = json_decode($response, true);

if ($data['success']) {
    print_r($data['data']);
}

import 'package:http/http.dart' as http;
import 'dart:convert';

Future<Map<String, dynamic>> getAscendant() async {
  final response = await http.post(
    Uri.parse('https://starsapi.com/api/v3/vedic/matchmaking/match-birth-details'),
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: jsonEncode({
      'person1': 'Array',
      'person2': 'Array',
    }),
  );
  return jsonDecode(response.body);
}

import Foundation

func getAscendant() async throws -> [String: Any] {
    var request = URLRequest(url: URL(string:
        "https://starsapi.com/api/v3/vedic/matchmaking/match-birth-details"
    )!)
    request.httpMethod = "POST"
    request.setValue("YOUR_API_KEY", forHTTPHeaderField: "X-Api-Key")
    request.setValue("application/json", forHTTPHeaderField: "Content-Type")
    request.httpBody = """
        {
            "person1": {
                "name": "Priya",
                "gender": "female",
                "year": 1990,
                "month": 5,
                "day": 20,
                "hour": 14,
                "minute": 30,
                "second": 0,
                "latitude": 28.6139,
                "longitude": 77.209,
                "timezone": "Asia/Kolkata"
            },
            "person2": {
                "name": "Rahul",
                "gender": "male",
                "year": 1992,
                "month": 8,
                "day": 15,
                "hour": 10,
                "minute": 0,
                "second": 0,
                "latitude": 19.076,
                "longitude": 72.8777,
                "timezone": "Asia/Kolkata"
            }
        }
        """.data(using: .utf8)

    let (data, _) = try await URLSession.shared.data(for: request)
    return try JSONSerialization.jsonObject(with: data) as! [String: Any]
}

import okhttp3.*
import org.json.JSONObject

val client = OkHttpClient()
val JSON = "application/json; charset=utf-8".toMediaType()

fun getAscendant(callback: (JSONObject) -> Unit) {
    val payload = """
    {
        "person1": {
            "name": "Priya",
            "gender": "female",
            "year": 1990,
            "month": 5,
            "day": 20,
            "hour": 14,
            "minute": 30,
            "second": 0,
            "latitude": 28.6139,
            "longitude": 77.209,
            "timezone": "Asia/Kolkata"
        },
        "person2": {
            "name": "Rahul",
            "gender": "male",
            "year": 1992,
            "month": 8,
            "day": 15,
            "hour": 10,
            "minute": 0,
            "second": 0,
            "latitude": 19.076,
            "longitude": 72.8777,
            "timezone": "Asia/Kolkata"
        }
    }
    """.trimIndent()

    val request = Request.Builder()
        .url("https://starsapi.com/api/v3/vedic/matchmaking/match-birth-details")
        .addHeader("X-Api-Key", "YOUR_API_KEY")
        .post(payload.toRequestBody(JSON))
        .build()

    client.newCall(request).enqueue(object : Callback {
        override fun onResponse(call: Call, response: Response) {
            callback(JSONObject(response.body!!.string()))
        }
        override fun onFailure(call: Call, e: java.io.IOException) {
            e.printStackTrace()
        }
    })
}

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "net/http"
    "os"
)

func main() {
    payload, _ := json.Marshal(map[string]interface{}{
        "person1": "Array",
        "person2": "Array",
    })

    req, _ := http.NewRequest("POST",
        "https://starsapi.com/api/v3/vedic/matchmaking/match-birth-details",
        bytes.NewBuffer(payload))
    req.Header.Set("X-Api-Key", os.Getenv("STARSAPI_KEY"))
    req.Header.Set("Content-Type", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()

    var result map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&result)
    fmt.Println(result["data"])
}

require 'net/http'
require 'json'

uri = URI('https://starsapi.com/api/v3/vedic/matchmaking/match-birth-details')
payload = {
  'person1' => 'Array',
  'person2' => 'Array'
}

req = Net::HTTP::Post.new(uri)
req['X-Api-Key'] = ENV['STARSAPI_KEY']
req['Content-Type'] = 'application/json'
req.body = payload.to_json

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
res = http.request(req)

data = JSON.parse(res.body)
puts data['data'] if data['success']

200 RESPONSE

{
  "status": 200,
  "success": true,
  "data": {
    "roles": { "person1": "bride", "person2": "groom" },
    "person1": {
      "name": "Priya",
      "birth_details": { "date": "1990-05-20", "time": "14:30:00", "day": "Sunday", "gender": "female" },
      "location": { "latitude": 28.6139, "longitude": 77.209 },
      "timezone": "Asia/Kolkata",
      "ayanamsa": { "name": "Lahiri", "value": 23.725957, "value_dms": "23°43'33\"" }
    },
    "person2": {
      "name": "Rahul",
      "birth_details": { "date": "1992-08-15", "time": "10:00:00", "day": "Saturday", "gender": "male" },
      "location": { "latitude": 19.076, "longitude": 72.8777 },
      "timezone": "Asia/Kolkata",
      "ayanamsa": { "name": "Lahiri", "value": 23.759133, "value_dms": "23°45'33\"" }
    },
    "node_type": "mean"
  },
  "meta": { "endpoint": "/api/v3/vedic/matchmaking/match-birth-details", "version": "3.0" }
}