Generate Muhurta Report (PDF or HTML)

POST

/reports/muhurta

curl -X POST https://api.astroway.info/v1/reports/muhurta \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "activity": "marriage", "search_window_start": "2026-05-15", "search_window_end": "2026-06-15", "latitude": 28.61, "longitude": 77.21, "timezoneOffset": 5.5, "topN": 10, "language": "en" }'

const res = await fetch('https://api.astroway.info/v1/reports/muhurta', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "activity": "marriage",
    "search_window_start": "2026-05-15",
    "search_window_end": "2026-06-15",
    "latitude": 28.61,
    "longitude": 77.21,
    "timezoneOffset": 5.5,
    "topN": 10,
    "language": "en"
  }),
});
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/reports/muhurta',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
    json={
      'activity': "marriage",
      'search_window_start': "2026-05-15",
      'search_window_end': "2026-06-15",
      'latitude': 28.61,
      'longitude': 77.21,
      'timezoneOffset': 5.5,
      'topN': 10,
      'language': "en"
    },
)
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('reports/muhurta', [
    'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')],
    'json' => [
        'activity' => 'marriage',
        'search_window_start' => '2026-05-15',
        'search_window_end' => '2026-06-15',
        'latitude' => 28.61,
        'longitude' => 77.21,
        'timezoneOffset' => 5.5,
        'topN' => 10,
        'language' => 'en',
    ],
]);
$result = json_decode($r->getBody(), true);
if (!$result['ok']) throw new \RuntimeException($result['error']['message']);
print_r($result['data']);

Render a standard A4 report of the most auspicious dates for a chosen activity over a search window. Same window-scan engine as /vedic/muhurat/*: it scores each day by sunrise Panchang (Tithi/Vara/Nakshatra/Yoga/Karana) per Muhurta Chintamani + B.V.Raman, and lists ranked days with per-day Abhijit Muhurat and the scoring factors as the rationale. activity is one of the 12 from /muhurta/types. PDF default; ?format=html returns HTML.

Authorizations

ApiKeyAuth

Parameters

Query Parameters

retain_days

integer

default: 1 >= 1 <= 90

How many days the PDF stays at its url. 1 by default; up to 90 for a link you hand to a client. Delete it sooner with DELETE /v1/reports/files/{filename}.

format

string

default: pdf

Allowed values: pdf html markdown

Same switch as the format body field (send one or the other; two different values are a 400). pdf stores a PDF and answers with its url. html returns one self-contained text/html document (inline CSS and drawings, no scripts, no external fonts; the white-label logo stays a link to your https image). markdown returns text/markdown with the same headings, text and tables, drawings left out with a one-line note. Neither html nor markdown is stored, so retain_days does not apply. Same price in every format.

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

object

activity required

string

Allowed values: marriage vehicle-purchase business-start travel naming-ceremony surgery education-start investment property-purchase journey-long name-change general-auspicious

search_window_start required

string

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

search_window_end

string

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

latitude required

number

>= -90 <= 90

longitude required

number

>= -180 <= 180

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.

number

0 nullable >= -14 <= 14

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

topN

integer

default: 10 >= 1 <= 30

language

string

Allowed values: uk en de ru pl es pt hi fr ko it ja id tr nl ro cs vi ar el hu

whitelabel

Any of:

boolean
object

boolean

format

pdf (default) stores a PDF and answers with its url. html returns one self-contained text/html document, markdown returns text/markdown with the same sections and tables; neither is stored. Same price in every format.

string

Allowed values: pdf html markdown

Example

{
  "activity": "marriage",
  "search_window_start": "2026-05-15",
  "search_window_end": "2026-06-15",
  "latitude": 28.61,
  "longitude": 77.21,
  "timezoneOffset": 5.5,
  "topN": 10,
  "language": "en"
}

Responses

200

With format pdf (default): JSON with the stored PDF url and its expires_at. With html or markdown: the document itself, nothing stored.

object

boolean

data

object

url

string

nullable

storage_key

string

nullable

byte_length

number

nullable

page_count

number

nullable

duration_ms

number

nullable

expires_at

string

nullable

Example

{
  "ok": true,
  "data": {
    "url": "https://api.astroway.info/reports/abc-muhurta.pdf",
    "storage_key": "reports/abc-muhurta.pdf",
    "byte_length": 90000,
    "page_count": 2,
    "duration_ms": 5200,
    "expires_at": "2026-06-23T07:00:00Z"
  }
}

string

Example

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><title>Natal Chart Report: Ada</title><style>h1{color:#d4a84c}</style></head><body><h1>Natal Chart Report</h1><p class="subtitle">Prepared for Ada</p><h2>Big Three</h2>...</body></html>

string

Example

# Natal Chart Report

Prepared for Ada

**Birth date:** 1990-05-15 **Birth time:** 14:30:00

## Big Three

Sun · ☉ · Taurus · 24.21°

## Planets

| Planet | Sign | Degree | House | Motion |
| --- | --- | --- | --- | --- |
| Sun | Taurus | 24.21° | 9 | – |

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

Generate Love Report (PDF or HTML)

Next //

Generate Stellaforge Birth-Chart Poster (PDF or HTML)

Generate Muhurta Report (PDF or HTML)

Authorizations

Parameters

Query Parameters

Example

Example

Header Parameters

Example

Request Body required

Example

Responses

200

Example

Example

Example

400

Example

401

Example

Request Body^required