vedicAPI

Marriage muhurta

Ranked marriage dates for a couple, with their ashtakoota score. The wedding place is required.

POST/muhurta/marriage
Counts as 5 API calls

Heavy call: it does more work, so it counts as 5 API calls on your plan. 15 API calls for a range over 90 days, 25 over 180 days. How API calls are counted

Authentication

Send your API key as a Bearer token. Keys start with sk_live_. Keep keys on your server. More on keys

Authorization: Bearer $VEDICAPI_KEY

Headers

  • Authorization
    Requiredrequired
    DescriptionBearer followed by your API key.
  • X-End-User
    Requiredoptional
    DescriptionYour own id for the person the call is for, up to 64 characters. Shows in Request logs. End-user tags
  • Content-Type
    Requiredrequired
    Descriptionapplication/json

Body parameters

  • boyobjectrequired

    Birth details of the groom. An object with datetime, lat, lon and tz, the same as the birth fields.

    Example {"datetime":"1990-10-21T00:45","lat":28.6139,"lon":77.209,"tz":"Asia/Kolkata"}
    • datetimestringrequired

      Local birth time, ISO 8601 with no offset: 1990-10-21T00:45. Seconds are optional.

    • latnumberrequired

      Latitude of the birth place, -90 to 90.

    • lonnumberrequired

      Longitude of the birth place, -180 to 180.

    • tzstringrequired

      IANA zone (Asia/Kolkata) or an offset (+05:30). Past rule changes and daylight saving are handled.

  • girlobjectrequired

    Birth details of the bride. An object with datetime, lat, lon and tz, the same as the birth fields.

    Example {"datetime":"1991-12-02T14:40","lat":19.076,"lon":72.8777,"tz":"Asia/Kolkata"}
    • datetimestringrequired

      Local birth time, ISO 8601 with no offset: 1990-10-21T00:45. Seconds are optional.

    • latnumberrequired

      Latitude of the birth place, -90 to 90.

    • lonnumberrequired

      Longitude of the birth place, -180 to 180.

    • tzstringrequired

      IANA zone (Asia/Kolkata) or an offset (+05:30). Past rule changes and daylight saving are handled.

  • fromstringrequired

    Start date, YYYY-MM-DD.

    Example 2028-01-01
  • tostringrequired

    End date, up to 366 days from the start.

    Example 2028-12-31
  • latnumberrequired

    Latitude of the wedding place. Or send a place object with lat, lon and tz.

    Example 28.6139
  • lonnumberrequired

    Longitude of the wedding place.

    Example 77.209
  • tzstringrequired

    IANA zone (Asia/Kolkata) or an offset (+05:30). Past rule changes and daylight saving are handled.

    Example Asia/Kolkata
  • langstring

    Language of names and labels: en, hi, mr, bn, te, gu, ta, pa, kn, ml, en_IN (Hinglish) or de. Default en.

    Example en
  • best_availableboolean

    When no day passes every check, return the days that miss one weak point, each with the trade-off named. Default true.

Response

JSON with 200 OK. Every answer carries units (how many API calls this request counts as) and request_id, and the same values in the X-Units and X-Request-Id headers. The example below is the real answer to the request shown.

  • ashtakootaobjectThe couple's guna milan score.
  • best_availablebooleanTrue when no time passed every check and these are the best available.
  • boyobjectFirst person's birth as you sent it.
  • computed_msnumberTime the scan took, in ms.
  • day_killedobjectDays ruled out, by reason.
  • days_scannednumberDays checked.
  • fromstringStart of the range.
  • girlobjectSecond person's birth as you sent it.
  • langstringLanguage of names and labels.
  • season_killedobjectDays ruled out by season (Kharmas, combust Jupiter or Venus and so on).
  • text_langstringLanguage of the longer text. English for now.
  • tostringEnd of the range.
  • trade_offsarrayWhat the best-available windows accept, in plain words.
  • valid_daysnumberDays that passed every check.
  • windowsarrayRanked time windows, best first.
  • unitsnumberHow many API calls this request counts as: 1, or 5 for a heavy call; 0 for errors and free endpoints.
  • request_idstringId of this call. Search it in Request logs. Also sent as the X-Request-Id header.

Errors

  • 400
    Codesinvalid_jsoninvalid_boyinvalid_girlinvalid_placeinvalid_latinvalid_loninvalid_tzinvalid_frominvalid_toinvalid_rangerange_too_longunsupported_langinvalid_end_user
    WhenA field is missing or invalid. The message names the field.
  • 401
    Codesmissing_keyunknown_key
    WhenNo key, or the key is wrong, revoked or past its rotation window.
  • 403
    Codesnot_allowed
    WhenThe key has an allow list and this call came from another IP or domain.
  • 404
    Codesno_such_endpoint
    WhenWrong path or method.
  • 429
    Codesrate_limitedmonthly_limitspend_cap
    WhenOver a limit. Wait the Retry-After seconds before trying again.
  • 503
    Codesbusy
    WhenLong searches are busy. Wait the Retry-After seconds and retry. Nothing is counted.
  • 502
    Codesengine_unavailableengine_error
    WhenOur engine could not answer. Retry with backoff.

Errors are never charged. Every error has one shape: { "error": "<message>", "code": "<code>", "request_id": "req_..." }. Errors and limits