How rare a pairing is: for two targets at an instant, the most recent earlier pairing that was at least as close and the next one, searched up to ten years each way; with a location, by default only pairings seen in a dark sky with both targets up count

How rare a pairing is: for two targets at an instant, the most recent earlier pairing that was at least as close and the next one, searched up to ten years each way; with a location, by default only pairings seen in a dark sky with both targets up count. Formats: json, csv, txt. Example: GET /v2/rarity?a=moon&b=jupiter&at=2026-09-08T09:56:30Z&lat=38.9696&lon=-77.3861&elevation_m=100&tz=America/New_York

get/v2/rarity

Request

  • Base URL: https://www.cyclecalcs.com
  • URL: https://www.cyclecalcs.com/v2/rarity
  • Auth: one of:
    • none
    • API key in header X-RapidAPI-Key

Query parameters

astring required

The first target: a body name, a named star (star:<name> or hr:<n>) or a radec: target, in the grammar of bodies above. Required.

bstring required

The second target, in the same grammar as a, and different from it. Required.

atstring

The instant to evaluate. ISO 8601: a date (2026-06-21), or a date and time with an optional seconds, fraction and either Z or a numeric UTC offset (+hh:mm, no seconds). No offset and no tz reads as UTC. Or jd: followed by a Julian Day on the UT scale, read as UTC whatever tz says: jd:2461000.5 is 2025-11-21T00:00:00Z. Reliable from 1700 to 2200.

frame'apparent' | 'geocentric'

The frame the separation is measured in. apparent is the true angle between the two apparent directions, topocentric when lat and lon are given; geocentric ignores the location. No ecliptic-longitude convention is offered here.

span_daysnumber

How far the outward walk runs EACH WAY from at, in days, so the window searched is twice this. The default is the maximum, because "closest in more than ten years" is only true when the whole span was walked.

exclude_daysnumber

visible=any only: a separation minimum closer to at than this belongs to the pass being observed and is never reported as previous or next. Ignored, with a warning, under visible=dark.

visible'dark' | 'any'

Which pairings count. dark, the default with a location, frame=apparent and no Sun: only moments with both targets at least 3 degrees up, refracted, and the Sun at least 6 degrees down; the stretch at is in, both targets above the horizon in daylight or dark and holding one dark night (its own, or the nearer one), at most 18 hours either way, is never previous or next, and a closer moment inside it, in a dark sky, is returned as closer.before or closer.after. any, the default otherwise: every minimum of the separation, above the horizon or not. dark needs a location and frame=apparent and refuses the Sun.

latnumber

Latitude in decimal degrees, north positive. No compass suffix (do not append N or S). Required together with lon, or neither.

lonnumber

Longitude in decimal degrees, east positive. No compass suffix (do not append E or W). Required together with lat, or neither.

elevation_mnumber

Observer elevation above mean sea level, in metres. Raises the observer on a locally flat plateau; sea-horizon dip is not modeled.

placestring

A place name (place=London), a name with a country (place=Cambridge,GB), or a stable identifier from GET /v2/places (place=id:us-n35198-w111651). Supplies lat, lon and, unless tz is also sent, the time zone. Mutually exclusive with sending lat and lon directly. Withheld unless GET /v2 reports capabilities.place_lookup true.

place_strategy'best' | 'error'

best guesses the intended place when a name is ambiguous and reports the guess as a warning. error refuses an ambiguous name with 400 AMBIGUOUS_PLACE and the candidates in supported. Only meaningful with place.

tzstring

An IANA time zone name, for example Europe/London or America/Chicago. Numeric offsets and abbreviations are not accepted. Governs how a date-only or offset-free at/start/end is read, and how local instants are rendered when time_format=iso. Before 1970 the tz database records the history of a zone for its principal location only, and some names are links to another zone: the tz_source_boundary_1970 warning names whose history was used, and tzdb_lmt_interval marks a local mean time. Neither changes an offset.

ambiguous'first' | 'last' | 'error'

How to resolve a local time that a clock repeated, such as the return from daylight saving. error refuses with 409 AMBIGUOUS_LOCAL_TIME.

nonexistent'error' | 'shift_forward' | 'shift_back'

How to resolve a local time that never happened, such as inside a spring-forward gap. error refuses with 400 NONEXISTENT_LOCAL_TIME.

time_format'iso' | 'unix'

How instants are rendered: iso for ISO 8601 strings carrying the effective offset, or unix for integer seconds since the epoch. An ISO offset has no seconds field, so an instant in a pre-1972 local mean time era whose offset has seconds (Moscow +02:30:17 until 1916) is written in UTC with a Z; utc_offset_seconds stays exact, utc_offset_iso rounds it to the nearest minute, and the tzdb_lmt_interval warning says so.

formatstring

Response representation. Each endpoint serves a subset of json, csv and txt; see that operation's description for the exact list, or GET /v2 for every endpoint's formats array. An unsupported value is 400 BAD_FORMAT with the accepted list in supported.

fieldsstring

Comma-separated dot paths into data (for example moon.phase_name,moon.illumination) so only those fields are returned. Up to 64 paths; an array element is addressed by its object key, never by index.

shape'nested' | 'flat'

nested returns the documented object tree. flat returns one object with dotted keys, format=json only.

precisioninteger

Decimal places for numeric fields.

pretty0 | 1

Whether the JSON body is indented (1) or compact (0). Has no effect on csv or txt.

verbosity'full' | 'compact'

full includes prose notes, frame definitions and withheld-field reasons in meta. compact keeps every value and every machine-readable name and drops the prose.

Response

The answer.

endpointstring required

The endpoint path that produced this response.

computed_atstring date-time required

A revision stamp, never a wall clock: identical requests return identical bytes, so a fixed_instant or reference response can be cached for a year and 304 stays reachable.

queryobject required

The request as understood: every resolved input (instant, location, presentation options) plus ignored, in the order spec-00 13.2 defines. Shape is endpoint-specific.

dataunknown required
linksobject required

Related URLs. self reproduces this exact response; docs is always present; others (page, spec, next, first, explain) appear where relevant.

metaobject required

Provenance: engine version, rights and attribution, cache class, accuracy statement, tzdb version, and endpoint-specific conventions (refraction model, horizon definitions, time scales, and so on). Never subject to fields projection.

attributionstring required

The credit line, byte-identical to meta.attribution.text.

docsstring uri required

The human-readable reference section for this endpoint.

Example response

{
  "endpoint": "/v2/sun",
  "computed_at": "2026-08-01T00:00:00.000Z",
  "links": {
    "self": "https://www.cyclecalcs.com/v2/sun?at=2026-06-21&lat=51.4778&lon=-0.0015",
    "docs": "https://www.cyclecalcs.com/api/reference.html#sun",
    "spec": "https://www.cyclecalcs.com/v2/openapi.json",
    "page": "https://www.cyclecalcs.com/sunrise-sunset-calculator.html",
    "explain": "https://www.cyclecalcs.com/learn/seasons.html"
  },
  "attribution": "Computed by CycleCalcs (cyclecalcs.com) with the MIT-licensed Astronomy Engine. Positional astronomy only.",
  "docs": "https://www.cyclecalcs.com/api/reference.html#sun"
}

Changes

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