comparative

Calculate Overlay

Return lightweight chart payloads for an overlay across multiple subjects (no aspects).

post/comparative/overlay

Request

  • Base URL: https://api.openephemeris.com
  • URL: https://api.openephemeris.com/comparative/overlay
  • Auth: one of:
    • HTTP bearer
    • API key in header X-OpenEphemeris-API-Key
    • API key in header X-API-Key
    • API key in header X-Service-Key

Query parameters

output_modestring nullable

Deprecated: use preset+format. Accepts full|simple|llm.

formatstring

Request body

include_visualboolean

If true and exactly two subjects are given, also render a bi-wheel (first subject inner, second outer) as SVG or PNG; with more than two subjects the request is rejected. Visuals incur a +2 credit surcharge.

Example request

{
  "subjects": [
    {
      "birth_datetime": {
        "iso": "1990-06-15T14:30:00"
      },
      "birth_location": {
        "latitude": {
          "decimal": 40.7128
        },
        "longitude": {
          "decimal": -74.006
        },
        "timezone": {
          "iana_name": "America/New_York"
        }
      },
      "name": "Alice"
    },
    {
      "birth_datetime": {
        "iso": "1992-02-10T09:15:00"
      },
      "birth_location": {
        "latitude": {
          "decimal": 34.0522
        },
        "longitude": {
          "decimal": -118.2437
        },
        "timezone": {
          "iana_name": "America/Los_Angeles"
        }
      },
      "name": "Bob"
    }
  ]
}

Response

Successful Response

Example response

{
  "calculation_metadata": {
    "technique_id": "natal",
    "technique_label": "Composite (Davison)",
    "technique_method": "davidson",
    "technique_version": "v1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.