@roxyapi/sdk 1.2.60 → 1.2.62
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +1 -1
- package/README.md +1 -1
- package/dist/factory.cjs +3 -3
- package/dist/factory.js +3 -3
- package/dist/sdk.gen.d.ts +2 -2
- package/dist/types.gen.d.ts +585 -128
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/docs/llms-full.txt +24 -2
- package/package.json +1 -1
- package/src/sdk.gen.ts +2 -2
- package/src/types.gen.ts +585 -128
- package/src/version.ts +1 -1
package/dist/types.gen.d.ts
CHANGED
|
@@ -71,6 +71,10 @@ export type NatalChartResponse = {
|
|
|
71
71
|
* Whether the planet is in retrograde motion.
|
|
72
72
|
*/
|
|
73
73
|
isRetrograde: boolean;
|
|
74
|
+
/**
|
|
75
|
+
* Essential dignity of this body in the sign it occupies: domicile (the sign it rules, its strongest placement), exaltation (honoured and amplified), detriment (opposite its rulership, where it struggles), fall (opposite its exaltation, where it is weakened), or peregrine (in none of its own dignity signs). Absent for the lunar nodes, Chiron and Black Moon Lilith, which rule no sign and therefore hold no dignity at all, so an absent field and peregrine are different answers. Derived by sign only, so triplicity, bounds and face are not considered. Always English, whatever the lang parameter says, so it stays safe to compare against in code. The four dignity signs behind it are published per body by GET /planet-meanings/{id}.
|
|
76
|
+
*/
|
|
77
|
+
dignity?: 'domicile' | 'exaltation' | 'detriment' | 'fall' | 'peregrine';
|
|
74
78
|
/**
|
|
75
79
|
* Planet-in-sign-in-house interpretation. Narrative analysis of what this placement means in the natal chart.
|
|
76
80
|
*/
|
|
@@ -163,9 +167,22 @@ export type NatalChartResponse = {
|
|
|
163
167
|
*/
|
|
164
168
|
strength: number;
|
|
165
169
|
/**
|
|
166
|
-
* Aspect nature: harmonious, challenging, or neutral.
|
|
170
|
+
* Aspect nature: harmonious, challenging, or neutral. Always English, whatever the lang parameter says, because it is an identifier to compare and style on. Read aspectInterpretation for the sentence a reader sees.
|
|
167
171
|
*/
|
|
168
172
|
interpretation: string;
|
|
173
|
+
/**
|
|
174
|
+
* Narrative interpretation of this aspect for this chart. The reference description of the aspect TYPE is not repeated per row, use GET or POST /astrology/aspects for that card.
|
|
175
|
+
*/
|
|
176
|
+
aspectInterpretation: {
|
|
177
|
+
/**
|
|
178
|
+
* One-sentence read of THIS pair: which two bodies, how tight the aspect is, whether it is applying or separating, and how it is classified. Translated in place, so it arrives in the requested language.
|
|
179
|
+
*/
|
|
180
|
+
summary: string;
|
|
181
|
+
/**
|
|
182
|
+
* Themes this aspect activates between the two bodies. Translated in place, so they arrive in the requested language.
|
|
183
|
+
*/
|
|
184
|
+
keywords: Array<string>;
|
|
185
|
+
};
|
|
169
186
|
}>;
|
|
170
187
|
/**
|
|
171
188
|
* Detected multi-planet aspect configurations (Grand Trine, Kite, T-Square, Grand Cross, Yod, Mystic Rectangle, Stellium). Grand Cross suppresses contained T-Squares, Kite suppresses underlying Grand Trine.
|
|
@@ -394,6 +411,10 @@ export type NatalChartRequest = {
|
|
|
394
411
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
395
412
|
*/
|
|
396
413
|
timezone: number | string;
|
|
414
|
+
/**
|
|
415
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
416
|
+
*/
|
|
417
|
+
nodeType?: 'mean' | 'true';
|
|
397
418
|
/**
|
|
398
419
|
* House system for dividing the chart into 12 houses. Placidus (default) is most popular in Western astrology and time-sensitive. Whole Sign assigns one sign per house (simpler, ancient). Equal houses divide chart into 30° segments from Ascendant. Koch emphasizes houses in high latitudes.
|
|
399
420
|
*/
|
|
@@ -570,7 +591,7 @@ export type AspectsResponse = {
|
|
|
570
591
|
*/
|
|
571
592
|
strength: number;
|
|
572
593
|
/**
|
|
573
|
-
* Aspect nature: harmonious, challenging, or neutral.
|
|
594
|
+
* Aspect nature for this pair: harmonious, challenging, or neutral. Always English, whatever the lang parameter says, because it is an identifier to compare and style on. This is the field to branch on; meaning.nature is the reference card characterisation of the aspect type and is translated for display.
|
|
574
595
|
*/
|
|
575
596
|
interpretation: string;
|
|
576
597
|
/**
|
|
@@ -599,7 +620,7 @@ export type AspectsResponse = {
|
|
|
599
620
|
*/
|
|
600
621
|
keywords: Array<string>;
|
|
601
622
|
/**
|
|
602
|
-
*
|
|
623
|
+
* How this aspect type is characterised in its reference card, in the requested language, exactly like the name, description and keywords beside it. This is a property of the aspect TYPE, so branch on the aspect-level interpretation field instead, which is always English and is the classification applied to this particular pair.
|
|
603
624
|
*/
|
|
604
625
|
nature: string;
|
|
605
626
|
};
|
|
@@ -796,6 +817,10 @@ export type AspectPatternsRequest = {
|
|
|
796
817
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
797
818
|
*/
|
|
798
819
|
timezone: number | string;
|
|
820
|
+
/**
|
|
821
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
822
|
+
*/
|
|
823
|
+
nodeType?: 'mean' | 'true';
|
|
799
824
|
};
|
|
800
825
|
export type TransitsResponse = {
|
|
801
826
|
/**
|
|
@@ -960,6 +985,10 @@ export type TransitsRequest = {
|
|
|
960
985
|
* Transit timezone: decimal hours from UTC OR IANA name (e.g. "America/New_York"). IANA resolved to the DST-correct offset for the transit date. Defaults to 0 (UTC).
|
|
961
986
|
*/
|
|
962
987
|
timezone?: number | string;
|
|
988
|
+
/**
|
|
989
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
990
|
+
*/
|
|
991
|
+
nodeType?: 'mean' | 'true';
|
|
963
992
|
/**
|
|
964
993
|
* Optional natal chart data to compare transits against
|
|
965
994
|
*/
|
|
@@ -1017,9 +1046,13 @@ export type AstrocartographyResponse = {
|
|
|
1017
1046
|
*/
|
|
1018
1047
|
lines: Array<{
|
|
1019
1048
|
/**
|
|
1020
|
-
* Celestial body this set of planetary lines belongs to.
|
|
1049
|
+
* Celestial body this set of planetary lines belongs to. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use planetLocalized for anything a reader sees.
|
|
1021
1050
|
*/
|
|
1022
1051
|
planet: string;
|
|
1052
|
+
/**
|
|
1053
|
+
* Body name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
1054
|
+
*/
|
|
1055
|
+
planetLocalized?: string;
|
|
1023
1056
|
/**
|
|
1024
1057
|
* Unicode astronomical symbol for this body.
|
|
1025
1058
|
*/
|
|
@@ -1309,7 +1342,7 @@ export type RelocationChartResponse = {
|
|
|
1309
1342
|
};
|
|
1310
1343
|
export type RelocationPlanet = {
|
|
1311
1344
|
/**
|
|
1312
|
-
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee).
|
|
1345
|
+
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee). The nodes follow the request `nodeType`, which defaults to the true (osculating) node; pass "mean" for the smoothed node. The two differ by up to about 1.8 degrees and no other body is affected.
|
|
1313
1346
|
*/
|
|
1314
1347
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
1315
1348
|
/**
|
|
@@ -1431,9 +1464,13 @@ export type LocalSpaceResponse = {
|
|
|
1431
1464
|
*/
|
|
1432
1465
|
bodies: Array<{
|
|
1433
1466
|
/**
|
|
1434
|
-
* Body name (Sun, Moon, Mercury through Pluto, plus North Node, Chiron, or Black Moon Lilith when requested).
|
|
1467
|
+
* Body name (Sun, Moon, Mercury through Pluto, plus North Node, Chiron, or Black Moon Lilith when requested). Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use planetLocalized for anything a reader sees.
|
|
1435
1468
|
*/
|
|
1436
1469
|
planet: string;
|
|
1470
|
+
/**
|
|
1471
|
+
* Body name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
1472
|
+
*/
|
|
1473
|
+
planetLocalized?: string;
|
|
1437
1474
|
/**
|
|
1438
1475
|
* Unicode astronomical symbol for this body.
|
|
1439
1476
|
*/
|
|
@@ -1553,9 +1590,13 @@ export type FixedStarsResponse = {
|
|
|
1553
1590
|
*/
|
|
1554
1591
|
conjunctions: Array<{
|
|
1555
1592
|
/**
|
|
1556
|
-
* Natal point conjunct this star: a planet name, or the chart angles MC and ASC.
|
|
1593
|
+
* Natal point conjunct this star: a planet name, or the chart angles MC and ASC. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use pointLocalized for anything a reader sees.
|
|
1557
1594
|
*/
|
|
1558
1595
|
point: string;
|
|
1596
|
+
/**
|
|
1597
|
+
* Natal point name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
1598
|
+
*/
|
|
1599
|
+
pointLocalized?: string;
|
|
1559
1600
|
/**
|
|
1560
1601
|
* Tropical ecliptic longitude of the natal point in degrees (0-360).
|
|
1561
1602
|
*/
|
|
@@ -1575,9 +1616,13 @@ export type FixedStarsResponse = {
|
|
|
1575
1616
|
*/
|
|
1576
1617
|
star: string;
|
|
1577
1618
|
/**
|
|
1578
|
-
* Natal point conjunct the star: a
|
|
1619
|
+
* Natal point conjunct the star: a planet name, or the chart angles MC and ASC. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use pointLocalized for anything a reader sees.
|
|
1579
1620
|
*/
|
|
1580
1621
|
point: string;
|
|
1622
|
+
/**
|
|
1623
|
+
* Natal point name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
1624
|
+
*/
|
|
1625
|
+
pointLocalized?: string;
|
|
1581
1626
|
/**
|
|
1582
1627
|
* Angular separation in degrees between the star and the natal point.
|
|
1583
1628
|
*/
|
|
@@ -1627,13 +1672,17 @@ export type ArabicLotsResponse = {
|
|
|
1627
1672
|
*/
|
|
1628
1673
|
lots: Array<{
|
|
1629
1674
|
/**
|
|
1630
|
-
* Stable machine identifier for the lot (fortune, spirit, eros, necessity, courage, victory, nemesis). Use this for lookups
|
|
1675
|
+
* Stable machine identifier for the lot (fortune, spirit, eros, necessity, courage, victory, nemesis). Use this for lookups.
|
|
1631
1676
|
*/
|
|
1632
1677
|
id: string;
|
|
1633
1678
|
/**
|
|
1634
|
-
*
|
|
1679
|
+
* Name of the lot. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use nameLocalized for anything a reader sees.
|
|
1635
1680
|
*/
|
|
1636
1681
|
name: string;
|
|
1682
|
+
/**
|
|
1683
|
+
* Lot name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
1684
|
+
*/
|
|
1685
|
+
nameLocalized?: string;
|
|
1637
1686
|
/**
|
|
1638
1687
|
* Absolute tropical ecliptic longitude of the lot in degrees (0 to 360).
|
|
1639
1688
|
*/
|
|
@@ -1681,6 +1730,10 @@ export type ArabicLotsRequest = {
|
|
|
1681
1730
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
1682
1731
|
*/
|
|
1683
1732
|
timezone: number | string;
|
|
1733
|
+
/**
|
|
1734
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
1735
|
+
*/
|
|
1736
|
+
nodeType?: 'mean' | 'true';
|
|
1684
1737
|
/**
|
|
1685
1738
|
* House system used to place the Sun, which determines the chart sect (day when the Sun is above the horizon, night when below) and therefore which lot formula applies. Placidus (default), Whole Sign, Equal, or Koch.
|
|
1686
1739
|
*/
|
|
@@ -1721,9 +1774,13 @@ export type AsteroidsResponse = {
|
|
|
1721
1774
|
*/
|
|
1722
1775
|
asteroids: Array<{
|
|
1723
1776
|
/**
|
|
1724
|
-
*
|
|
1777
|
+
* Name of the asteroid: Ceres, Pallas, Juno, or Vesta. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use nameLocalized for anything a reader sees.
|
|
1725
1778
|
*/
|
|
1726
1779
|
name: string;
|
|
1780
|
+
/**
|
|
1781
|
+
* Asteroid name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
1782
|
+
*/
|
|
1783
|
+
nameLocalized?: string;
|
|
1727
1784
|
/**
|
|
1728
1785
|
* Absolute tropical ecliptic longitude of the asteroid in degrees (0 to 360).
|
|
1729
1786
|
*/
|
|
@@ -1783,6 +1840,10 @@ export type AsteroidsRequest = {
|
|
|
1783
1840
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
1784
1841
|
*/
|
|
1785
1842
|
timezone: number | string;
|
|
1843
|
+
/**
|
|
1844
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
1845
|
+
*/
|
|
1846
|
+
nodeType?: 'mean' | 'true';
|
|
1786
1847
|
/**
|
|
1787
1848
|
* House system used to assign each asteroid to a natal house. Placidus (default), Whole Sign, Equal, or Koch. Above the polar circle, quadrant systems fall back to Whole Sign and the echoed houseSystem reports the system actually used.
|
|
1788
1849
|
*/
|
|
@@ -1823,9 +1884,13 @@ export type LilithResponse = {
|
|
|
1823
1884
|
*/
|
|
1824
1885
|
lilith: Array<{
|
|
1825
1886
|
/**
|
|
1826
|
-
* Which lunar apogee this entry describes
|
|
1887
|
+
* Which lunar apogee this entry describes. The mean variant is the smoothed average apogee; the true variant is the instantaneous osculating apogee. Always one of these two English literals, whatever the lang parameter says, so it stays safe to compare against in code. Use variantLocalized for anything a reader sees.
|
|
1827
1888
|
*/
|
|
1828
|
-
variant:
|
|
1889
|
+
variant: 'mean' | 'true';
|
|
1890
|
+
/**
|
|
1891
|
+
* Apogee variant label in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
1892
|
+
*/
|
|
1893
|
+
variantLocalized?: string;
|
|
1829
1894
|
/**
|
|
1830
1895
|
* Absolute tropical ecliptic longitude of the apogee in degrees (0 to 360).
|
|
1831
1896
|
*/
|
|
@@ -1889,6 +1954,10 @@ export type LilithRequest = {
|
|
|
1889
1954
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
1890
1955
|
*/
|
|
1891
1956
|
timezone: number | string;
|
|
1957
|
+
/**
|
|
1958
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
1959
|
+
*/
|
|
1960
|
+
nodeType?: 'mean' | 'true';
|
|
1892
1961
|
/**
|
|
1893
1962
|
* House system used to place each Lilith variant in a house. Placidus (default), Whole Sign, Equal, or Koch.
|
|
1894
1963
|
*/
|
|
@@ -2045,6 +2114,10 @@ export type ProgressionsRequest = {
|
|
|
2045
2114
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
2046
2115
|
*/
|
|
2047
2116
|
timezone: number | string;
|
|
2117
|
+
/**
|
|
2118
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
2119
|
+
*/
|
|
2120
|
+
nodeType?: 'mean' | 'true';
|
|
2048
2121
|
/**
|
|
2049
2122
|
* Date to progress the chart to, in YYYY-MM-DD format. Usually today or a forecast date. The day-for-a-year key turns the elapsed years since birth into the same number of ephemeris days after the birth moment.
|
|
2050
2123
|
*/
|
|
@@ -2093,9 +2166,13 @@ export type SolarArcResponse = {
|
|
|
2093
2166
|
*/
|
|
2094
2167
|
directed: Array<{
|
|
2095
2168
|
/**
|
|
2096
|
-
* Name of the directed point,
|
|
2169
|
+
* Name of the directed point, covering the planets and the two angles, the Ascendant and the Midheaven, alike. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use nameLocalized for anything a reader sees.
|
|
2097
2170
|
*/
|
|
2098
2171
|
name: string;
|
|
2172
|
+
/**
|
|
2173
|
+
* Directed point name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
2174
|
+
*/
|
|
2175
|
+
nameLocalized?: string;
|
|
2099
2176
|
/**
|
|
2100
2177
|
* Absolute tropical ecliptic longitude of the point in the natal chart, in degrees (0 to 360).
|
|
2101
2178
|
*/
|
|
@@ -2139,6 +2216,10 @@ export type SolarArcRequest = {
|
|
|
2139
2216
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
2140
2217
|
*/
|
|
2141
2218
|
timezone: number | string;
|
|
2219
|
+
/**
|
|
2220
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
2221
|
+
*/
|
|
2222
|
+
nodeType?: 'mean' | 'true';
|
|
2142
2223
|
/**
|
|
2143
2224
|
* Date to direct the chart to, in YYYY-MM-DD format. Every natal point is advanced by the solar arc accumulated from birth to this date, about one degree for each year of life.
|
|
2144
2225
|
*/
|
|
@@ -2233,6 +2314,10 @@ export type ProfectionsRequest = {
|
|
|
2233
2314
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
2234
2315
|
*/
|
|
2235
2316
|
timezone: number | string;
|
|
2317
|
+
/**
|
|
2318
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
2319
|
+
*/
|
|
2320
|
+
nodeType?: 'mean' | 'true';
|
|
2236
2321
|
/**
|
|
2237
2322
|
* Date whose profection year you want, in YYYY-MM-DD format. The completed whole years from the birth date to this date select the profected house and sign. Must fall on or after the birth date.
|
|
2238
2323
|
*/
|
|
@@ -4358,7 +4443,7 @@ export type KpPlanetsRequest = {
|
|
|
4358
4443
|
*/
|
|
4359
4444
|
ayanamsaValue?: number;
|
|
4360
4445
|
/**
|
|
4361
|
-
* Lunar node
|
|
4446
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the Rahu and Ketu positions. Mean is the traditional Vedic default and what printed panchangs use; the choice can move a KP sub-lord in narrow boundary cases, where a span can be as small as 0.5 degrees. Defaults to "mean".
|
|
4362
4447
|
*/
|
|
4363
4448
|
nodeType?: 'mean' | 'true';
|
|
4364
4449
|
};
|
|
@@ -4812,7 +4897,7 @@ export type KpChartRequest = {
|
|
|
4812
4897
|
*/
|
|
4813
4898
|
ayanamsaValue?: number;
|
|
4814
4899
|
/**
|
|
4815
|
-
* Lunar node
|
|
4900
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the Rahu and Ketu positions. Mean is the traditional Vedic default and what printed panchangs use; the choice can move a KP sub-lord in narrow boundary cases, where a span can be as small as 0.5 degrees. Defaults to "mean".
|
|
4816
4901
|
*/
|
|
4817
4902
|
nodeType?: 'mean' | 'true';
|
|
4818
4903
|
};
|
|
@@ -5182,7 +5267,7 @@ export type KpSublordChangesRequest = {
|
|
|
5182
5267
|
*/
|
|
5183
5268
|
ayanamsa?: 'kp-newcomb' | 'kp-old' | 'lahiri' | 'raman';
|
|
5184
5269
|
/**
|
|
5185
|
-
* Lunar node
|
|
5270
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the Rahu and Ketu positions. Mean is the traditional Vedic default and what printed panchangs use; the choice can move a KP sub-lord in narrow boundary cases, where a span can be as small as 0.5 degrees. Defaults to "mean".
|
|
5186
5271
|
*/
|
|
5187
5272
|
nodeType?: 'mean' | 'true';
|
|
5188
5273
|
};
|
|
@@ -5259,7 +5344,7 @@ export type KpRasiChangesRequest = {
|
|
|
5259
5344
|
*/
|
|
5260
5345
|
ayanamsa?: 'kp-newcomb' | 'kp-old' | 'lahiri' | 'raman';
|
|
5261
5346
|
/**
|
|
5262
|
-
* Lunar node
|
|
5347
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the Rahu and Ketu positions. Mean is the traditional Vedic default and what printed panchangs use; the choice can move a KP sub-lord in narrow boundary cases, where a span can be as small as 0.5 degrees. Defaults to "mean".
|
|
5263
5348
|
*/
|
|
5264
5349
|
nodeType?: 'mean' | 'true';
|
|
5265
5350
|
};
|
|
@@ -5383,7 +5468,7 @@ export type KpPlanetsIntervalRequest = {
|
|
|
5383
5468
|
*/
|
|
5384
5469
|
ayanamsa?: 'kp-newcomb' | 'kp-old' | 'lahiri' | 'raman';
|
|
5385
5470
|
/**
|
|
5386
|
-
* Lunar node
|
|
5471
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the Rahu and Ketu positions. Mean is the traditional Vedic default and what printed panchangs use; the choice can move a KP sub-lord in narrow boundary cases, where a span can be as small as 0.5 degrees. Defaults to "mean".
|
|
5387
5472
|
*/
|
|
5388
5473
|
nodeType?: 'mean' | 'true';
|
|
5389
5474
|
};
|
|
@@ -5665,7 +5750,7 @@ export type KpHoraryRequest = {
|
|
|
5665
5750
|
*/
|
|
5666
5751
|
ayanamsaValue?: number;
|
|
5667
5752
|
/**
|
|
5668
|
-
* Lunar node
|
|
5753
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the Rahu and Ketu positions. Mean is the traditional Vedic default and what printed panchangs use; the choice can move a KP sub-lord in narrow boundary cases, where a span can be as small as 0.5 degrees. Defaults to "mean".
|
|
5669
5754
|
*/
|
|
5670
5755
|
nodeType?: 'mean' | 'true';
|
|
5671
5756
|
};
|
|
@@ -7406,9 +7491,13 @@ export type GetAstrologySignsResponses = {
|
|
|
7406
7491
|
*/
|
|
7407
7492
|
symbol?: string;
|
|
7408
7493
|
/**
|
|
7409
|
-
* Elemental classification:
|
|
7494
|
+
* Elemental classification: fire, earth, air, or water. Always one of these four English literals, whatever the lang parameter says, so it stays safe to compare against in code. Use elementLocalized for anything a reader sees.
|
|
7410
7495
|
*/
|
|
7411
7496
|
element: 'fire' | 'earth' | 'air' | 'water';
|
|
7497
|
+
/**
|
|
7498
|
+
* Element name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
7499
|
+
*/
|
|
7500
|
+
elementLocalized?: string;
|
|
7412
7501
|
/**
|
|
7413
7502
|
* Tropical zodiac date range for this sign.
|
|
7414
7503
|
*/
|
|
@@ -7582,17 +7671,29 @@ export type GetAstrologySignsByIdResponses = {
|
|
|
7582
7671
|
*/
|
|
7583
7672
|
symbolName: string;
|
|
7584
7673
|
/**
|
|
7585
|
-
* Elemental classification:
|
|
7674
|
+
* Elemental classification: fire, earth, air, or water. Determines temperament and compatibility group. Always one of these four English literals, whatever the lang parameter says, so it stays safe to compare against in code. Use elementLocalized for anything a reader sees.
|
|
7586
7675
|
*/
|
|
7587
7676
|
element: 'fire' | 'earth' | 'air' | 'water';
|
|
7588
7677
|
/**
|
|
7589
|
-
*
|
|
7678
|
+
* Element name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
7679
|
+
*/
|
|
7680
|
+
elementLocalized?: string;
|
|
7681
|
+
/**
|
|
7682
|
+
* Quality/modality: cardinal (initiating), fixed (sustaining), or mutable (adapting). Always one of these three English literals, whatever the lang parameter says, so it stays safe to compare against in code. Use modalityLocalized for anything a reader sees.
|
|
7590
7683
|
*/
|
|
7591
7684
|
modality: 'cardinal' | 'fixed' | 'mutable';
|
|
7592
7685
|
/**
|
|
7593
|
-
*
|
|
7686
|
+
* Modality name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
7687
|
+
*/
|
|
7688
|
+
modalityLocalized?: string;
|
|
7689
|
+
/**
|
|
7690
|
+
* Traditional ruling planet that governs this sign. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use rulingPlanetLocalized for anything a reader sees.
|
|
7594
7691
|
*/
|
|
7595
7692
|
rulingPlanet: string;
|
|
7693
|
+
/**
|
|
7694
|
+
* Ruling planet name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
7695
|
+
*/
|
|
7696
|
+
rulingPlanetLocalized?: string;
|
|
7596
7697
|
/**
|
|
7597
7698
|
* Tropical zodiac date range for this sign.
|
|
7598
7699
|
*/
|
|
@@ -8150,6 +8251,10 @@ export type PostAstrologyPlanetsData = {
|
|
|
8150
8251
|
* Time in 24-hour HH:MM:SS format for precise calculations. Moon moves ~13° per day, so time matters for accurate lunar position. Use 12:00:00 (noon) as default if exact time not needed.
|
|
8151
8252
|
*/
|
|
8152
8253
|
time: string;
|
|
8254
|
+
/**
|
|
8255
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
8256
|
+
*/
|
|
8257
|
+
nodeType?: 'mean' | 'true';
|
|
8153
8258
|
/**
|
|
8154
8259
|
* Observer latitude in decimal degrees (-90 to 90). While planetary longitudes are geocentric (same worldwide), this is needed for house calculations if extending functionality. For basic ephemeris, use 0 as default.
|
|
8155
8260
|
*/
|
|
@@ -9046,6 +9151,10 @@ export type PostAstrologySynastryData = {
|
|
|
9046
9151
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
9047
9152
|
*/
|
|
9048
9153
|
timezone: number | string;
|
|
9154
|
+
/**
|
|
9155
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
9156
|
+
*/
|
|
9157
|
+
nodeType?: 'mean' | 'true';
|
|
9049
9158
|
/**
|
|
9050
9159
|
* Optional display name for this person. Included in the response for easy identification.
|
|
9051
9160
|
*/
|
|
@@ -9072,6 +9181,10 @@ export type PostAstrologySynastryData = {
|
|
|
9072
9181
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
9073
9182
|
*/
|
|
9074
9183
|
timezone: number | string;
|
|
9184
|
+
/**
|
|
9185
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
9186
|
+
*/
|
|
9187
|
+
nodeType?: 'mean' | 'true';
|
|
9075
9188
|
/**
|
|
9076
9189
|
* Optional display name for this person. Included in the response for easy identification.
|
|
9077
9190
|
*/
|
|
@@ -9430,7 +9543,7 @@ export type PostAstrologySynastryResponses = {
|
|
|
9430
9543
|
*/
|
|
9431
9544
|
keywords: Array<string>;
|
|
9432
9545
|
/**
|
|
9433
|
-
*
|
|
9546
|
+
* How this aspect type is characterised in its reference card, in the requested language, exactly like the name, description and keywords beside it. Branch on the aspect-level interpretation field instead, which is always English.
|
|
9434
9547
|
*/
|
|
9435
9548
|
nature: string;
|
|
9436
9549
|
/**
|
|
@@ -10025,6 +10138,10 @@ export type PostAstrologyTransitAspectsData = {
|
|
|
10025
10138
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
10026
10139
|
*/
|
|
10027
10140
|
timezone: number | string;
|
|
10141
|
+
/**
|
|
10142
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
10143
|
+
*/
|
|
10144
|
+
nodeType?: 'mean' | 'true';
|
|
10028
10145
|
};
|
|
10029
10146
|
/**
|
|
10030
10147
|
* Transit date in YYYY-MM-DD format. Defaults to current date if omitted. Use future dates for predictive transit analysis.
|
|
@@ -10175,12 +10292,58 @@ export type PostAstrologyTransitAspectsResponses = {
|
|
|
10175
10292
|
* House system actually used for the natal cusps behind every house number in this response. Differs from the requested system only above the polar circle, where quadrant systems fall back to Whole Sign.
|
|
10176
10293
|
*/
|
|
10177
10294
|
houseSystem: 'placidus' | 'whole-sign' | 'equal' | 'koch';
|
|
10295
|
+
/**
|
|
10296
|
+
* The twelve NATAL house cusps that every house number in this response is read against, in the house system named by houseSystem. Same shape as the natal-chart houses array, so a bi-wheel can be drawn with real house sectors from this one response instead of pairing it with a second call.
|
|
10297
|
+
*/
|
|
10298
|
+
houses: Array<{
|
|
10299
|
+
/**
|
|
10300
|
+
* House number (1-12). Each house governs specific life themes in Western astrology.
|
|
10301
|
+
*/
|
|
10302
|
+
number: number;
|
|
10303
|
+
/**
|
|
10304
|
+
* Ecliptic longitude of this house cusp in degrees (0-360).
|
|
10305
|
+
*/
|
|
10306
|
+
longitude: number;
|
|
10307
|
+
/**
|
|
10308
|
+
* Zodiac sign on this house cusp. Colors the themes of this life area.
|
|
10309
|
+
*/
|
|
10310
|
+
sign: string;
|
|
10311
|
+
/**
|
|
10312
|
+
* Degree within the zodiac sign on this cusp (0-29.999).
|
|
10313
|
+
*/
|
|
10314
|
+
degree: number;
|
|
10315
|
+
/**
|
|
10316
|
+
* Zodiac sign name on this cusp in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
10317
|
+
*/
|
|
10318
|
+
signLocalized?: string;
|
|
10319
|
+
}>;
|
|
10320
|
+
/**
|
|
10321
|
+
* The natal Ascendant (rising sign): the eastern horizon at birth, and the left-hand horizon a chart wheel is oriented to. Reported alongside the cusps because the two are not the same longitude in every house system: Whole Sign puts the first cusp at 0 degrees of the rising sign, which can sit most of a sign away from the Ascendant itself.
|
|
10322
|
+
*/
|
|
10323
|
+
ascendant: {
|
|
10324
|
+
/**
|
|
10325
|
+
* Tropical zodiac sign on the natal Ascendant. Always English, whatever the lang parameter says. Use signLocalized for anything a reader sees.
|
|
10326
|
+
*/
|
|
10327
|
+
sign: string;
|
|
10328
|
+
/**
|
|
10329
|
+
* Ascendant sign name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
10330
|
+
*/
|
|
10331
|
+
signLocalized?: string;
|
|
10332
|
+
/**
|
|
10333
|
+
* Degree within the Ascendant sign (0-29.999).
|
|
10334
|
+
*/
|
|
10335
|
+
degree: number;
|
|
10336
|
+
/**
|
|
10337
|
+
* Absolute ecliptic longitude of the natal Ascendant in degrees (0-360).
|
|
10338
|
+
*/
|
|
10339
|
+
longitude: number;
|
|
10340
|
+
};
|
|
10178
10341
|
/**
|
|
10179
10342
|
* Current transiting positions in the tropical zodiac, each placed in the natal house it is passing through. All 14 celestial bodies: the 10 classical planets (Sun through Pluto), the lunar nodes, Chiron, and Black Moon Lilith.
|
|
10180
10343
|
*/
|
|
10181
10344
|
transitPlanets: Array<{
|
|
10182
10345
|
/**
|
|
10183
|
-
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee).
|
|
10346
|
+
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee). The nodes follow the request `nodeType`, which defaults to the true (osculating) node; pass "mean" for the smoothed node. The two differ by up to about 1.8 degrees and no other body is affected.
|
|
10184
10347
|
*/
|
|
10185
10348
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
10186
10349
|
/**
|
|
@@ -10225,7 +10388,7 @@ export type PostAstrologyTransitAspectsResponses = {
|
|
|
10225
10388
|
*/
|
|
10226
10389
|
natalPlanets: Array<{
|
|
10227
10390
|
/**
|
|
10228
|
-
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee).
|
|
10391
|
+
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee). The nodes follow the request `nodeType`, which defaults to the true (osculating) node; pass "mean" for the smoothed node. The two differ by up to about 1.8 degrees and no other body is affected.
|
|
10229
10392
|
*/
|
|
10230
10393
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
10231
10394
|
/**
|
|
@@ -10298,7 +10461,7 @@ export type PostAstrologyTransitAspectsResponses = {
|
|
|
10298
10461
|
*/
|
|
10299
10462
|
strength: number;
|
|
10300
10463
|
/**
|
|
10301
|
-
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
|
|
10464
|
+
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
|
|
10302
10465
|
*/
|
|
10303
10466
|
interpretation: 'harmonious' | 'challenging' | 'neutral';
|
|
10304
10467
|
/**
|
|
@@ -10313,7 +10476,10 @@ export type PostAstrologyTransitAspectsResponses = {
|
|
|
10313
10476
|
* Aspect type name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
10314
10477
|
*/
|
|
10315
10478
|
typeLocalized?: string;
|
|
10316
|
-
|
|
10479
|
+
/**
|
|
10480
|
+
* Rich interpretation of the transit aspect: narrative summary, timing, impact assessment, practical guidance, and keywords.
|
|
10481
|
+
*/
|
|
10482
|
+
transitInterpretation: {
|
|
10317
10483
|
/**
|
|
10318
10484
|
* Narrative interpretation of this transit aspect and its life impact.
|
|
10319
10485
|
*/
|
|
@@ -10389,7 +10555,7 @@ export type PostAstrologyTransitAspectsResponses = {
|
|
|
10389
10555
|
*/
|
|
10390
10556
|
strength: number;
|
|
10391
10557
|
/**
|
|
10392
|
-
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
|
|
10558
|
+
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
|
|
10393
10559
|
*/
|
|
10394
10560
|
interpretation: 'harmonious' | 'challenging' | 'neutral';
|
|
10395
10561
|
/**
|
|
@@ -10404,6 +10570,31 @@ export type PostAstrologyTransitAspectsResponses = {
|
|
|
10404
10570
|
* Aspect type name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
10405
10571
|
*/
|
|
10406
10572
|
typeLocalized?: string;
|
|
10573
|
+
/**
|
|
10574
|
+
* Rich interpretation of the transit aspect: narrative summary, timing, impact assessment, practical guidance, and keywords.
|
|
10575
|
+
*/
|
|
10576
|
+
transitInterpretation: {
|
|
10577
|
+
/**
|
|
10578
|
+
* Narrative interpretation of this transit aspect and its life impact.
|
|
10579
|
+
*/
|
|
10580
|
+
summary: string;
|
|
10581
|
+
/**
|
|
10582
|
+
* When this transit is most active and how long its influence lasts, localized. The bucket follows the speed of the transiting body: a few hours for the Moon, a few days for the Sun, Mercury, Venus and Mars, one to two weeks for Jupiter, several weeks for Saturn, and an extended period for Uranus, Neptune and Pluto.
|
|
10583
|
+
*/
|
|
10584
|
+
timing: string;
|
|
10585
|
+
/**
|
|
10586
|
+
* Strength and nature of this transit effect — constructive, challenging, or neutral.
|
|
10587
|
+
*/
|
|
10588
|
+
impact: string;
|
|
10589
|
+
/**
|
|
10590
|
+
* Practical advice for working with this transit energy.
|
|
10591
|
+
*/
|
|
10592
|
+
guidance: string;
|
|
10593
|
+
/**
|
|
10594
|
+
* Key themes activated by this transit aspect.
|
|
10595
|
+
*/
|
|
10596
|
+
keywords: Array<string>;
|
|
10597
|
+
};
|
|
10407
10598
|
} | null;
|
|
10408
10599
|
/**
|
|
10409
10600
|
* Transit aspect counts grouped by aspect type (conjunction, trine, square, opposition, sextile, etc.). Useful for quickly assessing the transit weather.
|
|
@@ -10621,11 +10812,11 @@ export type PostAstrologySolarReturnResponses = {
|
|
|
10621
10812
|
timezone: number;
|
|
10622
10813
|
};
|
|
10623
10814
|
/**
|
|
10624
|
-
* All 14 celestial bodies in the tropical zodiac with house placements: the 10 classical planets (Sun through Pluto), the lunar nodes (North Node, South Node), Chiron, and Black Moon Lilith.
|
|
10815
|
+
* All 14 celestial bodies in the tropical zodiac with house placements: the 10 classical planets (Sun through Pluto), the lunar nodes (North Node, South Node, in the requested `nodeType` convention), Chiron, and Black Moon Lilith.
|
|
10625
10816
|
*/
|
|
10626
10817
|
planets: Array<{
|
|
10627
10818
|
/**
|
|
10628
|
-
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee).
|
|
10819
|
+
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee). The nodes follow the request `nodeType`, which defaults to the true (osculating) node; pass "mean" for the smoothed node. The two differ by up to about 1.8 degrees and no other body is affected.
|
|
10629
10820
|
*/
|
|
10630
10821
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
10631
10822
|
/**
|
|
@@ -10715,7 +10906,7 @@ export type PostAstrologySolarReturnResponses = {
|
|
|
10715
10906
|
*/
|
|
10716
10907
|
strength: number;
|
|
10717
10908
|
/**
|
|
10718
|
-
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
|
|
10909
|
+
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
|
|
10719
10910
|
*/
|
|
10720
10911
|
interpretation: 'harmonious' | 'challenging' | 'neutral';
|
|
10721
10912
|
}>;
|
|
@@ -10997,11 +11188,11 @@ export type PostAstrologyLunarReturnResponses = {
|
|
|
10997
11188
|
timezone: number;
|
|
10998
11189
|
};
|
|
10999
11190
|
/**
|
|
11000
|
-
* All 14 celestial bodies in the tropical zodiac with house placements: the 10 classical planets (Sun through Pluto), the lunar nodes (North Node, South Node), Chiron, and Black Moon Lilith.
|
|
11191
|
+
* All 14 celestial bodies in the tropical zodiac with house placements: the 10 classical planets (Sun through Pluto), the lunar nodes (North Node, South Node, in the requested `nodeType` convention), Chiron, and Black Moon Lilith.
|
|
11001
11192
|
*/
|
|
11002
11193
|
planets: Array<{
|
|
11003
11194
|
/**
|
|
11004
|
-
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee).
|
|
11195
|
+
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee). The nodes follow the request `nodeType`, which defaults to the true (osculating) node; pass "mean" for the smoothed node. The two differ by up to about 1.8 degrees and no other body is affected.
|
|
11005
11196
|
*/
|
|
11006
11197
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
11007
11198
|
/**
|
|
@@ -11091,7 +11282,7 @@ export type PostAstrologyLunarReturnResponses = {
|
|
|
11091
11282
|
*/
|
|
11092
11283
|
strength: number;
|
|
11093
11284
|
/**
|
|
11094
|
-
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
|
|
11285
|
+
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
|
|
11095
11286
|
*/
|
|
11096
11287
|
interpretation: 'harmonious' | 'challenging' | 'neutral';
|
|
11097
11288
|
}>;
|
|
@@ -11197,6 +11388,10 @@ export type PostAstrologyCompositeChartData = {
|
|
|
11197
11388
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
11198
11389
|
*/
|
|
11199
11390
|
timezone: number | string;
|
|
11391
|
+
/**
|
|
11392
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
11393
|
+
*/
|
|
11394
|
+
nodeType?: 'mean' | 'true';
|
|
11200
11395
|
};
|
|
11201
11396
|
/**
|
|
11202
11397
|
* Second person birth details (date, time, location, timezone).
|
|
@@ -11222,6 +11417,10 @@ export type PostAstrologyCompositeChartData = {
|
|
|
11222
11417
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
11223
11418
|
*/
|
|
11224
11419
|
timezone: number | string;
|
|
11420
|
+
/**
|
|
11421
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
11422
|
+
*/
|
|
11423
|
+
nodeType?: 'mean' | 'true';
|
|
11225
11424
|
};
|
|
11226
11425
|
/**
|
|
11227
11426
|
* House system for the composite chart. Placidus (default), Whole Sign, Equal, or Koch.
|
|
@@ -11399,7 +11598,7 @@ export type PostAstrologyCompositeChartResponses = {
|
|
|
11399
11598
|
*/
|
|
11400
11599
|
compositePlanets: Array<{
|
|
11401
11600
|
/**
|
|
11402
|
-
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee).
|
|
11601
|
+
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee). The nodes follow the request `nodeType`, which defaults to the true (osculating) node; pass "mean" for the smoothed node. The two differ by up to about 1.8 degrees and no other body is affected.
|
|
11403
11602
|
*/
|
|
11404
11603
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
11405
11604
|
/**
|
|
@@ -11536,7 +11735,7 @@ export type PostAstrologyCompositeChartResponses = {
|
|
|
11536
11735
|
*/
|
|
11537
11736
|
strength: number;
|
|
11538
11737
|
/**
|
|
11539
|
-
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
|
|
11738
|
+
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
|
|
11540
11739
|
*/
|
|
11541
11740
|
interpretation: 'harmonious' | 'challenging' | 'neutral';
|
|
11542
11741
|
}>;
|
|
@@ -11586,6 +11785,10 @@ export type PostAstrologyCompatibilityScoreData = {
|
|
|
11586
11785
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
11587
11786
|
*/
|
|
11588
11787
|
timezone: number | string;
|
|
11788
|
+
/**
|
|
11789
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
11790
|
+
*/
|
|
11791
|
+
nodeType?: 'mean' | 'true';
|
|
11589
11792
|
};
|
|
11590
11793
|
/**
|
|
11591
11794
|
* Second person birth details. Compared against person1 to evaluate inter-chart aspects and compatibility.
|
|
@@ -11611,6 +11814,10 @@ export type PostAstrologyCompatibilityScoreData = {
|
|
|
11611
11814
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
11612
11815
|
*/
|
|
11613
11816
|
timezone: number | string;
|
|
11817
|
+
/**
|
|
11818
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
11819
|
+
*/
|
|
11820
|
+
nodeType?: 'mean' | 'true';
|
|
11614
11821
|
};
|
|
11615
11822
|
};
|
|
11616
11823
|
path?: never;
|
|
@@ -12881,11 +13088,11 @@ export type PostAstrologyPlanetaryReturnsResponses = {
|
|
|
12881
13088
|
timezone: number;
|
|
12882
13089
|
};
|
|
12883
13090
|
/**
|
|
12884
|
-
* All 14 celestial bodies in the tropical zodiac with house placements: the 10 classical planets (Sun through Pluto), the lunar nodes (North Node, South Node), Chiron, and Black Moon Lilith.
|
|
13091
|
+
* All 14 celestial bodies in the tropical zodiac with house placements: the 10 classical planets (Sun through Pluto), the lunar nodes (North Node, South Node, in the requested `nodeType` convention), Chiron, and Black Moon Lilith.
|
|
12885
13092
|
*/
|
|
12886
13093
|
planets: Array<{
|
|
12887
13094
|
/**
|
|
12888
|
-
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee).
|
|
13095
|
+
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee). The nodes follow the request `nodeType`, which defaults to the true (osculating) node; pass "mean" for the smoothed node. The two differ by up to about 1.8 degrees and no other body is affected.
|
|
12889
13096
|
*/
|
|
12890
13097
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
12891
13098
|
/**
|
|
@@ -12975,7 +13182,7 @@ export type PostAstrologyPlanetaryReturnsResponses = {
|
|
|
12975
13182
|
*/
|
|
12976
13183
|
strength: number;
|
|
12977
13184
|
/**
|
|
12978
|
-
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
|
|
13185
|
+
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
|
|
12979
13186
|
*/
|
|
12980
13187
|
interpretation: 'harmonious' | 'challenging' | 'neutral';
|
|
12981
13188
|
}>;
|
|
@@ -13073,6 +13280,10 @@ export type PostAstrologyAstrocartographyData = {
|
|
|
13073
13280
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
13074
13281
|
*/
|
|
13075
13282
|
timezone: number | string;
|
|
13283
|
+
/**
|
|
13284
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
13285
|
+
*/
|
|
13286
|
+
nodeType?: 'mean' | 'true';
|
|
13076
13287
|
};
|
|
13077
13288
|
path?: never;
|
|
13078
13289
|
query?: {
|
|
@@ -13483,6 +13694,10 @@ export type PostAstrologyFixedStarsData = {
|
|
|
13483
13694
|
* Timezone: IANA name (e.g. "America/New_York", "Europe/London") OR decimal hours from UTC (e.g. -5 for EST, 1 for CET). IANA strings are resolved to the DST-correct offset for the given date, so you can pass `cities[0].timezone` from /location/search directly.
|
|
13484
13695
|
*/
|
|
13485
13696
|
timezone: number | string;
|
|
13697
|
+
/**
|
|
13698
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node. True is what most Western software reports (Astrolabe, Cafe Astrology, TimePassages), which is why it is the default here; astro-seek and the Steven Forrest evolutionary school use mean, so pass "mean" to match those. Nothing else in the chart changes, and the two agree on the sign except when the node sits within about 1.8 degrees of a cusp. Defaults to "true".
|
|
13699
|
+
*/
|
|
13700
|
+
nodeType?: 'mean' | 'true';
|
|
13486
13701
|
};
|
|
13487
13702
|
path?: never;
|
|
13488
13703
|
query?: {
|
|
@@ -20438,7 +20653,7 @@ export type PostVedicAstrologyKpRulingPlanetsData = {
|
|
|
20438
20653
|
*/
|
|
20439
20654
|
birthTime?: string;
|
|
20440
20655
|
/**
|
|
20441
|
-
* Lunar node
|
|
20656
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the Rahu and Ketu positions. Mean is the traditional Vedic default and what printed panchangs use; the choice can move a KP sub-lord in narrow boundary cases, where a span can be as small as 0.5 degrees. Defaults to "mean".
|
|
20442
20657
|
*/
|
|
20443
20658
|
nodeType?: 'mean' | 'true';
|
|
20444
20659
|
};
|
|
@@ -20595,7 +20810,7 @@ export type PostVedicAstrologyKpRulingPlanetsIntervalData = {
|
|
|
20595
20810
|
*/
|
|
20596
20811
|
ayanamsa?: 'kp-newcomb' | 'kp-old' | 'lahiri' | 'raman';
|
|
20597
20812
|
/**
|
|
20598
|
-
* Lunar node
|
|
20813
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the Rahu and Ketu positions. Mean is the traditional Vedic default and what printed panchangs use; the choice can move a KP sub-lord in narrow boundary cases, where a span can be as small as 0.5 degrees. Defaults to "mean".
|
|
20599
20814
|
*/
|
|
20600
20815
|
nodeType?: 'mean' | 'true';
|
|
20601
20816
|
};
|
|
@@ -21964,6 +22179,19 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
21964
22179
|
* Transit analysis calculated successfully
|
|
21965
22180
|
*/
|
|
21966
22181
|
200: {
|
|
22182
|
+
/**
|
|
22183
|
+
* The zodiac frame every longitude in this response was computed in, so a cached or forwarded payload is self describing. Sidereal requests report the Lahiri ayanamsa, read at the birth instant; the transit positions use the same named frame resolved at their own instant, which moves by about 50 arcseconds a year. A tropical request reports "tropical" with 0 degrees subtracted, which is the one case a Vedic table can otherwise be rendered in the wrong zodiac with nothing on screen saying so.
|
|
22184
|
+
*/
|
|
22185
|
+
frame: {
|
|
22186
|
+
/**
|
|
22187
|
+
* Sidereal frame this chart was cast in, echoing the ayanamsa request field. "lahiri" when the field was omitted.
|
|
22188
|
+
*/
|
|
22189
|
+
ayanamsa: string;
|
|
22190
|
+
/**
|
|
22191
|
+
* Degrees actually subtracted from every tropical longitude to produce this chart, read at the birth instant. Subtract it back to recover the tropical positions, or compare it against your reference software to confirm you are in the same frame before chasing a placement difference.
|
|
22192
|
+
*/
|
|
22193
|
+
ayanamsaDegrees: number;
|
|
22194
|
+
};
|
|
21967
22195
|
/**
|
|
21968
22196
|
* Birth datetime used for the natal chart, echoed as the local civil date and time supplied in the request (YYYY-MM-DDTHH:MM:SS). Combine it with the timezone field to recover the UTC instant.
|
|
21969
22197
|
*/
|
|
@@ -22010,11 +22238,15 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
22010
22238
|
*/
|
|
22011
22239
|
sign: string;
|
|
22012
22240
|
/**
|
|
22013
|
-
* Which natal house (whole-sign bhava from the Lagna) this
|
|
22241
|
+
* Which natal house (whole-sign bhava counted from the Lagna) this graha is currently transiting through. This is the Lagna reading of the transit, which is what a transit chart drawn over the birth chart shows. For the house classical Gochara is judged from, read houseFromMoon instead.
|
|
22014
22242
|
*/
|
|
22015
22243
|
natalHouse: number;
|
|
22016
22244
|
/**
|
|
22017
|
-
*
|
|
22245
|
+
* Which house this graha is transiting counted from the natal Moon sign (Janma Rashi), 1-12 whole-sign and counted inclusively, so the Moon sign itself is 1. This is the number classical Gochara is reckoned in: Phaladeepika chapter 26 opens by saying that of all the Lagnas only the Moon Lagna matters for transit results, and the Vedha and Ashtakavarga transit rules are counted from the Moon throughout. The reference sign is the sign of the Moon entry in natalPlanets, so a client can label the column without a second request.
|
|
22246
|
+
*/
|
|
22247
|
+
houseFromMoon: number;
|
|
22248
|
+
/**
|
|
22249
|
+
* Degree-based angular aspects between this transiting graha and the natal grahas. Western vocabulary, kept for callers who read a chart that way; drishtiToNatal is the Vedic answer to the same question.
|
|
22018
22250
|
*/
|
|
22019
22251
|
aspectsToNatal: Array<{
|
|
22020
22252
|
/**
|
|
@@ -22022,7 +22254,7 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
22022
22254
|
*/
|
|
22023
22255
|
natalPlanet: string;
|
|
22024
22256
|
/**
|
|
22025
|
-
*
|
|
22257
|
+
* Degree-based angular aspect between the two longitudes: conjunction, opposition, trine, square, or sextile. This is the Western aspect vocabulary and it is offered for charts read that way. Parashari jyotish has no sextile, square or trine, so for the Vedic reading use drishtiToNatal, which reports graha drishti by house count.
|
|
22026
22258
|
*/
|
|
22027
22259
|
aspectType: string;
|
|
22028
22260
|
/**
|
|
@@ -22030,6 +22262,27 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
22030
22262
|
*/
|
|
22031
22263
|
orb: number;
|
|
22032
22264
|
}>;
|
|
22265
|
+
/**
|
|
22266
|
+
* Graha drishti cast by this transiting graha onto the natal grahas, the Vedic reading of transit-to-natal aspects. Rahu and Ketu cast none. Empty when this graha reaches no occupied natal sign.
|
|
22267
|
+
*/
|
|
22268
|
+
drishtiToNatal: Array<{
|
|
22269
|
+
/**
|
|
22270
|
+
* Natal graha receiving the drishti from this transiting graha.
|
|
22271
|
+
*/
|
|
22272
|
+
natalPlanet: string;
|
|
22273
|
+
/**
|
|
22274
|
+
* Which house the drishti falls on, counted whole-sign and inclusively from the transiting graha. Every graha aspects the 7th; Mars adds the 4th and 8th, Jupiter the 5th and 9th, Saturn the 3rd and 10th. Same vocabulary the /aspects endpoint returns, so the two can be compared directly.
|
|
22275
|
+
*/
|
|
22276
|
+
aspectType: 'conjunction' | '7th' | '4th' | '8th' | '5th' | '9th' | '3rd' | '10th';
|
|
22277
|
+
/**
|
|
22278
|
+
* Drishti strength as a percentage. Full and special aspects are 100; the partial quarter, half and three-quarter sights are not reported.
|
|
22279
|
+
*/
|
|
22280
|
+
strength: number;
|
|
22281
|
+
/**
|
|
22282
|
+
* Gap between the two degrees-in-sign, in degrees. Graha drishti is whole-sign and does not depend on this, so read it as how exact the sight is inside the pair of rashis rather than as a condition for the aspect.
|
|
22283
|
+
*/
|
|
22284
|
+
orb: number;
|
|
22285
|
+
}>;
|
|
22033
22286
|
/**
|
|
22034
22287
|
* Gochara Kaksha: the ashtakavarga-qualified reading of this transit. The sign says where a graha is, this says whether the exact stretch it currently occupies is one its own Bhinnashtakavarga supports, which is the classical way of refining a transit verdict from sign-level to under four degrees.
|
|
22035
22288
|
*/
|
|
@@ -22069,17 +22322,25 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
22069
22322
|
*/
|
|
22070
22323
|
planet: string;
|
|
22071
22324
|
/**
|
|
22072
|
-
* Human-readable transit summary.
|
|
22325
|
+
* Human-readable transit summary, naming the rashi being transited and both house readings: from the Lagna, then from the natal Moon.
|
|
22073
22326
|
*/
|
|
22074
22327
|
description: string;
|
|
22075
22328
|
/**
|
|
22076
|
-
* Natal house being transited by this slow
|
|
22329
|
+
* Natal house being transited by this slow graha, counted whole-sign from the Lagna. Mirrors natalHouse on the matching transitingPlanets entry.
|
|
22077
22330
|
*/
|
|
22078
22331
|
natalHouse: number;
|
|
22079
22332
|
/**
|
|
22080
|
-
*
|
|
22333
|
+
* House being transited by this slow graha counted from the natal Moon sign (Janma Rashi), the classical Gochara reference. Mirrors houseFromMoon on the matching transitingPlanets entry.
|
|
22334
|
+
*/
|
|
22335
|
+
houseFromMoon: number;
|
|
22336
|
+
/**
|
|
22337
|
+
* Notable degree-based angular aspects to natal planets from this slow-moving transiting planet, in Western vocabulary.
|
|
22081
22338
|
*/
|
|
22082
22339
|
aspects: Array<string>;
|
|
22340
|
+
/**
|
|
22341
|
+
* Graha drishti this slow-moving transiting graha casts on the natal grahas, the Vedic reading. Empty for Rahu and Ketu, which cast none.
|
|
22342
|
+
*/
|
|
22343
|
+
drishti: Array<string>;
|
|
22083
22344
|
}>;
|
|
22084
22345
|
};
|
|
22085
22346
|
};
|
|
@@ -26010,11 +26271,11 @@ export type PostForecastSolarReturnResponses = {
|
|
|
26010
26271
|
timezone: number;
|
|
26011
26272
|
};
|
|
26012
26273
|
/**
|
|
26013
|
-
* All 14 celestial bodies in the tropical zodiac with house placements: the 10 classical planets (Sun through Pluto), the lunar nodes (North Node, South Node), Chiron, and Black Moon Lilith.
|
|
26274
|
+
* All 14 celestial bodies in the tropical zodiac with house placements: the 10 classical planets (Sun through Pluto), the lunar nodes (North Node, South Node, in the requested `nodeType` convention), Chiron, and Black Moon Lilith.
|
|
26014
26275
|
*/
|
|
26015
26276
|
planets: Array<{
|
|
26016
26277
|
/**
|
|
26017
|
-
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee).
|
|
26278
|
+
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee). The nodes follow the request `nodeType`, which defaults to the true (osculating) node; pass "mean" for the smoothed node. The two differ by up to about 1.8 degrees and no other body is affected.
|
|
26018
26279
|
*/
|
|
26019
26280
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
26020
26281
|
/**
|
|
@@ -26104,7 +26365,7 @@ export type PostForecastSolarReturnResponses = {
|
|
|
26104
26365
|
*/
|
|
26105
26366
|
strength: number;
|
|
26106
26367
|
/**
|
|
26107
|
-
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
|
|
26368
|
+
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
|
|
26108
26369
|
*/
|
|
26109
26370
|
interpretation: 'harmonious' | 'challenging' | 'neutral';
|
|
26110
26371
|
}>;
|
|
@@ -26173,7 +26434,7 @@ export type PostHumanDesignBodygraphData = {
|
|
|
26173
26434
|
*/
|
|
26174
26435
|
longitude?: number;
|
|
26175
26436
|
/**
|
|
26176
|
-
* Lunar node convention
|
|
26437
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice can move a node gate and, rarely, change the completed channels and therefore the type, authority or definition. If another calculator shows a different type, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
26177
26438
|
*/
|
|
26178
26439
|
nodeType?: 'mean' | 'true';
|
|
26179
26440
|
};
|
|
@@ -26294,9 +26555,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
26294
26555
|
*/
|
|
26295
26556
|
200: {
|
|
26296
26557
|
/**
|
|
26297
|
-
* Human Design energy type. One of Manifestor, Generator, Manifesting Generator, Projector, Reflector.
|
|
26558
|
+
* Human Design energy type. One of Manifestor, Generator, Manifesting Generator, Projector, Reflector. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use typeLocalized for anything a reader sees.
|
|
26298
26559
|
*/
|
|
26299
26560
|
type: string;
|
|
26561
|
+
/**
|
|
26562
|
+
* Energy type name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
26563
|
+
*/
|
|
26564
|
+
typeLocalized?: string;
|
|
26300
26565
|
/**
|
|
26301
26566
|
* What the aura of this type does and how it is designed to engage life. The grounding text for the type label, so a consuming agent does not have to supply the meaning itself.
|
|
26302
26567
|
*/
|
|
@@ -26306,29 +26571,45 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
26306
26571
|
*/
|
|
26307
26572
|
aura: string;
|
|
26308
26573
|
/**
|
|
26309
|
-
* The aura strategy for engaging life correctly for this type.
|
|
26574
|
+
* The aura strategy for engaging life correctly for this type. Always English, whatever the lang parameter says. Use strategyLocalized for anything a reader sees.
|
|
26310
26575
|
*/
|
|
26311
26576
|
strategy: string;
|
|
26577
|
+
/**
|
|
26578
|
+
* Strategy name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
26579
|
+
*/
|
|
26580
|
+
strategyLocalized?: string;
|
|
26312
26581
|
/**
|
|
26313
26582
|
* How to actually apply the strategy. The strategy field alone is a bare label such as Respond or Inform; this is the operating instruction behind it.
|
|
26314
26583
|
*/
|
|
26315
26584
|
strategyDescription: string;
|
|
26316
26585
|
/**
|
|
26317
|
-
* Inner authority for decision making. One of Emotional, Sacral, Splenic, Ego, Self-Projected, Mental, Lunar.
|
|
26586
|
+
* Inner authority for decision making. One of Emotional, Sacral, Splenic, Ego, Self-Projected, Mental, Lunar. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use authorityLocalized for anything a reader sees.
|
|
26318
26587
|
*/
|
|
26319
26588
|
authority: string;
|
|
26589
|
+
/**
|
|
26590
|
+
* Inner authority name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
26591
|
+
*/
|
|
26592
|
+
authorityLocalized?: string;
|
|
26320
26593
|
/**
|
|
26321
26594
|
* How the decision is made, the timing it requires, and the characteristic trap. Inner authority is the most actionable output of a Human Design chart, so this is the field to lean on when grounding a reading.
|
|
26322
26595
|
*/
|
|
26323
26596
|
authorityDescription: string;
|
|
26324
26597
|
/**
|
|
26325
|
-
* The signature feeling of living in alignment with the type.
|
|
26598
|
+
* The signature feeling of living in alignment with the type. Always English, whatever the lang parameter says. Use signatureLocalized for anything a reader sees.
|
|
26326
26599
|
*/
|
|
26327
26600
|
signature: string;
|
|
26328
26601
|
/**
|
|
26329
|
-
*
|
|
26602
|
+
* Signature theme name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
26603
|
+
*/
|
|
26604
|
+
signatureLocalized?: string;
|
|
26605
|
+
/**
|
|
26606
|
+
* The not-self theme, the recurring feeling that signals being out of alignment. Always English, whatever the lang parameter says. Use notSelfLocalized for anything a reader sees.
|
|
26330
26607
|
*/
|
|
26331
26608
|
notSelf: string;
|
|
26609
|
+
/**
|
|
26610
|
+
* Not-self theme name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
26611
|
+
*/
|
|
26612
|
+
notSelfLocalized?: string;
|
|
26332
26613
|
/**
|
|
26333
26614
|
* Profile in conscious/unconscious form from the Personality Sun line over the Design Sun line.
|
|
26334
26615
|
*/
|
|
@@ -26359,9 +26640,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
26359
26640
|
*/
|
|
26360
26641
|
profileDescription: string;
|
|
26361
26642
|
/**
|
|
26362
|
-
* Definition type from the number of connected components among defined centers. One of None, Single, Split, Triple Split, Quadruple Split.
|
|
26643
|
+
* Definition type from the number of connected components among defined centers. One of None, Single, Split, Triple Split, Quadruple Split. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use definitionLocalized for anything a reader sees.
|
|
26363
26644
|
*/
|
|
26364
26645
|
definition: string;
|
|
26646
|
+
/**
|
|
26647
|
+
* Definition type name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
26648
|
+
*/
|
|
26649
|
+
definitionLocalized?: string;
|
|
26365
26650
|
/**
|
|
26366
26651
|
* How energy flows through the defined centers in this configuration, and what the configuration needs. For a split, this is where the bridging gates of other people matter.
|
|
26367
26652
|
*/
|
|
@@ -26381,9 +26666,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
26381
26666
|
*/
|
|
26382
26667
|
gates: Array<number>;
|
|
26383
26668
|
/**
|
|
26384
|
-
* Cross angle. One of Right Angle, Juxtaposition, Left Angle.
|
|
26669
|
+
* Cross angle. One of Right Angle, Juxtaposition, Left Angle. Always English, whatever the lang parameter says. Use angleLocalized for anything a reader sees.
|
|
26385
26670
|
*/
|
|
26386
26671
|
angle: string;
|
|
26672
|
+
/**
|
|
26673
|
+
* Cross angle name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
26674
|
+
*/
|
|
26675
|
+
angleLocalized?: string;
|
|
26387
26676
|
/**
|
|
26388
26677
|
* Short code for the angle. One of RAX, JXT, LAX.
|
|
26389
26678
|
*/
|
|
@@ -26406,9 +26695,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
26406
26695
|
*/
|
|
26407
26696
|
id: string;
|
|
26408
26697
|
/**
|
|
26409
|
-
* Display name of the center.
|
|
26698
|
+
* Display name of the center. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use nameLocalized for anything a reader sees.
|
|
26410
26699
|
*/
|
|
26411
26700
|
name: string;
|
|
26701
|
+
/**
|
|
26702
|
+
* Center name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
26703
|
+
*/
|
|
26704
|
+
nameLocalized?: string;
|
|
26412
26705
|
/**
|
|
26413
26706
|
* Whether the center is defined. A defined center is a consistent source of energy or awareness; an undefined center is open and conditioned by others.
|
|
26414
26707
|
*/
|
|
@@ -26451,13 +26744,21 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
26451
26744
|
*/
|
|
26452
26745
|
gateB: number;
|
|
26453
26746
|
/**
|
|
26454
|
-
* Name of the defined channel.
|
|
26747
|
+
* Name of the defined channel. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
26455
26748
|
*/
|
|
26456
26749
|
name: string;
|
|
26457
26750
|
/**
|
|
26458
|
-
*
|
|
26751
|
+
* Channel name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
26752
|
+
*/
|
|
26753
|
+
nameLocalized?: string;
|
|
26754
|
+
/**
|
|
26755
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal. Always English, whatever the lang parameter says. Use circuitLocalized for anything a reader sees.
|
|
26459
26756
|
*/
|
|
26460
26757
|
circuit: string;
|
|
26758
|
+
/**
|
|
26759
|
+
* Circuit family name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
26760
|
+
*/
|
|
26761
|
+
circuitLocalized?: string;
|
|
26461
26762
|
/**
|
|
26462
26763
|
* The two centers this channel connects and defines.
|
|
26463
26764
|
*/
|
|
@@ -26476,9 +26777,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
26476
26777
|
*/
|
|
26477
26778
|
gates: Array<{
|
|
26478
26779
|
/**
|
|
26479
|
-
* Activating body. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto.
|
|
26780
|
+
* Activating body. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto. Always English, whatever the lang parameter says, so it stays safe to compare against in code and to key a glyph table on. Use planetLocalized for anything a reader sees.
|
|
26480
26781
|
*/
|
|
26481
26782
|
planet: string;
|
|
26783
|
+
/**
|
|
26784
|
+
* Activating body name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
26785
|
+
*/
|
|
26786
|
+
planetLocalized?: string;
|
|
26482
26787
|
/**
|
|
26483
26788
|
* Chart side. personality is the conscious birth-moment activation, design is the unconscious activation 88 degrees of solar arc before birth.
|
|
26484
26789
|
*/
|
|
@@ -26492,9 +26797,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
26492
26797
|
*/
|
|
26493
26798
|
line: number;
|
|
26494
26799
|
/**
|
|
26495
|
-
* Human Design keynote name of the gate, describing its bodygraph function.
|
|
26800
|
+
* Human Design keynote name of the gate, describing its bodygraph function. Always English, whatever the lang parameter says. Use gateNameLocalized for anything a reader sees.
|
|
26496
26801
|
*/
|
|
26497
26802
|
gateName: string;
|
|
26803
|
+
/**
|
|
26804
|
+
* Gate keynote name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
26805
|
+
*/
|
|
26806
|
+
gateNameLocalized?: string;
|
|
26498
26807
|
/**
|
|
26499
26808
|
* Bodygraph function of the gate: what it does in the center it sits in and the channel it forms. This is NOT the meaning of the I-Ching hexagram that shares its number. They share a number, not a definition.
|
|
26500
26809
|
*/
|
|
@@ -26551,7 +26860,7 @@ export type PostHumanDesignConnectionData = {
|
|
|
26551
26860
|
*/
|
|
26552
26861
|
longitude?: number;
|
|
26553
26862
|
/**
|
|
26554
|
-
* Lunar node convention
|
|
26863
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice can move a node gate and, rarely, change the completed channels and therefore the type, authority or definition. If another calculator shows a different type, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
26555
26864
|
*/
|
|
26556
26865
|
nodeType?: 'mean' | 'true';
|
|
26557
26866
|
};
|
|
@@ -26580,7 +26889,7 @@ export type PostHumanDesignConnectionData = {
|
|
|
26580
26889
|
*/
|
|
26581
26890
|
longitude?: number;
|
|
26582
26891
|
/**
|
|
26583
|
-
* Lunar node convention
|
|
26892
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice can move a node gate and, rarely, change the completed channels and therefore the type, authority or definition. If another calculator shows a different type, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
26584
26893
|
*/
|
|
26585
26894
|
nodeType?: 'mean' | 'true';
|
|
26586
26895
|
};
|
|
@@ -26718,21 +27027,33 @@ export type PostHumanDesignConnectionResponses = {
|
|
|
26718
27027
|
*/
|
|
26719
27028
|
gateB: number;
|
|
26720
27029
|
/**
|
|
26721
|
-
* Name of the channel whose connection dynamic is reported.
|
|
27030
|
+
* Name of the channel whose connection dynamic is reported. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
26722
27031
|
*/
|
|
26723
27032
|
name: string;
|
|
26724
27033
|
/**
|
|
26725
|
-
*
|
|
27034
|
+
* Channel name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27035
|
+
*/
|
|
27036
|
+
nameLocalized?: string;
|
|
27037
|
+
/**
|
|
27038
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal. Always English, whatever the lang parameter says. Use circuitLocalized for anything a reader sees.
|
|
26726
27039
|
*/
|
|
26727
27040
|
circuit: string;
|
|
27041
|
+
/**
|
|
27042
|
+
* Circuit family name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27043
|
+
*/
|
|
27044
|
+
circuitLocalized?: string;
|
|
26728
27045
|
/**
|
|
26729
27046
|
* The two centers this channel connects in the bodygraph.
|
|
26730
27047
|
*/
|
|
26731
27048
|
centers: Array<string>;
|
|
26732
27049
|
/**
|
|
26733
|
-
* Connection dynamic for this channel. Electromagnetic means each person holds one of the two gates and the channel completes only together, the classic point of attraction. Dominance means one person holds both gates and the other holds neither, a one-way conditioning. Compromise means one person holds both gates and the other holds a single hanging gate. Companionship means both people independently hold both gates, a shared and familiar frequency.
|
|
27050
|
+
* Connection dynamic for this channel. Electromagnetic means each person holds one of the two gates and the channel completes only together, the classic point of attraction. Dominance means one person holds both gates and the other holds neither, a one-way conditioning. Compromise means one person holds both gates and the other holds a single hanging gate. Companionship means both people independently hold both gates, a shared and familiar frequency. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use dynamicLocalized for anything a reader sees.
|
|
26734
27051
|
*/
|
|
26735
27052
|
dynamic: string;
|
|
27053
|
+
/**
|
|
27054
|
+
* Connection dynamic name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27055
|
+
*/
|
|
27056
|
+
dynamicLocalized?: string;
|
|
26736
27057
|
/**
|
|
26737
27058
|
* Which of the channel two gates person A holds, from one to both.
|
|
26738
27059
|
*/
|
|
@@ -26751,9 +27072,13 @@ export type PostHumanDesignConnectionResponses = {
|
|
|
26751
27072
|
*/
|
|
26752
27073
|
id: string;
|
|
26753
27074
|
/**
|
|
26754
|
-
* Display name of the center.
|
|
27075
|
+
* Display name of the center. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
26755
27076
|
*/
|
|
26756
27077
|
name: string;
|
|
27078
|
+
/**
|
|
27079
|
+
* Center name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27080
|
+
*/
|
|
27081
|
+
nameLocalized?: string;
|
|
26757
27082
|
/**
|
|
26758
27083
|
* Whether the center is defined in the combined connection bodygraph, where a channel counts as defined when the two people together hold both of its gates.
|
|
26759
27084
|
*/
|
|
@@ -26764,9 +27089,13 @@ export type PostHumanDesignConnectionResponses = {
|
|
|
26764
27089
|
definedBy: Array<string>;
|
|
26765
27090
|
}>;
|
|
26766
27091
|
/**
|
|
26767
|
-
* Definition of the combined connection bodygraph from connected components among its defined centers. One of None, Single, Split, Triple Split, Quadruple Split.
|
|
27092
|
+
* Definition of the combined connection bodygraph from connected components among its defined centers. One of None, Single, Split, Triple Split, Quadruple Split. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use combinedDefinitionLocalized for anything a reader sees.
|
|
26768
27093
|
*/
|
|
26769
27094
|
combinedDefinition: string;
|
|
27095
|
+
/**
|
|
27096
|
+
* Combined definition name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27097
|
+
*/
|
|
27098
|
+
combinedDefinitionLocalized?: string;
|
|
26770
27099
|
/**
|
|
26771
27100
|
* Count of each connection dynamic across all connected channels.
|
|
26772
27101
|
*/
|
|
@@ -26818,7 +27147,7 @@ export type PostHumanDesignPentaData = {
|
|
|
26818
27147
|
*/
|
|
26819
27148
|
longitude?: number;
|
|
26820
27149
|
/**
|
|
26821
|
-
* Lunar node convention
|
|
27150
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice can move a node gate and, rarely, change the completed channels and therefore the type, authority or definition. If another calculator shows a different type, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
26822
27151
|
*/
|
|
26823
27152
|
nodeType?: 'mean' | 'true';
|
|
26824
27153
|
}>;
|
|
@@ -26956,13 +27285,21 @@ export type PostHumanDesignPentaResponses = {
|
|
|
26956
27285
|
*/
|
|
26957
27286
|
gateB: number;
|
|
26958
27287
|
/**
|
|
26959
|
-
* Name of the Penta channel. One of The Alpha, Inspiration, The Prodigal, Rhythm, The Beat, Discovery.
|
|
27288
|
+
* Name of the Penta channel. One of The Alpha, Inspiration, The Prodigal, Rhythm, The Beat, Discovery. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
26960
27289
|
*/
|
|
26961
27290
|
name: string;
|
|
26962
27291
|
/**
|
|
26963
|
-
*
|
|
27292
|
+
* Penta channel name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27293
|
+
*/
|
|
27294
|
+
nameLocalized?: string;
|
|
27295
|
+
/**
|
|
27296
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal. Always English, whatever the lang parameter says. Use circuitLocalized for anything a reader sees.
|
|
26964
27297
|
*/
|
|
26965
27298
|
circuit: string;
|
|
27299
|
+
/**
|
|
27300
|
+
* Circuit family name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27301
|
+
*/
|
|
27302
|
+
circuitLocalized?: string;
|
|
26966
27303
|
/**
|
|
26967
27304
|
* Position of the channel in the Penta. upper channels run from the G Center to the Throat and carry the leadership and how-the-group-presents roles. lower channels run from the G Center to the Sacral and carry the managed, generative, resource roles.
|
|
26968
27305
|
*/
|
|
@@ -26993,9 +27330,13 @@ export type PostHumanDesignPentaResponses = {
|
|
|
26993
27330
|
*/
|
|
26994
27331
|
gate: number;
|
|
26995
27332
|
/**
|
|
26996
|
-
* Human Design keynote name of the gate, describing the role it brings to the group.
|
|
27333
|
+
* Human Design keynote name of the gate, describing the role it brings to the group. Always English, whatever the lang parameter says. Use gateNameLocalized for anything a reader sees.
|
|
26997
27334
|
*/
|
|
26998
27335
|
gateName: string;
|
|
27336
|
+
/**
|
|
27337
|
+
* Gate keynote name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27338
|
+
*/
|
|
27339
|
+
gateNameLocalized?: string;
|
|
26999
27340
|
/**
|
|
27000
27341
|
* Whether at least one member holds this gate. A gate held by nobody is a gap that conditions the group to compensate for the missing role.
|
|
27001
27342
|
*/
|
|
@@ -27056,7 +27397,7 @@ export type PostHumanDesignTransitData = {
|
|
|
27056
27397
|
*/
|
|
27057
27398
|
longitude?: number;
|
|
27058
27399
|
/**
|
|
27059
|
-
* Lunar node convention
|
|
27400
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice can move a node gate and, rarely, change the completed channels and therefore the type, authority or definition. If another calculator shows a different type, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
27060
27401
|
*/
|
|
27061
27402
|
nodeType?: 'mean' | 'true';
|
|
27062
27403
|
};
|
|
@@ -27202,9 +27543,13 @@ export type PostHumanDesignTransitResponses = {
|
|
|
27202
27543
|
*/
|
|
27203
27544
|
activations: Array<{
|
|
27204
27545
|
/**
|
|
27205
|
-
* Transiting body whose current position lands on this gate. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto.
|
|
27546
|
+
* Transiting body whose current position lands on this gate. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto. Always English, whatever the lang parameter says, so it stays safe to compare against in code and to key a glyph table on. Use bodyLocalized for anything a reader sees.
|
|
27206
27547
|
*/
|
|
27207
27548
|
body: string;
|
|
27549
|
+
/**
|
|
27550
|
+
* Transiting body name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27551
|
+
*/
|
|
27552
|
+
bodyLocalized?: string;
|
|
27208
27553
|
/**
|
|
27209
27554
|
* Human Design gate number from 1 to 64 this transiting body currently sits in.
|
|
27210
27555
|
*/
|
|
@@ -27214,9 +27559,13 @@ export type PostHumanDesignTransitResponses = {
|
|
|
27214
27559
|
*/
|
|
27215
27560
|
line: number;
|
|
27216
27561
|
/**
|
|
27217
|
-
* Human Design keynote name of the gate the transiting body activates.
|
|
27562
|
+
* Human Design keynote name of the gate the transiting body activates. Always English, whatever the lang parameter says. Use gateNameLocalized for anything a reader sees.
|
|
27218
27563
|
*/
|
|
27219
27564
|
gateName: string;
|
|
27565
|
+
/**
|
|
27566
|
+
* Gate keynote name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27567
|
+
*/
|
|
27568
|
+
gateNameLocalized?: string;
|
|
27220
27569
|
/**
|
|
27221
27570
|
* Cross-reference to the I-Ching hexagram that shares this gate number.
|
|
27222
27571
|
*/
|
|
@@ -27244,21 +27593,33 @@ export type PostHumanDesignTransitResponses = {
|
|
|
27244
27593
|
*/
|
|
27245
27594
|
gateB: number;
|
|
27246
27595
|
/**
|
|
27247
|
-
* Name of the channel the transit temporarily completes.
|
|
27596
|
+
* Name of the channel the transit temporarily completes. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
27248
27597
|
*/
|
|
27249
27598
|
name: string;
|
|
27250
27599
|
/**
|
|
27251
|
-
*
|
|
27600
|
+
* Channel name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27601
|
+
*/
|
|
27602
|
+
nameLocalized?: string;
|
|
27603
|
+
/**
|
|
27604
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal. Always English, whatever the lang parameter says. Use circuitLocalized for anything a reader sees.
|
|
27252
27605
|
*/
|
|
27253
27606
|
circuit: string;
|
|
27607
|
+
/**
|
|
27608
|
+
* Circuit family name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27609
|
+
*/
|
|
27610
|
+
circuitLocalized?: string;
|
|
27254
27611
|
/**
|
|
27255
27612
|
* The two centers this channel connects and temporarily defines.
|
|
27256
27613
|
*/
|
|
27257
27614
|
centers: Array<string>;
|
|
27258
27615
|
/**
|
|
27259
|
-
* How the transit completes the channel. personal means the natal chart already holds one gate and the transit supplies the other, the classic electromagnetic completion. educational means both gates are open in the natal chart and the transit supplies both at once.
|
|
27616
|
+
* How the transit completes the channel. personal means the natal chart already holds one gate and the transit supplies the other, the classic electromagnetic completion. educational means both gates are open in the natal chart and the transit supplies both at once. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use kindLocalized for anything a reader sees.
|
|
27260
27617
|
*/
|
|
27261
27618
|
kind: string;
|
|
27619
|
+
/**
|
|
27620
|
+
* Completion kind name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27621
|
+
*/
|
|
27622
|
+
kindLocalized?: string;
|
|
27262
27623
|
/**
|
|
27263
27624
|
* Gate or gates of this channel the natal chart already holds. Empty for an educational channel.
|
|
27264
27625
|
*/
|
|
@@ -27277,9 +27638,13 @@ export type PostHumanDesignTransitResponses = {
|
|
|
27277
27638
|
*/
|
|
27278
27639
|
id: string;
|
|
27279
27640
|
/**
|
|
27280
|
-
* Display name of the center.
|
|
27641
|
+
* Display name of the center. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
27281
27642
|
*/
|
|
27282
27643
|
name: string;
|
|
27644
|
+
/**
|
|
27645
|
+
* Center name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27646
|
+
*/
|
|
27647
|
+
nameLocalized?: string;
|
|
27283
27648
|
/**
|
|
27284
27649
|
* Always true. The center is open in the natal chart and temporarily defined by a transit-completed channel for the duration of the transit.
|
|
27285
27650
|
*/
|
|
@@ -27315,7 +27680,7 @@ export type PostHumanDesignTypeData = {
|
|
|
27315
27680
|
*/
|
|
27316
27681
|
longitude?: number;
|
|
27317
27682
|
/**
|
|
27318
|
-
* Lunar node convention
|
|
27683
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice can move a node gate and, rarely, change the completed channels and therefore the type, authority or definition. If another calculator shows a different type, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
27319
27684
|
*/
|
|
27320
27685
|
nodeType?: 'mean' | 'true';
|
|
27321
27686
|
};
|
|
@@ -27436,9 +27801,13 @@ export type PostHumanDesignTypeResponses = {
|
|
|
27436
27801
|
*/
|
|
27437
27802
|
200: {
|
|
27438
27803
|
/**
|
|
27439
|
-
* Human Design energy type. One of Manifestor, Generator, Manifesting Generator, Projector, Reflector.
|
|
27804
|
+
* Human Design energy type. One of Manifestor, Generator, Manifesting Generator, Projector, Reflector. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use typeLocalized for anything a reader sees.
|
|
27440
27805
|
*/
|
|
27441
27806
|
type: string;
|
|
27807
|
+
/**
|
|
27808
|
+
* Energy type name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27809
|
+
*/
|
|
27810
|
+
typeLocalized?: string;
|
|
27442
27811
|
/**
|
|
27443
27812
|
* What the aura of this type does and how it is designed to engage life. The grounding text for the type label, so a consuming agent does not have to supply the meaning itself.
|
|
27444
27813
|
*/
|
|
@@ -27448,29 +27817,45 @@ export type PostHumanDesignTypeResponses = {
|
|
|
27448
27817
|
*/
|
|
27449
27818
|
aura: string;
|
|
27450
27819
|
/**
|
|
27451
|
-
* The aura strategy for engaging life correctly for this type.
|
|
27820
|
+
* The aura strategy for engaging life correctly for this type. Always English, whatever the lang parameter says. Use strategyLocalized for anything a reader sees.
|
|
27452
27821
|
*/
|
|
27453
27822
|
strategy: string;
|
|
27823
|
+
/**
|
|
27824
|
+
* Strategy name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27825
|
+
*/
|
|
27826
|
+
strategyLocalized?: string;
|
|
27454
27827
|
/**
|
|
27455
27828
|
* How to actually apply the strategy. The strategy field alone is a bare label such as Respond or Inform; this is the operating instruction behind it.
|
|
27456
27829
|
*/
|
|
27457
27830
|
strategyDescription: string;
|
|
27458
27831
|
/**
|
|
27459
|
-
* Inner authority for decision making. One of Emotional, Sacral, Splenic, Ego, Self-Projected, Mental, Lunar.
|
|
27832
|
+
* Inner authority for decision making. One of Emotional, Sacral, Splenic, Ego, Self-Projected, Mental, Lunar. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use authorityLocalized for anything a reader sees.
|
|
27460
27833
|
*/
|
|
27461
27834
|
authority: string;
|
|
27835
|
+
/**
|
|
27836
|
+
* Inner authority name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27837
|
+
*/
|
|
27838
|
+
authorityLocalized?: string;
|
|
27462
27839
|
/**
|
|
27463
27840
|
* How the decision is made, the timing it requires, and the characteristic trap. Inner authority is the most actionable output of a Human Design chart.
|
|
27464
27841
|
*/
|
|
27465
27842
|
authorityDescription: string;
|
|
27466
27843
|
/**
|
|
27467
|
-
* The signature feeling of living in alignment.
|
|
27844
|
+
* The signature feeling of living in alignment. Always English, whatever the lang parameter says. Use signatureLocalized for anything a reader sees.
|
|
27468
27845
|
*/
|
|
27469
27846
|
signature: string;
|
|
27470
27847
|
/**
|
|
27471
|
-
*
|
|
27848
|
+
* Signature theme name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27849
|
+
*/
|
|
27850
|
+
signatureLocalized?: string;
|
|
27851
|
+
/**
|
|
27852
|
+
* The not-self theme that signals being out of alignment. Always English, whatever the lang parameter says. Use notSelfLocalized for anything a reader sees.
|
|
27472
27853
|
*/
|
|
27473
27854
|
notSelf: string;
|
|
27855
|
+
/**
|
|
27856
|
+
* Not-self theme name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
27857
|
+
*/
|
|
27858
|
+
notSelfLocalized?: string;
|
|
27474
27859
|
/**
|
|
27475
27860
|
* Profile from the Personality Sun line over the Design Sun line.
|
|
27476
27861
|
*/
|
|
@@ -27501,7 +27886,7 @@ export type PostHumanDesignGatesData = {
|
|
|
27501
27886
|
*/
|
|
27502
27887
|
longitude?: number;
|
|
27503
27888
|
/**
|
|
27504
|
-
* Lunar node convention
|
|
27889
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice can move a node gate and, rarely, change the completed channels and therefore the type, authority or definition. If another calculator shows a different type, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
27505
27890
|
*/
|
|
27506
27891
|
nodeType?: 'mean' | 'true';
|
|
27507
27892
|
};
|
|
@@ -27626,9 +28011,13 @@ export type PostHumanDesignGatesResponses = {
|
|
|
27626
28011
|
*/
|
|
27627
28012
|
personality: Array<{
|
|
27628
28013
|
/**
|
|
27629
|
-
* Activating body. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto.
|
|
28014
|
+
* Activating body. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto. Always English, whatever the lang parameter says, so it stays safe to compare against in code and to key a glyph table on. Use planetLocalized for anything a reader sees.
|
|
27630
28015
|
*/
|
|
27631
28016
|
planet: string;
|
|
28017
|
+
/**
|
|
28018
|
+
* Activating body name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
28019
|
+
*/
|
|
28020
|
+
planetLocalized?: string;
|
|
27632
28021
|
/**
|
|
27633
28022
|
* Chart side. personality is the conscious birth-moment activation, design is the unconscious activation 88 degrees of solar arc before birth.
|
|
27634
28023
|
*/
|
|
@@ -27642,9 +28031,13 @@ export type PostHumanDesignGatesResponses = {
|
|
|
27642
28031
|
*/
|
|
27643
28032
|
line: number;
|
|
27644
28033
|
/**
|
|
27645
|
-
* Human Design keynote name of the gate, describing its bodygraph function.
|
|
28034
|
+
* Human Design keynote name of the gate, describing its bodygraph function. Always English, whatever the lang parameter says. Use gateNameLocalized for anything a reader sees.
|
|
27646
28035
|
*/
|
|
27647
28036
|
gateName: string;
|
|
28037
|
+
/**
|
|
28038
|
+
* Gate keynote name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
28039
|
+
*/
|
|
28040
|
+
gateNameLocalized?: string;
|
|
27648
28041
|
/**
|
|
27649
28042
|
* Bodygraph function of the gate: what it does in the center it sits in and the channel it forms. This is NOT the meaning of the I-Ching hexagram that shares its number. They share a number, not a definition.
|
|
27650
28043
|
*/
|
|
@@ -27676,9 +28069,13 @@ export type PostHumanDesignGatesResponses = {
|
|
|
27676
28069
|
*/
|
|
27677
28070
|
design: Array<{
|
|
27678
28071
|
/**
|
|
27679
|
-
* Activating body. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto.
|
|
28072
|
+
* Activating body. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto. Always English, whatever the lang parameter says, so it stays safe to compare against in code and to key a glyph table on. Use planetLocalized for anything a reader sees.
|
|
27680
28073
|
*/
|
|
27681
28074
|
planet: string;
|
|
28075
|
+
/**
|
|
28076
|
+
* Activating body name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
28077
|
+
*/
|
|
28078
|
+
planetLocalized?: string;
|
|
27682
28079
|
/**
|
|
27683
28080
|
* Chart side. personality is the conscious birth-moment activation, design is the unconscious activation 88 degrees of solar arc before birth.
|
|
27684
28081
|
*/
|
|
@@ -27692,9 +28089,13 @@ export type PostHumanDesignGatesResponses = {
|
|
|
27692
28089
|
*/
|
|
27693
28090
|
line: number;
|
|
27694
28091
|
/**
|
|
27695
|
-
* Human Design keynote name of the gate, describing its bodygraph function.
|
|
28092
|
+
* Human Design keynote name of the gate, describing its bodygraph function. Always English, whatever the lang parameter says. Use gateNameLocalized for anything a reader sees.
|
|
27696
28093
|
*/
|
|
27697
28094
|
gateName: string;
|
|
28095
|
+
/**
|
|
28096
|
+
* Gate keynote name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
28097
|
+
*/
|
|
28098
|
+
gateNameLocalized?: string;
|
|
27698
28099
|
/**
|
|
27699
28100
|
* Bodygraph function of the gate: what it does in the center it sits in and the channel it forms. This is NOT the meaning of the I-Ching hexagram that shares its number. They share a number, not a definition.
|
|
27700
28101
|
*/
|
|
@@ -27865,17 +28266,25 @@ export type GetHumanDesignGatesByNumberResponses = {
|
|
|
27865
28266
|
*/
|
|
27866
28267
|
number: number;
|
|
27867
28268
|
/**
|
|
27868
|
-
* Human Design keynote name of the gate.
|
|
28269
|
+
* Human Design keynote name of the gate. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
27869
28270
|
*/
|
|
27870
28271
|
name: string;
|
|
28272
|
+
/**
|
|
28273
|
+
* Gate keynote name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
28274
|
+
*/
|
|
28275
|
+
nameLocalized?: string;
|
|
27871
28276
|
/**
|
|
27872
28277
|
* Center the gate sits in.
|
|
27873
28278
|
*/
|
|
27874
28279
|
center: string;
|
|
27875
28280
|
/**
|
|
27876
|
-
* Display name of the center.
|
|
28281
|
+
* Display name of the center. Always English, whatever the lang parameter says. Use centerNameLocalized for anything a reader sees.
|
|
27877
28282
|
*/
|
|
27878
28283
|
centerName: string;
|
|
28284
|
+
/**
|
|
28285
|
+
* Center name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
28286
|
+
*/
|
|
28287
|
+
centerNameLocalized?: string;
|
|
27879
28288
|
/**
|
|
27880
28289
|
* The I-Ching hexagram that shares this gate number.
|
|
27881
28290
|
*/
|
|
@@ -27898,9 +28307,13 @@ export type GetHumanDesignGatesByNumberResponses = {
|
|
|
27898
28307
|
*/
|
|
27899
28308
|
gate: number;
|
|
27900
28309
|
/**
|
|
27901
|
-
* Name of the shared channel.
|
|
28310
|
+
* Name of the shared channel. Always English, whatever the lang parameter says. Use channelLocalized for anything a reader sees.
|
|
27902
28311
|
*/
|
|
27903
28312
|
channel: string;
|
|
28313
|
+
/**
|
|
28314
|
+
* Channel name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
28315
|
+
*/
|
|
28316
|
+
channelLocalized?: string;
|
|
27904
28317
|
}>;
|
|
27905
28318
|
};
|
|
27906
28319
|
};
|
|
@@ -27928,7 +28341,7 @@ export type PostHumanDesignChannelsData = {
|
|
|
27928
28341
|
*/
|
|
27929
28342
|
longitude?: number;
|
|
27930
28343
|
/**
|
|
27931
|
-
* Lunar node convention
|
|
28344
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice can move a node gate and, rarely, change the completed channels and therefore the type, authority or definition. If another calculator shows a different type, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
27932
28345
|
*/
|
|
27933
28346
|
nodeType?: 'mean' | 'true';
|
|
27934
28347
|
};
|
|
@@ -28061,13 +28474,21 @@ export type PostHumanDesignChannelsResponses = {
|
|
|
28061
28474
|
*/
|
|
28062
28475
|
gateB: number;
|
|
28063
28476
|
/**
|
|
28064
|
-
* Name of the defined channel.
|
|
28477
|
+
* Name of the defined channel. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
28065
28478
|
*/
|
|
28066
28479
|
name: string;
|
|
28067
28480
|
/**
|
|
28068
|
-
*
|
|
28481
|
+
* Channel name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
28482
|
+
*/
|
|
28483
|
+
nameLocalized?: string;
|
|
28484
|
+
/**
|
|
28485
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal. Always English, whatever the lang parameter says. Use circuitLocalized for anything a reader sees.
|
|
28069
28486
|
*/
|
|
28070
28487
|
circuit: string;
|
|
28488
|
+
/**
|
|
28489
|
+
* Circuit family name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
28490
|
+
*/
|
|
28491
|
+
circuitLocalized?: string;
|
|
28071
28492
|
/**
|
|
28072
28493
|
* The two centers this channel connects and defines.
|
|
28073
28494
|
*/
|
|
@@ -28115,7 +28536,7 @@ export type PostHumanDesignCentersData = {
|
|
|
28115
28536
|
*/
|
|
28116
28537
|
longitude?: number;
|
|
28117
28538
|
/**
|
|
28118
|
-
* Lunar node convention
|
|
28539
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice can move a node gate and, rarely, change the completed channels and therefore the type, authority or definition. If another calculator shows a different type, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
28119
28540
|
*/
|
|
28120
28541
|
nodeType?: 'mean' | 'true';
|
|
28121
28542
|
};
|
|
@@ -28244,9 +28665,13 @@ export type PostHumanDesignCentersResponses = {
|
|
|
28244
28665
|
*/
|
|
28245
28666
|
id: string;
|
|
28246
28667
|
/**
|
|
28247
|
-
* Display name of the center.
|
|
28668
|
+
* Display name of the center. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use nameLocalized for anything a reader sees.
|
|
28248
28669
|
*/
|
|
28249
28670
|
name: string;
|
|
28671
|
+
/**
|
|
28672
|
+
* Center name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
28673
|
+
*/
|
|
28674
|
+
nameLocalized?: string;
|
|
28250
28675
|
/**
|
|
28251
28676
|
* Whether the center is defined. A defined center is a consistent source of energy or awareness; an undefined center is open and conditioned by others.
|
|
28252
28677
|
*/
|
|
@@ -28411,9 +28836,13 @@ export type GetHumanDesignCentersByIdResponses = {
|
|
|
28411
28836
|
*/
|
|
28412
28837
|
id: string;
|
|
28413
28838
|
/**
|
|
28414
|
-
* Display name of the center.
|
|
28839
|
+
* Display name of the center. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
28415
28840
|
*/
|
|
28416
28841
|
name: string;
|
|
28842
|
+
/**
|
|
28843
|
+
* Center name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
28844
|
+
*/
|
|
28845
|
+
nameLocalized?: string;
|
|
28417
28846
|
/**
|
|
28418
28847
|
* Whether this is a motor center.
|
|
28419
28848
|
*/
|
|
@@ -28456,7 +28885,7 @@ export type PostHumanDesignProfileData = {
|
|
|
28456
28885
|
*/
|
|
28457
28886
|
longitude?: number;
|
|
28458
28887
|
/**
|
|
28459
|
-
* Lunar node convention
|
|
28888
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice can move a node gate and, rarely, change the completed channels and therefore the type, authority or definition. If another calculator shows a different type, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
28460
28889
|
*/
|
|
28461
28890
|
nodeType?: 'mean' | 'true';
|
|
28462
28891
|
};
|
|
@@ -28622,7 +29051,7 @@ export type PostHumanDesignVariablesData = {
|
|
|
28622
29051
|
*/
|
|
28623
29052
|
longitude?: number;
|
|
28624
29053
|
/**
|
|
28625
|
-
* Lunar node convention
|
|
29054
|
+
* Lunar node convention. "mean" is the smoothed average node, which always moves retrograde; "true" is the osculating node, which tracks the real perturbed node, oscillates up to about 1.5 degrees either side of the mean on a 173-day cycle, and can briefly turn direct. Neither is more correct and they almost always fall in the same sign. Applies to the North and South Node activations. True is what professional Human Design software uses (HumanDesign.ai, Total Human Design) and is the value RoxyAPI verifies against, so leave it unset for a standard chart. It matters only when a node sits on a gate boundary, where the choice can move a node gate and, rarely, change the completed channels and therefore the type, authority or definition. If another calculator shows a different type, it is almost certainly using the mean node: pass "mean" to match it. Defaults to "true".
|
|
28626
29055
|
*/
|
|
28627
29056
|
nodeType?: 'mean' | 'true';
|
|
28628
29057
|
};
|
|
@@ -28751,17 +29180,29 @@ export type PostHumanDesignVariablesResponses = {
|
|
|
28751
29180
|
*/
|
|
28752
29181
|
key: string;
|
|
28753
29182
|
/**
|
|
28754
|
-
* Arrow name. Determination is the top-left arrow governing the Primary Health System and digestion, Environment the bottom-left arrow, Perspective the bottom-right arrow also called View, and Motivation the top-right arrow.
|
|
29183
|
+
* Arrow name. Determination is the top-left arrow governing the Primary Health System and digestion, Environment the bottom-left arrow, Perspective the bottom-right arrow also called View, and Motivation the top-right arrow. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
28755
29184
|
*/
|
|
28756
29185
|
name: string;
|
|
28757
29186
|
/**
|
|
28758
|
-
*
|
|
29187
|
+
* Arrow name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
29188
|
+
*/
|
|
29189
|
+
nameLocalized?: string;
|
|
29190
|
+
/**
|
|
29191
|
+
* Which half of the advanced layer the arrow belongs to. Primary Health System covers the body-side Determination and Environment arrows, Rave Psychology covers the mind-side Perspective and Motivation arrows. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use layerLocalized for anything a reader sees.
|
|
28759
29192
|
*/
|
|
28760
29193
|
layer: string;
|
|
28761
29194
|
/**
|
|
28762
|
-
*
|
|
29195
|
+
* Layer name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
29196
|
+
*/
|
|
29197
|
+
layerLocalized?: string;
|
|
29198
|
+
/**
|
|
29199
|
+
* Position of the arrow at the head of the bodygraph. One of Top left, Bottom left, Top right, Bottom right. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use positionLocalized for anything a reader sees.
|
|
28763
29200
|
*/
|
|
28764
29201
|
position: string;
|
|
29202
|
+
/**
|
|
29203
|
+
* Arrow position name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
29204
|
+
*/
|
|
29205
|
+
positionLocalized?: string;
|
|
28765
29206
|
/**
|
|
28766
29207
|
* The single activation, body and chart side, that this arrow is derived from.
|
|
28767
29208
|
*/
|
|
@@ -28792,13 +29233,21 @@ export type PostHumanDesignVariablesResponses = {
|
|
|
28792
29233
|
*/
|
|
28793
29234
|
direction: string;
|
|
28794
29235
|
/**
|
|
28795
|
-
* Name of the Color theme for this arrow, for example a determination family such as Touch, an environment such as Mountains, a perspective such as Personal, or a motivation such as Hope.
|
|
29236
|
+
* Name of the Color theme for this arrow, for example a determination family such as Touch, an environment such as Mountains, a perspective such as Personal, or a motivation such as Hope. Always English, whatever the lang parameter says. Use colorLabelLocalized for anything a reader sees.
|
|
28796
29237
|
*/
|
|
28797
29238
|
colorLabel: string;
|
|
28798
29239
|
/**
|
|
28799
|
-
*
|
|
29240
|
+
* Color theme name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
29241
|
+
*/
|
|
29242
|
+
colorLabelLocalized?: string;
|
|
29243
|
+
/**
|
|
29244
|
+
* Keynote of the arrow direction for this arrow, for example Active or Passive for Determination, Focused or Peripheral for Perspective. Always English, whatever the lang parameter says. Use directionLabelLocalized for anything a reader sees.
|
|
28800
29245
|
*/
|
|
28801
29246
|
directionLabel: string;
|
|
29247
|
+
/**
|
|
29248
|
+
* Arrow direction keynote in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
29249
|
+
*/
|
|
29250
|
+
directionLabelLocalized?: string;
|
|
28802
29251
|
/**
|
|
28803
29252
|
* What this arrow is and what it governs.
|
|
28804
29253
|
*/
|
|
@@ -28820,17 +29269,25 @@ export type PostHumanDesignVariablesResponses = {
|
|
|
28820
29269
|
*/
|
|
28821
29270
|
directionMeaning: string;
|
|
28822
29271
|
/**
|
|
28823
|
-
* Name of the Base. Informational only: the Base is finer than any civil birth time can resolve.
|
|
29272
|
+
* Name of the Base. Informational only: the Base is finer than any civil birth time can resolve. Always English, whatever the lang parameter says. Use baseNameLocalized for anything a reader sees.
|
|
28824
29273
|
*/
|
|
28825
29274
|
baseName: string;
|
|
29275
|
+
/**
|
|
29276
|
+
* Base name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
29277
|
+
*/
|
|
29278
|
+
baseNameLocalized?: string;
|
|
28826
29279
|
/**
|
|
28827
29280
|
* Cognition, the strongest sense, read off the Determination Tone. Present on the determination arrow ONLY: no authority supports reading Cognition from the other three arrows, so it is omitted rather than invented.
|
|
28828
29281
|
*/
|
|
28829
29282
|
cognition?: {
|
|
28830
29283
|
/**
|
|
28831
|
-
* Name of the Cognition, the strongest sense. One of six read off the Determination Tone: Smell, Taste, Outer Vision, Inner Vision, Feeling, Touch.
|
|
29284
|
+
* Name of the Cognition, the strongest sense. One of six read off the Determination Tone: Smell, Taste, Outer Vision, Inner Vision, Feeling, Touch. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use labelLocalized for anything a reader sees.
|
|
28832
29285
|
*/
|
|
28833
29286
|
label: string;
|
|
29287
|
+
/**
|
|
29288
|
+
* Cognition name in the requested language, for display only. Present only when lang is set to a language other than English, since in English it would repeat its canonical partner field exactly. Never compare against this value, compare against the canonical field beside it.
|
|
29289
|
+
*/
|
|
29290
|
+
labelLocalized?: string;
|
|
28834
29291
|
/**
|
|
28835
29292
|
* How this Cognition discriminates what is correct for the body, and the conditions that sharpen it. Renderable as the Cognition paragraph of a Variables or Primary Health System report.
|
|
28836
29293
|
*/
|
|
@@ -41320,7 +41777,7 @@ export type GetLocationSearchData = {
|
|
|
41320
41777
|
path?: never;
|
|
41321
41778
|
query: {
|
|
41322
41779
|
/**
|
|
41323
|
-
*
|
|
41780
|
+
* Place to search for, written the way a person would. Accepts a bare city (berlin), a city plus country (berlin germany), a comma-qualified place (richfield, utah), a fully qualified place (richfield, utah, united states), or a historic name (bombay, peking, constantinople). Commas are optional, and a qualifier the dataset spells differently, such as USA for United States, still resolves. Matched against city name, alternate names, state or province, and country. Add the state or country whenever the name is common, since that is what separates the six Springfields, and Richfield, Utah from Richfield, Minnesota.
|
|
41324
41781
|
*/
|
|
41325
41782
|
q: string;
|
|
41326
41783
|
/**
|
|
@@ -41438,11 +41895,11 @@ export type GetLocationSearchErrors = {
|
|
|
41438
41895
|
export type GetLocationSearchError = GetLocationSearchErrors[keyof GetLocationSearchErrors];
|
|
41439
41896
|
export type GetLocationSearchResponses = {
|
|
41440
41897
|
/**
|
|
41441
|
-
* Matching
|
|
41898
|
+
* Matching places, best match first, with coordinates, IANA timezone and UTC offset
|
|
41442
41899
|
*/
|
|
41443
41900
|
200: {
|
|
41444
41901
|
/**
|
|
41445
|
-
*
|
|
41902
|
+
* Number of places matching the query across all pages, not the number returned in this response. Greater than 1 means the name is ambiguous, so show province and country and let the user confirm before using the result for a chart.
|
|
41446
41903
|
*/
|
|
41447
41904
|
total: number;
|
|
41448
41905
|
/**
|
|
@@ -41450,11 +41907,11 @@ export type GetLocationSearchResponses = {
|
|
|
41450
41907
|
*/
|
|
41451
41908
|
limit: number;
|
|
41452
41909
|
/**
|
|
41453
|
-
* Number of
|
|
41910
|
+
* Number of places skipped. Use with limit to page through results.
|
|
41454
41911
|
*/
|
|
41455
41912
|
offset: number;
|
|
41456
41913
|
/**
|
|
41457
|
-
*
|
|
41914
|
+
* Matching places for the current page, best match first. Ordered by match quality, then population within equal quality: an exact name beats a qualified name such as richfield, utah, which beats a name merely starting with the query, which beats an incidental match on state or country. Take the first entry when total is 1, otherwise disambiguate on province and country.
|
|
41458
41915
|
*/
|
|
41459
41916
|
cities: Array<{
|
|
41460
41917
|
/**
|
|
@@ -41462,7 +41919,7 @@ export type GetLocationSearchResponses = {
|
|
|
41462
41919
|
*/
|
|
41463
41920
|
city: string;
|
|
41464
41921
|
/**
|
|
41465
|
-
* State, province, canton, or administrative region.
|
|
41922
|
+
* State, province, canton, or administrative region. Show it whenever more than one result comes back: it is what separates Richfield, Utah from Richfield, Minnesota, and the six US Springfields from each other. Empty for the small number of places with no administrative division recorded.
|
|
41466
41923
|
*/
|
|
41467
41924
|
province: string;
|
|
41468
41925
|
/**
|
|
@@ -41482,15 +41939,15 @@ export type GetLocationSearchResponses = {
|
|
|
41482
41939
|
*/
|
|
41483
41940
|
longitude: number;
|
|
41484
41941
|
/**
|
|
41485
|
-
* IANA timezone identifier following the tz database standard (e.g. Europe/Berlin, America/New_York, Asia/Tokyo).
|
|
41942
|
+
* IANA timezone identifier following the tz database standard (e.g. Europe/Berlin, America/New_York, Asia/Tokyo). Always present. Pass THIS, not the numeric offset, into any chart or panchang request for a past date: the calculation endpoints resolve it to the offset that was actually in force on that date, including historical daylight saving. Also works directly with JavaScript Date, Luxon, day.js, or any date library.
|
|
41486
41943
|
*/
|
|
41487
41944
|
timezone: string;
|
|
41488
41945
|
/**
|
|
41489
|
-
*
|
|
41946
|
+
* UTC offset in decimal hours for TODAY at this place, already adjusted for daylight saving. Convenient for displaying local time now. For a birth date or any past date use the `timezone` field instead, since the offset in force then may differ. Examples: 1 for CET, 2 for CEST, -5 for EST, 5.5 for IST, 5.75 for Nepal.
|
|
41490
41947
|
*/
|
|
41491
41948
|
utcOffset: number;
|
|
41492
41949
|
/**
|
|
41493
|
-
*
|
|
41950
|
+
* Population estimate for the place. Breaks ties between results of equal match quality, so among several places matching equally well the largest leads. It never outranks a better match, which is why a small town still wins when its name is typed exactly. May be 0 for a hamlet or administrative seat that carries no published figure.
|
|
41494
41951
|
*/
|
|
41495
41952
|
population: number;
|
|
41496
41953
|
}>;
|
|
@@ -41620,7 +42077,7 @@ export type GetLocationCountriesResponses = {
|
|
|
41620
42077
|
*/
|
|
41621
42078
|
200: {
|
|
41622
42079
|
/**
|
|
41623
|
-
* Total number of countries
|
|
42080
|
+
* Total number of countries with at least one place in the dataset.
|
|
41624
42081
|
*/
|
|
41625
42082
|
total: number;
|
|
41626
42083
|
/**
|
|
@@ -41648,7 +42105,7 @@ export type GetLocationCountriesResponses = {
|
|
|
41648
42105
|
*/
|
|
41649
42106
|
iso3: string;
|
|
41650
42107
|
/**
|
|
41651
|
-
* Number of searchable
|
|
42108
|
+
* Number of searchable places in this country, including small towns and administrative seats. Useful for showing coverage in a UI or sizing a dependent city dropdown.
|
|
41652
42109
|
*/
|
|
41653
42110
|
cityCount: number;
|
|
41654
42111
|
}>;
|
|
@@ -41783,7 +42240,7 @@ export type GetLocationCountriesByIso2Responses = {
|
|
|
41783
42240
|
*/
|
|
41784
42241
|
200: {
|
|
41785
42242
|
/**
|
|
41786
|
-
* Total number of
|
|
42243
|
+
* Total number of places available for this country across all pages.
|
|
41787
42244
|
*/
|
|
41788
42245
|
total: number;
|
|
41789
42246
|
/**
|
|
@@ -41803,7 +42260,7 @@ export type GetLocationCountriesByIso2Responses = {
|
|
|
41803
42260
|
*/
|
|
41804
42261
|
city: string;
|
|
41805
42262
|
/**
|
|
41806
|
-
* State, province, canton, or administrative region.
|
|
42263
|
+
* State, province, canton, or administrative region. Show it whenever more than one result comes back: it is what separates Richfield, Utah from Richfield, Minnesota, and the six US Springfields from each other. Empty for the small number of places with no administrative division recorded.
|
|
41807
42264
|
*/
|
|
41808
42265
|
province: string;
|
|
41809
42266
|
/**
|
|
@@ -41823,15 +42280,15 @@ export type GetLocationCountriesByIso2Responses = {
|
|
|
41823
42280
|
*/
|
|
41824
42281
|
longitude: number;
|
|
41825
42282
|
/**
|
|
41826
|
-
* IANA timezone identifier following the tz database standard (e.g. Europe/Berlin, America/New_York, Asia/Tokyo).
|
|
42283
|
+
* IANA timezone identifier following the tz database standard (e.g. Europe/Berlin, America/New_York, Asia/Tokyo). Always present. Pass THIS, not the numeric offset, into any chart or panchang request for a past date: the calculation endpoints resolve it to the offset that was actually in force on that date, including historical daylight saving. Also works directly with JavaScript Date, Luxon, day.js, or any date library.
|
|
41827
42284
|
*/
|
|
41828
42285
|
timezone: string;
|
|
41829
42286
|
/**
|
|
41830
|
-
*
|
|
42287
|
+
* UTC offset in decimal hours for TODAY at this place, already adjusted for daylight saving. Convenient for displaying local time now. For a birth date or any past date use the `timezone` field instead, since the offset in force then may differ. Examples: 1 for CET, 2 for CEST, -5 for EST, 5.5 for IST, 5.75 for Nepal.
|
|
41831
42288
|
*/
|
|
41832
42289
|
utcOffset: number;
|
|
41833
42290
|
/**
|
|
41834
|
-
*
|
|
42291
|
+
* Population estimate for the place. Breaks ties between results of equal match quality, so among several places matching equally well the largest leads. It never outranks a better match, which is why a small town still wins when its name is typed exactly. May be 0 for a hamlet or administrative seat that carries no published figure.
|
|
41835
42292
|
*/
|
|
41836
42293
|
population: number;
|
|
41837
42294
|
}>;
|