@roxyapi/sdk 1.2.59 → 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 +24 -8
- package/dist/factory.js +24 -8
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/sdk.gen.d.ts +14 -8
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/types.gen.d.ts +1125 -204
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/docs/llms-full.txt +27 -2
- package/package.json +1 -1
- package/src/index.ts +1 -1
- package/src/sdk.gen.ts +25 -8
- package/src/types.gen.ts +1130 -204
- package/src/version.ts +1 -1
package/dist/types.gen.d.ts
CHANGED
|
@@ -32,9 +32,13 @@ export type NatalChartResponse = {
|
|
|
32
32
|
*/
|
|
33
33
|
planets: Array<{
|
|
34
34
|
/**
|
|
35
|
-
* Planet or point name (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto, North Node, South Node, Chiron, Black Moon Lilith). The lunar nodes are the mean node; software using the true node may show node positions up to 1.75 degrees different.
|
|
35
|
+
* Planet or point name (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto, North Node, South Node, Chiron, Black Moon Lilith). Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use nameLocalized for anything a reader sees. The lunar nodes are the mean node; software using the true node may show node positions up to 1.75 degrees different.
|
|
36
36
|
*/
|
|
37
37
|
name: string;
|
|
38
|
+
/**
|
|
39
|
+
* Planet or 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.
|
|
40
|
+
*/
|
|
41
|
+
nameLocalized?: string;
|
|
38
42
|
/**
|
|
39
43
|
* Tropical ecliptic longitude in degrees (0-360).
|
|
40
44
|
*/
|
|
@@ -44,9 +48,13 @@ export type NatalChartResponse = {
|
|
|
44
48
|
*/
|
|
45
49
|
latitude: number;
|
|
46
50
|
/**
|
|
47
|
-
* Tropical zodiac sign this planet occupies.
|
|
51
|
+
* Tropical zodiac sign this planet occupies. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use signLocalized for anything a reader sees.
|
|
48
52
|
*/
|
|
49
53
|
sign: string;
|
|
54
|
+
/**
|
|
55
|
+
* Zodiac 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.
|
|
56
|
+
*/
|
|
57
|
+
signLocalized?: string;
|
|
50
58
|
/**
|
|
51
59
|
* Degree within the zodiac sign (0-29.999).
|
|
52
60
|
*/
|
|
@@ -94,9 +102,13 @@ export type NatalChartResponse = {
|
|
|
94
102
|
*/
|
|
95
103
|
longitude: number;
|
|
96
104
|
/**
|
|
97
|
-
* Zodiac sign on this house cusp.
|
|
105
|
+
* Zodiac sign on this house cusp. Always English, whatever the lang parameter says. Use signLocalized for anything a reader sees.
|
|
98
106
|
*/
|
|
99
107
|
sign: string;
|
|
108
|
+
/**
|
|
109
|
+
* 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.
|
|
110
|
+
*/
|
|
111
|
+
signLocalized?: string;
|
|
100
112
|
/**
|
|
101
113
|
* Degree within the zodiac sign (0-29.999).
|
|
102
114
|
*/
|
|
@@ -111,17 +123,29 @@ export type NatalChartResponse = {
|
|
|
111
123
|
*/
|
|
112
124
|
aspects: Array<{
|
|
113
125
|
/**
|
|
114
|
-
* First planet in the aspect pair.
|
|
126
|
+
* First planet in the aspect pair. Always English, whatever the lang parameter says. Use planet1Localized for anything a reader sees.
|
|
115
127
|
*/
|
|
116
128
|
planet1: string;
|
|
117
129
|
/**
|
|
118
|
-
*
|
|
130
|
+
* First 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.
|
|
131
|
+
*/
|
|
132
|
+
planet1Localized?: string;
|
|
133
|
+
/**
|
|
134
|
+
* Second planet in the aspect pair. Always English, whatever the lang parameter says. Use planet2Localized for anything a reader sees.
|
|
119
135
|
*/
|
|
120
136
|
planet2: string;
|
|
121
137
|
/**
|
|
122
|
-
*
|
|
138
|
+
* Second 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.
|
|
139
|
+
*/
|
|
140
|
+
planet2Localized?: string;
|
|
141
|
+
/**
|
|
142
|
+
* Aspect type (CONJUNCTION, OPPOSITION, TRINE, SQUARE, SEXTILE, etc.). Always English, whatever the lang parameter says. Use typeLocalized for anything a reader sees.
|
|
123
143
|
*/
|
|
124
144
|
type: string;
|
|
145
|
+
/**
|
|
146
|
+
* 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.
|
|
147
|
+
*/
|
|
148
|
+
typeLocalized?: string;
|
|
125
149
|
/**
|
|
126
150
|
* Exact angle of this aspect type in degrees.
|
|
127
151
|
*/
|
|
@@ -224,9 +248,13 @@ export type NatalChartResponse = {
|
|
|
224
248
|
*/
|
|
225
249
|
ascendant: {
|
|
226
250
|
/**
|
|
227
|
-
* Zodiac sign on the Ascendant (rising sign).
|
|
251
|
+
* Zodiac sign on the Ascendant (rising sign). Always English, whatever the lang parameter says. Use signLocalized for anything a reader sees.
|
|
228
252
|
*/
|
|
229
253
|
sign: string;
|
|
254
|
+
/**
|
|
255
|
+
* 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.
|
|
256
|
+
*/
|
|
257
|
+
signLocalized?: string;
|
|
230
258
|
/**
|
|
231
259
|
* Degree within the Ascendant sign (0-29.999).
|
|
232
260
|
*/
|
|
@@ -241,9 +269,13 @@ export type NatalChartResponse = {
|
|
|
241
269
|
*/
|
|
242
270
|
midheaven: {
|
|
243
271
|
/**
|
|
244
|
-
* Zodiac sign on the Midheaven (MC).
|
|
272
|
+
* Zodiac sign on the Midheaven (MC). Always English, whatever the lang parameter says. Use signLocalized for anything a reader sees.
|
|
245
273
|
*/
|
|
246
274
|
sign: string;
|
|
275
|
+
/**
|
|
276
|
+
* Midheaven 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.
|
|
277
|
+
*/
|
|
278
|
+
signLocalized?: string;
|
|
247
279
|
/**
|
|
248
280
|
* Degree within the Midheaven sign (0-29.999).
|
|
249
281
|
*/
|
|
@@ -273,6 +305,10 @@ export type NatalChartResponse = {
|
|
|
273
305
|
* Chart sect used for the calculation. Day (diurnal) when the Sun is above the horizon, night (nocturnal) when below. Day charts use Ascendant plus Moon minus Sun, night charts use Ascendant plus Sun minus Moon.
|
|
274
306
|
*/
|
|
275
307
|
sect: 'day' | 'night';
|
|
308
|
+
/**
|
|
309
|
+
* Part of Fortune 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.
|
|
310
|
+
*/
|
|
311
|
+
signLocalized?: string;
|
|
276
312
|
};
|
|
277
313
|
/**
|
|
278
314
|
* Vertex. The western intersection of the prime vertical with the ecliptic, often read as a point of fated encounters and turning-point relationships. The opposite point is the Anti-Vertex.
|
|
@@ -290,23 +326,39 @@ export type NatalChartResponse = {
|
|
|
290
326
|
* Absolute ecliptic longitude of the Vertex (0-360).
|
|
291
327
|
*/
|
|
292
328
|
longitude: number;
|
|
329
|
+
/**
|
|
330
|
+
* Vertex 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.
|
|
331
|
+
*/
|
|
332
|
+
signLocalized?: string;
|
|
293
333
|
};
|
|
294
334
|
/**
|
|
295
335
|
* Chart summary with dominant element, modality, retrograde planets, and distribution analysis.
|
|
296
336
|
*/
|
|
297
337
|
summary: {
|
|
298
338
|
/**
|
|
299
|
-
* Most represented element in the chart (Fire, Earth, Air, Water).
|
|
339
|
+
* Most represented element in the chart (Fire, Earth, Air, Water). Always English, whatever the lang parameter says. Use dominantElementLocalized for anything a reader sees.
|
|
300
340
|
*/
|
|
301
341
|
dominantElement: string;
|
|
302
342
|
/**
|
|
303
|
-
*
|
|
343
|
+
* 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.
|
|
344
|
+
*/
|
|
345
|
+
dominantElementLocalized?: string;
|
|
346
|
+
/**
|
|
347
|
+
* Most represented modality in the chart (Cardinal, Fixed, Mutable). Always English, whatever the lang parameter says. Use dominantModalityLocalized for anything a reader sees.
|
|
304
348
|
*/
|
|
305
349
|
dominantModality: string;
|
|
306
350
|
/**
|
|
307
|
-
*
|
|
351
|
+
* 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.
|
|
352
|
+
*/
|
|
353
|
+
dominantModalityLocalized?: string;
|
|
354
|
+
/**
|
|
355
|
+
* Planets in retrograde motion at the time of birth. Always English, whatever the lang parameter says. Use retrogradePlanetsLocalized for anything a reader sees.
|
|
308
356
|
*/
|
|
309
357
|
retrogradePlanets: Array<string>;
|
|
358
|
+
/**
|
|
359
|
+
* The same retrograde bodies in the requested language, for display only. Index aligned with retrogradePlanets, so entry n of one names entry n of the other. Present only when lang is set to a language other than English, since in English it would repeat retrogradePlanets exactly.
|
|
360
|
+
*/
|
|
361
|
+
retrogradePlanetsLocalized?: Array<string>;
|
|
310
362
|
/**
|
|
311
363
|
* Count of planets in each element. Shows elemental emphasis in the personality.
|
|
312
364
|
*/
|
|
@@ -342,6 +394,10 @@ export type NatalChartRequest = {
|
|
|
342
394
|
* 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.
|
|
343
395
|
*/
|
|
344
396
|
timezone: number | string;
|
|
397
|
+
/**
|
|
398
|
+
* 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".
|
|
399
|
+
*/
|
|
400
|
+
nodeType?: 'mean' | 'true';
|
|
345
401
|
/**
|
|
346
402
|
* 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.
|
|
347
403
|
*/
|
|
@@ -478,17 +534,29 @@ export type AspectsResponse = {
|
|
|
478
534
|
*/
|
|
479
535
|
aspects: Array<{
|
|
480
536
|
/**
|
|
481
|
-
* First planet in the aspect pair.
|
|
537
|
+
* First planet in the aspect pair. Always English, whatever the lang parameter says. Use planet1Localized for anything a reader sees.
|
|
482
538
|
*/
|
|
483
539
|
planet1: string;
|
|
484
540
|
/**
|
|
485
|
-
*
|
|
541
|
+
* First 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.
|
|
542
|
+
*/
|
|
543
|
+
planet1Localized?: string;
|
|
544
|
+
/**
|
|
545
|
+
* Second planet in the aspect pair. Always English, whatever the lang parameter says. Use planet2Localized for anything a reader sees.
|
|
486
546
|
*/
|
|
487
547
|
planet2: string;
|
|
488
548
|
/**
|
|
489
|
-
*
|
|
549
|
+
* Second 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.
|
|
550
|
+
*/
|
|
551
|
+
planet2Localized?: string;
|
|
552
|
+
/**
|
|
553
|
+
* Aspect type (CONJUNCTION, OPPOSITION, TRINE, SQUARE, SEXTILE, etc.). Always English, whatever the lang parameter says. Use typeLocalized for anything a reader sees.
|
|
490
554
|
*/
|
|
491
555
|
type: string;
|
|
556
|
+
/**
|
|
557
|
+
* 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.
|
|
558
|
+
*/
|
|
559
|
+
typeLocalized?: string;
|
|
492
560
|
/**
|
|
493
561
|
* Exact angle defining this aspect type in degrees.
|
|
494
562
|
*/
|
|
@@ -732,6 +800,10 @@ export type AspectPatternsRequest = {
|
|
|
732
800
|
* 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.
|
|
733
801
|
*/
|
|
734
802
|
timezone: number | string;
|
|
803
|
+
/**
|
|
804
|
+
* 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".
|
|
805
|
+
*/
|
|
806
|
+
nodeType?: 'mean' | 'true';
|
|
735
807
|
};
|
|
736
808
|
export type TransitsResponse = {
|
|
737
809
|
/**
|
|
@@ -751,9 +823,13 @@ export type TransitsResponse = {
|
|
|
751
823
|
*/
|
|
752
824
|
transitPlanets: Array<{
|
|
753
825
|
/**
|
|
754
|
-
* Planet name (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto, North Node, South Node, Chiron, Black Moon Lilith). The lunar nodes are the mean node; software using the true node may show node positions up to 1.75 degrees different.
|
|
826
|
+
* Planet name (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto, North Node, South Node, Chiron, Black Moon Lilith). Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use nameLocalized for anything a reader sees. The lunar nodes are the mean node; software using the true node may show node positions up to 1.75 degrees different.
|
|
755
827
|
*/
|
|
756
828
|
name: string;
|
|
829
|
+
/**
|
|
830
|
+
* 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.
|
|
831
|
+
*/
|
|
832
|
+
nameLocalized?: string;
|
|
757
833
|
/**
|
|
758
834
|
* Tropical ecliptic longitude in degrees (0-360). Primary coordinate for sign and aspect calculation.
|
|
759
835
|
*/
|
|
@@ -763,9 +839,13 @@ export type TransitsResponse = {
|
|
|
763
839
|
*/
|
|
764
840
|
latitude: number;
|
|
765
841
|
/**
|
|
766
|
-
* Tropical zodiac sign the planet currently occupies. Changes when longitude crosses a 30-degree boundary.
|
|
842
|
+
* Tropical zodiac sign the planet currently occupies. Changes when longitude crosses a 30-degree boundary. Always English, whatever the lang parameter says. Use signLocalized for anything a reader sees.
|
|
767
843
|
*/
|
|
768
844
|
sign: string;
|
|
845
|
+
/**
|
|
846
|
+
* Zodiac 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.
|
|
847
|
+
*/
|
|
848
|
+
signLocalized?: string;
|
|
769
849
|
/**
|
|
770
850
|
* Degree within the current zodiac sign (0-29.999). Indicates how far into the sign the planet has progressed.
|
|
771
851
|
*/
|
|
@@ -784,17 +864,29 @@ export type TransitsResponse = {
|
|
|
784
864
|
*/
|
|
785
865
|
transitAspects?: Array<{
|
|
786
866
|
/**
|
|
787
|
-
* Transiting planet forming the aspect.
|
|
867
|
+
* Transiting planet forming the aspect. Always English, whatever the lang parameter says. Use transitPlanetLocalized for anything a reader sees.
|
|
788
868
|
*/
|
|
789
869
|
transitPlanet: string;
|
|
790
870
|
/**
|
|
791
|
-
*
|
|
871
|
+
* Transiting 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.
|
|
872
|
+
*/
|
|
873
|
+
transitPlanetLocalized?: string;
|
|
874
|
+
/**
|
|
875
|
+
* Natal planet being aspected. Always English, whatever the lang parameter says. Use natalPlanetLocalized for anything a reader sees.
|
|
792
876
|
*/
|
|
793
877
|
natalPlanet: string;
|
|
794
878
|
/**
|
|
795
|
-
*
|
|
879
|
+
* Natal 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.
|
|
880
|
+
*/
|
|
881
|
+
natalPlanetLocalized?: string;
|
|
882
|
+
/**
|
|
883
|
+
* Aspect type (CONJUNCTION, OPPOSITION, TRINE, SQUARE, SEXTILE, etc.). Always English, whatever the lang parameter says. Use typeLocalized for anything a reader sees.
|
|
796
884
|
*/
|
|
797
885
|
type: string;
|
|
886
|
+
/**
|
|
887
|
+
* 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.
|
|
888
|
+
*/
|
|
889
|
+
typeLocalized?: string;
|
|
798
890
|
/**
|
|
799
891
|
* Exact angle of this aspect type in degrees.
|
|
800
892
|
*/
|
|
@@ -876,6 +968,10 @@ export type TransitsRequest = {
|
|
|
876
968
|
* 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).
|
|
877
969
|
*/
|
|
878
970
|
timezone?: number | string;
|
|
971
|
+
/**
|
|
972
|
+
* 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".
|
|
973
|
+
*/
|
|
974
|
+
nodeType?: 'mean' | 'true';
|
|
879
975
|
/**
|
|
880
976
|
* Optional natal chart data to compare transits against
|
|
881
977
|
*/
|
|
@@ -933,9 +1029,13 @@ export type AstrocartographyResponse = {
|
|
|
933
1029
|
*/
|
|
934
1030
|
lines: Array<{
|
|
935
1031
|
/**
|
|
936
|
-
* Celestial body this set of planetary lines belongs to.
|
|
1032
|
+
* 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.
|
|
937
1033
|
*/
|
|
938
1034
|
planet: string;
|
|
1035
|
+
/**
|
|
1036
|
+
* 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.
|
|
1037
|
+
*/
|
|
1038
|
+
planetLocalized?: string;
|
|
939
1039
|
/**
|
|
940
1040
|
* Unicode astronomical symbol for this body.
|
|
941
1041
|
*/
|
|
@@ -1095,6 +1195,10 @@ export type RelocationChartResponse = {
|
|
|
1095
1195
|
* Degree within the zodiac sign on this cusp (0-29.999).
|
|
1096
1196
|
*/
|
|
1097
1197
|
degree: number;
|
|
1198
|
+
/**
|
|
1199
|
+
* 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.
|
|
1200
|
+
*/
|
|
1201
|
+
signLocalized?: string;
|
|
1098
1202
|
}>;
|
|
1099
1203
|
/**
|
|
1100
1204
|
* House system used for the relocated chart (placidus, whole-sign, equal, or koch). Quadrant systems fall back to whole-sign above the polar circle.
|
|
@@ -1105,9 +1209,13 @@ export type RelocationChartResponse = {
|
|
|
1105
1209
|
*/
|
|
1106
1210
|
ascendant: {
|
|
1107
1211
|
/**
|
|
1108
|
-
* Tropical zodiac sign on this relocated angle.
|
|
1212
|
+
* Tropical zodiac sign on this relocated angle. Always English, whatever the lang parameter says. Use signLocalized for anything a reader sees.
|
|
1109
1213
|
*/
|
|
1110
1214
|
sign: string;
|
|
1215
|
+
/**
|
|
1216
|
+
* Zodiac sign name on this angle 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.
|
|
1217
|
+
*/
|
|
1218
|
+
signLocalized?: string;
|
|
1111
1219
|
/**
|
|
1112
1220
|
* Degree within the zodiac sign on this angle (0-29.999).
|
|
1113
1221
|
*/
|
|
@@ -1122,9 +1230,13 @@ export type RelocationChartResponse = {
|
|
|
1122
1230
|
*/
|
|
1123
1231
|
midheaven: {
|
|
1124
1232
|
/**
|
|
1125
|
-
* Tropical zodiac sign on this relocated angle.
|
|
1233
|
+
* Tropical zodiac sign on this relocated angle. Always English, whatever the lang parameter says. Use signLocalized for anything a reader sees.
|
|
1126
1234
|
*/
|
|
1127
1235
|
sign: string;
|
|
1236
|
+
/**
|
|
1237
|
+
* Zodiac sign name on this angle 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.
|
|
1238
|
+
*/
|
|
1239
|
+
signLocalized?: string;
|
|
1128
1240
|
/**
|
|
1129
1241
|
* Degree within the zodiac sign on this angle (0-29.999).
|
|
1130
1242
|
*/
|
|
@@ -1150,6 +1262,10 @@ export type RelocationChartResponse = {
|
|
|
1150
1262
|
* Absolute ecliptic longitude of the Vertex (0-360).
|
|
1151
1263
|
*/
|
|
1152
1264
|
longitude: number;
|
|
1265
|
+
/**
|
|
1266
|
+
* Vertex 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.
|
|
1267
|
+
*/
|
|
1268
|
+
signLocalized?: string;
|
|
1153
1269
|
};
|
|
1154
1270
|
/**
|
|
1155
1271
|
* How relocation reshapes the chart: Ascendant shift, planets that change house, angular planets, and the move geometry from the birthplace.
|
|
@@ -1164,9 +1280,13 @@ export type RelocationChartResponse = {
|
|
|
1164
1280
|
*/
|
|
1165
1281
|
planetsChangedHouse: Array<{
|
|
1166
1282
|
/**
|
|
1167
|
-
* Body that occupies a different house after relocation.
|
|
1283
|
+
* Body that occupies a different house after relocation. Always English, whatever the lang parameter says. Use planetLocalized for anything a reader sees.
|
|
1168
1284
|
*/
|
|
1169
1285
|
planet: string;
|
|
1286
|
+
/**
|
|
1287
|
+
* 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.
|
|
1288
|
+
*/
|
|
1289
|
+
planetLocalized?: string;
|
|
1170
1290
|
/**
|
|
1171
1291
|
* House this body occupied in the birthplace chart (1-12).
|
|
1172
1292
|
*/
|
|
@@ -1177,9 +1297,13 @@ export type RelocationChartResponse = {
|
|
|
1177
1297
|
relocatedHouse: number;
|
|
1178
1298
|
}>;
|
|
1179
1299
|
/**
|
|
1180
|
-
* Bodies within three degrees of a relocated angle (Ascendant, Imum Coeli, Descendant, or Midheaven), where their influence is strongest at this location.
|
|
1300
|
+
* Bodies within three degrees of a relocated angle (Ascendant, Imum Coeli, Descendant, or Midheaven), where their influence is strongest at this location. Always English, whatever the lang parameter says. Use angularPlanetsLocalized for anything a reader sees.
|
|
1181
1301
|
*/
|
|
1182
1302
|
angularPlanets: Array<string>;
|
|
1303
|
+
/**
|
|
1304
|
+
* The same angular bodies in the requested language, for display only. Index aligned with angularPlanets. Present only when lang is set to a language other than English.
|
|
1305
|
+
*/
|
|
1306
|
+
angularPlanetsLocalized?: Array<string>;
|
|
1183
1307
|
/**
|
|
1184
1308
|
* Great-circle distance from the birthplace to the new location in kilometers.
|
|
1185
1309
|
*/
|
|
@@ -1201,7 +1325,7 @@ export type RelocationChartResponse = {
|
|
|
1201
1325
|
};
|
|
1202
1326
|
export type RelocationPlanet = {
|
|
1203
1327
|
/**
|
|
1204
|
-
* 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).
|
|
1328
|
+
* 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.
|
|
1205
1329
|
*/
|
|
1206
1330
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
1207
1331
|
/**
|
|
@@ -1232,6 +1356,14 @@ export type RelocationPlanet = {
|
|
|
1232
1356
|
* Whether the planet appears to move backward from Earth perspective. Retrograde periods signal review and introspection.
|
|
1233
1357
|
*/
|
|
1234
1358
|
isRetrograde: boolean;
|
|
1359
|
+
/**
|
|
1360
|
+
* 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.
|
|
1361
|
+
*/
|
|
1362
|
+
nameLocalized?: string;
|
|
1363
|
+
/**
|
|
1364
|
+
* Zodiac 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.
|
|
1365
|
+
*/
|
|
1366
|
+
signLocalized?: string;
|
|
1235
1367
|
/**
|
|
1236
1368
|
* Relocated placement interpretation. The planet keeps its natal sign, so this reads its meaning through the new house it occupies at this location.
|
|
1237
1369
|
*/
|
|
@@ -1315,9 +1447,13 @@ export type LocalSpaceResponse = {
|
|
|
1315
1447
|
*/
|
|
1316
1448
|
bodies: Array<{
|
|
1317
1449
|
/**
|
|
1318
|
-
* Body name (Sun, Moon, Mercury through Pluto, plus North Node, Chiron, or Black Moon Lilith when requested).
|
|
1450
|
+
* 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.
|
|
1319
1451
|
*/
|
|
1320
1452
|
planet: string;
|
|
1453
|
+
/**
|
|
1454
|
+
* 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.
|
|
1455
|
+
*/
|
|
1456
|
+
planetLocalized?: string;
|
|
1321
1457
|
/**
|
|
1322
1458
|
* Unicode astronomical symbol for this body.
|
|
1323
1459
|
*/
|
|
@@ -1437,9 +1573,13 @@ export type FixedStarsResponse = {
|
|
|
1437
1573
|
*/
|
|
1438
1574
|
conjunctions: Array<{
|
|
1439
1575
|
/**
|
|
1440
|
-
* Natal point conjunct this star: a planet name, or the chart angles MC and ASC.
|
|
1576
|
+
* 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.
|
|
1441
1577
|
*/
|
|
1442
1578
|
point: string;
|
|
1579
|
+
/**
|
|
1580
|
+
* 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.
|
|
1581
|
+
*/
|
|
1582
|
+
pointLocalized?: string;
|
|
1443
1583
|
/**
|
|
1444
1584
|
* Tropical ecliptic longitude of the natal point in degrees (0-360).
|
|
1445
1585
|
*/
|
|
@@ -1459,9 +1599,13 @@ export type FixedStarsResponse = {
|
|
|
1459
1599
|
*/
|
|
1460
1600
|
star: string;
|
|
1461
1601
|
/**
|
|
1462
|
-
* Natal point conjunct the star: a
|
|
1602
|
+
* 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.
|
|
1463
1603
|
*/
|
|
1464
1604
|
point: string;
|
|
1605
|
+
/**
|
|
1606
|
+
* 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.
|
|
1607
|
+
*/
|
|
1608
|
+
pointLocalized?: string;
|
|
1465
1609
|
/**
|
|
1466
1610
|
* Angular separation in degrees between the star and the natal point.
|
|
1467
1611
|
*/
|
|
@@ -1511,13 +1655,17 @@ export type ArabicLotsResponse = {
|
|
|
1511
1655
|
*/
|
|
1512
1656
|
lots: Array<{
|
|
1513
1657
|
/**
|
|
1514
|
-
* Stable machine identifier for the lot (fortune, spirit, eros, necessity, courage, victory, nemesis). Use this for lookups
|
|
1658
|
+
* Stable machine identifier for the lot (fortune, spirit, eros, necessity, courage, victory, nemesis). Use this for lookups.
|
|
1515
1659
|
*/
|
|
1516
1660
|
id: string;
|
|
1517
1661
|
/**
|
|
1518
|
-
*
|
|
1662
|
+
* 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.
|
|
1519
1663
|
*/
|
|
1520
1664
|
name: string;
|
|
1665
|
+
/**
|
|
1666
|
+
* 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.
|
|
1667
|
+
*/
|
|
1668
|
+
nameLocalized?: string;
|
|
1521
1669
|
/**
|
|
1522
1670
|
* Absolute tropical ecliptic longitude of the lot in degrees (0 to 360).
|
|
1523
1671
|
*/
|
|
@@ -1565,6 +1713,10 @@ export type ArabicLotsRequest = {
|
|
|
1565
1713
|
* 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.
|
|
1566
1714
|
*/
|
|
1567
1715
|
timezone: number | string;
|
|
1716
|
+
/**
|
|
1717
|
+
* 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".
|
|
1718
|
+
*/
|
|
1719
|
+
nodeType?: 'mean' | 'true';
|
|
1568
1720
|
/**
|
|
1569
1721
|
* 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.
|
|
1570
1722
|
*/
|
|
@@ -1605,9 +1757,13 @@ export type AsteroidsResponse = {
|
|
|
1605
1757
|
*/
|
|
1606
1758
|
asteroids: Array<{
|
|
1607
1759
|
/**
|
|
1608
|
-
*
|
|
1760
|
+
* 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.
|
|
1609
1761
|
*/
|
|
1610
1762
|
name: string;
|
|
1763
|
+
/**
|
|
1764
|
+
* 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.
|
|
1765
|
+
*/
|
|
1766
|
+
nameLocalized?: string;
|
|
1611
1767
|
/**
|
|
1612
1768
|
* Absolute tropical ecliptic longitude of the asteroid in degrees (0 to 360).
|
|
1613
1769
|
*/
|
|
@@ -1667,6 +1823,10 @@ export type AsteroidsRequest = {
|
|
|
1667
1823
|
* 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.
|
|
1668
1824
|
*/
|
|
1669
1825
|
timezone: number | string;
|
|
1826
|
+
/**
|
|
1827
|
+
* 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".
|
|
1828
|
+
*/
|
|
1829
|
+
nodeType?: 'mean' | 'true';
|
|
1670
1830
|
/**
|
|
1671
1831
|
* 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.
|
|
1672
1832
|
*/
|
|
@@ -1707,9 +1867,13 @@ export type LilithResponse = {
|
|
|
1707
1867
|
*/
|
|
1708
1868
|
lilith: Array<{
|
|
1709
1869
|
/**
|
|
1710
|
-
* Which lunar apogee this entry describes
|
|
1870
|
+
* 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.
|
|
1871
|
+
*/
|
|
1872
|
+
variant: 'mean' | 'true';
|
|
1873
|
+
/**
|
|
1874
|
+
* 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.
|
|
1711
1875
|
*/
|
|
1712
|
-
|
|
1876
|
+
variantLocalized?: string;
|
|
1713
1877
|
/**
|
|
1714
1878
|
* Absolute tropical ecliptic longitude of the apogee in degrees (0 to 360).
|
|
1715
1879
|
*/
|
|
@@ -1773,6 +1937,10 @@ export type LilithRequest = {
|
|
|
1773
1937
|
* 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.
|
|
1774
1938
|
*/
|
|
1775
1939
|
timezone: number | string;
|
|
1940
|
+
/**
|
|
1941
|
+
* 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".
|
|
1942
|
+
*/
|
|
1943
|
+
nodeType?: 'mean' | 'true';
|
|
1776
1944
|
/**
|
|
1777
1945
|
* House system used to place each Lilith variant in a house. Placidus (default), Whole Sign, Equal, or Koch.
|
|
1778
1946
|
*/
|
|
@@ -1821,17 +1989,25 @@ export type ProgressionsResponse = {
|
|
|
1821
1989
|
*/
|
|
1822
1990
|
planets: Array<{
|
|
1823
1991
|
/**
|
|
1824
|
-
* Body name in canonical English. One of the 10 classical planets, the lunar nodes, Chiron, or Black Moon Lilith.
|
|
1992
|
+
* Body name in canonical English. One of the 10 classical planets, the lunar nodes, Chiron, or Black Moon Lilith. Unchanged by the lang parameter, so it stays safe to compare against in code. Use nameLocalized for anything a reader sees.
|
|
1825
1993
|
*/
|
|
1826
1994
|
name: string;
|
|
1995
|
+
/**
|
|
1996
|
+
* 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.
|
|
1997
|
+
*/
|
|
1998
|
+
nameLocalized?: string;
|
|
1827
1999
|
/**
|
|
1828
2000
|
* Progressed tropical ecliptic longitude in degrees (0 to 360).
|
|
1829
2001
|
*/
|
|
1830
2002
|
longitude: number;
|
|
1831
2003
|
/**
|
|
1832
|
-
* Tropical zodiac sign the progressed body falls in.
|
|
2004
|
+
* Tropical zodiac sign the progressed body falls in. Always English, whatever the lang parameter says. Use signLocalized for anything a reader sees.
|
|
1833
2005
|
*/
|
|
1834
2006
|
sign: string;
|
|
2007
|
+
/**
|
|
2008
|
+
* Zodiac 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.
|
|
2009
|
+
*/
|
|
2010
|
+
signLocalized?: string;
|
|
1835
2011
|
/**
|
|
1836
2012
|
* Degree of the progressed body within its zodiac sign (0 to 29.999).
|
|
1837
2013
|
*/
|
|
@@ -1862,9 +2038,13 @@ export type ProgressionsResponse = {
|
|
|
1862
2038
|
*/
|
|
1863
2039
|
longitude: number;
|
|
1864
2040
|
/**
|
|
1865
|
-
* Tropical zodiac sign the progressed angle falls in.
|
|
2041
|
+
* Tropical zodiac sign the progressed angle falls in. Always English, whatever the lang parameter says. Use signLocalized for anything a reader sees.
|
|
1866
2042
|
*/
|
|
1867
2043
|
sign: string;
|
|
2044
|
+
/**
|
|
2045
|
+
* Zodiac sign name on this angle 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.
|
|
2046
|
+
*/
|
|
2047
|
+
signLocalized?: string;
|
|
1868
2048
|
/**
|
|
1869
2049
|
* Degree of the progressed angle within its zodiac sign (0 to 29.999).
|
|
1870
2050
|
*/
|
|
@@ -1879,9 +2059,13 @@ export type ProgressionsResponse = {
|
|
|
1879
2059
|
*/
|
|
1880
2060
|
longitude: number;
|
|
1881
2061
|
/**
|
|
1882
|
-
* Tropical zodiac sign the progressed angle falls in.
|
|
2062
|
+
* Tropical zodiac sign the progressed angle falls in. Always English, whatever the lang parameter says. Use signLocalized for anything a reader sees.
|
|
1883
2063
|
*/
|
|
1884
2064
|
sign: string;
|
|
2065
|
+
/**
|
|
2066
|
+
* Zodiac sign name on this angle 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.
|
|
2067
|
+
*/
|
|
2068
|
+
signLocalized?: string;
|
|
1885
2069
|
/**
|
|
1886
2070
|
* Degree of the progressed angle within its zodiac sign (0 to 29.999).
|
|
1887
2071
|
*/
|
|
@@ -1913,6 +2097,10 @@ export type ProgressionsRequest = {
|
|
|
1913
2097
|
* 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.
|
|
1914
2098
|
*/
|
|
1915
2099
|
timezone: number | string;
|
|
2100
|
+
/**
|
|
2101
|
+
* 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".
|
|
2102
|
+
*/
|
|
2103
|
+
nodeType?: 'mean' | 'true';
|
|
1916
2104
|
/**
|
|
1917
2105
|
* 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.
|
|
1918
2106
|
*/
|
|
@@ -1961,9 +2149,13 @@ export type SolarArcResponse = {
|
|
|
1961
2149
|
*/
|
|
1962
2150
|
directed: Array<{
|
|
1963
2151
|
/**
|
|
1964
|
-
* Name of the directed point,
|
|
2152
|
+
* 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.
|
|
1965
2153
|
*/
|
|
1966
2154
|
name: string;
|
|
2155
|
+
/**
|
|
2156
|
+
* 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.
|
|
2157
|
+
*/
|
|
2158
|
+
nameLocalized?: string;
|
|
1967
2159
|
/**
|
|
1968
2160
|
* Absolute tropical ecliptic longitude of the point in the natal chart, in degrees (0 to 360).
|
|
1969
2161
|
*/
|
|
@@ -2007,6 +2199,10 @@ export type SolarArcRequest = {
|
|
|
2007
2199
|
* 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.
|
|
2008
2200
|
*/
|
|
2009
2201
|
timezone: number | string;
|
|
2202
|
+
/**
|
|
2203
|
+
* 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".
|
|
2204
|
+
*/
|
|
2205
|
+
nodeType?: 'mean' | 'true';
|
|
2010
2206
|
/**
|
|
2011
2207
|
* 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.
|
|
2012
2208
|
*/
|
|
@@ -2101,6 +2297,10 @@ export type ProfectionsRequest = {
|
|
|
2101
2297
|
* 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.
|
|
2102
2298
|
*/
|
|
2103
2299
|
timezone: number | string;
|
|
2300
|
+
/**
|
|
2301
|
+
* 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".
|
|
2302
|
+
*/
|
|
2303
|
+
nodeType?: 'mean' | 'true';
|
|
2104
2304
|
/**
|
|
2105
2305
|
* 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.
|
|
2106
2306
|
*/
|
|
@@ -4226,7 +4426,7 @@ export type KpPlanetsRequest = {
|
|
|
4226
4426
|
*/
|
|
4227
4427
|
ayanamsaValue?: number;
|
|
4228
4428
|
/**
|
|
4229
|
-
* Lunar node
|
|
4429
|
+
* 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".
|
|
4230
4430
|
*/
|
|
4231
4431
|
nodeType?: 'mean' | 'true';
|
|
4232
4432
|
};
|
|
@@ -4680,7 +4880,7 @@ export type KpChartRequest = {
|
|
|
4680
4880
|
*/
|
|
4681
4881
|
ayanamsaValue?: number;
|
|
4682
4882
|
/**
|
|
4683
|
-
* Lunar node
|
|
4883
|
+
* 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".
|
|
4684
4884
|
*/
|
|
4685
4885
|
nodeType?: 'mean' | 'true';
|
|
4686
4886
|
};
|
|
@@ -5050,7 +5250,7 @@ export type KpSublordChangesRequest = {
|
|
|
5050
5250
|
*/
|
|
5051
5251
|
ayanamsa?: 'kp-newcomb' | 'kp-old' | 'lahiri' | 'raman';
|
|
5052
5252
|
/**
|
|
5053
|
-
* Lunar node
|
|
5253
|
+
* 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".
|
|
5054
5254
|
*/
|
|
5055
5255
|
nodeType?: 'mean' | 'true';
|
|
5056
5256
|
};
|
|
@@ -5127,7 +5327,7 @@ export type KpRasiChangesRequest = {
|
|
|
5127
5327
|
*/
|
|
5128
5328
|
ayanamsa?: 'kp-newcomb' | 'kp-old' | 'lahiri' | 'raman';
|
|
5129
5329
|
/**
|
|
5130
|
-
* Lunar node
|
|
5330
|
+
* 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".
|
|
5131
5331
|
*/
|
|
5132
5332
|
nodeType?: 'mean' | 'true';
|
|
5133
5333
|
};
|
|
@@ -5251,7 +5451,7 @@ export type KpPlanetsIntervalRequest = {
|
|
|
5251
5451
|
*/
|
|
5252
5452
|
ayanamsa?: 'kp-newcomb' | 'kp-old' | 'lahiri' | 'raman';
|
|
5253
5453
|
/**
|
|
5254
|
-
* Lunar node
|
|
5454
|
+
* 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".
|
|
5255
5455
|
*/
|
|
5256
5456
|
nodeType?: 'mean' | 'true';
|
|
5257
5457
|
};
|
|
@@ -5533,7 +5733,7 @@ export type KpHoraryRequest = {
|
|
|
5533
5733
|
*/
|
|
5534
5734
|
ayanamsaValue?: number;
|
|
5535
5735
|
/**
|
|
5536
|
-
* Lunar node
|
|
5736
|
+
* 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".
|
|
5537
5737
|
*/
|
|
5538
5738
|
nodeType?: 'mean' | 'true';
|
|
5539
5739
|
};
|
|
@@ -7274,9 +7474,13 @@ export type GetAstrologySignsResponses = {
|
|
|
7274
7474
|
*/
|
|
7275
7475
|
symbol?: string;
|
|
7276
7476
|
/**
|
|
7277
|
-
* Elemental classification:
|
|
7477
|
+
* 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.
|
|
7278
7478
|
*/
|
|
7279
7479
|
element: 'fire' | 'earth' | 'air' | 'water';
|
|
7480
|
+
/**
|
|
7481
|
+
* 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.
|
|
7482
|
+
*/
|
|
7483
|
+
elementLocalized?: string;
|
|
7280
7484
|
/**
|
|
7281
7485
|
* Tropical zodiac date range for this sign.
|
|
7282
7486
|
*/
|
|
@@ -7450,17 +7654,29 @@ export type GetAstrologySignsByIdResponses = {
|
|
|
7450
7654
|
*/
|
|
7451
7655
|
symbolName: string;
|
|
7452
7656
|
/**
|
|
7453
|
-
* Elemental classification:
|
|
7657
|
+
* 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.
|
|
7454
7658
|
*/
|
|
7455
7659
|
element: 'fire' | 'earth' | 'air' | 'water';
|
|
7456
7660
|
/**
|
|
7457
|
-
*
|
|
7661
|
+
* 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.
|
|
7662
|
+
*/
|
|
7663
|
+
elementLocalized?: string;
|
|
7664
|
+
/**
|
|
7665
|
+
* 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.
|
|
7458
7666
|
*/
|
|
7459
7667
|
modality: 'cardinal' | 'fixed' | 'mutable';
|
|
7460
7668
|
/**
|
|
7461
|
-
*
|
|
7669
|
+
* 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.
|
|
7670
|
+
*/
|
|
7671
|
+
modalityLocalized?: string;
|
|
7672
|
+
/**
|
|
7673
|
+
* 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.
|
|
7462
7674
|
*/
|
|
7463
7675
|
rulingPlanet: string;
|
|
7676
|
+
/**
|
|
7677
|
+
* 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.
|
|
7678
|
+
*/
|
|
7679
|
+
rulingPlanetLocalized?: string;
|
|
7464
7680
|
/**
|
|
7465
7681
|
* Tropical zodiac date range for this sign.
|
|
7466
7682
|
*/
|
|
@@ -8018,6 +8234,10 @@ export type PostAstrologyPlanetsData = {
|
|
|
8018
8234
|
* 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.
|
|
8019
8235
|
*/
|
|
8020
8236
|
time: string;
|
|
8237
|
+
/**
|
|
8238
|
+
* 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".
|
|
8239
|
+
*/
|
|
8240
|
+
nodeType?: 'mean' | 'true';
|
|
8021
8241
|
/**
|
|
8022
8242
|
* 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.
|
|
8023
8243
|
*/
|
|
@@ -8220,6 +8440,186 @@ export type PostAstrologyPlanetsResponses = {
|
|
|
8220
8440
|
};
|
|
8221
8441
|
};
|
|
8222
8442
|
export type PostAstrologyPlanetsResponse = PostAstrologyPlanetsResponses[keyof PostAstrologyPlanetsResponses];
|
|
8443
|
+
export type PostAstrologyPlanetsMonthlyData = {
|
|
8444
|
+
body?: {
|
|
8445
|
+
/**
|
|
8446
|
+
* Year for the monthly ephemeris (1900-2100). Defaults to the current year (UTC).
|
|
8447
|
+
*/
|
|
8448
|
+
year?: number;
|
|
8449
|
+
/**
|
|
8450
|
+
* Month number (1-12) for the ephemeris. Defaults to the current month (UTC).
|
|
8451
|
+
*/
|
|
8452
|
+
month?: number;
|
|
8453
|
+
};
|
|
8454
|
+
path?: never;
|
|
8455
|
+
query?: {
|
|
8456
|
+
/**
|
|
8457
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
8458
|
+
*/
|
|
8459
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
8460
|
+
};
|
|
8461
|
+
url: '/astrology/planets/monthly';
|
|
8462
|
+
};
|
|
8463
|
+
export type PostAstrologyPlanetsMonthlyErrors = {
|
|
8464
|
+
/**
|
|
8465
|
+
* Validation error. `issues[]` lists every failed field.
|
|
8466
|
+
*/
|
|
8467
|
+
400: {
|
|
8468
|
+
/**
|
|
8469
|
+
* First issue summary.
|
|
8470
|
+
*/
|
|
8471
|
+
error: string;
|
|
8472
|
+
code: 'validation_error';
|
|
8473
|
+
/**
|
|
8474
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
8475
|
+
*/
|
|
8476
|
+
issues: Array<{
|
|
8477
|
+
/**
|
|
8478
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
8479
|
+
*/
|
|
8480
|
+
path: string;
|
|
8481
|
+
message: string;
|
|
8482
|
+
/**
|
|
8483
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
8484
|
+
*/
|
|
8485
|
+
code?: string;
|
|
8486
|
+
/**
|
|
8487
|
+
* Expected type for invalid_type.
|
|
8488
|
+
*/
|
|
8489
|
+
expected?: string;
|
|
8490
|
+
/**
|
|
8491
|
+
* Minimum bound for too_small issues.
|
|
8492
|
+
*/
|
|
8493
|
+
minimum?: number | string;
|
|
8494
|
+
/**
|
|
8495
|
+
* Maximum bound for too_big issues.
|
|
8496
|
+
*/
|
|
8497
|
+
maximum?: number | string;
|
|
8498
|
+
inclusive?: boolean;
|
|
8499
|
+
/**
|
|
8500
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
8501
|
+
*/
|
|
8502
|
+
format?: string;
|
|
8503
|
+
/**
|
|
8504
|
+
* Regex pattern when format is regex.
|
|
8505
|
+
*/
|
|
8506
|
+
pattern?: string;
|
|
8507
|
+
}>;
|
|
8508
|
+
};
|
|
8509
|
+
/**
|
|
8510
|
+
* Invalid or missing API key
|
|
8511
|
+
*/
|
|
8512
|
+
401: {
|
|
8513
|
+
/**
|
|
8514
|
+
* Human-readable error message. May change wording.
|
|
8515
|
+
*/
|
|
8516
|
+
error: string;
|
|
8517
|
+
/**
|
|
8518
|
+
* Machine-readable error code. Stable identifier.
|
|
8519
|
+
*/
|
|
8520
|
+
code: string;
|
|
8521
|
+
};
|
|
8522
|
+
/**
|
|
8523
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
8524
|
+
*/
|
|
8525
|
+
405: {
|
|
8526
|
+
error: string;
|
|
8527
|
+
code: 'method_not_allowed';
|
|
8528
|
+
/**
|
|
8529
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
8530
|
+
*/
|
|
8531
|
+
allow: Array<string>;
|
|
8532
|
+
/**
|
|
8533
|
+
* Link to the product page for this domain.
|
|
8534
|
+
*/
|
|
8535
|
+
docs?: string;
|
|
8536
|
+
};
|
|
8537
|
+
/**
|
|
8538
|
+
* Monthly rate limit exceeded
|
|
8539
|
+
*/
|
|
8540
|
+
429: {
|
|
8541
|
+
/**
|
|
8542
|
+
* Human-readable error message. May change wording.
|
|
8543
|
+
*/
|
|
8544
|
+
error: string;
|
|
8545
|
+
/**
|
|
8546
|
+
* Machine-readable error code. Stable identifier.
|
|
8547
|
+
*/
|
|
8548
|
+
code: string;
|
|
8549
|
+
};
|
|
8550
|
+
/**
|
|
8551
|
+
* Internal server error
|
|
8552
|
+
*/
|
|
8553
|
+
500: {
|
|
8554
|
+
/**
|
|
8555
|
+
* Human-readable error message. May change wording.
|
|
8556
|
+
*/
|
|
8557
|
+
error: string;
|
|
8558
|
+
/**
|
|
8559
|
+
* Machine-readable error code. Stable identifier.
|
|
8560
|
+
*/
|
|
8561
|
+
code: string;
|
|
8562
|
+
};
|
|
8563
|
+
};
|
|
8564
|
+
export type PostAstrologyPlanetsMonthlyError = PostAstrologyPlanetsMonthlyErrors[keyof PostAstrologyPlanetsMonthlyErrors];
|
|
8565
|
+
export type PostAstrologyPlanetsMonthlyResponses = {
|
|
8566
|
+
/**
|
|
8567
|
+
* Monthly ephemeris data
|
|
8568
|
+
*/
|
|
8569
|
+
200: {
|
|
8570
|
+
/**
|
|
8571
|
+
* Year of the ephemeris. Echoes the year that was requested, or the current UTC year when it was omitted.
|
|
8572
|
+
*/
|
|
8573
|
+
year: number;
|
|
8574
|
+
/**
|
|
8575
|
+
* Month of the ephemeris. Echoes the month that was requested, or the current UTC month when it was omitted.
|
|
8576
|
+
*/
|
|
8577
|
+
month: number;
|
|
8578
|
+
/**
|
|
8579
|
+
* Daily planetary position entries for the entire month.
|
|
8580
|
+
*/
|
|
8581
|
+
days: Array<{
|
|
8582
|
+
/**
|
|
8583
|
+
* Date in YYYY-MM-DD format.
|
|
8584
|
+
*/
|
|
8585
|
+
date: string;
|
|
8586
|
+
/**
|
|
8587
|
+
* Tropical positions of all 14 Western bodies on this date at noon UTC.
|
|
8588
|
+
*/
|
|
8589
|
+
positions: Array<{
|
|
8590
|
+
/**
|
|
8591
|
+
* Body name, one of the 14 bodies Western astrology reads: Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto, North Node, South Node, Chiron, Black Moon Lilith. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use planetLocalized for anything a reader sees.
|
|
8592
|
+
*/
|
|
8593
|
+
planet: string;
|
|
8594
|
+
/**
|
|
8595
|
+
* Body name in the requested language, for display. Present only when lang is set to a language other than English, since in English it would repeat planet exactly.
|
|
8596
|
+
*/
|
|
8597
|
+
planetLocalized?: string;
|
|
8598
|
+
/**
|
|
8599
|
+
* Tropical ecliptic longitude in degrees (0-360), measured from the vernal equinox. This is the Western zodiac, not the sidereal one, so the two differ by the ayanamsa of roughly 24 degrees.
|
|
8600
|
+
*/
|
|
8601
|
+
longitude: number;
|
|
8602
|
+
/**
|
|
8603
|
+
* Tropical zodiac sign the body occupies on this date. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use signLocalized for anything a reader sees.
|
|
8604
|
+
*/
|
|
8605
|
+
sign: string;
|
|
8606
|
+
/**
|
|
8607
|
+
* Zodiac sign name in the requested language, for display. Present only when lang is set to a language other than English, since in English it would repeat sign exactly.
|
|
8608
|
+
*/
|
|
8609
|
+
signLocalized?: string;
|
|
8610
|
+
/**
|
|
8611
|
+
* Degrees traversed within the current sign (0-30). Useful for precise transit tracking and for printing a position as sign plus degree.
|
|
8612
|
+
*/
|
|
8613
|
+
degreeInSign: number;
|
|
8614
|
+
/**
|
|
8615
|
+
* Whether the body is in apparent retrograde motion on this date. The lunar nodes are always retrograde and Black Moon Lilith is always direct.
|
|
8616
|
+
*/
|
|
8617
|
+
isRetrograde: boolean;
|
|
8618
|
+
}>;
|
|
8619
|
+
}>;
|
|
8620
|
+
};
|
|
8621
|
+
};
|
|
8622
|
+
export type PostAstrologyPlanetsMonthlyResponse = PostAstrologyPlanetsMonthlyResponses[keyof PostAstrologyPlanetsMonthlyResponses];
|
|
8223
8623
|
export type GetAstrologyMoonPhaseCurrentData = {
|
|
8224
8624
|
body?: never;
|
|
8225
8625
|
path?: never;
|
|
@@ -8734,6 +9134,10 @@ export type PostAstrologySynastryData = {
|
|
|
8734
9134
|
* 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.
|
|
8735
9135
|
*/
|
|
8736
9136
|
timezone: number | string;
|
|
9137
|
+
/**
|
|
9138
|
+
* 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".
|
|
9139
|
+
*/
|
|
9140
|
+
nodeType?: 'mean' | 'true';
|
|
8737
9141
|
/**
|
|
8738
9142
|
* Optional display name for this person. Included in the response for easy identification.
|
|
8739
9143
|
*/
|
|
@@ -8760,6 +9164,10 @@ export type PostAstrologySynastryData = {
|
|
|
8760
9164
|
* 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.
|
|
8761
9165
|
*/
|
|
8762
9166
|
timezone: number | string;
|
|
9167
|
+
/**
|
|
9168
|
+
* 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".
|
|
9169
|
+
*/
|
|
9170
|
+
nodeType?: 'mean' | 'true';
|
|
8763
9171
|
/**
|
|
8764
9172
|
* Optional display name for this person. Included in the response for easy identification.
|
|
8765
9173
|
*/
|
|
@@ -8899,38 +9307,58 @@ export type PostAstrologySynastryResponses = {
|
|
|
8899
9307
|
*/
|
|
8900
9308
|
ascendant: {
|
|
8901
9309
|
/**
|
|
8902
|
-
* Ascendant (rising sign) of this person.
|
|
9310
|
+
* Ascendant (rising sign) of this person. Always English, whatever the lang parameter says. Use signLocalized for anything a reader sees.
|
|
8903
9311
|
*/
|
|
8904
9312
|
sign: string;
|
|
9313
|
+
/**
|
|
9314
|
+
* 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.
|
|
9315
|
+
*/
|
|
9316
|
+
signLocalized?: string;
|
|
8905
9317
|
/**
|
|
8906
9318
|
* Degree within the Ascendant sign (0-29.999).
|
|
8907
9319
|
*/
|
|
8908
9320
|
degree: number;
|
|
8909
9321
|
};
|
|
8910
9322
|
/**
|
|
8911
|
-
* Sun sign (zodiac sign) of this person. Core identity and ego expression.
|
|
9323
|
+
* Sun sign (zodiac sign) of this person. Core identity and ego expression. Always English, whatever the lang parameter says. Use sunSignLocalized for anything a reader sees.
|
|
8912
9324
|
*/
|
|
8913
9325
|
sunSign: string;
|
|
8914
9326
|
/**
|
|
8915
|
-
*
|
|
9327
|
+
* Sun 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.
|
|
9328
|
+
*/
|
|
9329
|
+
sunSignLocalized?: string;
|
|
9330
|
+
/**
|
|
9331
|
+
* Moon sign of this person. Emotional nature and inner needs. Always English, whatever the lang parameter says. Use moonSignLocalized for anything a reader sees.
|
|
8916
9332
|
*/
|
|
8917
9333
|
moonSign: string;
|
|
9334
|
+
/**
|
|
9335
|
+
* Moon 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.
|
|
9336
|
+
*/
|
|
9337
|
+
moonSignLocalized?: string;
|
|
8918
9338
|
/**
|
|
8919
9339
|
* Planet positions for person 1, enough to render this side of a dual wheel without a second request. Per-planet interpretations are not repeated here; call the natal chart endpoint for an individual reading.
|
|
8920
9340
|
*/
|
|
8921
9341
|
planets: Array<{
|
|
8922
9342
|
/**
|
|
8923
|
-
* Planet or point name. Matches the names used in interAspects.
|
|
9343
|
+
* Planet or point name. Matches the names used in interAspects. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
8924
9344
|
*/
|
|
8925
9345
|
name: string;
|
|
9346
|
+
/**
|
|
9347
|
+
* Planet or 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.
|
|
9348
|
+
*/
|
|
9349
|
+
nameLocalized?: string;
|
|
8926
9350
|
/**
|
|
8927
9351
|
* Ecliptic longitude in degrees (0-360) measured from 0 Aries. This is the value a wheel plots.
|
|
8928
9352
|
*/
|
|
8929
9353
|
longitude: number;
|
|
8930
9354
|
/**
|
|
8931
|
-
* Zodiac sign containing the planet.
|
|
9355
|
+
* Zodiac sign containing the planet. Always English, whatever the lang parameter says. Use signLocalized for anything a reader sees.
|
|
8932
9356
|
*/
|
|
8933
9357
|
sign: string;
|
|
9358
|
+
/**
|
|
9359
|
+
* Zodiac 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.
|
|
9360
|
+
*/
|
|
9361
|
+
signLocalized?: string;
|
|
8934
9362
|
/**
|
|
8935
9363
|
* Degree within the sign (0-29.999).
|
|
8936
9364
|
*/
|
|
@@ -8958,38 +9386,58 @@ export type PostAstrologySynastryResponses = {
|
|
|
8958
9386
|
*/
|
|
8959
9387
|
ascendant: {
|
|
8960
9388
|
/**
|
|
8961
|
-
* Ascendant (rising sign) of this person.
|
|
9389
|
+
* Ascendant (rising sign) of this person. Always English, whatever the lang parameter says. Use signLocalized for anything a reader sees.
|
|
8962
9390
|
*/
|
|
8963
9391
|
sign: string;
|
|
9392
|
+
/**
|
|
9393
|
+
* 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.
|
|
9394
|
+
*/
|
|
9395
|
+
signLocalized?: string;
|
|
8964
9396
|
/**
|
|
8965
9397
|
* Degree within the Ascendant sign (0-29.999).
|
|
8966
9398
|
*/
|
|
8967
9399
|
degree: number;
|
|
8968
9400
|
};
|
|
8969
9401
|
/**
|
|
8970
|
-
* Sun sign (zodiac sign) of this person. Core identity and ego expression.
|
|
9402
|
+
* Sun sign (zodiac sign) of this person. Core identity and ego expression. Always English, whatever the lang parameter says. Use sunSignLocalized for anything a reader sees.
|
|
8971
9403
|
*/
|
|
8972
9404
|
sunSign: string;
|
|
8973
9405
|
/**
|
|
8974
|
-
*
|
|
9406
|
+
* Sun 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.
|
|
9407
|
+
*/
|
|
9408
|
+
sunSignLocalized?: string;
|
|
9409
|
+
/**
|
|
9410
|
+
* Moon sign of this person. Emotional nature and inner needs. Always English, whatever the lang parameter says. Use moonSignLocalized for anything a reader sees.
|
|
8975
9411
|
*/
|
|
8976
9412
|
moonSign: string;
|
|
9413
|
+
/**
|
|
9414
|
+
* Moon 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.
|
|
9415
|
+
*/
|
|
9416
|
+
moonSignLocalized?: string;
|
|
8977
9417
|
/**
|
|
8978
9418
|
* Planet positions for person 2, enough to render this side of a dual wheel without a second request. Per-planet interpretations are not repeated here; call the natal chart endpoint for an individual reading.
|
|
8979
9419
|
*/
|
|
8980
9420
|
planets: Array<{
|
|
8981
9421
|
/**
|
|
8982
|
-
* Planet or point name. Matches the names used in interAspects.
|
|
9422
|
+
* Planet or point name. Matches the names used in interAspects. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
8983
9423
|
*/
|
|
8984
9424
|
name: string;
|
|
9425
|
+
/**
|
|
9426
|
+
* Planet or 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.
|
|
9427
|
+
*/
|
|
9428
|
+
nameLocalized?: string;
|
|
8985
9429
|
/**
|
|
8986
9430
|
* Ecliptic longitude in degrees (0-360) measured from 0 Aries. This is the value a wheel plots.
|
|
8987
9431
|
*/
|
|
8988
9432
|
longitude: number;
|
|
8989
9433
|
/**
|
|
8990
|
-
* Zodiac sign containing the planet.
|
|
9434
|
+
* Zodiac sign containing the planet. Always English, whatever the lang parameter says. Use signLocalized for anything a reader sees.
|
|
8991
9435
|
*/
|
|
8992
9436
|
sign: string;
|
|
9437
|
+
/**
|
|
9438
|
+
* Zodiac 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.
|
|
9439
|
+
*/
|
|
9440
|
+
signLocalized?: string;
|
|
8993
9441
|
/**
|
|
8994
9442
|
* Degree within the sign (0-29.999).
|
|
8995
9443
|
*/
|
|
@@ -9013,17 +9461,29 @@ export type PostAstrologySynastryResponses = {
|
|
|
9013
9461
|
*/
|
|
9014
9462
|
interAspects: Array<{
|
|
9015
9463
|
/**
|
|
9016
|
-
* Planet from person 1 chart.
|
|
9464
|
+
* Planet from person 1 chart. Always English, whatever the lang parameter says. Use planet1Localized for anything a reader sees.
|
|
9017
9465
|
*/
|
|
9018
9466
|
planet1: string;
|
|
9019
9467
|
/**
|
|
9020
|
-
*
|
|
9468
|
+
* Person 1 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.
|
|
9469
|
+
*/
|
|
9470
|
+
planet1Localized?: string;
|
|
9471
|
+
/**
|
|
9472
|
+
* Planet from person 2 chart. Always English, whatever the lang parameter says. Use planet2Localized for anything a reader sees.
|
|
9021
9473
|
*/
|
|
9022
9474
|
planet2: string;
|
|
9023
9475
|
/**
|
|
9024
|
-
*
|
|
9476
|
+
* Person 2 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.
|
|
9477
|
+
*/
|
|
9478
|
+
planet2Localized?: string;
|
|
9479
|
+
/**
|
|
9480
|
+
* Aspect type (CONJUNCTION, OPPOSITION, TRINE, SQUARE, SEXTILE, etc.). Always English, whatever the lang parameter says. Use typeLocalized for anything a reader sees.
|
|
9025
9481
|
*/
|
|
9026
9482
|
type: string;
|
|
9483
|
+
/**
|
|
9484
|
+
* 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.
|
|
9485
|
+
*/
|
|
9486
|
+
typeLocalized?: string;
|
|
9027
9487
|
/**
|
|
9028
9488
|
* Exact angle of this aspect type in degrees.
|
|
9029
9489
|
*/
|
|
@@ -9661,6 +10121,10 @@ export type PostAstrologyTransitAspectsData = {
|
|
|
9661
10121
|
* 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.
|
|
9662
10122
|
*/
|
|
9663
10123
|
timezone: number | string;
|
|
10124
|
+
/**
|
|
10125
|
+
* 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".
|
|
10126
|
+
*/
|
|
10127
|
+
nodeType?: 'mean' | 'true';
|
|
9664
10128
|
};
|
|
9665
10129
|
/**
|
|
9666
10130
|
* Transit date in YYYY-MM-DD format. Defaults to current date if omitted. Use future dates for predictive transit analysis.
|
|
@@ -9811,12 +10275,58 @@ export type PostAstrologyTransitAspectsResponses = {
|
|
|
9811
10275
|
* 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.
|
|
9812
10276
|
*/
|
|
9813
10277
|
houseSystem: 'placidus' | 'whole-sign' | 'equal' | 'koch';
|
|
10278
|
+
/**
|
|
10279
|
+
* 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.
|
|
10280
|
+
*/
|
|
10281
|
+
houses: Array<{
|
|
10282
|
+
/**
|
|
10283
|
+
* House number (1-12). Each house governs specific life themes in Western astrology.
|
|
10284
|
+
*/
|
|
10285
|
+
number: number;
|
|
10286
|
+
/**
|
|
10287
|
+
* Ecliptic longitude of this house cusp in degrees (0-360).
|
|
10288
|
+
*/
|
|
10289
|
+
longitude: number;
|
|
10290
|
+
/**
|
|
10291
|
+
* Zodiac sign on this house cusp. Colors the themes of this life area.
|
|
10292
|
+
*/
|
|
10293
|
+
sign: string;
|
|
10294
|
+
/**
|
|
10295
|
+
* Degree within the zodiac sign on this cusp (0-29.999).
|
|
10296
|
+
*/
|
|
10297
|
+
degree: number;
|
|
10298
|
+
/**
|
|
10299
|
+
* 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.
|
|
10300
|
+
*/
|
|
10301
|
+
signLocalized?: string;
|
|
10302
|
+
}>;
|
|
10303
|
+
/**
|
|
10304
|
+
* 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.
|
|
10305
|
+
*/
|
|
10306
|
+
ascendant: {
|
|
10307
|
+
/**
|
|
10308
|
+
* Tropical zodiac sign on the natal Ascendant. Always English, whatever the lang parameter says. Use signLocalized for anything a reader sees.
|
|
10309
|
+
*/
|
|
10310
|
+
sign: string;
|
|
10311
|
+
/**
|
|
10312
|
+
* 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.
|
|
10313
|
+
*/
|
|
10314
|
+
signLocalized?: string;
|
|
10315
|
+
/**
|
|
10316
|
+
* Degree within the Ascendant sign (0-29.999).
|
|
10317
|
+
*/
|
|
10318
|
+
degree: number;
|
|
10319
|
+
/**
|
|
10320
|
+
* Absolute ecliptic longitude of the natal Ascendant in degrees (0-360).
|
|
10321
|
+
*/
|
|
10322
|
+
longitude: number;
|
|
10323
|
+
};
|
|
9814
10324
|
/**
|
|
9815
10325
|
* 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.
|
|
9816
10326
|
*/
|
|
9817
10327
|
transitPlanets: Array<{
|
|
9818
10328
|
/**
|
|
9819
|
-
* 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).
|
|
10329
|
+
* 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.
|
|
9820
10330
|
*/
|
|
9821
10331
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
9822
10332
|
/**
|
|
@@ -9847,13 +10357,21 @@ export type PostAstrologyTransitAspectsResponses = {
|
|
|
9847
10357
|
* Whether the planet appears to move backward from Earth perspective. Retrograde periods signal review and introspection.
|
|
9848
10358
|
*/
|
|
9849
10359
|
isRetrograde: boolean;
|
|
10360
|
+
/**
|
|
10361
|
+
* 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.
|
|
10362
|
+
*/
|
|
10363
|
+
nameLocalized?: string;
|
|
10364
|
+
/**
|
|
10365
|
+
* Zodiac 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.
|
|
10366
|
+
*/
|
|
10367
|
+
signLocalized?: string;
|
|
9850
10368
|
}>;
|
|
9851
10369
|
/**
|
|
9852
10370
|
* Natal (birth chart) planetary positions used as the baseline for transit aspect comparison, each placed in its natal house.
|
|
9853
10371
|
*/
|
|
9854
10372
|
natalPlanets: Array<{
|
|
9855
10373
|
/**
|
|
9856
|
-
* 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).
|
|
10374
|
+
* 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.
|
|
9857
10375
|
*/
|
|
9858
10376
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
9859
10377
|
/**
|
|
@@ -9884,6 +10402,14 @@ export type PostAstrologyTransitAspectsResponses = {
|
|
|
9884
10402
|
* Whether the planet appears to move backward from Earth perspective. Retrograde periods signal review and introspection.
|
|
9885
10403
|
*/
|
|
9886
10404
|
isRetrograde: boolean;
|
|
10405
|
+
/**
|
|
10406
|
+
* 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.
|
|
10407
|
+
*/
|
|
10408
|
+
nameLocalized?: string;
|
|
10409
|
+
/**
|
|
10410
|
+
* Zodiac 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.
|
|
10411
|
+
*/
|
|
10412
|
+
signLocalized?: string;
|
|
9887
10413
|
}>;
|
|
9888
10414
|
/**
|
|
9889
10415
|
* Transit-to-natal aspects with interpretations, strength ratings, and guidance. Each aspect represents a transiting planet forming a geometric angle to a natal planet.
|
|
@@ -9921,7 +10447,22 @@ export type PostAstrologyTransitAspectsResponses = {
|
|
|
9921
10447
|
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
|
|
9922
10448
|
*/
|
|
9923
10449
|
interpretation: 'harmonious' | 'challenging' | 'neutral';
|
|
9924
|
-
|
|
10450
|
+
/**
|
|
10451
|
+
* First 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.
|
|
10452
|
+
*/
|
|
10453
|
+
planet1Localized?: string;
|
|
10454
|
+
/**
|
|
10455
|
+
* Second 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.
|
|
10456
|
+
*/
|
|
10457
|
+
planet2Localized?: string;
|
|
10458
|
+
/**
|
|
10459
|
+
* 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.
|
|
10460
|
+
*/
|
|
10461
|
+
typeLocalized?: string;
|
|
10462
|
+
/**
|
|
10463
|
+
* Rich interpretation of the transit aspect: narrative summary, timing, impact assessment, practical guidance, and keywords.
|
|
10464
|
+
*/
|
|
10465
|
+
transitInterpretation: {
|
|
9925
10466
|
/**
|
|
9926
10467
|
* Narrative interpretation of this transit aspect and its life impact.
|
|
9927
10468
|
*/
|
|
@@ -10000,6 +10541,43 @@ export type PostAstrologyTransitAspectsResponses = {
|
|
|
10000
10541
|
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
|
|
10001
10542
|
*/
|
|
10002
10543
|
interpretation: 'harmonious' | 'challenging' | 'neutral';
|
|
10544
|
+
/**
|
|
10545
|
+
* First 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.
|
|
10546
|
+
*/
|
|
10547
|
+
planet1Localized?: string;
|
|
10548
|
+
/**
|
|
10549
|
+
* Second 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.
|
|
10550
|
+
*/
|
|
10551
|
+
planet2Localized?: string;
|
|
10552
|
+
/**
|
|
10553
|
+
* 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.
|
|
10554
|
+
*/
|
|
10555
|
+
typeLocalized?: string;
|
|
10556
|
+
/**
|
|
10557
|
+
* Rich interpretation of the transit aspect: narrative summary, timing, impact assessment, practical guidance, and keywords.
|
|
10558
|
+
*/
|
|
10559
|
+
transitInterpretation: {
|
|
10560
|
+
/**
|
|
10561
|
+
* Narrative interpretation of this transit aspect and its life impact.
|
|
10562
|
+
*/
|
|
10563
|
+
summary: string;
|
|
10564
|
+
/**
|
|
10565
|
+
* 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.
|
|
10566
|
+
*/
|
|
10567
|
+
timing: string;
|
|
10568
|
+
/**
|
|
10569
|
+
* Strength and nature of this transit effect — constructive, challenging, or neutral.
|
|
10570
|
+
*/
|
|
10571
|
+
impact: string;
|
|
10572
|
+
/**
|
|
10573
|
+
* Practical advice for working with this transit energy.
|
|
10574
|
+
*/
|
|
10575
|
+
guidance: string;
|
|
10576
|
+
/**
|
|
10577
|
+
* Key themes activated by this transit aspect.
|
|
10578
|
+
*/
|
|
10579
|
+
keywords: Array<string>;
|
|
10580
|
+
};
|
|
10003
10581
|
} | null;
|
|
10004
10582
|
/**
|
|
10005
10583
|
* Transit aspect counts grouped by aspect type (conjunction, trine, square, opposition, sextile, etc.). Useful for quickly assessing the transit weather.
|
|
@@ -10217,11 +10795,11 @@ export type PostAstrologySolarReturnResponses = {
|
|
|
10217
10795
|
timezone: number;
|
|
10218
10796
|
};
|
|
10219
10797
|
/**
|
|
10220
|
-
* 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.
|
|
10798
|
+
* 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.
|
|
10221
10799
|
*/
|
|
10222
10800
|
planets: Array<{
|
|
10223
10801
|
/**
|
|
10224
|
-
* 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).
|
|
10802
|
+
* 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.
|
|
10225
10803
|
*/
|
|
10226
10804
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
10227
10805
|
/**
|
|
@@ -10593,11 +11171,11 @@ export type PostAstrologyLunarReturnResponses = {
|
|
|
10593
11171
|
timezone: number;
|
|
10594
11172
|
};
|
|
10595
11173
|
/**
|
|
10596
|
-
* 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.
|
|
11174
|
+
* 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.
|
|
10597
11175
|
*/
|
|
10598
11176
|
planets: Array<{
|
|
10599
11177
|
/**
|
|
10600
|
-
* 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).
|
|
11178
|
+
* 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.
|
|
10601
11179
|
*/
|
|
10602
11180
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
10603
11181
|
/**
|
|
@@ -10793,6 +11371,10 @@ export type PostAstrologyCompositeChartData = {
|
|
|
10793
11371
|
* 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.
|
|
10794
11372
|
*/
|
|
10795
11373
|
timezone: number | string;
|
|
11374
|
+
/**
|
|
11375
|
+
* 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".
|
|
11376
|
+
*/
|
|
11377
|
+
nodeType?: 'mean' | 'true';
|
|
10796
11378
|
};
|
|
10797
11379
|
/**
|
|
10798
11380
|
* Second person birth details (date, time, location, timezone).
|
|
@@ -10818,6 +11400,10 @@ export type PostAstrologyCompositeChartData = {
|
|
|
10818
11400
|
* 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.
|
|
10819
11401
|
*/
|
|
10820
11402
|
timezone: number | string;
|
|
11403
|
+
/**
|
|
11404
|
+
* 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".
|
|
11405
|
+
*/
|
|
11406
|
+
nodeType?: 'mean' | 'true';
|
|
10821
11407
|
};
|
|
10822
11408
|
/**
|
|
10823
11409
|
* House system for the composite chart. Placidus (default), Whole Sign, Equal, or Koch.
|
|
@@ -10995,7 +11581,7 @@ export type PostAstrologyCompositeChartResponses = {
|
|
|
10995
11581
|
*/
|
|
10996
11582
|
compositePlanets: Array<{
|
|
10997
11583
|
/**
|
|
10998
|
-
* 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).
|
|
11584
|
+
* 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.
|
|
10999
11585
|
*/
|
|
11000
11586
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
11001
11587
|
/**
|
|
@@ -11182,6 +11768,10 @@ export type PostAstrologyCompatibilityScoreData = {
|
|
|
11182
11768
|
* 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.
|
|
11183
11769
|
*/
|
|
11184
11770
|
timezone: number | string;
|
|
11771
|
+
/**
|
|
11772
|
+
* 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".
|
|
11773
|
+
*/
|
|
11774
|
+
nodeType?: 'mean' | 'true';
|
|
11185
11775
|
};
|
|
11186
11776
|
/**
|
|
11187
11777
|
* Second person birth details. Compared against person1 to evaluate inter-chart aspects and compatibility.
|
|
@@ -11207,6 +11797,10 @@ export type PostAstrologyCompatibilityScoreData = {
|
|
|
11207
11797
|
* 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.
|
|
11208
11798
|
*/
|
|
11209
11799
|
timezone: number | string;
|
|
11800
|
+
/**
|
|
11801
|
+
* 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".
|
|
11802
|
+
*/
|
|
11803
|
+
nodeType?: 'mean' | 'true';
|
|
11210
11804
|
};
|
|
11211
11805
|
};
|
|
11212
11806
|
path?: never;
|
|
@@ -12477,11 +13071,11 @@ export type PostAstrologyPlanetaryReturnsResponses = {
|
|
|
12477
13071
|
timezone: number;
|
|
12478
13072
|
};
|
|
12479
13073
|
/**
|
|
12480
|
-
* 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.
|
|
13074
|
+
* 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.
|
|
12481
13075
|
*/
|
|
12482
13076
|
planets: Array<{
|
|
12483
13077
|
/**
|
|
12484
|
-
* 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).
|
|
13078
|
+
* 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.
|
|
12485
13079
|
*/
|
|
12486
13080
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
12487
13081
|
/**
|
|
@@ -12669,6 +13263,10 @@ export type PostAstrologyAstrocartographyData = {
|
|
|
12669
13263
|
* 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.
|
|
12670
13264
|
*/
|
|
12671
13265
|
timezone: number | string;
|
|
13266
|
+
/**
|
|
13267
|
+
* 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".
|
|
13268
|
+
*/
|
|
13269
|
+
nodeType?: 'mean' | 'true';
|
|
12672
13270
|
};
|
|
12673
13271
|
path?: never;
|
|
12674
13272
|
query?: {
|
|
@@ -13079,6 +13677,10 @@ export type PostAstrologyFixedStarsData = {
|
|
|
13079
13677
|
* 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.
|
|
13080
13678
|
*/
|
|
13081
13679
|
timezone: number | string;
|
|
13680
|
+
/**
|
|
13681
|
+
* 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".
|
|
13682
|
+
*/
|
|
13683
|
+
nodeType?: 'mean' | 'true';
|
|
13082
13684
|
};
|
|
13083
13685
|
path?: never;
|
|
13084
13686
|
query?: {
|
|
@@ -14529,20 +15131,25 @@ export type PostVedicAstrologyPlanetaryPositionsResponse = PostVedicAstrologyPla
|
|
|
14529
15131
|
export type PostVedicAstrologyPlanetaryPositionsMonthlyData = {
|
|
14530
15132
|
body?: {
|
|
14531
15133
|
/**
|
|
14532
|
-
* Year for monthly ephemeris (1900-2100).
|
|
15134
|
+
* Year for monthly ephemeris (1900-2100). Defaults to the current year (UTC).
|
|
14533
15135
|
*/
|
|
14534
|
-
year
|
|
15136
|
+
year?: number;
|
|
14535
15137
|
/**
|
|
14536
|
-
* Month number (1-12) for ephemeris.
|
|
15138
|
+
* Month number (1-12) for ephemeris. Defaults to the current month (UTC).
|
|
14537
15139
|
*/
|
|
14538
|
-
month
|
|
15140
|
+
month?: number;
|
|
14539
15141
|
/**
|
|
14540
15142
|
* Coordinate system for longitude output. "sidereal" (Nirayana) uses Lahiri ayanamsa - standard for Vedic astrology. "tropical" (Sayana) uses raw ecliptic longitude matching Western astrology. Defaults to "sidereal".
|
|
14541
15143
|
*/
|
|
14542
15144
|
coordinateSystem?: 'sidereal' | 'tropical';
|
|
14543
15145
|
};
|
|
14544
15146
|
path?: never;
|
|
14545
|
-
query?:
|
|
15147
|
+
query?: {
|
|
15148
|
+
/**
|
|
15149
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
15150
|
+
*/
|
|
15151
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
15152
|
+
};
|
|
14546
15153
|
url: '/vedic-astrology/planetary-positions/monthly';
|
|
14547
15154
|
};
|
|
14548
15155
|
export type PostVedicAstrologyPlanetaryPositionsMonthlyErrors = {
|
|
@@ -14653,11 +15260,11 @@ export type PostVedicAstrologyPlanetaryPositionsMonthlyResponses = {
|
|
|
14653
15260
|
*/
|
|
14654
15261
|
200: {
|
|
14655
15262
|
/**
|
|
14656
|
-
* Year of the ephemeris.
|
|
15263
|
+
* Year of the ephemeris. Echoes the year that was requested, or the current UTC year when it was omitted.
|
|
14657
15264
|
*/
|
|
14658
15265
|
year: number;
|
|
14659
15266
|
/**
|
|
14660
|
-
* Month of the ephemeris.
|
|
15267
|
+
* Month of the ephemeris. Echoes the month that was requested, or the current UTC month when it was omitted.
|
|
14661
15268
|
*/
|
|
14662
15269
|
month: number;
|
|
14663
15270
|
/**
|
|
@@ -14673,17 +15280,25 @@ export type PostVedicAstrologyPlanetaryPositionsMonthlyResponses = {
|
|
|
14673
15280
|
*/
|
|
14674
15281
|
positions: Array<{
|
|
14675
15282
|
/**
|
|
14676
|
-
* Planet name, one of the Navagraha (Sun, Moon, Mars, Mercury, Jupiter, Venus, Saturn, Rahu, Ketu).
|
|
15283
|
+
* Planet name, one of the Navagraha (Sun, Moon, Mars, Mercury, Jupiter, Venus, Saturn, Rahu, Ketu). Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use planetLocalized for anything a reader sees.
|
|
14677
15284
|
*/
|
|
14678
15285
|
planet: string;
|
|
15286
|
+
/**
|
|
15287
|
+
* Planet name in the requested language, for display. Present only when lang is set to a language other than English, since in English it would repeat planet exactly. Rahu and Ketu are rendered as the lunar nodes they are, so Spanish returns Nodo Norte and Nodo Sur while Hindi returns their Sanskrit names.
|
|
15288
|
+
*/
|
|
15289
|
+
planetLocalized?: string;
|
|
14679
15290
|
/**
|
|
14680
15291
|
* Sidereal ecliptic longitude in degrees (0-360) using Lahiri ayanamsa.
|
|
14681
15292
|
*/
|
|
14682
15293
|
longitude: number;
|
|
14683
15294
|
/**
|
|
14684
|
-
* Zodiac sign (rashi) the planet occupies on this date.
|
|
15295
|
+
* Zodiac sign (rashi) the planet occupies on this date. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use signLocalized for anything a reader sees.
|
|
14685
15296
|
*/
|
|
14686
15297
|
sign: string;
|
|
15298
|
+
/**
|
|
15299
|
+
* Zodiac sign name in the requested language, for display. Present only when lang is set to a language other than English, since in English it would repeat sign exactly.
|
|
15300
|
+
*/
|
|
15301
|
+
signLocalized?: string;
|
|
14687
15302
|
/**
|
|
14688
15303
|
* Degrees traversed within the current sign (0-30). Useful for precise transit tracking.
|
|
14689
15304
|
*/
|
|
@@ -20021,7 +20636,7 @@ export type PostVedicAstrologyKpRulingPlanetsData = {
|
|
|
20021
20636
|
*/
|
|
20022
20637
|
birthTime?: string;
|
|
20023
20638
|
/**
|
|
20024
|
-
* Lunar node
|
|
20639
|
+
* 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".
|
|
20025
20640
|
*/
|
|
20026
20641
|
nodeType?: 'mean' | 'true';
|
|
20027
20642
|
};
|
|
@@ -20178,7 +20793,7 @@ export type PostVedicAstrologyKpRulingPlanetsIntervalData = {
|
|
|
20178
20793
|
*/
|
|
20179
20794
|
ayanamsa?: 'kp-newcomb' | 'kp-old' | 'lahiri' | 'raman';
|
|
20180
20795
|
/**
|
|
20181
|
-
* Lunar node
|
|
20796
|
+
* 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".
|
|
20182
20797
|
*/
|
|
20183
20798
|
nodeType?: 'mean' | 'true';
|
|
20184
20799
|
};
|
|
@@ -21006,13 +21621,13 @@ export type PostVedicAstrologyAspectsResponse = PostVedicAstrologyAspectsRespons
|
|
|
21006
21621
|
export type PostVedicAstrologyAspectsMonthlyData = {
|
|
21007
21622
|
body?: {
|
|
21008
21623
|
/**
|
|
21009
|
-
* Year for monthly analysis (1900-2100).
|
|
21624
|
+
* Year for monthly analysis (1900-2100). Defaults to the current year (UTC).
|
|
21010
21625
|
*/
|
|
21011
|
-
year
|
|
21626
|
+
year?: number;
|
|
21012
21627
|
/**
|
|
21013
|
-
* Month number (1-12).
|
|
21628
|
+
* Month number (1-12). Defaults to the current month (UTC).
|
|
21014
21629
|
*/
|
|
21015
|
-
month
|
|
21630
|
+
month?: number;
|
|
21016
21631
|
/**
|
|
21017
21632
|
* Timezone offset from UTC in hours. Output times are converted to this timezone. Defaults to 0 (UTC).
|
|
21018
21633
|
*/
|
|
@@ -21023,7 +21638,12 @@ export type PostVedicAstrologyAspectsMonthlyData = {
|
|
|
21023
21638
|
coordinateSystem?: 'sidereal' | 'tropical';
|
|
21024
21639
|
};
|
|
21025
21640
|
path?: never;
|
|
21026
|
-
query?:
|
|
21641
|
+
query?: {
|
|
21642
|
+
/**
|
|
21643
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
21644
|
+
*/
|
|
21645
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
21646
|
+
};
|
|
21027
21647
|
url: '/vedic-astrology/aspects/monthly';
|
|
21028
21648
|
};
|
|
21029
21649
|
export type PostVedicAstrologyAspectsMonthlyErrors = {
|
|
@@ -21134,11 +21754,11 @@ export type PostVedicAstrologyAspectsMonthlyResponses = {
|
|
|
21134
21754
|
*/
|
|
21135
21755
|
200: {
|
|
21136
21756
|
/**
|
|
21137
|
-
* Year of the aspect analysis.
|
|
21757
|
+
* Year of the aspect analysis. Echoes the year that was requested, or the current UTC year when it was omitted.
|
|
21138
21758
|
*/
|
|
21139
21759
|
year: number;
|
|
21140
21760
|
/**
|
|
21141
|
-
* Month of the aspect analysis.
|
|
21761
|
+
* Month of the aspect analysis. Echoes the month that was requested, or the current UTC month when it was omitted.
|
|
21142
21762
|
*/
|
|
21143
21763
|
month: number;
|
|
21144
21764
|
/**
|
|
@@ -21150,13 +21770,21 @@ export type PostVedicAstrologyAspectsMonthlyResponses = {
|
|
|
21150
21770
|
*/
|
|
21151
21771
|
events: Array<{
|
|
21152
21772
|
/**
|
|
21153
|
-
* First planet forming the aspect. One of the Navagraha, Sun through Ketu.
|
|
21773
|
+
* First planet forming the aspect. One of the Navagraha, Sun through Ketu. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use planet1Localized for anything a reader sees.
|
|
21154
21774
|
*/
|
|
21155
21775
|
planet1: string;
|
|
21156
21776
|
/**
|
|
21157
|
-
*
|
|
21777
|
+
* First planet name in the requested language, for display. Present only when lang is set to a language other than English, since in English it would repeat planet1 exactly.
|
|
21778
|
+
*/
|
|
21779
|
+
planet1Localized?: string;
|
|
21780
|
+
/**
|
|
21781
|
+
* Second planet forming the aspect. Always English, whatever the lang parameter says. Use planet2Localized for anything a reader sees.
|
|
21158
21782
|
*/
|
|
21159
21783
|
planet2: string;
|
|
21784
|
+
/**
|
|
21785
|
+
* Second planet name in the requested language, for display. Present only when lang is set to a language other than English.
|
|
21786
|
+
*/
|
|
21787
|
+
planet2Localized?: string;
|
|
21160
21788
|
/**
|
|
21161
21789
|
* Aspect type. major: conjunction (0 deg), opposition (180 deg), trine (120 deg), square (90 deg), sextile (60 deg). Minor: vigintile (18 deg), semi-sextile (30 deg), undecile (32.73 deg), semi-quintile (36 deg), novile (40 deg), semi-square (45 deg), septile (51.43 deg), quintile (72 deg), binovile (80 deg), centile (100 deg), biseptile (102.86 deg), tredecile (108 deg), sesqui-square (135 deg), bi-quintile (144 deg), quincunx (150 deg), triseptile (154.29 deg), quadranovile (160 deg).
|
|
21162
21790
|
*/
|
|
@@ -21196,13 +21824,13 @@ export type PostVedicAstrologyAspectsMonthlyResponse = PostVedicAstrologyAspects
|
|
|
21196
21824
|
export type PostVedicAstrologyAspectsLunarData = {
|
|
21197
21825
|
body?: {
|
|
21198
21826
|
/**
|
|
21199
|
-
* Year for monthly analysis (1900-2100).
|
|
21827
|
+
* Year for monthly analysis (1900-2100). Defaults to the current year (UTC).
|
|
21200
21828
|
*/
|
|
21201
|
-
year
|
|
21829
|
+
year?: number;
|
|
21202
21830
|
/**
|
|
21203
|
-
* Month number (1-12).
|
|
21831
|
+
* Month number (1-12). Defaults to the current month (UTC).
|
|
21204
21832
|
*/
|
|
21205
|
-
month
|
|
21833
|
+
month?: number;
|
|
21206
21834
|
/**
|
|
21207
21835
|
* Timezone offset from UTC in hours. Output times are converted to this timezone. Defaults to 0 (UTC).
|
|
21208
21836
|
*/
|
|
@@ -21213,7 +21841,12 @@ export type PostVedicAstrologyAspectsLunarData = {
|
|
|
21213
21841
|
coordinateSystem?: 'sidereal' | 'tropical';
|
|
21214
21842
|
};
|
|
21215
21843
|
path?: never;
|
|
21216
|
-
query?:
|
|
21844
|
+
query?: {
|
|
21845
|
+
/**
|
|
21846
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
21847
|
+
*/
|
|
21848
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
21849
|
+
};
|
|
21217
21850
|
url: '/vedic-astrology/aspects/lunar';
|
|
21218
21851
|
};
|
|
21219
21852
|
export type PostVedicAstrologyAspectsLunarErrors = {
|
|
@@ -21324,11 +21957,11 @@ export type PostVedicAstrologyAspectsLunarResponses = {
|
|
|
21324
21957
|
*/
|
|
21325
21958
|
200: {
|
|
21326
21959
|
/**
|
|
21327
|
-
* Year of the lunar aspect analysis.
|
|
21960
|
+
* Year of the lunar aspect analysis. Echoes the year that was requested, or the current UTC year when it was omitted.
|
|
21328
21961
|
*/
|
|
21329
21962
|
year: number;
|
|
21330
21963
|
/**
|
|
21331
|
-
* Month of the lunar aspect analysis.
|
|
21964
|
+
* Month of the lunar aspect analysis. Echoes the month that was requested, or the current UTC month when it was omitted.
|
|
21332
21965
|
*/
|
|
21333
21966
|
month: number;
|
|
21334
21967
|
/**
|
|
@@ -21340,9 +21973,13 @@ export type PostVedicAstrologyAspectsLunarResponses = {
|
|
|
21340
21973
|
*/
|
|
21341
21974
|
events: Array<{
|
|
21342
21975
|
/**
|
|
21343
|
-
* Planet that the Moon forms an aspect with.
|
|
21976
|
+
* Planet that the Moon forms an aspect with. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use planetLocalized for anything a reader sees.
|
|
21344
21977
|
*/
|
|
21345
21978
|
planet: string;
|
|
21979
|
+
/**
|
|
21980
|
+
* Planet name in the requested language, for display. Present only when lang is set to a language other than English, since in English it would repeat planet exactly.
|
|
21981
|
+
*/
|
|
21982
|
+
planetLocalized?: string;
|
|
21346
21983
|
/**
|
|
21347
21984
|
* Aspect type. major: conjunction, opposition, trine, square, sextile. Minor: vigintile, semi-sextile, undecile, semi-quintile, novile, semi-square, septile, quintile, binovile, centile, biseptile, tredecile, sesqui-square, bi-quintile, quincunx, triseptile, quadranovile.
|
|
21348
21985
|
*/
|
|
@@ -21525,6 +22162,19 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
21525
22162
|
* Transit analysis calculated successfully
|
|
21526
22163
|
*/
|
|
21527
22164
|
200: {
|
|
22165
|
+
/**
|
|
22166
|
+
* 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.
|
|
22167
|
+
*/
|
|
22168
|
+
frame: {
|
|
22169
|
+
/**
|
|
22170
|
+
* Sidereal frame this chart was cast in, echoing the ayanamsa request field. "lahiri" when the field was omitted.
|
|
22171
|
+
*/
|
|
22172
|
+
ayanamsa: string;
|
|
22173
|
+
/**
|
|
22174
|
+
* 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.
|
|
22175
|
+
*/
|
|
22176
|
+
ayanamsaDegrees: number;
|
|
22177
|
+
};
|
|
21528
22178
|
/**
|
|
21529
22179
|
* 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.
|
|
21530
22180
|
*/
|
|
@@ -21571,11 +22221,15 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
21571
22221
|
*/
|
|
21572
22222
|
sign: string;
|
|
21573
22223
|
/**
|
|
21574
|
-
* Which natal house (whole-sign bhava from the Lagna) this
|
|
22224
|
+
* 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.
|
|
21575
22225
|
*/
|
|
21576
22226
|
natalHouse: number;
|
|
21577
22227
|
/**
|
|
21578
|
-
*
|
|
22228
|
+
* 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.
|
|
22229
|
+
*/
|
|
22230
|
+
houseFromMoon: number;
|
|
22231
|
+
/**
|
|
22232
|
+
* 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.
|
|
21579
22233
|
*/
|
|
21580
22234
|
aspectsToNatal: Array<{
|
|
21581
22235
|
/**
|
|
@@ -21583,7 +22237,7 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
21583
22237
|
*/
|
|
21584
22238
|
natalPlanet: string;
|
|
21585
22239
|
/**
|
|
21586
|
-
*
|
|
22240
|
+
* 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.
|
|
21587
22241
|
*/
|
|
21588
22242
|
aspectType: string;
|
|
21589
22243
|
/**
|
|
@@ -21591,6 +22245,27 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
21591
22245
|
*/
|
|
21592
22246
|
orb: number;
|
|
21593
22247
|
}>;
|
|
22248
|
+
/**
|
|
22249
|
+
* 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.
|
|
22250
|
+
*/
|
|
22251
|
+
drishtiToNatal: Array<{
|
|
22252
|
+
/**
|
|
22253
|
+
* Natal graha receiving the drishti from this transiting graha.
|
|
22254
|
+
*/
|
|
22255
|
+
natalPlanet: string;
|
|
22256
|
+
/**
|
|
22257
|
+
* 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.
|
|
22258
|
+
*/
|
|
22259
|
+
aspectType: 'conjunction' | '7th' | '4th' | '8th' | '5th' | '9th' | '3rd' | '10th';
|
|
22260
|
+
/**
|
|
22261
|
+
* Drishti strength as a percentage. Full and special aspects are 100; the partial quarter, half and three-quarter sights are not reported.
|
|
22262
|
+
*/
|
|
22263
|
+
strength: number;
|
|
22264
|
+
/**
|
|
22265
|
+
* 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.
|
|
22266
|
+
*/
|
|
22267
|
+
orb: number;
|
|
22268
|
+
}>;
|
|
21594
22269
|
/**
|
|
21595
22270
|
* 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.
|
|
21596
22271
|
*/
|
|
@@ -21630,17 +22305,25 @@ export type PostVedicAstrologyTransitResponses = {
|
|
|
21630
22305
|
*/
|
|
21631
22306
|
planet: string;
|
|
21632
22307
|
/**
|
|
21633
|
-
* Human-readable transit summary.
|
|
22308
|
+
* Human-readable transit summary, naming the rashi being transited and both house readings: from the Lagna, then from the natal Moon.
|
|
21634
22309
|
*/
|
|
21635
22310
|
description: string;
|
|
21636
22311
|
/**
|
|
21637
|
-
* Natal house being transited by this slow
|
|
22312
|
+
* Natal house being transited by this slow graha, counted whole-sign from the Lagna. Mirrors natalHouse on the matching transitingPlanets entry.
|
|
21638
22313
|
*/
|
|
21639
22314
|
natalHouse: number;
|
|
21640
22315
|
/**
|
|
21641
|
-
*
|
|
22316
|
+
* 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.
|
|
22317
|
+
*/
|
|
22318
|
+
houseFromMoon: number;
|
|
22319
|
+
/**
|
|
22320
|
+
* Notable degree-based angular aspects to natal planets from this slow-moving transiting planet, in Western vocabulary.
|
|
21642
22321
|
*/
|
|
21643
22322
|
aspects: Array<string>;
|
|
22323
|
+
/**
|
|
22324
|
+
* Graha drishti this slow-moving transiting graha casts on the natal grahas, the Vedic reading. Empty for Rahu and Ketu, which cast none.
|
|
22325
|
+
*/
|
|
22326
|
+
drishti: Array<string>;
|
|
21644
22327
|
}>;
|
|
21645
22328
|
};
|
|
21646
22329
|
};
|
|
@@ -21648,13 +22331,13 @@ export type PostVedicAstrologyTransitResponse = PostVedicAstrologyTransitRespons
|
|
|
21648
22331
|
export type PostVedicAstrologyTransitMonthlyData = {
|
|
21649
22332
|
body?: {
|
|
21650
22333
|
/**
|
|
21651
|
-
* Year for monthly transit analysis (1900-2100).
|
|
22334
|
+
* Year for monthly transit analysis (1900-2100). Defaults to the current year (UTC).
|
|
21652
22335
|
*/
|
|
21653
|
-
year
|
|
22336
|
+
year?: number;
|
|
21654
22337
|
/**
|
|
21655
|
-
* Month number (1-12) for transit analysis.
|
|
22338
|
+
* Month number (1-12) for transit analysis. Defaults to the current month (UTC).
|
|
21656
22339
|
*/
|
|
21657
|
-
month
|
|
22340
|
+
month?: number;
|
|
21658
22341
|
/**
|
|
21659
22342
|
* Timezone offset from UTC in hours. Output times are converted to this timezone. Defaults to 0 (UTC).
|
|
21660
22343
|
*/
|
|
@@ -21665,7 +22348,12 @@ export type PostVedicAstrologyTransitMonthlyData = {
|
|
|
21665
22348
|
coordinateSystem?: 'sidereal' | 'tropical';
|
|
21666
22349
|
};
|
|
21667
22350
|
path?: never;
|
|
21668
|
-
query?:
|
|
22351
|
+
query?: {
|
|
22352
|
+
/**
|
|
22353
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
22354
|
+
*/
|
|
22355
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
22356
|
+
};
|
|
21669
22357
|
url: '/vedic-astrology/transit/monthly';
|
|
21670
22358
|
};
|
|
21671
22359
|
export type PostVedicAstrologyTransitMonthlyErrors = {
|
|
@@ -21776,25 +22464,37 @@ export type PostVedicAstrologyTransitMonthlyResponses = {
|
|
|
21776
22464
|
*/
|
|
21777
22465
|
200: {
|
|
21778
22466
|
/**
|
|
21779
|
-
* Year of the monthly transit analysis.
|
|
22467
|
+
* Year of the monthly transit analysis. Echoes the year that was requested, or the current UTC year when it was omitted.
|
|
21780
22468
|
*/
|
|
21781
22469
|
year: number;
|
|
21782
22470
|
/**
|
|
21783
|
-
* Month of the monthly transit analysis.
|
|
22471
|
+
* Month of the monthly transit analysis. Echoes the month that was requested, or the current UTC month when it was omitted.
|
|
21784
22472
|
*/
|
|
21785
22473
|
month: number;
|
|
22474
|
+
/**
|
|
22475
|
+
* Timezone offset from UTC in hours that the event dates and times are reported in. Echoes the requested timezone.
|
|
22476
|
+
*/
|
|
22477
|
+
timezone: number;
|
|
21786
22478
|
/**
|
|
21787
22479
|
* Planetary positions at the beginning of the month (day 1, 00:00 UTC).
|
|
21788
22480
|
*/
|
|
21789
22481
|
startingPositions: Array<{
|
|
21790
22482
|
/**
|
|
21791
|
-
* Planet (graha) name. One of the 9 Navagraha used in Vedic transit (Gochar) analysis.
|
|
22483
|
+
* Planet (graha) name. One of the 9 Navagraha used in Vedic transit (Gochar) analysis. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use planetLocalized for anything a reader sees.
|
|
21792
22484
|
*/
|
|
21793
22485
|
planet: string;
|
|
21794
22486
|
/**
|
|
21795
|
-
*
|
|
22487
|
+
* Planet name in the requested language, for display. Present only when lang is set to a language other than English.
|
|
22488
|
+
*/
|
|
22489
|
+
planetLocalized?: string;
|
|
22490
|
+
/**
|
|
22491
|
+
* Zodiac sign (rashi) the planet occupies at the start of the month. Always English. Use signLocalized for anything a reader sees.
|
|
21796
22492
|
*/
|
|
21797
22493
|
sign: string;
|
|
22494
|
+
/**
|
|
22495
|
+
* Zodiac sign name in the requested language, for display. Present only when lang is set to a language other than English.
|
|
22496
|
+
*/
|
|
22497
|
+
signLocalized?: string;
|
|
21798
22498
|
/**
|
|
21799
22499
|
* Sidereal longitude at the start of the month.
|
|
21800
22500
|
*/
|
|
@@ -21805,17 +22505,29 @@ export type PostVedicAstrologyTransitMonthlyResponses = {
|
|
|
21805
22505
|
*/
|
|
21806
22506
|
transitEvents: Array<{
|
|
21807
22507
|
/**
|
|
21808
|
-
* Planet that changes sign (rashi) during this month. One of the Navagraha: Sun, Moon, Mars, Mercury, Jupiter, Venus, Saturn, Rahu, Ketu.
|
|
22508
|
+
* Planet that changes sign (rashi) during this month. One of the Navagraha: Sun, Moon, Mars, Mercury, Jupiter, Venus, Saturn, Rahu, Ketu. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use planetLocalized for anything a reader sees.
|
|
21809
22509
|
*/
|
|
21810
22510
|
planet: string;
|
|
21811
22511
|
/**
|
|
21812
|
-
*
|
|
22512
|
+
* Planet name in the requested language, for display. Present only when lang is set to a language other than English, since in English it would repeat planet exactly.
|
|
22513
|
+
*/
|
|
22514
|
+
planetLocalized?: string;
|
|
22515
|
+
/**
|
|
22516
|
+
* Zodiac sign the planet is leaving (previous rashi). Always English. Use fromSignLocalized for anything a reader sees.
|
|
21813
22517
|
*/
|
|
21814
22518
|
fromSign: string;
|
|
21815
22519
|
/**
|
|
21816
|
-
*
|
|
22520
|
+
* Name of the sign being left, in the requested language, for display. Present only when lang is set to a language other than English.
|
|
22521
|
+
*/
|
|
22522
|
+
fromSignLocalized?: string;
|
|
22523
|
+
/**
|
|
22524
|
+
* Zodiac sign the planet is entering (new rashi transit). Always English. Use toSignLocalized for anything a reader sees.
|
|
21817
22525
|
*/
|
|
21818
22526
|
toSign: string;
|
|
22527
|
+
/**
|
|
22528
|
+
* Name of the sign being entered, in the requested language, for display. Present only when lang is set to a language other than English.
|
|
22529
|
+
*/
|
|
22530
|
+
toSignLocalized?: string;
|
|
21819
22531
|
/**
|
|
21820
22532
|
* Date of the sign change (YYYY-MM-DD). Adjusted to requested timezone.
|
|
21821
22533
|
*/
|
|
@@ -22030,20 +22742,25 @@ export type PostVedicAstrologyParallelsResponse = PostVedicAstrologyParallelsRes
|
|
|
22030
22742
|
export type PostVedicAstrologyParallelsMonthlyData = {
|
|
22031
22743
|
body?: {
|
|
22032
22744
|
/**
|
|
22033
|
-
* Year for monthly parallel analysis (1900-2100).
|
|
22745
|
+
* Year for monthly parallel analysis (1900-2100). Defaults to the current year (UTC).
|
|
22034
22746
|
*/
|
|
22035
|
-
year
|
|
22747
|
+
year?: number;
|
|
22036
22748
|
/**
|
|
22037
|
-
* Month number (1-12) for parallel analysis.
|
|
22749
|
+
* Month number (1-12) for parallel analysis. Defaults to the current month (UTC).
|
|
22038
22750
|
*/
|
|
22039
|
-
month
|
|
22751
|
+
month?: number;
|
|
22040
22752
|
/**
|
|
22041
22753
|
* Timezone offset from UTC in hours. Output times are converted to this timezone. Defaults to 0 (UTC).
|
|
22042
22754
|
*/
|
|
22043
22755
|
timezone?: number | string;
|
|
22044
22756
|
};
|
|
22045
22757
|
path?: never;
|
|
22046
|
-
query?:
|
|
22758
|
+
query?: {
|
|
22759
|
+
/**
|
|
22760
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
22761
|
+
*/
|
|
22762
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
22763
|
+
};
|
|
22047
22764
|
url: '/vedic-astrology/parallels/monthly';
|
|
22048
22765
|
};
|
|
22049
22766
|
export type PostVedicAstrologyParallelsMonthlyErrors = {
|
|
@@ -22154,11 +22871,11 @@ export type PostVedicAstrologyParallelsMonthlyResponses = {
|
|
|
22154
22871
|
*/
|
|
22155
22872
|
200: {
|
|
22156
22873
|
/**
|
|
22157
|
-
* Year of the parallel analysis.
|
|
22874
|
+
* Year of the parallel analysis. Echoes the year that was requested, or the current UTC year when it was omitted.
|
|
22158
22875
|
*/
|
|
22159
22876
|
year: number;
|
|
22160
22877
|
/**
|
|
22161
|
-
* Month of the parallel analysis.
|
|
22878
|
+
* Month of the parallel analysis. Echoes the month that was requested, or the current UTC month when it was omitted.
|
|
22162
22879
|
*/
|
|
22163
22880
|
month: number;
|
|
22164
22881
|
/**
|
|
@@ -22166,13 +22883,21 @@ export type PostVedicAstrologyParallelsMonthlyResponses = {
|
|
|
22166
22883
|
*/
|
|
22167
22884
|
events: Array<{
|
|
22168
22885
|
/**
|
|
22169
|
-
* First planet in the parallel or contraparallel pair.
|
|
22886
|
+
* First planet in the parallel or contraparallel pair. Always English, whatever the lang parameter says, so it stays safe to compare against in code. Use planet1Localized for anything a reader sees.
|
|
22170
22887
|
*/
|
|
22171
22888
|
planet1: string;
|
|
22172
22889
|
/**
|
|
22173
|
-
*
|
|
22890
|
+
* First planet name in the requested language, for display. Present only when lang is set to a language other than English, since in English it would repeat planet1 exactly.
|
|
22891
|
+
*/
|
|
22892
|
+
planet1Localized?: string;
|
|
22893
|
+
/**
|
|
22894
|
+
* Second planet in the pair. Always English, whatever the lang parameter says. Use planet2Localized for anything a reader sees.
|
|
22174
22895
|
*/
|
|
22175
22896
|
planet2: string;
|
|
22897
|
+
/**
|
|
22898
|
+
* Second planet name in the requested language, for display. Present only when lang is set to a language other than English.
|
|
22899
|
+
*/
|
|
22900
|
+
planet2Localized?: string;
|
|
22176
22901
|
/**
|
|
22177
22902
|
* Parallel = same declination (acts like conjunction in strength). Contraparallel = opposite declination (acts like opposition).
|
|
22178
22903
|
*/
|
|
@@ -25529,11 +26254,11 @@ export type PostForecastSolarReturnResponses = {
|
|
|
25529
26254
|
timezone: number;
|
|
25530
26255
|
};
|
|
25531
26256
|
/**
|
|
25532
|
-
* 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.
|
|
26257
|
+
* 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.
|
|
25533
26258
|
*/
|
|
25534
26259
|
planets: Array<{
|
|
25535
26260
|
/**
|
|
25536
|
-
* 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).
|
|
26261
|
+
* 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.
|
|
25537
26262
|
*/
|
|
25538
26263
|
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
25539
26264
|
/**
|
|
@@ -25692,7 +26417,7 @@ export type PostHumanDesignBodygraphData = {
|
|
|
25692
26417
|
*/
|
|
25693
26418
|
longitude?: number;
|
|
25694
26419
|
/**
|
|
25695
|
-
* Lunar node convention
|
|
26420
|
+
* 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".
|
|
25696
26421
|
*/
|
|
25697
26422
|
nodeType?: 'mean' | 'true';
|
|
25698
26423
|
};
|
|
@@ -25813,9 +26538,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
25813
26538
|
*/
|
|
25814
26539
|
200: {
|
|
25815
26540
|
/**
|
|
25816
|
-
* Human Design energy type. One of Manifestor, Generator, Manifesting Generator, Projector, Reflector.
|
|
26541
|
+
* 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.
|
|
25817
26542
|
*/
|
|
25818
26543
|
type: string;
|
|
26544
|
+
/**
|
|
26545
|
+
* 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.
|
|
26546
|
+
*/
|
|
26547
|
+
typeLocalized?: string;
|
|
25819
26548
|
/**
|
|
25820
26549
|
* 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.
|
|
25821
26550
|
*/
|
|
@@ -25825,29 +26554,45 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
25825
26554
|
*/
|
|
25826
26555
|
aura: string;
|
|
25827
26556
|
/**
|
|
25828
|
-
* The aura strategy for engaging life correctly for this type.
|
|
26557
|
+
* The aura strategy for engaging life correctly for this type. Always English, whatever the lang parameter says. Use strategyLocalized for anything a reader sees.
|
|
25829
26558
|
*/
|
|
25830
26559
|
strategy: string;
|
|
26560
|
+
/**
|
|
26561
|
+
* 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.
|
|
26562
|
+
*/
|
|
26563
|
+
strategyLocalized?: string;
|
|
25831
26564
|
/**
|
|
25832
26565
|
* 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.
|
|
25833
26566
|
*/
|
|
25834
26567
|
strategyDescription: string;
|
|
25835
26568
|
/**
|
|
25836
|
-
* Inner authority for decision making. One of Emotional, Sacral, Splenic, Ego, Self-Projected, Mental, Lunar.
|
|
26569
|
+
* 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.
|
|
25837
26570
|
*/
|
|
25838
26571
|
authority: string;
|
|
26572
|
+
/**
|
|
26573
|
+
* 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.
|
|
26574
|
+
*/
|
|
26575
|
+
authorityLocalized?: string;
|
|
25839
26576
|
/**
|
|
25840
26577
|
* 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.
|
|
25841
26578
|
*/
|
|
25842
26579
|
authorityDescription: string;
|
|
25843
26580
|
/**
|
|
25844
|
-
* The signature feeling of living in alignment with the type.
|
|
26581
|
+
* The signature feeling of living in alignment with the type. Always English, whatever the lang parameter says. Use signatureLocalized for anything a reader sees.
|
|
25845
26582
|
*/
|
|
25846
26583
|
signature: string;
|
|
25847
26584
|
/**
|
|
25848
|
-
*
|
|
26585
|
+
* 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.
|
|
26586
|
+
*/
|
|
26587
|
+
signatureLocalized?: string;
|
|
26588
|
+
/**
|
|
26589
|
+
* 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.
|
|
25849
26590
|
*/
|
|
25850
26591
|
notSelf: string;
|
|
26592
|
+
/**
|
|
26593
|
+
* 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.
|
|
26594
|
+
*/
|
|
26595
|
+
notSelfLocalized?: string;
|
|
25851
26596
|
/**
|
|
25852
26597
|
* Profile in conscious/unconscious form from the Personality Sun line over the Design Sun line.
|
|
25853
26598
|
*/
|
|
@@ -25878,9 +26623,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
25878
26623
|
*/
|
|
25879
26624
|
profileDescription: string;
|
|
25880
26625
|
/**
|
|
25881
|
-
* Definition type from the number of connected components among defined centers. One of None, Single, Split, Triple Split, Quadruple Split.
|
|
26626
|
+
* 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.
|
|
25882
26627
|
*/
|
|
25883
26628
|
definition: string;
|
|
26629
|
+
/**
|
|
26630
|
+
* 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.
|
|
26631
|
+
*/
|
|
26632
|
+
definitionLocalized?: string;
|
|
25884
26633
|
/**
|
|
25885
26634
|
* 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.
|
|
25886
26635
|
*/
|
|
@@ -25900,9 +26649,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
25900
26649
|
*/
|
|
25901
26650
|
gates: Array<number>;
|
|
25902
26651
|
/**
|
|
25903
|
-
* Cross angle. One of Right Angle, Juxtaposition, Left Angle.
|
|
26652
|
+
* Cross angle. One of Right Angle, Juxtaposition, Left Angle. Always English, whatever the lang parameter says. Use angleLocalized for anything a reader sees.
|
|
25904
26653
|
*/
|
|
25905
26654
|
angle: string;
|
|
26655
|
+
/**
|
|
26656
|
+
* 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.
|
|
26657
|
+
*/
|
|
26658
|
+
angleLocalized?: string;
|
|
25906
26659
|
/**
|
|
25907
26660
|
* Short code for the angle. One of RAX, JXT, LAX.
|
|
25908
26661
|
*/
|
|
@@ -25925,9 +26678,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
25925
26678
|
*/
|
|
25926
26679
|
id: string;
|
|
25927
26680
|
/**
|
|
25928
|
-
* Display name of the center.
|
|
26681
|
+
* 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.
|
|
25929
26682
|
*/
|
|
25930
26683
|
name: string;
|
|
26684
|
+
/**
|
|
26685
|
+
* 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.
|
|
26686
|
+
*/
|
|
26687
|
+
nameLocalized?: string;
|
|
25931
26688
|
/**
|
|
25932
26689
|
* 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.
|
|
25933
26690
|
*/
|
|
@@ -25970,13 +26727,21 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
25970
26727
|
*/
|
|
25971
26728
|
gateB: number;
|
|
25972
26729
|
/**
|
|
25973
|
-
* Name of the defined channel.
|
|
26730
|
+
* Name of the defined channel. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
25974
26731
|
*/
|
|
25975
26732
|
name: string;
|
|
25976
26733
|
/**
|
|
25977
|
-
*
|
|
26734
|
+
* 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.
|
|
26735
|
+
*/
|
|
26736
|
+
nameLocalized?: string;
|
|
26737
|
+
/**
|
|
26738
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal. Always English, whatever the lang parameter says. Use circuitLocalized for anything a reader sees.
|
|
25978
26739
|
*/
|
|
25979
26740
|
circuit: string;
|
|
26741
|
+
/**
|
|
26742
|
+
* 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.
|
|
26743
|
+
*/
|
|
26744
|
+
circuitLocalized?: string;
|
|
25980
26745
|
/**
|
|
25981
26746
|
* The two centers this channel connects and defines.
|
|
25982
26747
|
*/
|
|
@@ -25995,9 +26760,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
25995
26760
|
*/
|
|
25996
26761
|
gates: Array<{
|
|
25997
26762
|
/**
|
|
25998
|
-
* Activating body. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto.
|
|
26763
|
+
* 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.
|
|
25999
26764
|
*/
|
|
26000
26765
|
planet: string;
|
|
26766
|
+
/**
|
|
26767
|
+
* 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.
|
|
26768
|
+
*/
|
|
26769
|
+
planetLocalized?: string;
|
|
26001
26770
|
/**
|
|
26002
26771
|
* Chart side. personality is the conscious birth-moment activation, design is the unconscious activation 88 degrees of solar arc before birth.
|
|
26003
26772
|
*/
|
|
@@ -26011,9 +26780,13 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
26011
26780
|
*/
|
|
26012
26781
|
line: number;
|
|
26013
26782
|
/**
|
|
26014
|
-
* Human Design keynote name of the gate, describing its bodygraph function.
|
|
26783
|
+
* 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.
|
|
26015
26784
|
*/
|
|
26016
26785
|
gateName: string;
|
|
26786
|
+
/**
|
|
26787
|
+
* 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.
|
|
26788
|
+
*/
|
|
26789
|
+
gateNameLocalized?: string;
|
|
26017
26790
|
/**
|
|
26018
26791
|
* 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.
|
|
26019
26792
|
*/
|
|
@@ -26070,7 +26843,7 @@ export type PostHumanDesignConnectionData = {
|
|
|
26070
26843
|
*/
|
|
26071
26844
|
longitude?: number;
|
|
26072
26845
|
/**
|
|
26073
|
-
* Lunar node convention
|
|
26846
|
+
* 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".
|
|
26074
26847
|
*/
|
|
26075
26848
|
nodeType?: 'mean' | 'true';
|
|
26076
26849
|
};
|
|
@@ -26099,7 +26872,7 @@ export type PostHumanDesignConnectionData = {
|
|
|
26099
26872
|
*/
|
|
26100
26873
|
longitude?: number;
|
|
26101
26874
|
/**
|
|
26102
|
-
* Lunar node convention
|
|
26875
|
+
* 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".
|
|
26103
26876
|
*/
|
|
26104
26877
|
nodeType?: 'mean' | 'true';
|
|
26105
26878
|
};
|
|
@@ -26237,21 +27010,33 @@ export type PostHumanDesignConnectionResponses = {
|
|
|
26237
27010
|
*/
|
|
26238
27011
|
gateB: number;
|
|
26239
27012
|
/**
|
|
26240
|
-
* Name of the channel whose connection dynamic is reported.
|
|
27013
|
+
* Name of the channel whose connection dynamic is reported. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
26241
27014
|
*/
|
|
26242
27015
|
name: string;
|
|
26243
27016
|
/**
|
|
26244
|
-
*
|
|
27017
|
+
* 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.
|
|
27018
|
+
*/
|
|
27019
|
+
nameLocalized?: string;
|
|
27020
|
+
/**
|
|
27021
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal. Always English, whatever the lang parameter says. Use circuitLocalized for anything a reader sees.
|
|
26245
27022
|
*/
|
|
26246
27023
|
circuit: string;
|
|
27024
|
+
/**
|
|
27025
|
+
* 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.
|
|
27026
|
+
*/
|
|
27027
|
+
circuitLocalized?: string;
|
|
26247
27028
|
/**
|
|
26248
27029
|
* The two centers this channel connects in the bodygraph.
|
|
26249
27030
|
*/
|
|
26250
27031
|
centers: Array<string>;
|
|
26251
27032
|
/**
|
|
26252
|
-
* 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.
|
|
27033
|
+
* 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.
|
|
26253
27034
|
*/
|
|
26254
27035
|
dynamic: string;
|
|
27036
|
+
/**
|
|
27037
|
+
* 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.
|
|
27038
|
+
*/
|
|
27039
|
+
dynamicLocalized?: string;
|
|
26255
27040
|
/**
|
|
26256
27041
|
* Which of the channel two gates person A holds, from one to both.
|
|
26257
27042
|
*/
|
|
@@ -26270,9 +27055,13 @@ export type PostHumanDesignConnectionResponses = {
|
|
|
26270
27055
|
*/
|
|
26271
27056
|
id: string;
|
|
26272
27057
|
/**
|
|
26273
|
-
* Display name of the center.
|
|
27058
|
+
* Display name of the center. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
26274
27059
|
*/
|
|
26275
27060
|
name: string;
|
|
27061
|
+
/**
|
|
27062
|
+
* 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.
|
|
27063
|
+
*/
|
|
27064
|
+
nameLocalized?: string;
|
|
26276
27065
|
/**
|
|
26277
27066
|
* 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.
|
|
26278
27067
|
*/
|
|
@@ -26283,9 +27072,13 @@ export type PostHumanDesignConnectionResponses = {
|
|
|
26283
27072
|
definedBy: Array<string>;
|
|
26284
27073
|
}>;
|
|
26285
27074
|
/**
|
|
26286
|
-
* Definition of the combined connection bodygraph from connected components among its defined centers. One of None, Single, Split, Triple Split, Quadruple Split.
|
|
27075
|
+
* 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.
|
|
26287
27076
|
*/
|
|
26288
27077
|
combinedDefinition: string;
|
|
27078
|
+
/**
|
|
27079
|
+
* 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.
|
|
27080
|
+
*/
|
|
27081
|
+
combinedDefinitionLocalized?: string;
|
|
26289
27082
|
/**
|
|
26290
27083
|
* Count of each connection dynamic across all connected channels.
|
|
26291
27084
|
*/
|
|
@@ -26337,7 +27130,7 @@ export type PostHumanDesignPentaData = {
|
|
|
26337
27130
|
*/
|
|
26338
27131
|
longitude?: number;
|
|
26339
27132
|
/**
|
|
26340
|
-
* Lunar node convention
|
|
27133
|
+
* 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".
|
|
26341
27134
|
*/
|
|
26342
27135
|
nodeType?: 'mean' | 'true';
|
|
26343
27136
|
}>;
|
|
@@ -26475,13 +27268,21 @@ export type PostHumanDesignPentaResponses = {
|
|
|
26475
27268
|
*/
|
|
26476
27269
|
gateB: number;
|
|
26477
27270
|
/**
|
|
26478
|
-
* Name of the Penta channel. One of The Alpha, Inspiration, The Prodigal, Rhythm, The Beat, Discovery.
|
|
27271
|
+
* 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.
|
|
26479
27272
|
*/
|
|
26480
27273
|
name: string;
|
|
26481
27274
|
/**
|
|
26482
|
-
*
|
|
27275
|
+
* 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.
|
|
27276
|
+
*/
|
|
27277
|
+
nameLocalized?: string;
|
|
27278
|
+
/**
|
|
27279
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal. Always English, whatever the lang parameter says. Use circuitLocalized for anything a reader sees.
|
|
26483
27280
|
*/
|
|
26484
27281
|
circuit: string;
|
|
27282
|
+
/**
|
|
27283
|
+
* 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.
|
|
27284
|
+
*/
|
|
27285
|
+
circuitLocalized?: string;
|
|
26485
27286
|
/**
|
|
26486
27287
|
* 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.
|
|
26487
27288
|
*/
|
|
@@ -26512,9 +27313,13 @@ export type PostHumanDesignPentaResponses = {
|
|
|
26512
27313
|
*/
|
|
26513
27314
|
gate: number;
|
|
26514
27315
|
/**
|
|
26515
|
-
* Human Design keynote name of the gate, describing the role it brings to the group.
|
|
27316
|
+
* 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.
|
|
26516
27317
|
*/
|
|
26517
27318
|
gateName: string;
|
|
27319
|
+
/**
|
|
27320
|
+
* 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.
|
|
27321
|
+
*/
|
|
27322
|
+
gateNameLocalized?: string;
|
|
26518
27323
|
/**
|
|
26519
27324
|
* 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.
|
|
26520
27325
|
*/
|
|
@@ -26575,7 +27380,7 @@ export type PostHumanDesignTransitData = {
|
|
|
26575
27380
|
*/
|
|
26576
27381
|
longitude?: number;
|
|
26577
27382
|
/**
|
|
26578
|
-
* Lunar node convention
|
|
27383
|
+
* 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".
|
|
26579
27384
|
*/
|
|
26580
27385
|
nodeType?: 'mean' | 'true';
|
|
26581
27386
|
};
|
|
@@ -26721,9 +27526,13 @@ export type PostHumanDesignTransitResponses = {
|
|
|
26721
27526
|
*/
|
|
26722
27527
|
activations: Array<{
|
|
26723
27528
|
/**
|
|
26724
|
-
* 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.
|
|
27529
|
+
* 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.
|
|
26725
27530
|
*/
|
|
26726
27531
|
body: string;
|
|
27532
|
+
/**
|
|
27533
|
+
* 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.
|
|
27534
|
+
*/
|
|
27535
|
+
bodyLocalized?: string;
|
|
26727
27536
|
/**
|
|
26728
27537
|
* Human Design gate number from 1 to 64 this transiting body currently sits in.
|
|
26729
27538
|
*/
|
|
@@ -26733,9 +27542,13 @@ export type PostHumanDesignTransitResponses = {
|
|
|
26733
27542
|
*/
|
|
26734
27543
|
line: number;
|
|
26735
27544
|
/**
|
|
26736
|
-
* Human Design keynote name of the gate the transiting body activates.
|
|
27545
|
+
* 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.
|
|
26737
27546
|
*/
|
|
26738
27547
|
gateName: string;
|
|
27548
|
+
/**
|
|
27549
|
+
* 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.
|
|
27550
|
+
*/
|
|
27551
|
+
gateNameLocalized?: string;
|
|
26739
27552
|
/**
|
|
26740
27553
|
* Cross-reference to the I-Ching hexagram that shares this gate number.
|
|
26741
27554
|
*/
|
|
@@ -26763,21 +27576,33 @@ export type PostHumanDesignTransitResponses = {
|
|
|
26763
27576
|
*/
|
|
26764
27577
|
gateB: number;
|
|
26765
27578
|
/**
|
|
26766
|
-
* Name of the channel the transit temporarily completes.
|
|
27579
|
+
* Name of the channel the transit temporarily completes. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
26767
27580
|
*/
|
|
26768
27581
|
name: string;
|
|
26769
27582
|
/**
|
|
26770
|
-
*
|
|
27583
|
+
* 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.
|
|
27584
|
+
*/
|
|
27585
|
+
nameLocalized?: string;
|
|
27586
|
+
/**
|
|
27587
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal. Always English, whatever the lang parameter says. Use circuitLocalized for anything a reader sees.
|
|
26771
27588
|
*/
|
|
26772
27589
|
circuit: string;
|
|
27590
|
+
/**
|
|
27591
|
+
* 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.
|
|
27592
|
+
*/
|
|
27593
|
+
circuitLocalized?: string;
|
|
26773
27594
|
/**
|
|
26774
27595
|
* The two centers this channel connects and temporarily defines.
|
|
26775
27596
|
*/
|
|
26776
27597
|
centers: Array<string>;
|
|
26777
27598
|
/**
|
|
26778
|
-
* 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.
|
|
27599
|
+
* 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.
|
|
26779
27600
|
*/
|
|
26780
27601
|
kind: string;
|
|
27602
|
+
/**
|
|
27603
|
+
* 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.
|
|
27604
|
+
*/
|
|
27605
|
+
kindLocalized?: string;
|
|
26781
27606
|
/**
|
|
26782
27607
|
* Gate or gates of this channel the natal chart already holds. Empty for an educational channel.
|
|
26783
27608
|
*/
|
|
@@ -26796,9 +27621,13 @@ export type PostHumanDesignTransitResponses = {
|
|
|
26796
27621
|
*/
|
|
26797
27622
|
id: string;
|
|
26798
27623
|
/**
|
|
26799
|
-
* Display name of the center.
|
|
27624
|
+
* Display name of the center. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
26800
27625
|
*/
|
|
26801
27626
|
name: string;
|
|
27627
|
+
/**
|
|
27628
|
+
* 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.
|
|
27629
|
+
*/
|
|
27630
|
+
nameLocalized?: string;
|
|
26802
27631
|
/**
|
|
26803
27632
|
* Always true. The center is open in the natal chart and temporarily defined by a transit-completed channel for the duration of the transit.
|
|
26804
27633
|
*/
|
|
@@ -26834,7 +27663,7 @@ export type PostHumanDesignTypeData = {
|
|
|
26834
27663
|
*/
|
|
26835
27664
|
longitude?: number;
|
|
26836
27665
|
/**
|
|
26837
|
-
* Lunar node convention
|
|
27666
|
+
* 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".
|
|
26838
27667
|
*/
|
|
26839
27668
|
nodeType?: 'mean' | 'true';
|
|
26840
27669
|
};
|
|
@@ -26955,9 +27784,13 @@ export type PostHumanDesignTypeResponses = {
|
|
|
26955
27784
|
*/
|
|
26956
27785
|
200: {
|
|
26957
27786
|
/**
|
|
26958
|
-
* Human Design energy type. One of Manifestor, Generator, Manifesting Generator, Projector, Reflector.
|
|
27787
|
+
* 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.
|
|
26959
27788
|
*/
|
|
26960
27789
|
type: string;
|
|
27790
|
+
/**
|
|
27791
|
+
* 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.
|
|
27792
|
+
*/
|
|
27793
|
+
typeLocalized?: string;
|
|
26961
27794
|
/**
|
|
26962
27795
|
* 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.
|
|
26963
27796
|
*/
|
|
@@ -26967,29 +27800,45 @@ export type PostHumanDesignTypeResponses = {
|
|
|
26967
27800
|
*/
|
|
26968
27801
|
aura: string;
|
|
26969
27802
|
/**
|
|
26970
|
-
* The aura strategy for engaging life correctly for this type.
|
|
27803
|
+
* The aura strategy for engaging life correctly for this type. Always English, whatever the lang parameter says. Use strategyLocalized for anything a reader sees.
|
|
26971
27804
|
*/
|
|
26972
27805
|
strategy: string;
|
|
27806
|
+
/**
|
|
27807
|
+
* 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.
|
|
27808
|
+
*/
|
|
27809
|
+
strategyLocalized?: string;
|
|
26973
27810
|
/**
|
|
26974
27811
|
* 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.
|
|
26975
27812
|
*/
|
|
26976
27813
|
strategyDescription: string;
|
|
26977
27814
|
/**
|
|
26978
|
-
* Inner authority for decision making. One of Emotional, Sacral, Splenic, Ego, Self-Projected, Mental, Lunar.
|
|
27815
|
+
* 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.
|
|
26979
27816
|
*/
|
|
26980
27817
|
authority: string;
|
|
27818
|
+
/**
|
|
27819
|
+
* 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.
|
|
27820
|
+
*/
|
|
27821
|
+
authorityLocalized?: string;
|
|
26981
27822
|
/**
|
|
26982
27823
|
* 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.
|
|
26983
27824
|
*/
|
|
26984
27825
|
authorityDescription: string;
|
|
26985
27826
|
/**
|
|
26986
|
-
* The signature feeling of living in alignment.
|
|
27827
|
+
* The signature feeling of living in alignment. Always English, whatever the lang parameter says. Use signatureLocalized for anything a reader sees.
|
|
26987
27828
|
*/
|
|
26988
27829
|
signature: string;
|
|
26989
27830
|
/**
|
|
26990
|
-
*
|
|
27831
|
+
* 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.
|
|
27832
|
+
*/
|
|
27833
|
+
signatureLocalized?: string;
|
|
27834
|
+
/**
|
|
27835
|
+
* The not-self theme that signals being out of alignment. Always English, whatever the lang parameter says. Use notSelfLocalized for anything a reader sees.
|
|
26991
27836
|
*/
|
|
26992
27837
|
notSelf: string;
|
|
27838
|
+
/**
|
|
27839
|
+
* 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.
|
|
27840
|
+
*/
|
|
27841
|
+
notSelfLocalized?: string;
|
|
26993
27842
|
/**
|
|
26994
27843
|
* Profile from the Personality Sun line over the Design Sun line.
|
|
26995
27844
|
*/
|
|
@@ -27020,7 +27869,7 @@ export type PostHumanDesignGatesData = {
|
|
|
27020
27869
|
*/
|
|
27021
27870
|
longitude?: number;
|
|
27022
27871
|
/**
|
|
27023
|
-
* Lunar node convention
|
|
27872
|
+
* 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".
|
|
27024
27873
|
*/
|
|
27025
27874
|
nodeType?: 'mean' | 'true';
|
|
27026
27875
|
};
|
|
@@ -27145,9 +27994,13 @@ export type PostHumanDesignGatesResponses = {
|
|
|
27145
27994
|
*/
|
|
27146
27995
|
personality: Array<{
|
|
27147
27996
|
/**
|
|
27148
|
-
* Activating body. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto.
|
|
27997
|
+
* 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.
|
|
27149
27998
|
*/
|
|
27150
27999
|
planet: string;
|
|
28000
|
+
/**
|
|
28001
|
+
* 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.
|
|
28002
|
+
*/
|
|
28003
|
+
planetLocalized?: string;
|
|
27151
28004
|
/**
|
|
27152
28005
|
* Chart side. personality is the conscious birth-moment activation, design is the unconscious activation 88 degrees of solar arc before birth.
|
|
27153
28006
|
*/
|
|
@@ -27161,9 +28014,13 @@ export type PostHumanDesignGatesResponses = {
|
|
|
27161
28014
|
*/
|
|
27162
28015
|
line: number;
|
|
27163
28016
|
/**
|
|
27164
|
-
* Human Design keynote name of the gate, describing its bodygraph function.
|
|
28017
|
+
* 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.
|
|
27165
28018
|
*/
|
|
27166
28019
|
gateName: string;
|
|
28020
|
+
/**
|
|
28021
|
+
* 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.
|
|
28022
|
+
*/
|
|
28023
|
+
gateNameLocalized?: string;
|
|
27167
28024
|
/**
|
|
27168
28025
|
* 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.
|
|
27169
28026
|
*/
|
|
@@ -27195,9 +28052,13 @@ export type PostHumanDesignGatesResponses = {
|
|
|
27195
28052
|
*/
|
|
27196
28053
|
design: Array<{
|
|
27197
28054
|
/**
|
|
27198
|
-
* Activating body. One of Sun, Earth, Moon, North Node, South Node, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto.
|
|
28055
|
+
* 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.
|
|
27199
28056
|
*/
|
|
27200
28057
|
planet: string;
|
|
28058
|
+
/**
|
|
28059
|
+
* 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.
|
|
28060
|
+
*/
|
|
28061
|
+
planetLocalized?: string;
|
|
27201
28062
|
/**
|
|
27202
28063
|
* Chart side. personality is the conscious birth-moment activation, design is the unconscious activation 88 degrees of solar arc before birth.
|
|
27203
28064
|
*/
|
|
@@ -27211,9 +28072,13 @@ export type PostHumanDesignGatesResponses = {
|
|
|
27211
28072
|
*/
|
|
27212
28073
|
line: number;
|
|
27213
28074
|
/**
|
|
27214
|
-
* Human Design keynote name of the gate, describing its bodygraph function.
|
|
28075
|
+
* 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.
|
|
27215
28076
|
*/
|
|
27216
28077
|
gateName: string;
|
|
28078
|
+
/**
|
|
28079
|
+
* 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.
|
|
28080
|
+
*/
|
|
28081
|
+
gateNameLocalized?: string;
|
|
27217
28082
|
/**
|
|
27218
28083
|
* 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.
|
|
27219
28084
|
*/
|
|
@@ -27384,17 +28249,25 @@ export type GetHumanDesignGatesByNumberResponses = {
|
|
|
27384
28249
|
*/
|
|
27385
28250
|
number: number;
|
|
27386
28251
|
/**
|
|
27387
|
-
* Human Design keynote name of the gate.
|
|
28252
|
+
* Human Design keynote name of the gate. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
27388
28253
|
*/
|
|
27389
28254
|
name: string;
|
|
28255
|
+
/**
|
|
28256
|
+
* 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.
|
|
28257
|
+
*/
|
|
28258
|
+
nameLocalized?: string;
|
|
27390
28259
|
/**
|
|
27391
28260
|
* Center the gate sits in.
|
|
27392
28261
|
*/
|
|
27393
28262
|
center: string;
|
|
27394
28263
|
/**
|
|
27395
|
-
* Display name of the center.
|
|
28264
|
+
* Display name of the center. Always English, whatever the lang parameter says. Use centerNameLocalized for anything a reader sees.
|
|
27396
28265
|
*/
|
|
27397
28266
|
centerName: string;
|
|
28267
|
+
/**
|
|
28268
|
+
* 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.
|
|
28269
|
+
*/
|
|
28270
|
+
centerNameLocalized?: string;
|
|
27398
28271
|
/**
|
|
27399
28272
|
* The I-Ching hexagram that shares this gate number.
|
|
27400
28273
|
*/
|
|
@@ -27417,9 +28290,13 @@ export type GetHumanDesignGatesByNumberResponses = {
|
|
|
27417
28290
|
*/
|
|
27418
28291
|
gate: number;
|
|
27419
28292
|
/**
|
|
27420
|
-
* Name of the shared channel.
|
|
28293
|
+
* Name of the shared channel. Always English, whatever the lang parameter says. Use channelLocalized for anything a reader sees.
|
|
27421
28294
|
*/
|
|
27422
28295
|
channel: string;
|
|
28296
|
+
/**
|
|
28297
|
+
* 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.
|
|
28298
|
+
*/
|
|
28299
|
+
channelLocalized?: string;
|
|
27423
28300
|
}>;
|
|
27424
28301
|
};
|
|
27425
28302
|
};
|
|
@@ -27447,7 +28324,7 @@ export type PostHumanDesignChannelsData = {
|
|
|
27447
28324
|
*/
|
|
27448
28325
|
longitude?: number;
|
|
27449
28326
|
/**
|
|
27450
|
-
* Lunar node convention
|
|
28327
|
+
* 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".
|
|
27451
28328
|
*/
|
|
27452
28329
|
nodeType?: 'mean' | 'true';
|
|
27453
28330
|
};
|
|
@@ -27580,13 +28457,21 @@ export type PostHumanDesignChannelsResponses = {
|
|
|
27580
28457
|
*/
|
|
27581
28458
|
gateB: number;
|
|
27582
28459
|
/**
|
|
27583
|
-
* Name of the defined channel.
|
|
28460
|
+
* Name of the defined channel. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
27584
28461
|
*/
|
|
27585
28462
|
name: string;
|
|
27586
28463
|
/**
|
|
27587
|
-
*
|
|
28464
|
+
* 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.
|
|
28465
|
+
*/
|
|
28466
|
+
nameLocalized?: string;
|
|
28467
|
+
/**
|
|
28468
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal. Always English, whatever the lang parameter says. Use circuitLocalized for anything a reader sees.
|
|
27588
28469
|
*/
|
|
27589
28470
|
circuit: string;
|
|
28471
|
+
/**
|
|
28472
|
+
* 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.
|
|
28473
|
+
*/
|
|
28474
|
+
circuitLocalized?: string;
|
|
27590
28475
|
/**
|
|
27591
28476
|
* The two centers this channel connects and defines.
|
|
27592
28477
|
*/
|
|
@@ -27634,7 +28519,7 @@ export type PostHumanDesignCentersData = {
|
|
|
27634
28519
|
*/
|
|
27635
28520
|
longitude?: number;
|
|
27636
28521
|
/**
|
|
27637
|
-
* Lunar node convention
|
|
28522
|
+
* 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".
|
|
27638
28523
|
*/
|
|
27639
28524
|
nodeType?: 'mean' | 'true';
|
|
27640
28525
|
};
|
|
@@ -27763,9 +28648,13 @@ export type PostHumanDesignCentersResponses = {
|
|
|
27763
28648
|
*/
|
|
27764
28649
|
id: string;
|
|
27765
28650
|
/**
|
|
27766
|
-
* Display name of the center.
|
|
28651
|
+
* 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.
|
|
27767
28652
|
*/
|
|
27768
28653
|
name: string;
|
|
28654
|
+
/**
|
|
28655
|
+
* 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.
|
|
28656
|
+
*/
|
|
28657
|
+
nameLocalized?: string;
|
|
27769
28658
|
/**
|
|
27770
28659
|
* 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.
|
|
27771
28660
|
*/
|
|
@@ -27930,9 +28819,13 @@ export type GetHumanDesignCentersByIdResponses = {
|
|
|
27930
28819
|
*/
|
|
27931
28820
|
id: string;
|
|
27932
28821
|
/**
|
|
27933
|
-
* Display name of the center.
|
|
28822
|
+
* Display name of the center. Always English, whatever the lang parameter says. Use nameLocalized for anything a reader sees.
|
|
27934
28823
|
*/
|
|
27935
28824
|
name: string;
|
|
28825
|
+
/**
|
|
28826
|
+
* 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.
|
|
28827
|
+
*/
|
|
28828
|
+
nameLocalized?: string;
|
|
27936
28829
|
/**
|
|
27937
28830
|
* Whether this is a motor center.
|
|
27938
28831
|
*/
|
|
@@ -27975,7 +28868,7 @@ export type PostHumanDesignProfileData = {
|
|
|
27975
28868
|
*/
|
|
27976
28869
|
longitude?: number;
|
|
27977
28870
|
/**
|
|
27978
|
-
* Lunar node convention
|
|
28871
|
+
* 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".
|
|
27979
28872
|
*/
|
|
27980
28873
|
nodeType?: 'mean' | 'true';
|
|
27981
28874
|
};
|
|
@@ -28141,7 +29034,7 @@ export type PostHumanDesignVariablesData = {
|
|
|
28141
29034
|
*/
|
|
28142
29035
|
longitude?: number;
|
|
28143
29036
|
/**
|
|
28144
|
-
* Lunar node convention
|
|
29037
|
+
* 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".
|
|
28145
29038
|
*/
|
|
28146
29039
|
nodeType?: 'mean' | 'true';
|
|
28147
29040
|
};
|
|
@@ -28270,17 +29163,29 @@ export type PostHumanDesignVariablesResponses = {
|
|
|
28270
29163
|
*/
|
|
28271
29164
|
key: string;
|
|
28272
29165
|
/**
|
|
28273
|
-
* 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.
|
|
29166
|
+
* 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.
|
|
28274
29167
|
*/
|
|
28275
29168
|
name: string;
|
|
28276
29169
|
/**
|
|
28277
|
-
*
|
|
29170
|
+
* 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.
|
|
29171
|
+
*/
|
|
29172
|
+
nameLocalized?: string;
|
|
29173
|
+
/**
|
|
29174
|
+
* 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.
|
|
28278
29175
|
*/
|
|
28279
29176
|
layer: string;
|
|
28280
29177
|
/**
|
|
28281
|
-
*
|
|
29178
|
+
* 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.
|
|
29179
|
+
*/
|
|
29180
|
+
layerLocalized?: string;
|
|
29181
|
+
/**
|
|
29182
|
+
* 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.
|
|
28282
29183
|
*/
|
|
28283
29184
|
position: string;
|
|
29185
|
+
/**
|
|
29186
|
+
* 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.
|
|
29187
|
+
*/
|
|
29188
|
+
positionLocalized?: string;
|
|
28284
29189
|
/**
|
|
28285
29190
|
* The single activation, body and chart side, that this arrow is derived from.
|
|
28286
29191
|
*/
|
|
@@ -28311,13 +29216,21 @@ export type PostHumanDesignVariablesResponses = {
|
|
|
28311
29216
|
*/
|
|
28312
29217
|
direction: string;
|
|
28313
29218
|
/**
|
|
28314
|
-
* 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.
|
|
29219
|
+
* 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.
|
|
28315
29220
|
*/
|
|
28316
29221
|
colorLabel: string;
|
|
28317
29222
|
/**
|
|
28318
|
-
*
|
|
29223
|
+
* 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.
|
|
29224
|
+
*/
|
|
29225
|
+
colorLabelLocalized?: string;
|
|
29226
|
+
/**
|
|
29227
|
+
* 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.
|
|
28319
29228
|
*/
|
|
28320
29229
|
directionLabel: string;
|
|
29230
|
+
/**
|
|
29231
|
+
* 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.
|
|
29232
|
+
*/
|
|
29233
|
+
directionLabelLocalized?: string;
|
|
28321
29234
|
/**
|
|
28322
29235
|
* What this arrow is and what it governs.
|
|
28323
29236
|
*/
|
|
@@ -28339,17 +29252,25 @@ export type PostHumanDesignVariablesResponses = {
|
|
|
28339
29252
|
*/
|
|
28340
29253
|
directionMeaning: string;
|
|
28341
29254
|
/**
|
|
28342
|
-
* Name of the Base. Informational only: the Base is finer than any civil birth time can resolve.
|
|
29255
|
+
* 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.
|
|
28343
29256
|
*/
|
|
28344
29257
|
baseName: string;
|
|
29258
|
+
/**
|
|
29259
|
+
* 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.
|
|
29260
|
+
*/
|
|
29261
|
+
baseNameLocalized?: string;
|
|
28345
29262
|
/**
|
|
28346
29263
|
* 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.
|
|
28347
29264
|
*/
|
|
28348
29265
|
cognition?: {
|
|
28349
29266
|
/**
|
|
28350
|
-
* Name of the Cognition, the strongest sense. One of six read off the Determination Tone: Smell, Taste, Outer Vision, Inner Vision, Feeling, Touch.
|
|
29267
|
+
* 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.
|
|
28351
29268
|
*/
|
|
28352
29269
|
label: string;
|
|
29270
|
+
/**
|
|
29271
|
+
* 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.
|
|
29272
|
+
*/
|
|
29273
|
+
labelLocalized?: string;
|
|
28353
29274
|
/**
|
|
28354
29275
|
* 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.
|
|
28355
29276
|
*/
|
|
@@ -40839,7 +41760,7 @@ export type GetLocationSearchData = {
|
|
|
40839
41760
|
path?: never;
|
|
40840
41761
|
query: {
|
|
40841
41762
|
/**
|
|
40842
|
-
*
|
|
41763
|
+
* 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.
|
|
40843
41764
|
*/
|
|
40844
41765
|
q: string;
|
|
40845
41766
|
/**
|
|
@@ -40957,11 +41878,11 @@ export type GetLocationSearchErrors = {
|
|
|
40957
41878
|
export type GetLocationSearchError = GetLocationSearchErrors[keyof GetLocationSearchErrors];
|
|
40958
41879
|
export type GetLocationSearchResponses = {
|
|
40959
41880
|
/**
|
|
40960
|
-
* Matching
|
|
41881
|
+
* Matching places, best match first, with coordinates, IANA timezone and UTC offset
|
|
40961
41882
|
*/
|
|
40962
41883
|
200: {
|
|
40963
41884
|
/**
|
|
40964
|
-
*
|
|
41885
|
+
* 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.
|
|
40965
41886
|
*/
|
|
40966
41887
|
total: number;
|
|
40967
41888
|
/**
|
|
@@ -40969,11 +41890,11 @@ export type GetLocationSearchResponses = {
|
|
|
40969
41890
|
*/
|
|
40970
41891
|
limit: number;
|
|
40971
41892
|
/**
|
|
40972
|
-
* Number of
|
|
41893
|
+
* Number of places skipped. Use with limit to page through results.
|
|
40973
41894
|
*/
|
|
40974
41895
|
offset: number;
|
|
40975
41896
|
/**
|
|
40976
|
-
*
|
|
41897
|
+
* 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.
|
|
40977
41898
|
*/
|
|
40978
41899
|
cities: Array<{
|
|
40979
41900
|
/**
|
|
@@ -40981,7 +41902,7 @@ export type GetLocationSearchResponses = {
|
|
|
40981
41902
|
*/
|
|
40982
41903
|
city: string;
|
|
40983
41904
|
/**
|
|
40984
|
-
* State, province, canton, or administrative region.
|
|
41905
|
+
* 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.
|
|
40985
41906
|
*/
|
|
40986
41907
|
province: string;
|
|
40987
41908
|
/**
|
|
@@ -41001,15 +41922,15 @@ export type GetLocationSearchResponses = {
|
|
|
41001
41922
|
*/
|
|
41002
41923
|
longitude: number;
|
|
41003
41924
|
/**
|
|
41004
|
-
* IANA timezone identifier following the tz database standard (e.g. Europe/Berlin, America/New_York, Asia/Tokyo).
|
|
41925
|
+
* 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.
|
|
41005
41926
|
*/
|
|
41006
41927
|
timezone: string;
|
|
41007
41928
|
/**
|
|
41008
|
-
*
|
|
41929
|
+
* 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.
|
|
41009
41930
|
*/
|
|
41010
41931
|
utcOffset: number;
|
|
41011
41932
|
/**
|
|
41012
|
-
*
|
|
41933
|
+
* 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.
|
|
41013
41934
|
*/
|
|
41014
41935
|
population: number;
|
|
41015
41936
|
}>;
|
|
@@ -41139,7 +42060,7 @@ export type GetLocationCountriesResponses = {
|
|
|
41139
42060
|
*/
|
|
41140
42061
|
200: {
|
|
41141
42062
|
/**
|
|
41142
|
-
* Total number of countries
|
|
42063
|
+
* Total number of countries with at least one place in the dataset.
|
|
41143
42064
|
*/
|
|
41144
42065
|
total: number;
|
|
41145
42066
|
/**
|
|
@@ -41167,7 +42088,7 @@ export type GetLocationCountriesResponses = {
|
|
|
41167
42088
|
*/
|
|
41168
42089
|
iso3: string;
|
|
41169
42090
|
/**
|
|
41170
|
-
* Number of searchable
|
|
42091
|
+
* 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.
|
|
41171
42092
|
*/
|
|
41172
42093
|
cityCount: number;
|
|
41173
42094
|
}>;
|
|
@@ -41302,7 +42223,7 @@ export type GetLocationCountriesByIso2Responses = {
|
|
|
41302
42223
|
*/
|
|
41303
42224
|
200: {
|
|
41304
42225
|
/**
|
|
41305
|
-
* Total number of
|
|
42226
|
+
* Total number of places available for this country across all pages.
|
|
41306
42227
|
*/
|
|
41307
42228
|
total: number;
|
|
41308
42229
|
/**
|
|
@@ -41322,7 +42243,7 @@ export type GetLocationCountriesByIso2Responses = {
|
|
|
41322
42243
|
*/
|
|
41323
42244
|
city: string;
|
|
41324
42245
|
/**
|
|
41325
|
-
* State, province, canton, or administrative region.
|
|
42246
|
+
* 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.
|
|
41326
42247
|
*/
|
|
41327
42248
|
province: string;
|
|
41328
42249
|
/**
|
|
@@ -41342,15 +42263,15 @@ export type GetLocationCountriesByIso2Responses = {
|
|
|
41342
42263
|
*/
|
|
41343
42264
|
longitude: number;
|
|
41344
42265
|
/**
|
|
41345
|
-
* IANA timezone identifier following the tz database standard (e.g. Europe/Berlin, America/New_York, Asia/Tokyo).
|
|
42266
|
+
* 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.
|
|
41346
42267
|
*/
|
|
41347
42268
|
timezone: string;
|
|
41348
42269
|
/**
|
|
41349
|
-
*
|
|
42270
|
+
* 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.
|
|
41350
42271
|
*/
|
|
41351
42272
|
utcOffset: number;
|
|
41352
42273
|
/**
|
|
41353
|
-
*
|
|
42274
|
+
* 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.
|
|
41354
42275
|
*/
|
|
41355
42276
|
population: number;
|
|
41356
42277
|
}>;
|