@roxyapi/sdk 1.2.60 → 1.2.61
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 +557 -117
- 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 +557 -117
- package/src/version.ts +1 -1
package/src/types.gen.ts
CHANGED
|
@@ -398,6 +398,10 @@ export type NatalChartRequest = {
|
|
|
398
398
|
* 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.
|
|
399
399
|
*/
|
|
400
400
|
timezone: number | string;
|
|
401
|
+
/**
|
|
402
|
+
* 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".
|
|
403
|
+
*/
|
|
404
|
+
nodeType?: 'mean' | 'true';
|
|
401
405
|
/**
|
|
402
406
|
* 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.
|
|
403
407
|
*/
|
|
@@ -805,6 +809,10 @@ export type AspectPatternsRequest = {
|
|
|
805
809
|
* 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.
|
|
806
810
|
*/
|
|
807
811
|
timezone: number | string;
|
|
812
|
+
/**
|
|
813
|
+
* 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".
|
|
814
|
+
*/
|
|
815
|
+
nodeType?: 'mean' | 'true';
|
|
808
816
|
};
|
|
809
817
|
|
|
810
818
|
export type TransitsResponse = {
|
|
@@ -971,6 +979,10 @@ export type TransitsRequest = {
|
|
|
971
979
|
* 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).
|
|
972
980
|
*/
|
|
973
981
|
timezone?: number | string;
|
|
982
|
+
/**
|
|
983
|
+
* 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".
|
|
984
|
+
*/
|
|
985
|
+
nodeType?: 'mean' | 'true';
|
|
974
986
|
/**
|
|
975
987
|
* Optional natal chart data to compare transits against
|
|
976
988
|
*/
|
|
@@ -1029,9 +1041,13 @@ export type AstrocartographyResponse = {
|
|
|
1029
1041
|
*/
|
|
1030
1042
|
lines: Array<{
|
|
1031
1043
|
/**
|
|
1032
|
-
* Celestial body this set of planetary lines belongs to.
|
|
1044
|
+
* 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.
|
|
1033
1045
|
*/
|
|
1034
1046
|
planet: string;
|
|
1047
|
+
/**
|
|
1048
|
+
* 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.
|
|
1049
|
+
*/
|
|
1050
|
+
planetLocalized?: string;
|
|
1035
1051
|
/**
|
|
1036
1052
|
* Unicode astronomical symbol for this body.
|
|
1037
1053
|
*/
|
|
@@ -1323,7 +1339,7 @@ export type RelocationChartResponse = {
|
|
|
1323
1339
|
|
|
1324
1340
|
export type RelocationPlanet = {
|
|
1325
1341
|
/**
|
|
1326
|
-
* 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).
|
|
1342
|
+
* 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.
|
|
1327
1343
|
*/
|
|
1328
1344
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
1329
1345
|
/**
|
|
@@ -1447,9 +1463,13 @@ export type LocalSpaceResponse = {
|
|
|
1447
1463
|
*/
|
|
1448
1464
|
bodies: Array<{
|
|
1449
1465
|
/**
|
|
1450
|
-
* Body name (Sun, Moon, Mercury through Pluto, plus North Node, Chiron, or Black Moon Lilith when requested).
|
|
1466
|
+
* 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.
|
|
1451
1467
|
*/
|
|
1452
1468
|
planet: string;
|
|
1469
|
+
/**
|
|
1470
|
+
* 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.
|
|
1471
|
+
*/
|
|
1472
|
+
planetLocalized?: string;
|
|
1453
1473
|
/**
|
|
1454
1474
|
* Unicode astronomical symbol for this body.
|
|
1455
1475
|
*/
|
|
@@ -1570,9 +1590,13 @@ export type FixedStarsResponse = {
|
|
|
1570
1590
|
*/
|
|
1571
1591
|
conjunctions: Array<{
|
|
1572
1592
|
/**
|
|
1573
|
-
* 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.
|
|
1574
1594
|
*/
|
|
1575
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;
|
|
1576
1600
|
/**
|
|
1577
1601
|
* Tropical ecliptic longitude of the natal point in degrees (0-360).
|
|
1578
1602
|
*/
|
|
@@ -1592,9 +1616,13 @@ export type FixedStarsResponse = {
|
|
|
1592
1616
|
*/
|
|
1593
1617
|
star: string;
|
|
1594
1618
|
/**
|
|
1595
|
-
* 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.
|
|
1596
1620
|
*/
|
|
1597
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;
|
|
1598
1626
|
/**
|
|
1599
1627
|
* Angular separation in degrees between the star and the natal point.
|
|
1600
1628
|
*/
|
|
@@ -1645,13 +1673,17 @@ export type ArabicLotsResponse = {
|
|
|
1645
1673
|
*/
|
|
1646
1674
|
lots: Array<{
|
|
1647
1675
|
/**
|
|
1648
|
-
* Stable machine identifier for the lot (fortune, spirit, eros, necessity, courage, victory, nemesis). Use this for lookups
|
|
1676
|
+
* Stable machine identifier for the lot (fortune, spirit, eros, necessity, courage, victory, nemesis). Use this for lookups.
|
|
1649
1677
|
*/
|
|
1650
1678
|
id: string;
|
|
1651
1679
|
/**
|
|
1652
|
-
*
|
|
1680
|
+
* 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.
|
|
1653
1681
|
*/
|
|
1654
1682
|
name: string;
|
|
1683
|
+
/**
|
|
1684
|
+
* 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.
|
|
1685
|
+
*/
|
|
1686
|
+
nameLocalized?: string;
|
|
1655
1687
|
/**
|
|
1656
1688
|
* Absolute tropical ecliptic longitude of the lot in degrees (0 to 360).
|
|
1657
1689
|
*/
|
|
@@ -1700,6 +1732,10 @@ export type ArabicLotsRequest = {
|
|
|
1700
1732
|
* 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.
|
|
1701
1733
|
*/
|
|
1702
1734
|
timezone: number | string;
|
|
1735
|
+
/**
|
|
1736
|
+
* 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".
|
|
1737
|
+
*/
|
|
1738
|
+
nodeType?: 'mean' | 'true';
|
|
1703
1739
|
/**
|
|
1704
1740
|
* 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.
|
|
1705
1741
|
*/
|
|
@@ -1741,9 +1777,13 @@ export type AsteroidsResponse = {
|
|
|
1741
1777
|
*/
|
|
1742
1778
|
asteroids: Array<{
|
|
1743
1779
|
/**
|
|
1744
|
-
*
|
|
1780
|
+
* 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.
|
|
1745
1781
|
*/
|
|
1746
1782
|
name: string;
|
|
1783
|
+
/**
|
|
1784
|
+
* 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.
|
|
1785
|
+
*/
|
|
1786
|
+
nameLocalized?: string;
|
|
1747
1787
|
/**
|
|
1748
1788
|
* Absolute tropical ecliptic longitude of the asteroid in degrees (0 to 360).
|
|
1749
1789
|
*/
|
|
@@ -1804,6 +1844,10 @@ export type AsteroidsRequest = {
|
|
|
1804
1844
|
* 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.
|
|
1805
1845
|
*/
|
|
1806
1846
|
timezone: number | string;
|
|
1847
|
+
/**
|
|
1848
|
+
* 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".
|
|
1849
|
+
*/
|
|
1850
|
+
nodeType?: 'mean' | 'true';
|
|
1807
1851
|
/**
|
|
1808
1852
|
* 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.
|
|
1809
1853
|
*/
|
|
@@ -1845,9 +1889,13 @@ export type LilithResponse = {
|
|
|
1845
1889
|
*/
|
|
1846
1890
|
lilith: Array<{
|
|
1847
1891
|
/**
|
|
1848
|
-
* Which lunar apogee this entry describes
|
|
1892
|
+
* 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.
|
|
1849
1893
|
*/
|
|
1850
|
-
variant:
|
|
1894
|
+
variant: 'mean' | 'true';
|
|
1895
|
+
/**
|
|
1896
|
+
* 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.
|
|
1897
|
+
*/
|
|
1898
|
+
variantLocalized?: string;
|
|
1851
1899
|
/**
|
|
1852
1900
|
* Absolute tropical ecliptic longitude of the apogee in degrees (0 to 360).
|
|
1853
1901
|
*/
|
|
@@ -1912,6 +1960,10 @@ export type LilithRequest = {
|
|
|
1912
1960
|
* 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.
|
|
1913
1961
|
*/
|
|
1914
1962
|
timezone: number | string;
|
|
1963
|
+
/**
|
|
1964
|
+
* 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".
|
|
1965
|
+
*/
|
|
1966
|
+
nodeType?: 'mean' | 'true';
|
|
1915
1967
|
/**
|
|
1916
1968
|
* House system used to place each Lilith variant in a house. Placidus (default), Whole Sign, Equal, or Koch.
|
|
1917
1969
|
*/
|
|
@@ -2070,6 +2122,10 @@ export type ProgressionsRequest = {
|
|
|
2070
2122
|
* 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.
|
|
2071
2123
|
*/
|
|
2072
2124
|
timezone: number | string;
|
|
2125
|
+
/**
|
|
2126
|
+
* 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".
|
|
2127
|
+
*/
|
|
2128
|
+
nodeType?: 'mean' | 'true';
|
|
2073
2129
|
/**
|
|
2074
2130
|
* 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.
|
|
2075
2131
|
*/
|
|
@@ -2119,9 +2175,13 @@ export type SolarArcResponse = {
|
|
|
2119
2175
|
*/
|
|
2120
2176
|
directed: Array<{
|
|
2121
2177
|
/**
|
|
2122
|
-
* Name of the directed point,
|
|
2178
|
+
* 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.
|
|
2123
2179
|
*/
|
|
2124
2180
|
name: string;
|
|
2181
|
+
/**
|
|
2182
|
+
* 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.
|
|
2183
|
+
*/
|
|
2184
|
+
nameLocalized?: string;
|
|
2125
2185
|
/**
|
|
2126
2186
|
* Absolute tropical ecliptic longitude of the point in the natal chart, in degrees (0 to 360).
|
|
2127
2187
|
*/
|
|
@@ -2166,6 +2226,10 @@ export type SolarArcRequest = {
|
|
|
2166
2226
|
* 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.
|
|
2167
2227
|
*/
|
|
2168
2228
|
timezone: number | string;
|
|
2229
|
+
/**
|
|
2230
|
+
* 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".
|
|
2231
|
+
*/
|
|
2232
|
+
nodeType?: 'mean' | 'true';
|
|
2169
2233
|
/**
|
|
2170
2234
|
* 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.
|
|
2171
2235
|
*/
|
|
@@ -2262,6 +2326,10 @@ export type ProfectionsRequest = {
|
|
|
2262
2326
|
* 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.
|
|
2263
2327
|
*/
|
|
2264
2328
|
timezone: number | string;
|
|
2329
|
+
/**
|
|
2330
|
+
* 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".
|
|
2331
|
+
*/
|
|
2332
|
+
nodeType?: 'mean' | 'true';
|
|
2265
2333
|
/**
|
|
2266
2334
|
* 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.
|
|
2267
2335
|
*/
|
|
@@ -4409,7 +4477,7 @@ export type KpPlanetsRequest = {
|
|
|
4409
4477
|
*/
|
|
4410
4478
|
ayanamsaValue?: number;
|
|
4411
4479
|
/**
|
|
4412
|
-
* Lunar node
|
|
4480
|
+
* 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".
|
|
4413
4481
|
*/
|
|
4414
4482
|
nodeType?: 'mean' | 'true';
|
|
4415
4483
|
};
|
|
@@ -4867,7 +4935,7 @@ export type KpChartRequest = {
|
|
|
4867
4935
|
*/
|
|
4868
4936
|
ayanamsaValue?: number;
|
|
4869
4937
|
/**
|
|
4870
|
-
* Lunar node
|
|
4938
|
+
* 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".
|
|
4871
4939
|
*/
|
|
4872
4940
|
nodeType?: 'mean' | 'true';
|
|
4873
4941
|
};
|
|
@@ -5241,7 +5309,7 @@ export type KpSublordChangesRequest = {
|
|
|
5241
5309
|
*/
|
|
5242
5310
|
ayanamsa?: 'kp-newcomb' | 'kp-old' | 'lahiri' | 'raman';
|
|
5243
5311
|
/**
|
|
5244
|
-
* Lunar node
|
|
5312
|
+
* 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".
|
|
5245
5313
|
*/
|
|
5246
5314
|
nodeType?: 'mean' | 'true';
|
|
5247
5315
|
};
|
|
@@ -5320,7 +5388,7 @@ export type KpRasiChangesRequest = {
|
|
|
5320
5388
|
*/
|
|
5321
5389
|
ayanamsa?: 'kp-newcomb' | 'kp-old' | 'lahiri' | 'raman';
|
|
5322
5390
|
/**
|
|
5323
|
-
* Lunar node
|
|
5391
|
+
* 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".
|
|
5324
5392
|
*/
|
|
5325
5393
|
nodeType?: 'mean' | 'true';
|
|
5326
5394
|
};
|
|
@@ -5446,7 +5514,7 @@ export type KpPlanetsIntervalRequest = {
|
|
|
5446
5514
|
*/
|
|
5447
5515
|
ayanamsa?: 'kp-newcomb' | 'kp-old' | 'lahiri' | 'raman';
|
|
5448
5516
|
/**
|
|
5449
|
-
* Lunar node
|
|
5517
|
+
* 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".
|
|
5450
5518
|
*/
|
|
5451
5519
|
nodeType?: 'mean' | 'true';
|
|
5452
5520
|
};
|
|
@@ -5730,7 +5798,7 @@ export type KpHoraryRequest = {
|
|
|
5730
5798
|
*/
|
|
5731
5799
|
ayanamsaValue?: number;
|
|
5732
5800
|
/**
|
|
5733
|
-
* Lunar node
|
|
5801
|
+
* 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".
|
|
5734
5802
|
*/
|
|
5735
5803
|
nodeType?: 'mean' | 'true';
|
|
5736
5804
|
};
|
|
@@ -7506,9 +7574,13 @@ export type GetAstrologySignsResponses = {
|
|
|
7506
7574
|
*/
|
|
7507
7575
|
symbol?: string;
|
|
7508
7576
|
/**
|
|
7509
|
-
* Elemental classification:
|
|
7577
|
+
* 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.
|
|
7510
7578
|
*/
|
|
7511
7579
|
element: 'fire' | 'earth' | 'air' | 'water';
|
|
7580
|
+
/**
|
|
7581
|
+
* 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.
|
|
7582
|
+
*/
|
|
7583
|
+
elementLocalized?: string;
|
|
7512
7584
|
/**
|
|
7513
7585
|
* Tropical zodiac date range for this sign.
|
|
7514
7586
|
*/
|
|
@@ -7687,17 +7759,29 @@ export type GetAstrologySignsByIdResponses = {
|
|
|
7687
7759
|
*/
|
|
7688
7760
|
symbolName: string;
|
|
7689
7761
|
/**
|
|
7690
|
-
* Elemental classification:
|
|
7762
|
+
* 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.
|
|
7691
7763
|
*/
|
|
7692
7764
|
element: 'fire' | 'earth' | 'air' | 'water';
|
|
7693
7765
|
/**
|
|
7694
|
-
*
|
|
7766
|
+
* 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.
|
|
7767
|
+
*/
|
|
7768
|
+
elementLocalized?: string;
|
|
7769
|
+
/**
|
|
7770
|
+
* 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.
|
|
7695
7771
|
*/
|
|
7696
7772
|
modality: 'cardinal' | 'fixed' | 'mutable';
|
|
7697
7773
|
/**
|
|
7698
|
-
*
|
|
7774
|
+
* 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.
|
|
7775
|
+
*/
|
|
7776
|
+
modalityLocalized?: string;
|
|
7777
|
+
/**
|
|
7778
|
+
* 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.
|
|
7699
7779
|
*/
|
|
7700
7780
|
rulingPlanet: string;
|
|
7781
|
+
/**
|
|
7782
|
+
* 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.
|
|
7783
|
+
*/
|
|
7784
|
+
rulingPlanetLocalized?: string;
|
|
7701
7785
|
/**
|
|
7702
7786
|
* Tropical zodiac date range for this sign.
|
|
7703
7787
|
*/
|
|
@@ -8272,6 +8356,10 @@ export type PostAstrologyPlanetsData = {
|
|
|
8272
8356
|
* 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.
|
|
8273
8357
|
*/
|
|
8274
8358
|
time: string;
|
|
8359
|
+
/**
|
|
8360
|
+
* 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".
|
|
8361
|
+
*/
|
|
8362
|
+
nodeType?: 'mean' | 'true';
|
|
8275
8363
|
/**
|
|
8276
8364
|
* 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.
|
|
8277
8365
|
*/
|
|
@@ -9193,6 +9281,10 @@ export type PostAstrologySynastryData = {
|
|
|
9193
9281
|
* 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.
|
|
9194
9282
|
*/
|
|
9195
9283
|
timezone: number | string;
|
|
9284
|
+
/**
|
|
9285
|
+
* 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".
|
|
9286
|
+
*/
|
|
9287
|
+
nodeType?: 'mean' | 'true';
|
|
9196
9288
|
/**
|
|
9197
9289
|
* Optional display name for this person. Included in the response for easy identification.
|
|
9198
9290
|
*/
|
|
@@ -9219,6 +9311,10 @@ export type PostAstrologySynastryData = {
|
|
|
9219
9311
|
* 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.
|
|
9220
9312
|
*/
|
|
9221
9313
|
timezone: number | string;
|
|
9314
|
+
/**
|
|
9315
|
+
* 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".
|
|
9316
|
+
*/
|
|
9317
|
+
nodeType?: 'mean' | 'true';
|
|
9222
9318
|
/**
|
|
9223
9319
|
* Optional display name for this person. Included in the response for easy identification.
|
|
9224
9320
|
*/
|
|
@@ -10197,6 +10293,10 @@ export type PostAstrologyTransitAspectsData = {
|
|
|
10197
10293
|
* 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.
|
|
10198
10294
|
*/
|
|
10199
10295
|
timezone: number | string;
|
|
10296
|
+
/**
|
|
10297
|
+
* 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".
|
|
10298
|
+
*/
|
|
10299
|
+
nodeType?: 'mean' | 'true';
|
|
10200
10300
|
};
|
|
10201
10301
|
/**
|
|
10202
10302
|
* Transit date in YYYY-MM-DD format. Defaults to current date if omitted. Use future dates for predictive transit analysis.
|
|
@@ -10350,12 +10450,58 @@ export type PostAstrologyTransitAspectsResponses = {
|
|
|
10350
10450
|
* 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.
|
|
10351
10451
|
*/
|
|
10352
10452
|
houseSystem: 'placidus' | 'whole-sign' | 'equal' | 'koch';
|
|
10453
|
+
/**
|
|
10454
|
+
* 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.
|
|
10455
|
+
*/
|
|
10456
|
+
houses: Array<{
|
|
10457
|
+
/**
|
|
10458
|
+
* House number (1-12). Each house governs specific life themes in Western astrology.
|
|
10459
|
+
*/
|
|
10460
|
+
number: number;
|
|
10461
|
+
/**
|
|
10462
|
+
* Ecliptic longitude of this house cusp in degrees (0-360).
|
|
10463
|
+
*/
|
|
10464
|
+
longitude: number;
|
|
10465
|
+
/**
|
|
10466
|
+
* Zodiac sign on this house cusp. Colors the themes of this life area.
|
|
10467
|
+
*/
|
|
10468
|
+
sign: string;
|
|
10469
|
+
/**
|
|
10470
|
+
* Degree within the zodiac sign on this cusp (0-29.999).
|
|
10471
|
+
*/
|
|
10472
|
+
degree: number;
|
|
10473
|
+
/**
|
|
10474
|
+
* 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.
|
|
10475
|
+
*/
|
|
10476
|
+
signLocalized?: string;
|
|
10477
|
+
}>;
|
|
10478
|
+
/**
|
|
10479
|
+
* 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.
|
|
10480
|
+
*/
|
|
10481
|
+
ascendant: {
|
|
10482
|
+
/**
|
|
10483
|
+
* Tropical zodiac sign on the natal Ascendant. Always English, whatever the lang parameter says. Use signLocalized for anything a reader sees.
|
|
10484
|
+
*/
|
|
10485
|
+
sign: string;
|
|
10486
|
+
/**
|
|
10487
|
+
* 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.
|
|
10488
|
+
*/
|
|
10489
|
+
signLocalized?: string;
|
|
10490
|
+
/**
|
|
10491
|
+
* Degree within the Ascendant sign (0-29.999).
|
|
10492
|
+
*/
|
|
10493
|
+
degree: number;
|
|
10494
|
+
/**
|
|
10495
|
+
* Absolute ecliptic longitude of the natal Ascendant in degrees (0-360).
|
|
10496
|
+
*/
|
|
10497
|
+
longitude: number;
|
|
10498
|
+
};
|
|
10353
10499
|
/**
|
|
10354
10500
|
* 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.
|
|
10355
10501
|
*/
|
|
10356
10502
|
transitPlanets: Array<{
|
|
10357
10503
|
/**
|
|
10358
|
-
* 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).
|
|
10504
|
+
* 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.
|
|
10359
10505
|
*/
|
|
10360
10506
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
10361
10507
|
/**
|
|
@@ -10400,7 +10546,7 @@ export type PostAstrologyTransitAspectsResponses = {
|
|
|
10400
10546
|
*/
|
|
10401
10547
|
natalPlanets: Array<{
|
|
10402
10548
|
/**
|
|
10403
|
-
* 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).
|
|
10549
|
+
* 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.
|
|
10404
10550
|
*/
|
|
10405
10551
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
10406
10552
|
/**
|
|
@@ -10488,7 +10634,10 @@ export type PostAstrologyTransitAspectsResponses = {
|
|
|
10488
10634
|
* 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.
|
|
10489
10635
|
*/
|
|
10490
10636
|
typeLocalized?: string;
|
|
10491
|
-
|
|
10637
|
+
/**
|
|
10638
|
+
* Rich interpretation of the transit aspect: narrative summary, timing, impact assessment, practical guidance, and keywords.
|
|
10639
|
+
*/
|
|
10640
|
+
transitInterpretation: {
|
|
10492
10641
|
/**
|
|
10493
10642
|
* Narrative interpretation of this transit aspect and its life impact.
|
|
10494
10643
|
*/
|
|
@@ -10579,6 +10728,31 @@ export type PostAstrologyTransitAspectsResponses = {
|
|
|
10579
10728
|
* 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.
|
|
10580
10729
|
*/
|
|
10581
10730
|
typeLocalized?: string;
|
|
10731
|
+
/**
|
|
10732
|
+
* Rich interpretation of the transit aspect: narrative summary, timing, impact assessment, practical guidance, and keywords.
|
|
10733
|
+
*/
|
|
10734
|
+
transitInterpretation: {
|
|
10735
|
+
/**
|
|
10736
|
+
* Narrative interpretation of this transit aspect and its life impact.
|
|
10737
|
+
*/
|
|
10738
|
+
summary: string;
|
|
10739
|
+
/**
|
|
10740
|
+
* 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.
|
|
10741
|
+
*/
|
|
10742
|
+
timing: string;
|
|
10743
|
+
/**
|
|
10744
|
+
* Strength and nature of this transit effect — constructive, challenging, or neutral.
|
|
10745
|
+
*/
|
|
10746
|
+
impact: string;
|
|
10747
|
+
/**
|
|
10748
|
+
* Practical advice for working with this transit energy.
|
|
10749
|
+
*/
|
|
10750
|
+
guidance: string;
|
|
10751
|
+
/**
|
|
10752
|
+
* Key themes activated by this transit aspect.
|
|
10753
|
+
*/
|
|
10754
|
+
keywords: Array<string>;
|
|
10755
|
+
};
|
|
10582
10756
|
} | null;
|
|
10583
10757
|
/**
|
|
10584
10758
|
* Transit aspect counts grouped by aspect type (conjunction, trine, square, opposition, sextile, etc.). Useful for quickly assessing the transit weather.
|
|
@@ -10801,11 +10975,11 @@ export type PostAstrologySolarReturnResponses = {
|
|
|
10801
10975
|
timezone: number;
|
|
10802
10976
|
};
|
|
10803
10977
|
/**
|
|
10804
|
-
* 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.
|
|
10978
|
+
* 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.
|
|
10805
10979
|
*/
|
|
10806
10980
|
planets: Array<{
|
|
10807
10981
|
/**
|
|
10808
|
-
* 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).
|
|
10982
|
+
* 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.
|
|
10809
10983
|
*/
|
|
10810
10984
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
10811
10985
|
/**
|
|
@@ -11182,11 +11356,11 @@ export type PostAstrologyLunarReturnResponses = {
|
|
|
11182
11356
|
timezone: number;
|
|
11183
11357
|
};
|
|
11184
11358
|
/**
|
|
11185
|
-
* 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.
|
|
11359
|
+
* 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.
|
|
11186
11360
|
*/
|
|
11187
11361
|
planets: Array<{
|
|
11188
11362
|
/**
|
|
11189
|
-
* 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).
|
|
11363
|
+
* 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.
|
|
11190
11364
|
*/
|
|
11191
11365
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
11192
11366
|
/**
|
|
@@ -11384,6 +11558,10 @@ export type PostAstrologyCompositeChartData = {
|
|
|
11384
11558
|
* 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.
|
|
11385
11559
|
*/
|
|
11386
11560
|
timezone: number | string;
|
|
11561
|
+
/**
|
|
11562
|
+
* 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".
|
|
11563
|
+
*/
|
|
11564
|
+
nodeType?: 'mean' | 'true';
|
|
11387
11565
|
};
|
|
11388
11566
|
/**
|
|
11389
11567
|
* Second person birth details (date, time, location, timezone).
|
|
@@ -11409,6 +11587,10 @@ export type PostAstrologyCompositeChartData = {
|
|
|
11409
11587
|
* 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.
|
|
11410
11588
|
*/
|
|
11411
11589
|
timezone: number | string;
|
|
11590
|
+
/**
|
|
11591
|
+
* 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".
|
|
11592
|
+
*/
|
|
11593
|
+
nodeType?: 'mean' | 'true';
|
|
11412
11594
|
};
|
|
11413
11595
|
/**
|
|
11414
11596
|
* House system for the composite chart. Placidus (default), Whole Sign, Equal, or Koch.
|
|
@@ -11589,7 +11771,7 @@ export type PostAstrologyCompositeChartResponses = {
|
|
|
11589
11771
|
*/
|
|
11590
11772
|
compositePlanets: Array<{
|
|
11591
11773
|
/**
|
|
11592
|
-
* 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).
|
|
11774
|
+
* 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.
|
|
11593
11775
|
*/
|
|
11594
11776
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
11595
11777
|
/**
|
|
@@ -11778,6 +11960,10 @@ export type PostAstrologyCompatibilityScoreData = {
|
|
|
11778
11960
|
* 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.
|
|
11779
11961
|
*/
|
|
11780
11962
|
timezone: number | string;
|
|
11963
|
+
/**
|
|
11964
|
+
* 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".
|
|
11965
|
+
*/
|
|
11966
|
+
nodeType?: 'mean' | 'true';
|
|
11781
11967
|
};
|
|
11782
11968
|
/**
|
|
11783
11969
|
* Second person birth details. Compared against person1 to evaluate inter-chart aspects and compatibility.
|
|
@@ -11803,6 +11989,10 @@ export type PostAstrologyCompatibilityScoreData = {
|
|
|
11803
11989
|
* 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.
|
|
11804
11990
|
*/
|
|
11805
11991
|
timezone: number | string;
|
|
11992
|
+
/**
|
|
11993
|
+
* 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".
|
|
11994
|
+
*/
|
|
11995
|
+
nodeType?: 'mean' | 'true';
|
|
11806
11996
|
};
|
|
11807
11997
|
};
|
|
11808
11998
|
path?: never;
|
|
@@ -13096,11 +13286,11 @@ export type PostAstrologyPlanetaryReturnsResponses = {
|
|
|
13096
13286
|
timezone: number;
|
|
13097
13287
|
};
|
|
13098
13288
|
/**
|
|
13099
|
-
* 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.
|
|
13289
|
+
* 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.
|
|
13100
13290
|
*/
|
|
13101
13291
|
planets: Array<{
|
|
13102
13292
|
/**
|
|
13103
|
-
* 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).
|
|
13293
|
+
* 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.
|
|
13104
13294
|
*/
|
|
13105
13295
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
13106
13296
|
/**
|
|
@@ -13290,6 +13480,10 @@ export type PostAstrologyAstrocartographyData = {
|
|
|
13290
13480
|
* 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.
|
|
13291
13481
|
*/
|
|
13292
13482
|
timezone: number | string;
|
|
13483
|
+
/**
|
|
13484
|
+
* 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".
|
|
13485
|
+
*/
|
|
13486
|
+
nodeType?: 'mean' | 'true';
|
|
13293
13487
|
};
|
|
13294
13488
|
path?: never;
|
|
13295
13489
|
query?: {
|
|
@@ -13715,6 +13909,10 @@ export type PostAstrologyFixedStarsData = {
|
|
|
13715
13909
|
* 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.
|
|
13716
13910
|
*/
|
|
13717
13911
|
timezone: number | string;
|
|
13912
|
+
/**
|
|
13913
|
+
* 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".
|
|
13914
|
+
*/
|
|
13915
|
+
nodeType?: 'mean' | 'true';
|
|
13718
13916
|
};
|
|
13719
13917
|
path?: never;
|
|
13720
13918
|
query?: {
|
|
@@ -20835,7 +21033,7 @@ export type PostVedicAstrologyKpRulingPlanetsData = {
|
|
|
20835
21033
|
*/
|
|
20836
21034
|
birthTime?: string;
|
|
20837
21035
|
/**
|
|
20838
|
-
* Lunar node
|
|
21036
|
+
* 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".
|
|
20839
21037
|
*/
|
|
20840
21038
|
nodeType?: 'mean' | 'true';
|
|
20841
21039
|
};
|
|
@@ -20997,7 +21195,7 @@ export type PostVedicAstrologyKpRulingPlanetsIntervalData = {
|
|
|
20997
21195
|
*/
|
|
20998
21196
|
ayanamsa?: 'kp-newcomb' | 'kp-old' | 'lahiri' | 'raman';
|
|
20999
21197
|
/**
|
|
21000
|
-
* Lunar node
|
|
21198
|
+
* 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".
|
|
21001
21199
|
*/
|
|
21002
21200
|
nodeType?: 'mean' | 'true';
|
|
21003
21201
|
};
|
|
@@ -22409,6 +22607,19 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
22409
22607
|
* Transit analysis calculated successfully
|
|
22410
22608
|
*/
|
|
22411
22609
|
200: {
|
|
22610
|
+
/**
|
|
22611
|
+
* 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.
|
|
22612
|
+
*/
|
|
22613
|
+
frame: {
|
|
22614
|
+
/**
|
|
22615
|
+
* Sidereal frame this chart was cast in, echoing the ayanamsa request field. "lahiri" when the field was omitted.
|
|
22616
|
+
*/
|
|
22617
|
+
ayanamsa: string;
|
|
22618
|
+
/**
|
|
22619
|
+
* 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.
|
|
22620
|
+
*/
|
|
22621
|
+
ayanamsaDegrees: number;
|
|
22622
|
+
};
|
|
22412
22623
|
/**
|
|
22413
22624
|
* 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.
|
|
22414
22625
|
*/
|
|
@@ -22455,11 +22666,15 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
22455
22666
|
*/
|
|
22456
22667
|
sign: string;
|
|
22457
22668
|
/**
|
|
22458
|
-
* Which natal house (whole-sign bhava from the Lagna) this
|
|
22669
|
+
* 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.
|
|
22459
22670
|
*/
|
|
22460
22671
|
natalHouse: number;
|
|
22461
22672
|
/**
|
|
22462
|
-
*
|
|
22673
|
+
* 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.
|
|
22674
|
+
*/
|
|
22675
|
+
houseFromMoon: number;
|
|
22676
|
+
/**
|
|
22677
|
+
* 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.
|
|
22463
22678
|
*/
|
|
22464
22679
|
aspectsToNatal: Array<{
|
|
22465
22680
|
/**
|
|
@@ -22467,7 +22682,7 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
22467
22682
|
*/
|
|
22468
22683
|
natalPlanet: string;
|
|
22469
22684
|
/**
|
|
22470
|
-
*
|
|
22685
|
+
* 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.
|
|
22471
22686
|
*/
|
|
22472
22687
|
aspectType: string;
|
|
22473
22688
|
/**
|
|
@@ -22475,6 +22690,27 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
22475
22690
|
*/
|
|
22476
22691
|
orb: number;
|
|
22477
22692
|
}>;
|
|
22693
|
+
/**
|
|
22694
|
+
* 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.
|
|
22695
|
+
*/
|
|
22696
|
+
drishtiToNatal: Array<{
|
|
22697
|
+
/**
|
|
22698
|
+
* Natal graha receiving the drishti from this transiting graha.
|
|
22699
|
+
*/
|
|
22700
|
+
natalPlanet: string;
|
|
22701
|
+
/**
|
|
22702
|
+
* 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.
|
|
22703
|
+
*/
|
|
22704
|
+
aspectType: 'conjunction' | '7th' | '4th' | '8th' | '5th' | '9th' | '3rd' | '10th';
|
|
22705
|
+
/**
|
|
22706
|
+
* Drishti strength as a percentage. Full and special aspects are 100; the partial quarter, half and three-quarter sights are not reported.
|
|
22707
|
+
*/
|
|
22708
|
+
strength: number;
|
|
22709
|
+
/**
|
|
22710
|
+
* 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.
|
|
22711
|
+
*/
|
|
22712
|
+
orb: number;
|
|
22713
|
+
}>;
|
|
22478
22714
|
/**
|
|
22479
22715
|
* 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.
|
|
22480
22716
|
*/
|
|
@@ -22514,17 +22750,25 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
22514
22750
|
*/
|
|
22515
22751
|
planet: string;
|
|
22516
22752
|
/**
|
|
22517
|
-
* Human-readable transit summary.
|
|
22753
|
+
* Human-readable transit summary, naming the rashi being transited and both house readings: from the Lagna, then from the natal Moon.
|
|
22518
22754
|
*/
|
|
22519
22755
|
description: string;
|
|
22520
22756
|
/**
|
|
22521
|
-
* Natal house being transited by this slow
|
|
22757
|
+
* Natal house being transited by this slow graha, counted whole-sign from the Lagna. Mirrors natalHouse on the matching transitingPlanets entry.
|
|
22522
22758
|
*/
|
|
22523
22759
|
natalHouse: number;
|
|
22524
22760
|
/**
|
|
22525
|
-
*
|
|
22761
|
+
* 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.
|
|
22762
|
+
*/
|
|
22763
|
+
houseFromMoon: number;
|
|
22764
|
+
/**
|
|
22765
|
+
* Notable degree-based angular aspects to natal planets from this slow-moving transiting planet, in Western vocabulary.
|
|
22526
22766
|
*/
|
|
22527
22767
|
aspects: Array<string>;
|
|
22768
|
+
/**
|
|
22769
|
+
* Graha drishti this slow-moving transiting graha casts on the natal grahas, the Vedic reading. Empty for Rahu and Ketu, which cast none.
|
|
22770
|
+
*/
|
|
22771
|
+
drishti: Array<string>;
|
|
22528
22772
|
}>;
|
|
22529
22773
|
};
|
|
22530
22774
|
};
|
|
@@ -26570,11 +26814,11 @@ export type PostForecastSolarReturnResponses = {
|
|
|
26570
26814
|
timezone: number;
|
|
26571
26815
|
};
|
|
26572
26816
|
/**
|
|
26573
|
-
* 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.
|
|
26817
|
+
* 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.
|
|
26574
26818
|
*/
|
|
26575
26819
|
planets: Array<{
|
|
26576
26820
|
/**
|
|
26577
|
-
* 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).
|
|
26821
|
+
* 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.
|
|
26578
26822
|
*/
|
|
26579
26823
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
26580
26824
|
/**
|
|
@@ -26735,7 +26979,7 @@ export type PostHumanDesignBodygraphData = {
|
|
|
26735
26979
|
*/
|
|
26736
26980
|
longitude?: number;
|
|
26737
26981
|
/**
|
|
26738
|
-
* Lunar node convention
|
|
26982
|
+
* 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".
|
|
26739
26983
|
*/
|
|
26740
26984
|
nodeType?: 'mean' | 'true';
|
|
26741
26985
|
};
|
|
@@ -26859,9 +27103,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
26859
27103
|
*/
|
|
26860
27104
|
200: {
|
|
26861
27105
|
/**
|
|
26862
|
-
* Human Design energy type. One of Manifestor, Generator, Manifesting Generator, Projector, Reflector.
|
|
27106
|
+
* 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.
|
|
26863
27107
|
*/
|
|
26864
27108
|
type: string;
|
|
27109
|
+
/**
|
|
27110
|
+
* 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.
|
|
27111
|
+
*/
|
|
27112
|
+
typeLocalized?: string;
|
|
26865
27113
|
/**
|
|
26866
27114
|
* 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.
|
|
26867
27115
|
*/
|
|
@@ -26871,29 +27119,45 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
26871
27119
|
*/
|
|
26872
27120
|
aura: string;
|
|
26873
27121
|
/**
|
|
26874
|
-
* The aura strategy for engaging life correctly for this type.
|
|
27122
|
+
* The aura strategy for engaging life correctly for this type. Always English, whatever the lang parameter says. Use strategyLocalized for anything a reader sees.
|
|
26875
27123
|
*/
|
|
26876
27124
|
strategy: string;
|
|
27125
|
+
/**
|
|
27126
|
+
* 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.
|
|
27127
|
+
*/
|
|
27128
|
+
strategyLocalized?: string;
|
|
26877
27129
|
/**
|
|
26878
27130
|
* 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.
|
|
26879
27131
|
*/
|
|
26880
27132
|
strategyDescription: string;
|
|
26881
27133
|
/**
|
|
26882
|
-
* Inner authority for decision making. One of Emotional, Sacral, Splenic, Ego, Self-Projected, Mental, Lunar.
|
|
27134
|
+
* 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.
|
|
26883
27135
|
*/
|
|
26884
27136
|
authority: string;
|
|
27137
|
+
/**
|
|
27138
|
+
* 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.
|
|
27139
|
+
*/
|
|
27140
|
+
authorityLocalized?: string;
|
|
26885
27141
|
/**
|
|
26886
27142
|
* 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.
|
|
26887
27143
|
*/
|
|
26888
27144
|
authorityDescription: string;
|
|
26889
27145
|
/**
|
|
26890
|
-
* The signature feeling of living in alignment with the type.
|
|
27146
|
+
* The signature feeling of living in alignment with the type. Always English, whatever the lang parameter says. Use signatureLocalized for anything a reader sees.
|
|
26891
27147
|
*/
|
|
26892
27148
|
signature: string;
|
|
26893
27149
|
/**
|
|
26894
|
-
*
|
|
27150
|
+
* 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.
|
|
27151
|
+
*/
|
|
27152
|
+
signatureLocalized?: string;
|
|
27153
|
+
/**
|
|
27154
|
+
* 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.
|
|
26895
27155
|
*/
|
|
26896
27156
|
notSelf: string;
|
|
27157
|
+
/**
|
|
27158
|
+
* 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.
|
|
27159
|
+
*/
|
|
27160
|
+
notSelfLocalized?: string;
|
|
26897
27161
|
/**
|
|
26898
27162
|
* Profile in conscious/unconscious form from the Personality Sun line over the Design Sun line.
|
|
26899
27163
|
*/
|
|
@@ -26924,9 +27188,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
26924
27188
|
*/
|
|
26925
27189
|
profileDescription: string;
|
|
26926
27190
|
/**
|
|
26927
|
-
* Definition type from the number of connected components among defined centers. One of None, Single, Split, Triple Split, Quadruple Split.
|
|
27191
|
+
* 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.
|
|
26928
27192
|
*/
|
|
26929
27193
|
definition: string;
|
|
27194
|
+
/**
|
|
27195
|
+
* 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.
|
|
27196
|
+
*/
|
|
27197
|
+
definitionLocalized?: string;
|
|
26930
27198
|
/**
|
|
26931
27199
|
* 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.
|
|
26932
27200
|
*/
|
|
@@ -26946,9 +27214,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
26946
27214
|
*/
|
|
26947
27215
|
gates: Array<number>;
|
|
26948
27216
|
/**
|
|
26949
|
-
* Cross angle. One of Right Angle, Juxtaposition, Left Angle.
|
|
27217
|
+
* Cross angle. One of Right Angle, Juxtaposition, Left Angle. Always English, whatever the lang parameter says. Use angleLocalized for anything a reader sees.
|
|
26950
27218
|
*/
|
|
26951
27219
|
angle: string;
|
|
27220
|
+
/**
|
|
27221
|
+
* 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.
|
|
27222
|
+
*/
|
|
27223
|
+
angleLocalized?: string;
|
|
26952
27224
|
/**
|
|
26953
27225
|
* Short code for the angle. One of RAX, JXT, LAX.
|
|
26954
27226
|
*/
|
|
@@ -26971,9 +27243,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
26971
27243
|
*/
|
|
26972
27244
|
id: string;
|
|
26973
27245
|
/**
|
|
26974
|
-
* Display name of the center.
|
|
27246
|
+
* 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.
|
|
26975
27247
|
*/
|
|
26976
27248
|
name: string;
|
|
27249
|
+
/**
|
|
27250
|
+
* 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.
|
|
27251
|
+
*/
|
|
27252
|
+
nameLocalized?: string;
|
|
26977
27253
|
/**
|
|
26978
27254
|
* 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.
|
|
26979
27255
|
*/
|
|
@@ -27016,13 +27292,21 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
27016
27292
|
*/
|
|
27017
27293
|
gateB: number;
|
|
27018
27294
|
/**
|
|
27019
|
-
* Name of the defined channel.
|
|
27295
|
+
* Name of the defined channel. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
27020
27296
|
*/
|
|
27021
27297
|
name: string;
|
|
27022
27298
|
/**
|
|
27023
|
-
*
|
|
27299
|
+
* 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.
|
|
27300
|
+
*/
|
|
27301
|
+
nameLocalized?: string;
|
|
27302
|
+
/**
|
|
27303
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal. Always English, whatever the lang parameter says. Use circuitLocalized for anything a reader sees.
|
|
27024
27304
|
*/
|
|
27025
27305
|
circuit: string;
|
|
27306
|
+
/**
|
|
27307
|
+
* 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.
|
|
27308
|
+
*/
|
|
27309
|
+
circuitLocalized?: string;
|
|
27026
27310
|
/**
|
|
27027
27311
|
* The two centers this channel connects and defines.
|
|
27028
27312
|
*/
|
|
@@ -27041,9 +27325,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
27041
27325
|
*/
|
|
27042
27326
|
gates: Array<{
|
|
27043
27327
|
/**
|
|
27044
|
-
* Activating body. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto.
|
|
27328
|
+
* 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.
|
|
27045
27329
|
*/
|
|
27046
27330
|
planet: string;
|
|
27331
|
+
/**
|
|
27332
|
+
* 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.
|
|
27333
|
+
*/
|
|
27334
|
+
planetLocalized?: string;
|
|
27047
27335
|
/**
|
|
27048
27336
|
* Chart side. personality is the conscious birth-moment activation, design is the unconscious activation 88 degrees of solar arc before birth.
|
|
27049
27337
|
*/
|
|
@@ -27057,9 +27345,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
27057
27345
|
*/
|
|
27058
27346
|
line: number;
|
|
27059
27347
|
/**
|
|
27060
|
-
* Human Design keynote name of the gate, describing its bodygraph function.
|
|
27348
|
+
* 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.
|
|
27061
27349
|
*/
|
|
27062
27350
|
gateName: string;
|
|
27351
|
+
/**
|
|
27352
|
+
* 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.
|
|
27353
|
+
*/
|
|
27354
|
+
gateNameLocalized?: string;
|
|
27063
27355
|
/**
|
|
27064
27356
|
* 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.
|
|
27065
27357
|
*/
|
|
@@ -27118,7 +27410,7 @@ export type PostHumanDesignConnectionData = {
|
|
|
27118
27410
|
*/
|
|
27119
27411
|
longitude?: number;
|
|
27120
27412
|
/**
|
|
27121
|
-
* Lunar node convention
|
|
27413
|
+
* 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".
|
|
27122
27414
|
*/
|
|
27123
27415
|
nodeType?: 'mean' | 'true';
|
|
27124
27416
|
};
|
|
@@ -27147,7 +27439,7 @@ export type PostHumanDesignConnectionData = {
|
|
|
27147
27439
|
*/
|
|
27148
27440
|
longitude?: number;
|
|
27149
27441
|
/**
|
|
27150
|
-
* Lunar node convention
|
|
27442
|
+
* 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".
|
|
27151
27443
|
*/
|
|
27152
27444
|
nodeType?: 'mean' | 'true';
|
|
27153
27445
|
};
|
|
@@ -27288,21 +27580,33 @@ export type PostHumanDesignConnectionResponses = {
|
|
|
27288
27580
|
*/
|
|
27289
27581
|
gateB: number;
|
|
27290
27582
|
/**
|
|
27291
|
-
* Name of the channel whose connection dynamic is reported.
|
|
27583
|
+
* Name of the channel whose connection dynamic is reported. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
27292
27584
|
*/
|
|
27293
27585
|
name: string;
|
|
27294
27586
|
/**
|
|
27295
|
-
*
|
|
27587
|
+
* 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.
|
|
27588
|
+
*/
|
|
27589
|
+
nameLocalized?: string;
|
|
27590
|
+
/**
|
|
27591
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal. Always English, whatever the lang parameter says. Use circuitLocalized for anything a reader sees.
|
|
27296
27592
|
*/
|
|
27297
27593
|
circuit: string;
|
|
27594
|
+
/**
|
|
27595
|
+
* 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.
|
|
27596
|
+
*/
|
|
27597
|
+
circuitLocalized?: string;
|
|
27298
27598
|
/**
|
|
27299
27599
|
* The two centers this channel connects in the bodygraph.
|
|
27300
27600
|
*/
|
|
27301
27601
|
centers: Array<string>;
|
|
27302
27602
|
/**
|
|
27303
|
-
* 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.
|
|
27603
|
+
* 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.
|
|
27304
27604
|
*/
|
|
27305
27605
|
dynamic: string;
|
|
27606
|
+
/**
|
|
27607
|
+
* 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.
|
|
27608
|
+
*/
|
|
27609
|
+
dynamicLocalized?: string;
|
|
27306
27610
|
/**
|
|
27307
27611
|
* Which of the channel two gates person A holds, from one to both.
|
|
27308
27612
|
*/
|
|
@@ -27321,9 +27625,13 @@ export type PostHumanDesignConnectionResponses = {
|
|
|
27321
27625
|
*/
|
|
27322
27626
|
id: string;
|
|
27323
27627
|
/**
|
|
27324
|
-
* Display name of the center.
|
|
27628
|
+
* Display name of the center. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
27325
27629
|
*/
|
|
27326
27630
|
name: string;
|
|
27631
|
+
/**
|
|
27632
|
+
* 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.
|
|
27633
|
+
*/
|
|
27634
|
+
nameLocalized?: string;
|
|
27327
27635
|
/**
|
|
27328
27636
|
* 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.
|
|
27329
27637
|
*/
|
|
@@ -27334,9 +27642,13 @@ export type PostHumanDesignConnectionResponses = {
|
|
|
27334
27642
|
definedBy: Array<string>;
|
|
27335
27643
|
}>;
|
|
27336
27644
|
/**
|
|
27337
|
-
* Definition of the combined connection bodygraph from connected components among its defined centers. One of None, Single, Split, Triple Split, Quadruple Split.
|
|
27645
|
+
* 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.
|
|
27338
27646
|
*/
|
|
27339
27647
|
combinedDefinition: string;
|
|
27648
|
+
/**
|
|
27649
|
+
* 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.
|
|
27650
|
+
*/
|
|
27651
|
+
combinedDefinitionLocalized?: string;
|
|
27340
27652
|
/**
|
|
27341
27653
|
* Count of each connection dynamic across all connected channels.
|
|
27342
27654
|
*/
|
|
@@ -27390,7 +27702,7 @@ export type PostHumanDesignPentaData = {
|
|
|
27390
27702
|
*/
|
|
27391
27703
|
longitude?: number;
|
|
27392
27704
|
/**
|
|
27393
|
-
* Lunar node convention
|
|
27705
|
+
* 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".
|
|
27394
27706
|
*/
|
|
27395
27707
|
nodeType?: 'mean' | 'true';
|
|
27396
27708
|
}>;
|
|
@@ -27531,13 +27843,21 @@ export type PostHumanDesignPentaResponses = {
|
|
|
27531
27843
|
*/
|
|
27532
27844
|
gateB: number;
|
|
27533
27845
|
/**
|
|
27534
|
-
* Name of the Penta channel. One of The Alpha, Inspiration, The Prodigal, Rhythm, The Beat, Discovery.
|
|
27846
|
+
* 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.
|
|
27535
27847
|
*/
|
|
27536
27848
|
name: string;
|
|
27537
27849
|
/**
|
|
27538
|
-
*
|
|
27850
|
+
* 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.
|
|
27851
|
+
*/
|
|
27852
|
+
nameLocalized?: string;
|
|
27853
|
+
/**
|
|
27854
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal. Always English, whatever the lang parameter says. Use circuitLocalized for anything a reader sees.
|
|
27539
27855
|
*/
|
|
27540
27856
|
circuit: string;
|
|
27857
|
+
/**
|
|
27858
|
+
* 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.
|
|
27859
|
+
*/
|
|
27860
|
+
circuitLocalized?: string;
|
|
27541
27861
|
/**
|
|
27542
27862
|
* 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.
|
|
27543
27863
|
*/
|
|
@@ -27568,9 +27888,13 @@ export type PostHumanDesignPentaResponses = {
|
|
|
27568
27888
|
*/
|
|
27569
27889
|
gate: number;
|
|
27570
27890
|
/**
|
|
27571
|
-
* Human Design keynote name of the gate, describing the role it brings to the group.
|
|
27891
|
+
* 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.
|
|
27572
27892
|
*/
|
|
27573
27893
|
gateName: string;
|
|
27894
|
+
/**
|
|
27895
|
+
* 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.
|
|
27896
|
+
*/
|
|
27897
|
+
gateNameLocalized?: string;
|
|
27574
27898
|
/**
|
|
27575
27899
|
* 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.
|
|
27576
27900
|
*/
|
|
@@ -27633,7 +27957,7 @@ export type PostHumanDesignTransitData = {
|
|
|
27633
27957
|
*/
|
|
27634
27958
|
longitude?: number;
|
|
27635
27959
|
/**
|
|
27636
|
-
* Lunar node convention
|
|
27960
|
+
* 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".
|
|
27637
27961
|
*/
|
|
27638
27962
|
nodeType?: 'mean' | 'true';
|
|
27639
27963
|
};
|
|
@@ -27782,9 +28106,13 @@ export type PostHumanDesignTransitResponses = {
|
|
|
27782
28106
|
*/
|
|
27783
28107
|
activations: Array<{
|
|
27784
28108
|
/**
|
|
27785
|
-
* 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.
|
|
28109
|
+
* 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.
|
|
27786
28110
|
*/
|
|
27787
28111
|
body: string;
|
|
28112
|
+
/**
|
|
28113
|
+
* 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.
|
|
28114
|
+
*/
|
|
28115
|
+
bodyLocalized?: string;
|
|
27788
28116
|
/**
|
|
27789
28117
|
* Human Design gate number from 1 to 64 this transiting body currently sits in.
|
|
27790
28118
|
*/
|
|
@@ -27794,9 +28122,13 @@ export type PostHumanDesignTransitResponses = {
|
|
|
27794
28122
|
*/
|
|
27795
28123
|
line: number;
|
|
27796
28124
|
/**
|
|
27797
|
-
* Human Design keynote name of the gate the transiting body activates.
|
|
28125
|
+
* 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.
|
|
27798
28126
|
*/
|
|
27799
28127
|
gateName: string;
|
|
28128
|
+
/**
|
|
28129
|
+
* 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.
|
|
28130
|
+
*/
|
|
28131
|
+
gateNameLocalized?: string;
|
|
27800
28132
|
/**
|
|
27801
28133
|
* Cross-reference to the I-Ching hexagram that shares this gate number.
|
|
27802
28134
|
*/
|
|
@@ -27824,21 +28156,33 @@ export type PostHumanDesignTransitResponses = {
|
|
|
27824
28156
|
*/
|
|
27825
28157
|
gateB: number;
|
|
27826
28158
|
/**
|
|
27827
|
-
* Name of the channel the transit temporarily completes.
|
|
28159
|
+
* Name of the channel the transit temporarily completes. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
27828
28160
|
*/
|
|
27829
28161
|
name: string;
|
|
27830
28162
|
/**
|
|
27831
|
-
*
|
|
28163
|
+
* 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.
|
|
28164
|
+
*/
|
|
28165
|
+
nameLocalized?: string;
|
|
28166
|
+
/**
|
|
28167
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal. Always English, whatever the lang parameter says. Use circuitLocalized for anything a reader sees.
|
|
27832
28168
|
*/
|
|
27833
28169
|
circuit: string;
|
|
28170
|
+
/**
|
|
28171
|
+
* 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.
|
|
28172
|
+
*/
|
|
28173
|
+
circuitLocalized?: string;
|
|
27834
28174
|
/**
|
|
27835
28175
|
* The two centers this channel connects and temporarily defines.
|
|
27836
28176
|
*/
|
|
27837
28177
|
centers: Array<string>;
|
|
27838
28178
|
/**
|
|
27839
|
-
* 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.
|
|
28179
|
+
* 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.
|
|
27840
28180
|
*/
|
|
27841
28181
|
kind: string;
|
|
28182
|
+
/**
|
|
28183
|
+
* 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.
|
|
28184
|
+
*/
|
|
28185
|
+
kindLocalized?: string;
|
|
27842
28186
|
/**
|
|
27843
28187
|
* Gate or gates of this channel the natal chart already holds. Empty for an educational channel.
|
|
27844
28188
|
*/
|
|
@@ -27857,9 +28201,13 @@ export type PostHumanDesignTransitResponses = {
|
|
|
27857
28201
|
*/
|
|
27858
28202
|
id: string;
|
|
27859
28203
|
/**
|
|
27860
|
-
* Display name of the center.
|
|
28204
|
+
* Display name of the center. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
27861
28205
|
*/
|
|
27862
28206
|
name: string;
|
|
28207
|
+
/**
|
|
28208
|
+
* 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.
|
|
28209
|
+
*/
|
|
28210
|
+
nameLocalized?: string;
|
|
27863
28211
|
/**
|
|
27864
28212
|
* Always true. The center is open in the natal chart and temporarily defined by a transit-completed channel for the duration of the transit.
|
|
27865
28213
|
*/
|
|
@@ -27897,7 +28245,7 @@ export type PostHumanDesignTypeData = {
|
|
|
27897
28245
|
*/
|
|
27898
28246
|
longitude?: number;
|
|
27899
28247
|
/**
|
|
27900
|
-
* Lunar node convention
|
|
28248
|
+
* 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".
|
|
27901
28249
|
*/
|
|
27902
28250
|
nodeType?: 'mean' | 'true';
|
|
27903
28251
|
};
|
|
@@ -28021,9 +28369,13 @@ export type PostHumanDesignTypeResponses = {
|
|
|
28021
28369
|
*/
|
|
28022
28370
|
200: {
|
|
28023
28371
|
/**
|
|
28024
|
-
* Human Design energy type. One of Manifestor, Generator, Manifesting Generator, Projector, Reflector.
|
|
28372
|
+
* 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.
|
|
28025
28373
|
*/
|
|
28026
28374
|
type: string;
|
|
28375
|
+
/**
|
|
28376
|
+
* 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.
|
|
28377
|
+
*/
|
|
28378
|
+
typeLocalized?: string;
|
|
28027
28379
|
/**
|
|
28028
28380
|
* 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.
|
|
28029
28381
|
*/
|
|
@@ -28033,29 +28385,45 @@ export type PostHumanDesignTypeResponses = {
|
|
|
28033
28385
|
*/
|
|
28034
28386
|
aura: string;
|
|
28035
28387
|
/**
|
|
28036
|
-
* The aura strategy for engaging life correctly for this type.
|
|
28388
|
+
* The aura strategy for engaging life correctly for this type. Always English, whatever the lang parameter says. Use strategyLocalized for anything a reader sees.
|
|
28037
28389
|
*/
|
|
28038
28390
|
strategy: string;
|
|
28391
|
+
/**
|
|
28392
|
+
* 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.
|
|
28393
|
+
*/
|
|
28394
|
+
strategyLocalized?: string;
|
|
28039
28395
|
/**
|
|
28040
28396
|
* 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.
|
|
28041
28397
|
*/
|
|
28042
28398
|
strategyDescription: string;
|
|
28043
28399
|
/**
|
|
28044
|
-
* Inner authority for decision making. One of Emotional, Sacral, Splenic, Ego, Self-Projected, Mental, Lunar.
|
|
28400
|
+
* 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.
|
|
28045
28401
|
*/
|
|
28046
28402
|
authority: string;
|
|
28403
|
+
/**
|
|
28404
|
+
* 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.
|
|
28405
|
+
*/
|
|
28406
|
+
authorityLocalized?: string;
|
|
28047
28407
|
/**
|
|
28048
28408
|
* 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.
|
|
28049
28409
|
*/
|
|
28050
28410
|
authorityDescription: string;
|
|
28051
28411
|
/**
|
|
28052
|
-
* The signature feeling of living in alignment.
|
|
28412
|
+
* The signature feeling of living in alignment. Always English, whatever the lang parameter says. Use signatureLocalized for anything a reader sees.
|
|
28053
28413
|
*/
|
|
28054
28414
|
signature: string;
|
|
28055
28415
|
/**
|
|
28056
|
-
*
|
|
28416
|
+
* 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.
|
|
28417
|
+
*/
|
|
28418
|
+
signatureLocalized?: string;
|
|
28419
|
+
/**
|
|
28420
|
+
* The not-self theme that signals being out of alignment. Always English, whatever the lang parameter says. Use notSelfLocalized for anything a reader sees.
|
|
28057
28421
|
*/
|
|
28058
28422
|
notSelf: string;
|
|
28423
|
+
/**
|
|
28424
|
+
* 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.
|
|
28425
|
+
*/
|
|
28426
|
+
notSelfLocalized?: string;
|
|
28059
28427
|
/**
|
|
28060
28428
|
* Profile from the Personality Sun line over the Design Sun line.
|
|
28061
28429
|
*/
|
|
@@ -28088,7 +28456,7 @@ export type PostHumanDesignGatesData = {
|
|
|
28088
28456
|
*/
|
|
28089
28457
|
longitude?: number;
|
|
28090
28458
|
/**
|
|
28091
|
-
* Lunar node convention
|
|
28459
|
+
* 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".
|
|
28092
28460
|
*/
|
|
28093
28461
|
nodeType?: 'mean' | 'true';
|
|
28094
28462
|
};
|
|
@@ -28216,9 +28584,13 @@ export type PostHumanDesignGatesResponses = {
|
|
|
28216
28584
|
*/
|
|
28217
28585
|
personality: Array<{
|
|
28218
28586
|
/**
|
|
28219
|
-
* Activating body. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto.
|
|
28587
|
+
* 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.
|
|
28220
28588
|
*/
|
|
28221
28589
|
planet: string;
|
|
28590
|
+
/**
|
|
28591
|
+
* 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.
|
|
28592
|
+
*/
|
|
28593
|
+
planetLocalized?: string;
|
|
28222
28594
|
/**
|
|
28223
28595
|
* Chart side. personality is the conscious birth-moment activation, design is the unconscious activation 88 degrees of solar arc before birth.
|
|
28224
28596
|
*/
|
|
@@ -28232,9 +28604,13 @@ export type PostHumanDesignGatesResponses = {
|
|
|
28232
28604
|
*/
|
|
28233
28605
|
line: number;
|
|
28234
28606
|
/**
|
|
28235
|
-
* Human Design keynote name of the gate, describing its bodygraph function.
|
|
28607
|
+
* 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.
|
|
28236
28608
|
*/
|
|
28237
28609
|
gateName: string;
|
|
28610
|
+
/**
|
|
28611
|
+
* 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.
|
|
28612
|
+
*/
|
|
28613
|
+
gateNameLocalized?: string;
|
|
28238
28614
|
/**
|
|
28239
28615
|
* 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.
|
|
28240
28616
|
*/
|
|
@@ -28266,9 +28642,13 @@ export type PostHumanDesignGatesResponses = {
|
|
|
28266
28642
|
*/
|
|
28267
28643
|
design: Array<{
|
|
28268
28644
|
/**
|
|
28269
|
-
* Activating body. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto.
|
|
28645
|
+
* 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.
|
|
28270
28646
|
*/
|
|
28271
28647
|
planet: string;
|
|
28648
|
+
/**
|
|
28649
|
+
* 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.
|
|
28650
|
+
*/
|
|
28651
|
+
planetLocalized?: string;
|
|
28272
28652
|
/**
|
|
28273
28653
|
* Chart side. personality is the conscious birth-moment activation, design is the unconscious activation 88 degrees of solar arc before birth.
|
|
28274
28654
|
*/
|
|
@@ -28282,9 +28662,13 @@ export type PostHumanDesignGatesResponses = {
|
|
|
28282
28662
|
*/
|
|
28283
28663
|
line: number;
|
|
28284
28664
|
/**
|
|
28285
|
-
* Human Design keynote name of the gate, describing its bodygraph function.
|
|
28665
|
+
* 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.
|
|
28286
28666
|
*/
|
|
28287
28667
|
gateName: string;
|
|
28668
|
+
/**
|
|
28669
|
+
* 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.
|
|
28670
|
+
*/
|
|
28671
|
+
gateNameLocalized?: string;
|
|
28288
28672
|
/**
|
|
28289
28673
|
* 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.
|
|
28290
28674
|
*/
|
|
@@ -28460,17 +28844,25 @@ export type GetHumanDesignGatesByNumberResponses = {
|
|
|
28460
28844
|
*/
|
|
28461
28845
|
number: number;
|
|
28462
28846
|
/**
|
|
28463
|
-
* Human Design keynote name of the gate.
|
|
28847
|
+
* Human Design keynote name of the gate. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
28464
28848
|
*/
|
|
28465
28849
|
name: string;
|
|
28850
|
+
/**
|
|
28851
|
+
* 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.
|
|
28852
|
+
*/
|
|
28853
|
+
nameLocalized?: string;
|
|
28466
28854
|
/**
|
|
28467
28855
|
* Center the gate sits in.
|
|
28468
28856
|
*/
|
|
28469
28857
|
center: string;
|
|
28470
28858
|
/**
|
|
28471
|
-
* Display name of the center.
|
|
28859
|
+
* Display name of the center. Always English, whatever the lang parameter says. Use centerNameLocalized for anything a reader sees.
|
|
28472
28860
|
*/
|
|
28473
28861
|
centerName: string;
|
|
28862
|
+
/**
|
|
28863
|
+
* 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.
|
|
28864
|
+
*/
|
|
28865
|
+
centerNameLocalized?: string;
|
|
28474
28866
|
/**
|
|
28475
28867
|
* The I-Ching hexagram that shares this gate number.
|
|
28476
28868
|
*/
|
|
@@ -28493,9 +28885,13 @@ export type GetHumanDesignGatesByNumberResponses = {
|
|
|
28493
28885
|
*/
|
|
28494
28886
|
gate: number;
|
|
28495
28887
|
/**
|
|
28496
|
-
* Name of the shared channel.
|
|
28888
|
+
* Name of the shared channel. Always English, whatever the lang parameter says. Use channelLocalized for anything a reader sees.
|
|
28497
28889
|
*/
|
|
28498
28890
|
channel: string;
|
|
28891
|
+
/**
|
|
28892
|
+
* 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.
|
|
28893
|
+
*/
|
|
28894
|
+
channelLocalized?: string;
|
|
28499
28895
|
}>;
|
|
28500
28896
|
};
|
|
28501
28897
|
};
|
|
@@ -28525,7 +28921,7 @@ export type PostHumanDesignChannelsData = {
|
|
|
28525
28921
|
*/
|
|
28526
28922
|
longitude?: number;
|
|
28527
28923
|
/**
|
|
28528
|
-
* Lunar node convention
|
|
28924
|
+
* 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".
|
|
28529
28925
|
*/
|
|
28530
28926
|
nodeType?: 'mean' | 'true';
|
|
28531
28927
|
};
|
|
@@ -28661,13 +29057,21 @@ export type PostHumanDesignChannelsResponses = {
|
|
|
28661
29057
|
*/
|
|
28662
29058
|
gateB: number;
|
|
28663
29059
|
/**
|
|
28664
|
-
* Name of the defined channel.
|
|
29060
|
+
* Name of the defined channel. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
28665
29061
|
*/
|
|
28666
29062
|
name: string;
|
|
28667
29063
|
/**
|
|
28668
|
-
*
|
|
29064
|
+
* 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.
|
|
29065
|
+
*/
|
|
29066
|
+
nameLocalized?: string;
|
|
29067
|
+
/**
|
|
29068
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal. Always English, whatever the lang parameter says. Use circuitLocalized for anything a reader sees.
|
|
28669
29069
|
*/
|
|
28670
29070
|
circuit: string;
|
|
29071
|
+
/**
|
|
29072
|
+
* 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.
|
|
29073
|
+
*/
|
|
29074
|
+
circuitLocalized?: string;
|
|
28671
29075
|
/**
|
|
28672
29076
|
* The two centers this channel connects and defines.
|
|
28673
29077
|
*/
|
|
@@ -28717,7 +29121,7 @@ export type PostHumanDesignCentersData = {
|
|
|
28717
29121
|
*/
|
|
28718
29122
|
longitude?: number;
|
|
28719
29123
|
/**
|
|
28720
|
-
* Lunar node convention
|
|
29124
|
+
* 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".
|
|
28721
29125
|
*/
|
|
28722
29126
|
nodeType?: 'mean' | 'true';
|
|
28723
29127
|
};
|
|
@@ -28849,9 +29253,13 @@ export type PostHumanDesignCentersResponses = {
|
|
|
28849
29253
|
*/
|
|
28850
29254
|
id: string;
|
|
28851
29255
|
/**
|
|
28852
|
-
* Display name of the center.
|
|
29256
|
+
* 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.
|
|
28853
29257
|
*/
|
|
28854
29258
|
name: string;
|
|
29259
|
+
/**
|
|
29260
|
+
* 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.
|
|
29261
|
+
*/
|
|
29262
|
+
nameLocalized?: string;
|
|
28855
29263
|
/**
|
|
28856
29264
|
* 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.
|
|
28857
29265
|
*/
|
|
@@ -29021,9 +29429,13 @@ export type GetHumanDesignCentersByIdResponses = {
|
|
|
29021
29429
|
*/
|
|
29022
29430
|
id: string;
|
|
29023
29431
|
/**
|
|
29024
|
-
* Display name of the center.
|
|
29432
|
+
* Display name of the center. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
29025
29433
|
*/
|
|
29026
29434
|
name: string;
|
|
29435
|
+
/**
|
|
29436
|
+
* 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.
|
|
29437
|
+
*/
|
|
29438
|
+
nameLocalized?: string;
|
|
29027
29439
|
/**
|
|
29028
29440
|
* Whether this is a motor center.
|
|
29029
29441
|
*/
|
|
@@ -29068,7 +29480,7 @@ export type PostHumanDesignProfileData = {
|
|
|
29068
29480
|
*/
|
|
29069
29481
|
longitude?: number;
|
|
29070
29482
|
/**
|
|
29071
|
-
* Lunar node convention
|
|
29483
|
+
* 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".
|
|
29072
29484
|
*/
|
|
29073
29485
|
nodeType?: 'mean' | 'true';
|
|
29074
29486
|
};
|
|
@@ -29239,7 +29651,7 @@ export type PostHumanDesignVariablesData = {
|
|
|
29239
29651
|
*/
|
|
29240
29652
|
longitude?: number;
|
|
29241
29653
|
/**
|
|
29242
|
-
* Lunar node convention
|
|
29654
|
+
* 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".
|
|
29243
29655
|
*/
|
|
29244
29656
|
nodeType?: 'mean' | 'true';
|
|
29245
29657
|
};
|
|
@@ -29371,17 +29783,29 @@ export type PostHumanDesignVariablesResponses = {
|
|
|
29371
29783
|
*/
|
|
29372
29784
|
key: string;
|
|
29373
29785
|
/**
|
|
29374
|
-
* 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.
|
|
29786
|
+
* 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.
|
|
29375
29787
|
*/
|
|
29376
29788
|
name: string;
|
|
29377
29789
|
/**
|
|
29378
|
-
*
|
|
29790
|
+
* 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.
|
|
29791
|
+
*/
|
|
29792
|
+
nameLocalized?: string;
|
|
29793
|
+
/**
|
|
29794
|
+
* 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.
|
|
29379
29795
|
*/
|
|
29380
29796
|
layer: string;
|
|
29381
29797
|
/**
|
|
29382
|
-
*
|
|
29798
|
+
* 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.
|
|
29799
|
+
*/
|
|
29800
|
+
layerLocalized?: string;
|
|
29801
|
+
/**
|
|
29802
|
+
* 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.
|
|
29383
29803
|
*/
|
|
29384
29804
|
position: string;
|
|
29805
|
+
/**
|
|
29806
|
+
* 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.
|
|
29807
|
+
*/
|
|
29808
|
+
positionLocalized?: string;
|
|
29385
29809
|
/**
|
|
29386
29810
|
* The single activation, body and chart side, that this arrow is derived from.
|
|
29387
29811
|
*/
|
|
@@ -29412,13 +29836,21 @@ export type PostHumanDesignVariablesResponses = {
|
|
|
29412
29836
|
*/
|
|
29413
29837
|
direction: string;
|
|
29414
29838
|
/**
|
|
29415
|
-
* 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.
|
|
29839
|
+
* 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.
|
|
29416
29840
|
*/
|
|
29417
29841
|
colorLabel: string;
|
|
29418
29842
|
/**
|
|
29419
|
-
*
|
|
29843
|
+
* 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.
|
|
29844
|
+
*/
|
|
29845
|
+
colorLabelLocalized?: string;
|
|
29846
|
+
/**
|
|
29847
|
+
* 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.
|
|
29420
29848
|
*/
|
|
29421
29849
|
directionLabel: string;
|
|
29850
|
+
/**
|
|
29851
|
+
* 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.
|
|
29852
|
+
*/
|
|
29853
|
+
directionLabelLocalized?: string;
|
|
29422
29854
|
/**
|
|
29423
29855
|
* What this arrow is and what it governs.
|
|
29424
29856
|
*/
|
|
@@ -29440,17 +29872,25 @@ export type PostHumanDesignVariablesResponses = {
|
|
|
29440
29872
|
*/
|
|
29441
29873
|
directionMeaning: string;
|
|
29442
29874
|
/**
|
|
29443
|
-
* Name of the Base. Informational only: the Base is finer than any civil birth time can resolve.
|
|
29875
|
+
* 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.
|
|
29444
29876
|
*/
|
|
29445
29877
|
baseName: string;
|
|
29878
|
+
/**
|
|
29879
|
+
* 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.
|
|
29880
|
+
*/
|
|
29881
|
+
baseNameLocalized?: string;
|
|
29446
29882
|
/**
|
|
29447
29883
|
* 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.
|
|
29448
29884
|
*/
|
|
29449
29885
|
cognition?: {
|
|
29450
29886
|
/**
|
|
29451
|
-
* Name of the Cognition, the strongest sense. One of six read off the Determination Tone: Smell, Taste, Outer Vision, Inner Vision, Feeling, Touch.
|
|
29887
|
+
* 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.
|
|
29452
29888
|
*/
|
|
29453
29889
|
label: string;
|
|
29890
|
+
/**
|
|
29891
|
+
* 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.
|
|
29892
|
+
*/
|
|
29893
|
+
labelLocalized?: string;
|
|
29454
29894
|
/**
|
|
29455
29895
|
* 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.
|
|
29456
29896
|
*/
|
|
@@ -42272,7 +42712,7 @@ export type GetLocationSearchData = {
|
|
|
42272
42712
|
path?: never;
|
|
42273
42713
|
query: {
|
|
42274
42714
|
/**
|
|
42275
|
-
*
|
|
42715
|
+
* 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.
|
|
42276
42716
|
*/
|
|
42277
42717
|
q: string;
|
|
42278
42718
|
/**
|
|
@@ -42393,11 +42833,11 @@ export type GetLocationSearchError = GetLocationSearchErrors[keyof GetLocationSe
|
|
|
42393
42833
|
|
|
42394
42834
|
export type GetLocationSearchResponses = {
|
|
42395
42835
|
/**
|
|
42396
|
-
* Matching
|
|
42836
|
+
* Matching places, best match first, with coordinates, IANA timezone and UTC offset
|
|
42397
42837
|
*/
|
|
42398
42838
|
200: {
|
|
42399
42839
|
/**
|
|
42400
|
-
*
|
|
42840
|
+
* 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.
|
|
42401
42841
|
*/
|
|
42402
42842
|
total: number;
|
|
42403
42843
|
/**
|
|
@@ -42405,11 +42845,11 @@ export type GetLocationSearchResponses = {
|
|
|
42405
42845
|
*/
|
|
42406
42846
|
limit: number;
|
|
42407
42847
|
/**
|
|
42408
|
-
* Number of
|
|
42848
|
+
* Number of places skipped. Use with limit to page through results.
|
|
42409
42849
|
*/
|
|
42410
42850
|
offset: number;
|
|
42411
42851
|
/**
|
|
42412
|
-
*
|
|
42852
|
+
* 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.
|
|
42413
42853
|
*/
|
|
42414
42854
|
cities: Array<{
|
|
42415
42855
|
/**
|
|
@@ -42417,7 +42857,7 @@ export type GetLocationSearchResponses = {
|
|
|
42417
42857
|
*/
|
|
42418
42858
|
city: string;
|
|
42419
42859
|
/**
|
|
42420
|
-
* State, province, canton, or administrative region.
|
|
42860
|
+
* 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.
|
|
42421
42861
|
*/
|
|
42422
42862
|
province: string;
|
|
42423
42863
|
/**
|
|
@@ -42437,15 +42877,15 @@ export type GetLocationSearchResponses = {
|
|
|
42437
42877
|
*/
|
|
42438
42878
|
longitude: number;
|
|
42439
42879
|
/**
|
|
42440
|
-
* IANA timezone identifier following the tz database standard (e.g. Europe/Berlin, America/New_York, Asia/Tokyo).
|
|
42880
|
+
* 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.
|
|
42441
42881
|
*/
|
|
42442
42882
|
timezone: string;
|
|
42443
42883
|
/**
|
|
42444
|
-
*
|
|
42884
|
+
* 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.
|
|
42445
42885
|
*/
|
|
42446
42886
|
utcOffset: number;
|
|
42447
42887
|
/**
|
|
42448
|
-
*
|
|
42888
|
+
* 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.
|
|
42449
42889
|
*/
|
|
42450
42890
|
population: number;
|
|
42451
42891
|
}>;
|
|
@@ -42580,7 +43020,7 @@ export type GetLocationCountriesResponses = {
|
|
|
42580
43020
|
*/
|
|
42581
43021
|
200: {
|
|
42582
43022
|
/**
|
|
42583
|
-
* Total number of countries
|
|
43023
|
+
* Total number of countries with at least one place in the dataset.
|
|
42584
43024
|
*/
|
|
42585
43025
|
total: number;
|
|
42586
43026
|
/**
|
|
@@ -42608,7 +43048,7 @@ export type GetLocationCountriesResponses = {
|
|
|
42608
43048
|
*/
|
|
42609
43049
|
iso3: string;
|
|
42610
43050
|
/**
|
|
42611
|
-
* Number of searchable
|
|
43051
|
+
* 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.
|
|
42612
43052
|
*/
|
|
42613
43053
|
cityCount: number;
|
|
42614
43054
|
}>;
|
|
@@ -42748,7 +43188,7 @@ export type GetLocationCountriesByIso2Responses = {
|
|
|
42748
43188
|
*/
|
|
42749
43189
|
200: {
|
|
42750
43190
|
/**
|
|
42751
|
-
* Total number of
|
|
43191
|
+
* Total number of places available for this country across all pages.
|
|
42752
43192
|
*/
|
|
42753
43193
|
total: number;
|
|
42754
43194
|
/**
|
|
@@ -42768,7 +43208,7 @@ export type GetLocationCountriesByIso2Responses = {
|
|
|
42768
43208
|
*/
|
|
42769
43209
|
city: string;
|
|
42770
43210
|
/**
|
|
42771
|
-
* State, province, canton, or administrative region.
|
|
43211
|
+
* 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.
|
|
42772
43212
|
*/
|
|
42773
43213
|
province: string;
|
|
42774
43214
|
/**
|
|
@@ -42788,15 +43228,15 @@ export type GetLocationCountriesByIso2Responses = {
|
|
|
42788
43228
|
*/
|
|
42789
43229
|
longitude: number;
|
|
42790
43230
|
/**
|
|
42791
|
-
* IANA timezone identifier following the tz database standard (e.g. Europe/Berlin, America/New_York, Asia/Tokyo).
|
|
43231
|
+
* 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.
|
|
42792
43232
|
*/
|
|
42793
43233
|
timezone: string;
|
|
42794
43234
|
/**
|
|
42795
|
-
*
|
|
43235
|
+
* 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.
|
|
42796
43236
|
*/
|
|
42797
43237
|
utcOffset: number;
|
|
42798
43238
|
/**
|
|
42799
|
-
*
|
|
43239
|
+
* 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.
|
|
42800
43240
|
*/
|
|
42801
43241
|
population: number;
|
|
42802
43242
|
}>;
|