@roxyapi/sdk 1.2.84 → 1.2.85
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 +5 -5
- package/README.md +5 -5
- package/dist/factory.cjs +8 -8
- package/dist/factory.js +8 -8
- package/dist/sdk.gen.d.ts +7 -7
- package/dist/types.gen.d.ts +4 -0
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/docs/llms-full.txt +5 -5
- package/package.json +1 -1
- package/src/sdk.gen.ts +7 -7
- package/src/types.gen.ts +4 -0
- package/src/version.ts +1 -1
package/AGENTS.md
CHANGED
|
@@ -42,10 +42,10 @@ Type `roxy.` to see all available namespaces. Type `roxy.{domain}.` to see every
|
|
|
42
42
|
| Namespace | What it covers |
|
|
43
43
|
|-----------|----------------|
|
|
44
44
|
| `roxy.astrology` | Western astrology API for natal birth charts, daily, weekly, monthly, and yearly horoscopes with unique content per s... |
|
|
45
|
-
| `roxy.vedicAstrology` | Vedic astrology (Jyotish) and KP API for kundli generation with 15 divisional charts (D1-D60),
|
|
46
|
-
| `roxy.forecast` |
|
|
47
|
-
| `roxy.humanDesign` |
|
|
48
|
-
| `roxy.chineseAstrology` |
|
|
45
|
+
| `roxy.vedicAstrology` | Vedic astrology (Jyotish) and KP API for kundli generation with 15 divisional charts (D1-D60), panchang with choghadi... |
|
|
46
|
+
| `roxy.forecast` | Astrology forecast API that merges upcoming transit aspects, sign ingresses, retrograde stations, new and full moons,... |
|
|
47
|
+
| `roxy.humanDesign` | Human Design API that generates the full bodygraph from a birth moment: type, strategy, inner authority, profile, def... |
|
|
48
|
+
| `roxy.chineseAstrology` | Chinese zodiac and BaZi astrology API: Four Pillars charts, Chinese zodiac signs and the Chinese lunisolar calendar f... |
|
|
49
49
|
| `roxy.fengShui` | Compute classical feng shui from one API: Xuan Kong flying star natal charts for any of the nine periods and 24 mount... |
|
|
50
50
|
| `roxy.mesoamericanAstrology` | Calculate Mayan astrology day signs, the Tzolkin sacred round, the Haab year, the full Long Count and the Aztec tonal... |
|
|
51
51
|
| `roxy.vastu` | Vastu Shastra API for directional home and plot analysis: entrance padas with the classical effect of each of the 32... |
|
|
@@ -58,7 +58,7 @@ Type `roxy.` to see all available namespaces. Type `roxy.{domain}.` to see every
|
|
|
58
58
|
| `roxy.crystals` | Crystal healing API covering the most popular and widely-searched healing crystals and gemstones, from Amethyst and R... |
|
|
59
59
|
| `roxy.dreams` | Dream interpretation API with a 2,000+ symbol dream dictionary and psychological meanings covering animals, objects,... |
|
|
60
60
|
| `roxy.angelNumbers` | Angel numbers API with meanings for 111, 222, 333, 444, 555, 666, 777, 888, 999, 1111, and 75+ sequences covering eve... |
|
|
61
|
-
| `roxy.location` |
|
|
61
|
+
| `roxy.location` | Timezone and location API with city search and geocoding across 235,000+ cities in 240+ countries, returning latitude... |
|
|
62
62
|
| `roxy.usage` | Monitor your API usage, check rate limits, and track request consumption |
|
|
63
63
|
| `roxy.languages` | List the response languages accepted by the `lang` query parameter on every i18n-aware endpoint |
|
|
64
64
|
<!-- END:DOMAINS -->
|
package/README.md
CHANGED
|
@@ -86,10 +86,10 @@ const { latitude, longitude, timezone } = data.cities[0];
|
|
|
86
86
|
| Namespace | What it covers |
|
|
87
87
|
|-----------|----------------|
|
|
88
88
|
| `roxy.astrology` | Western astrology API for natal birth charts, daily, weekly, monthly, and yearly horoscopes with unique content per s... |
|
|
89
|
-
| `roxy.vedicAstrology` | Vedic astrology (Jyotish) and KP API for kundli generation with 15 divisional charts (D1-D60),
|
|
90
|
-
| `roxy.forecast` |
|
|
91
|
-
| `roxy.humanDesign` |
|
|
92
|
-
| `roxy.chineseAstrology` |
|
|
89
|
+
| `roxy.vedicAstrology` | Vedic astrology (Jyotish) and KP API for kundli generation with 15 divisional charts (D1-D60), panchang with choghadi... |
|
|
90
|
+
| `roxy.forecast` | Astrology forecast API that merges upcoming transit aspects, sign ingresses, retrograde stations, new and full moons,... |
|
|
91
|
+
| `roxy.humanDesign` | Human Design API that generates the full bodygraph from a birth moment: type, strategy, inner authority, profile, def... |
|
|
92
|
+
| `roxy.chineseAstrology` | Chinese zodiac and BaZi astrology API: Four Pillars charts, Chinese zodiac signs and the Chinese lunisolar calendar f... |
|
|
93
93
|
| `roxy.fengShui` | Compute classical feng shui from one API: Xuan Kong flying star natal charts for any of the nine periods and 24 mount... |
|
|
94
94
|
| `roxy.mesoamericanAstrology` | Calculate Mayan astrology day signs, the Tzolkin sacred round, the Haab year, the full Long Count and the Aztec tonal... |
|
|
95
95
|
| `roxy.vastu` | Vastu Shastra API for directional home and plot analysis: entrance padas with the classical effect of each of the 32... |
|
|
@@ -102,7 +102,7 @@ const { latitude, longitude, timezone } = data.cities[0];
|
|
|
102
102
|
| `roxy.crystals` | Crystal healing API covering the most popular and widely-searched healing crystals and gemstones, from Amethyst and R... |
|
|
103
103
|
| `roxy.dreams` | Dream interpretation API with a 2,000+ symbol dream dictionary and psychological meanings covering animals, objects,... |
|
|
104
104
|
| `roxy.angelNumbers` | Angel numbers API with meanings for 111, 222, 333, 444, 555, 666, 777, 888, 999, 1111, and 75+ sequences covering eve... |
|
|
105
|
-
| `roxy.location` |
|
|
105
|
+
| `roxy.location` | Timezone and location API with city search and geocoding across 235,000+ cities in 240+ countries, returning latitude... |
|
|
106
106
|
| `roxy.usage` | Monitor your API usage, check rate limits, and track request consumption |
|
|
107
107
|
| `roxy.languages` | List the response languages accepted by the `lang` query parameter on every i18n-aware endpoint |
|
|
108
108
|
<!-- END:DOMAINS -->
|
package/dist/factory.cjs
CHANGED
|
@@ -944,7 +944,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
944
944
|
/**
|
|
945
945
|
* Get planetary positions - Ephemeris calculator for all planets
|
|
946
946
|
*
|
|
947
|
-
* Calculate accurate tropical zodiac positions for all 14 celestial bodies
|
|
947
|
+
* Calculate accurate tropical zodiac positions for all 14 celestial bodies for any date, time, and location. The bodies are the 10 classical planets Sun through Pluto, the lunar nodes, Chiron, and Black Moon Lilith. Returns longitude, latitude, zodiac sign, degree within sign, daily motion speed, and retrograde status. Perfect for transit tracking, ephemeris tables, astrology apps, and planetary position widgets. Verified against NASA JPL Horizons.
|
|
948
948
|
*/
|
|
949
949
|
getPlanetaryPositions(options) {
|
|
950
950
|
return (options?.client ?? this.client).post({
|
|
@@ -1348,7 +1348,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
1348
1348
|
/**
|
|
1349
1349
|
* Fixed stars and star conjunctions calculator - Regulus, Spica, Algol natal report
|
|
1350
1350
|
*
|
|
1351
|
-
* Calculate the tropical zodiac positions of the major named fixed stars for any birth moment
|
|
1351
|
+
* Calculate the tropical zodiac positions of the major named fixed stars for any birth moment. Covers the four Royal stars and the fifteen Behenian stars, then detects conjunctions to the natal planets, Ascendant, and Midheaven. Each star returns its precessed ecliptic longitude, zodiac sign, visual magnitude, and traditional planetary nature, with a plain language interpretation for every conjunction inside the chosen orb. A focused tool for natal reports that weigh Regulus, Spica, Aldebaran, Antares, and Algol against the chart.
|
|
1352
1352
|
*/
|
|
1353
1353
|
generateFixedStars(options) {
|
|
1354
1354
|
return (options?.client ?? this.client).post({
|
|
@@ -1364,7 +1364,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
1364
1364
|
/**
|
|
1365
1365
|
* Arabic lots calculator - seven Hermetic parts including Part of Fortune and Spirit
|
|
1366
1366
|
*
|
|
1367
|
-
* Calculate the seven Hermetic lots (Arabic parts) for any birth moment
|
|
1367
|
+
* Calculate the seven Hermetic lots (Arabic parts) for any birth moment. The lots are the Part of Fortune, Part of Spirit, Eros, Necessity, Courage, Victory, and Nemesis. Each lot is a sensitive point projected by arc from the Ascendant, with the day or night formula applied automatically from the chart sect. Returns the zodiac sign, degree, exact longitude, the arc used, and a plain language interpretation per lot, for Hellenistic and traditional astrology apps. Built on accurate tropical chart positions, no astronomy expertise needed.
|
|
1368
1368
|
*/
|
|
1369
1369
|
calculateArabicLots(options) {
|
|
1370
1370
|
return (options?.client ?? this.client).post({
|
|
@@ -1412,7 +1412,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
1412
1412
|
/**
|
|
1413
1413
|
* Secondary progressions calculator - progressed chart, progressed Sun and Moon
|
|
1414
1414
|
*
|
|
1415
|
-
* Generate the secondary progressed chart for any date using the day-for-a-year key
|
|
1415
|
+
* Generate the secondary progressed chart for any date using the day-for-a-year key. Each day of ephemeris motion after birth stands in for one year of life. Returns every progressed body with its sign, degree, whole-sign house, motion, and retrograde state, plus the progressed Ascendant and Midheaven via the Naibod arc. The progressed Sun and progressed Moon are the headline timing markers for inner growth and emotional chapters. Secondary progressions API, progressed chart calculator, progressed Sun and Moon, progressed Ascendant and Midheaven.
|
|
1416
1416
|
*/
|
|
1417
1417
|
generateProgressions(options) {
|
|
1418
1418
|
return (options?.client ?? this.client).post({
|
|
@@ -1558,7 +1558,7 @@ var VedicAstrology = class extends HeyApiClient {
|
|
|
1558
1558
|
/**
|
|
1559
1559
|
* Get current Mahadasha, Antardasha, Pratyantardasha, Sookshma, Prana - Dasha Calculator API
|
|
1560
1560
|
*
|
|
1561
|
-
* Calculate all five running Vimshottari Dasha levels
|
|
1561
|
+
* Calculate all five running Vimshottari Dasha levels with remaining time in each. The levels are Mahadasha, Antardasha, Pratyantardasha, Sookshma, and Prana. Accurate dasha calculator API for life phase prediction and planetary period analysis. Returns the dasha timeline with start/end dates for every level, ready for a current DBA readout down to hour-level timing. Pass datetime to read the five lords at any moment instead of now, which is what a reading prepared for tomorrow or a backtest over a past day needs. Set significators true to add the KP star lord, sub lord, signified houses and strength grade of each running lord, plus the houses they have in common. Essential for understanding current planetary influences, dasha transitions, and timing events in Vedic astrology. 120-year dasha system based on moon nakshatra at birth, with selectable Lahiri or KP ayanamsa.
|
|
1562
1562
|
*/
|
|
1563
1563
|
getCurrentDasha(options) {
|
|
1564
1564
|
return (options?.client ?? this.client).post({
|
|
@@ -3824,7 +3824,7 @@ var Tarot = class extends HeyApiClient {
|
|
|
3824
3824
|
/**
|
|
3825
3825
|
* List all 78 tarot cards - Tarot deck catalog API
|
|
3826
3826
|
*
|
|
3827
|
-
* Retrieve the complete Rider-Waite-Smith tarot deck of 78 cards
|
|
3827
|
+
* Retrieve the complete Rider-Waite-Smith tarot deck of 78 cards. The 22 Major Arcana (numbered 0-21) carry life lessons, spiritual themes, and karmic influences like The Fool, Death, The Tower; the 56 Minor Arcana (4 suits × 14 cards each) cover daily situations and practical matters. Filter by arcana type (major for spiritual guidance, minor for everyday concerns), suit (cups for emotions and relationships, wands for creativity and passion, swords for intellect and conflict, pentacles for material wealth and finances), or card number (Ace=1 for new beginnings, 2-10 for progression, Page=11 for messages, Knight=12 for action, Queen=13 for mastery, King=14 for authority). Returns lightweight basic card data. Use GET /cards/{id} for full upright and reversed interpretations with keywords. Perfect for building tarot reference libraries, card databases, learning applications, or browsing the complete traditional deck used by professional tarot readers worldwide.
|
|
3828
3828
|
*/
|
|
3829
3829
|
listCards(options) {
|
|
3830
3830
|
return (options?.client ?? this.client).get({
|
|
@@ -3896,7 +3896,7 @@ var Tarot = class extends HeyApiClient {
|
|
|
3896
3896
|
/**
|
|
3897
3897
|
* Three card spread, past present future - Tarot spread API
|
|
3898
3898
|
*
|
|
3899
|
-
* Perform the classic three-card tarot spread revealing Past
|
|
3899
|
+
* Perform the classic three-card tarot spread revealing Past, Present, and Future. Past is what led to this situation, Present the current energy and circumstances, and Future the likely outcome if the current path continues. The most popular beginner-friendly spread, perfect for quick insights, daily guidance, or exploring specific questions. Each position includes a drawn card with reversal state, keywords, full meaning, and position-specific interpretation. Returns a summary connecting all three cards. Ideal for tarot reading apps, decision-making tools, and personal growth platforms. Optionally provide a seed for reproducible readings.
|
|
3900
3900
|
*/
|
|
3901
3901
|
castThreeCard(options) {
|
|
3902
3902
|
return (options.client ?? this.client).post({
|
|
@@ -4711,7 +4711,7 @@ var Roxy = class _Roxy extends HeyApiClient {
|
|
|
4711
4711
|
};
|
|
4712
4712
|
|
|
4713
4713
|
// src/version.ts
|
|
4714
|
-
var VERSION = "1.2.
|
|
4714
|
+
var VERSION = "1.2.85";
|
|
4715
4715
|
|
|
4716
4716
|
// src/factory.ts
|
|
4717
4717
|
function createRoxy(auth) {
|
package/dist/factory.js
CHANGED
|
@@ -117,7 +117,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
117
117
|
/**
|
|
118
118
|
* Get planetary positions - Ephemeris calculator for all planets
|
|
119
119
|
*
|
|
120
|
-
* Calculate accurate tropical zodiac positions for all 14 celestial bodies
|
|
120
|
+
* Calculate accurate tropical zodiac positions for all 14 celestial bodies for any date, time, and location. The bodies are the 10 classical planets Sun through Pluto, the lunar nodes, Chiron, and Black Moon Lilith. Returns longitude, latitude, zodiac sign, degree within sign, daily motion speed, and retrograde status. Perfect for transit tracking, ephemeris tables, astrology apps, and planetary position widgets. Verified against NASA JPL Horizons.
|
|
121
121
|
*/
|
|
122
122
|
getPlanetaryPositions(options) {
|
|
123
123
|
return (options?.client ?? this.client).post({
|
|
@@ -521,7 +521,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
521
521
|
/**
|
|
522
522
|
* Fixed stars and star conjunctions calculator - Regulus, Spica, Algol natal report
|
|
523
523
|
*
|
|
524
|
-
* Calculate the tropical zodiac positions of the major named fixed stars for any birth moment
|
|
524
|
+
* Calculate the tropical zodiac positions of the major named fixed stars for any birth moment. Covers the four Royal stars and the fifteen Behenian stars, then detects conjunctions to the natal planets, Ascendant, and Midheaven. Each star returns its precessed ecliptic longitude, zodiac sign, visual magnitude, and traditional planetary nature, with a plain language interpretation for every conjunction inside the chosen orb. A focused tool for natal reports that weigh Regulus, Spica, Aldebaran, Antares, and Algol against the chart.
|
|
525
525
|
*/
|
|
526
526
|
generateFixedStars(options) {
|
|
527
527
|
return (options?.client ?? this.client).post({
|
|
@@ -537,7 +537,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
537
537
|
/**
|
|
538
538
|
* Arabic lots calculator - seven Hermetic parts including Part of Fortune and Spirit
|
|
539
539
|
*
|
|
540
|
-
* Calculate the seven Hermetic lots (Arabic parts) for any birth moment
|
|
540
|
+
* Calculate the seven Hermetic lots (Arabic parts) for any birth moment. The lots are the Part of Fortune, Part of Spirit, Eros, Necessity, Courage, Victory, and Nemesis. Each lot is a sensitive point projected by arc from the Ascendant, with the day or night formula applied automatically from the chart sect. Returns the zodiac sign, degree, exact longitude, the arc used, and a plain language interpretation per lot, for Hellenistic and traditional astrology apps. Built on accurate tropical chart positions, no astronomy expertise needed.
|
|
541
541
|
*/
|
|
542
542
|
calculateArabicLots(options) {
|
|
543
543
|
return (options?.client ?? this.client).post({
|
|
@@ -585,7 +585,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
585
585
|
/**
|
|
586
586
|
* Secondary progressions calculator - progressed chart, progressed Sun and Moon
|
|
587
587
|
*
|
|
588
|
-
* Generate the secondary progressed chart for any date using the day-for-a-year key
|
|
588
|
+
* Generate the secondary progressed chart for any date using the day-for-a-year key. Each day of ephemeris motion after birth stands in for one year of life. Returns every progressed body with its sign, degree, whole-sign house, motion, and retrograde state, plus the progressed Ascendant and Midheaven via the Naibod arc. The progressed Sun and progressed Moon are the headline timing markers for inner growth and emotional chapters. Secondary progressions API, progressed chart calculator, progressed Sun and Moon, progressed Ascendant and Midheaven.
|
|
589
589
|
*/
|
|
590
590
|
generateProgressions(options) {
|
|
591
591
|
return (options?.client ?? this.client).post({
|
|
@@ -731,7 +731,7 @@ var VedicAstrology = class extends HeyApiClient {
|
|
|
731
731
|
/**
|
|
732
732
|
* Get current Mahadasha, Antardasha, Pratyantardasha, Sookshma, Prana - Dasha Calculator API
|
|
733
733
|
*
|
|
734
|
-
* Calculate all five running Vimshottari Dasha levels
|
|
734
|
+
* Calculate all five running Vimshottari Dasha levels with remaining time in each. The levels are Mahadasha, Antardasha, Pratyantardasha, Sookshma, and Prana. Accurate dasha calculator API for life phase prediction and planetary period analysis. Returns the dasha timeline with start/end dates for every level, ready for a current DBA readout down to hour-level timing. Pass datetime to read the five lords at any moment instead of now, which is what a reading prepared for tomorrow or a backtest over a past day needs. Set significators true to add the KP star lord, sub lord, signified houses and strength grade of each running lord, plus the houses they have in common. Essential for understanding current planetary influences, dasha transitions, and timing events in Vedic astrology. 120-year dasha system based on moon nakshatra at birth, with selectable Lahiri or KP ayanamsa.
|
|
735
735
|
*/
|
|
736
736
|
getCurrentDasha(options) {
|
|
737
737
|
return (options?.client ?? this.client).post({
|
|
@@ -2997,7 +2997,7 @@ var Tarot = class extends HeyApiClient {
|
|
|
2997
2997
|
/**
|
|
2998
2998
|
* List all 78 tarot cards - Tarot deck catalog API
|
|
2999
2999
|
*
|
|
3000
|
-
* Retrieve the complete Rider-Waite-Smith tarot deck of 78 cards
|
|
3000
|
+
* Retrieve the complete Rider-Waite-Smith tarot deck of 78 cards. The 22 Major Arcana (numbered 0-21) carry life lessons, spiritual themes, and karmic influences like The Fool, Death, The Tower; the 56 Minor Arcana (4 suits × 14 cards each) cover daily situations and practical matters. Filter by arcana type (major for spiritual guidance, minor for everyday concerns), suit (cups for emotions and relationships, wands for creativity and passion, swords for intellect and conflict, pentacles for material wealth and finances), or card number (Ace=1 for new beginnings, 2-10 for progression, Page=11 for messages, Knight=12 for action, Queen=13 for mastery, King=14 for authority). Returns lightweight basic card data. Use GET /cards/{id} for full upright and reversed interpretations with keywords. Perfect for building tarot reference libraries, card databases, learning applications, or browsing the complete traditional deck used by professional tarot readers worldwide.
|
|
3001
3001
|
*/
|
|
3002
3002
|
listCards(options) {
|
|
3003
3003
|
return (options?.client ?? this.client).get({
|
|
@@ -3069,7 +3069,7 @@ var Tarot = class extends HeyApiClient {
|
|
|
3069
3069
|
/**
|
|
3070
3070
|
* Three card spread, past present future - Tarot spread API
|
|
3071
3071
|
*
|
|
3072
|
-
* Perform the classic three-card tarot spread revealing Past
|
|
3072
|
+
* Perform the classic three-card tarot spread revealing Past, Present, and Future. Past is what led to this situation, Present the current energy and circumstances, and Future the likely outcome if the current path continues. The most popular beginner-friendly spread, perfect for quick insights, daily guidance, or exploring specific questions. Each position includes a drawn card with reversal state, keywords, full meaning, and position-specific interpretation. Returns a summary connecting all three cards. Ideal for tarot reading apps, decision-making tools, and personal growth platforms. Optionally provide a seed for reproducible readings.
|
|
3073
3073
|
*/
|
|
3074
3074
|
castThreeCard(options) {
|
|
3075
3075
|
return (options.client ?? this.client).post({
|
|
@@ -3884,7 +3884,7 @@ var Roxy = class _Roxy extends HeyApiClient {
|
|
|
3884
3884
|
};
|
|
3885
3885
|
|
|
3886
3886
|
// src/version.ts
|
|
3887
|
-
var VERSION = "1.2.
|
|
3887
|
+
var VERSION = "1.2.85";
|
|
3888
3888
|
|
|
3889
3889
|
// src/factory.ts
|
|
3890
3890
|
function createRoxy(auth) {
|
package/dist/sdk.gen.d.ts
CHANGED
|
@@ -73,7 +73,7 @@ export declare class Astrology extends HeyApiClient {
|
|
|
73
73
|
/**
|
|
74
74
|
* Get planetary positions - Ephemeris calculator for all planets
|
|
75
75
|
*
|
|
76
|
-
* Calculate accurate tropical zodiac positions for all 14 celestial bodies
|
|
76
|
+
* Calculate accurate tropical zodiac positions for all 14 celestial bodies for any date, time, and location. The bodies are the 10 classical planets Sun through Pluto, the lunar nodes, Chiron, and Black Moon Lilith. Returns longitude, latitude, zodiac sign, degree within sign, daily motion speed, and retrograde status. Perfect for transit tracking, ephemeris tables, astrology apps, and planetary position widgets. Verified against NASA JPL Horizons.
|
|
77
77
|
*/
|
|
78
78
|
getPlanetaryPositions<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyPlanetsData, ThrowOnError>): RequestResult<PostAstrologyPlanetsResponses, PostAstrologyPlanetsErrors, ThrowOnError>;
|
|
79
79
|
/**
|
|
@@ -235,13 +235,13 @@ export declare class Astrology extends HeyApiClient {
|
|
|
235
235
|
/**
|
|
236
236
|
* Fixed stars and star conjunctions calculator - Regulus, Spica, Algol natal report
|
|
237
237
|
*
|
|
238
|
-
* Calculate the tropical zodiac positions of the major named fixed stars for any birth moment
|
|
238
|
+
* Calculate the tropical zodiac positions of the major named fixed stars for any birth moment. Covers the four Royal stars and the fifteen Behenian stars, then detects conjunctions to the natal planets, Ascendant, and Midheaven. Each star returns its precessed ecliptic longitude, zodiac sign, visual magnitude, and traditional planetary nature, with a plain language interpretation for every conjunction inside the chosen orb. A focused tool for natal reports that weigh Regulus, Spica, Aldebaran, Antares, and Algol against the chart.
|
|
239
239
|
*/
|
|
240
240
|
generateFixedStars<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyFixedStarsData, ThrowOnError>): RequestResult<PostAstrologyFixedStarsResponses, PostAstrologyFixedStarsErrors, ThrowOnError>;
|
|
241
241
|
/**
|
|
242
242
|
* Arabic lots calculator - seven Hermetic parts including Part of Fortune and Spirit
|
|
243
243
|
*
|
|
244
|
-
* Calculate the seven Hermetic lots (Arabic parts) for any birth moment
|
|
244
|
+
* Calculate the seven Hermetic lots (Arabic parts) for any birth moment. The lots are the Part of Fortune, Part of Spirit, Eros, Necessity, Courage, Victory, and Nemesis. Each lot is a sensitive point projected by arc from the Ascendant, with the day or night formula applied automatically from the chart sect. Returns the zodiac sign, degree, exact longitude, the arc used, and a plain language interpretation per lot, for Hellenistic and traditional astrology apps. Built on accurate tropical chart positions, no astronomy expertise needed.
|
|
245
245
|
*/
|
|
246
246
|
calculateArabicLots<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyArabicLotsData, ThrowOnError>): RequestResult<PostAstrologyArabicLotsResponses, PostAstrologyArabicLotsErrors, ThrowOnError>;
|
|
247
247
|
/**
|
|
@@ -259,7 +259,7 @@ export declare class Astrology extends HeyApiClient {
|
|
|
259
259
|
/**
|
|
260
260
|
* Secondary progressions calculator - progressed chart, progressed Sun and Moon
|
|
261
261
|
*
|
|
262
|
-
* Generate the secondary progressed chart for any date using the day-for-a-year key
|
|
262
|
+
* Generate the secondary progressed chart for any date using the day-for-a-year key. Each day of ephemeris motion after birth stands in for one year of life. Returns every progressed body with its sign, degree, whole-sign house, motion, and retrograde state, plus the progressed Ascendant and Midheaven via the Naibod arc. The progressed Sun and progressed Moon are the headline timing markers for inner growth and emotional chapters. Secondary progressions API, progressed chart calculator, progressed Sun and Moon, progressed Ascendant and Midheaven.
|
|
263
263
|
*/
|
|
264
264
|
generateProgressions<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyProgressionsData, ThrowOnError>): RequestResult<PostAstrologyProgressionsResponses, PostAstrologyProgressionsErrors, ThrowOnError>;
|
|
265
265
|
/**
|
|
@@ -315,7 +315,7 @@ export declare class VedicAstrology extends HeyApiClient {
|
|
|
315
315
|
/**
|
|
316
316
|
* Get current Mahadasha, Antardasha, Pratyantardasha, Sookshma, Prana - Dasha Calculator API
|
|
317
317
|
*
|
|
318
|
-
* Calculate all five running Vimshottari Dasha levels
|
|
318
|
+
* Calculate all five running Vimshottari Dasha levels with remaining time in each. The levels are Mahadasha, Antardasha, Pratyantardasha, Sookshma, and Prana. Accurate dasha calculator API for life phase prediction and planetary period analysis. Returns the dasha timeline with start/end dates for every level, ready for a current DBA readout down to hour-level timing. Pass datetime to read the five lords at any moment instead of now, which is what a reading prepared for tomorrow or a backtest over a past day needs. Set significators true to add the KP star lord, sub lord, signified houses and strength grade of each running lord, plus the houses they have in common. Essential for understanding current planetary influences, dasha transitions, and timing events in Vedic astrology. 120-year dasha system based on moon nakshatra at birth, with selectable Lahiri or KP ayanamsa.
|
|
319
319
|
*/
|
|
320
320
|
getCurrentDasha<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDashaCurrentData, ThrowOnError>): RequestResult<PostVedicAstrologyDashaCurrentResponses, PostVedicAstrologyDashaCurrentErrors, ThrowOnError>;
|
|
321
321
|
/**
|
|
@@ -1257,7 +1257,7 @@ export declare class Tarot extends HeyApiClient {
|
|
|
1257
1257
|
/**
|
|
1258
1258
|
* List all 78 tarot cards - Tarot deck catalog API
|
|
1259
1259
|
*
|
|
1260
|
-
* Retrieve the complete Rider-Waite-Smith tarot deck of 78 cards
|
|
1260
|
+
* Retrieve the complete Rider-Waite-Smith tarot deck of 78 cards. The 22 Major Arcana (numbered 0-21) carry life lessons, spiritual themes, and karmic influences like The Fool, Death, The Tower; the 56 Minor Arcana (4 suits × 14 cards each) cover daily situations and practical matters. Filter by arcana type (major for spiritual guidance, minor for everyday concerns), suit (cups for emotions and relationships, wands for creativity and passion, swords for intellect and conflict, pentacles for material wealth and finances), or card number (Ace=1 for new beginnings, 2-10 for progression, Page=11 for messages, Knight=12 for action, Queen=13 for mastery, King=14 for authority). Returns lightweight basic card data. Use GET /cards/{id} for full upright and reversed interpretations with keywords. Perfect for building tarot reference libraries, card databases, learning applications, or browsing the complete traditional deck used by professional tarot readers worldwide.
|
|
1261
1261
|
*/
|
|
1262
1262
|
listCards<ThrowOnError extends boolean = false>(options?: Options<GetTarotCardsData, ThrowOnError>): RequestResult<GetTarotCardsResponses, GetTarotCardsErrors, ThrowOnError>;
|
|
1263
1263
|
/**
|
|
@@ -1287,7 +1287,7 @@ export declare class Tarot extends HeyApiClient {
|
|
|
1287
1287
|
/**
|
|
1288
1288
|
* Three card spread, past present future - Tarot spread API
|
|
1289
1289
|
*
|
|
1290
|
-
* Perform the classic three-card tarot spread revealing Past
|
|
1290
|
+
* Perform the classic three-card tarot spread revealing Past, Present, and Future. Past is what led to this situation, Present the current energy and circumstances, and Future the likely outcome if the current path continues. The most popular beginner-friendly spread, perfect for quick insights, daily guidance, or exploring specific questions. Each position includes a drawn card with reversal state, keywords, full meaning, and position-specific interpretation. Returns a summary connecting all three cards. Ideal for tarot reading apps, decision-making tools, and personal growth platforms. Optionally provide a seed for reproducible readings.
|
|
1291
1291
|
*/
|
|
1292
1292
|
castThreeCard<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsThreeCardData, ThrowOnError>): RequestResult<PostTarotSpreadsThreeCardResponses, PostTarotSpreadsThreeCardErrors, ThrowOnError>;
|
|
1293
1293
|
/**
|
package/dist/types.gen.d.ts
CHANGED
|
@@ -29476,6 +29476,10 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
29476
29476
|
sides: {
|
|
29477
29477
|
[key: string]: string;
|
|
29478
29478
|
};
|
|
29479
|
+
/**
|
|
29480
|
+
* The Design moment as an ISO 8601 UTC instant: the exact time the Sun stood 88 degrees of solar arc before its natal longitude, and the instant every Design activation was computed at. Compare it with the Design date a reference tool prints to validate the chart on the moment itself.
|
|
29481
|
+
*/
|
|
29482
|
+
designInstantUtc: string;
|
|
29479
29483
|
/**
|
|
29480
29484
|
* The incarnation cross built from the four cardinal gates and the profile angle.
|
|
29481
29485
|
*/
|