@roxyapi/sdk 1.2.73 → 1.2.75
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 +8 -4
- package/README.md +6 -2
- package/dist/factory.cjs +750 -74
- package/dist/factory.js +746 -74
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/sdk.gen.d.ts +373 -69
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/types.gen.d.ts +15342 -2593
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/docs/llms-full.txt +438 -42
- package/package.json +1 -1
- package/src/index.ts +2 -2
- package/src/sdk.gen.ts +794 -74
- package/src/types.gen.ts +15558 -2566
- package/src/version.ts +1 -1
package/AGENTS.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @roxyapi/sdk - Agent Guide
|
|
2
2
|
|
|
3
|
-
TypeScript SDK for RoxyAPI.
|
|
3
|
+
TypeScript SDK for RoxyAPI. 18+ domains (Western astrology, Vedic astrology, forecast, human design, Chinese astrology, feng shui, Mesoamerican astrology, Vastu, numerology, Kabbalah, tarot, biorhythm, Ayurveda, I Ching, crystals, dreams, angel numbers, location) plus utility namespaces (usage, languages). One API key, fully typed, zero runtime dependencies.
|
|
4
4
|
|
|
5
5
|
> Before writing any code with this SDK, read `docs/llms-full.txt` in this package for the complete method reference with examples.
|
|
6
6
|
|
|
@@ -47,9 +47,13 @@ Type `roxy.` to see all available namespaces. Type `roxy.{domain}.` to see every
|
|
|
47
47
|
| `roxy.humanDesign` | Generate the full Human Design bodygraph from a birth moment: type, strategy, inner authority, profile, definition, i... |
|
|
48
48
|
| `roxy.chineseAstrology` | Calculate BaZi Four Pillars charts, Chinese zodiac signs, and the Chinese lunisolar calendar from any birth moment: y... |
|
|
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
|
+
| `roxy.mesoamericanAstrology` | Calculate Mayan astrology day signs, the Tzolkin sacred round, the Haab year, the full Long Count and the Aztec tonal... |
|
|
51
|
+
| `roxy.vastu` | Vastu Shastra API for directional home and plot analysis: entrance padas with the classical effect of each of the 32... |
|
|
50
52
|
| `roxy.numerology` | Numerology API to calculate life path, expression, soul urge, personality, and maturity numbers, with Pinnacle and Ch... |
|
|
53
|
+
| `roxy.kabbalah` | Kabbalah API for gematria, the 72 names, the Tree of Life and the Hebrew birthday, from one key |
|
|
51
54
|
| `roxy.tarot` | Tarot reading API with the complete 78-card Rider-Waite-Smith deck and card meanings for love, career, health, and sp... |
|
|
52
55
|
| `roxy.biorhythm` | The most complete biorhythm API: 10 cycle types across 3 primary (physical, emotional, intellectual), 4 secondary (in... |
|
|
56
|
+
| `roxy.ayurveda` | Ayurveda API for dosha profiles, the dinacharya daily routine and the ritucharya seasonal regimen, with a verse cited... |
|
|
53
57
|
| `roxy.iching` | I-Ching oracle API with all 64 hexagrams, 384 changing lines, 8 trigrams, and modern interpretations for love, career... |
|
|
54
58
|
| `roxy.crystals` | Crystal healing API covering the most popular and widely-searched healing crystals and gemstones, from Amethyst and R... |
|
|
55
59
|
| `roxy.dreams` | Dream interpretation API with a 2,000+ symbol dream dictionary and psychological meanings covering animals, objects,... |
|
|
@@ -59,7 +63,7 @@ Type `roxy.` to see all available namespaces. Type `roxy.{domain}.` to see every
|
|
|
59
63
|
| `roxy.languages` | List the response languages accepted by the `lang` query parameter on every i18n-aware endpoint |
|
|
60
64
|
<!-- END:DOMAINS -->
|
|
61
65
|
|
|
62
|
-
**Total:**
|
|
66
|
+
**Total:** 258+ endpoints across 18+ product domains plus usage and languages. The table above auto-syncs from `specs/openapi.json` at release time.
|
|
63
67
|
|
|
64
68
|
## Quality guidelines for agents
|
|
65
69
|
|
|
@@ -112,7 +116,7 @@ await roxy.numerology.calculateLifePath({ body: { year: 1990, month: 1, day: 15
|
|
|
112
116
|
|
|
113
117
|
### Multi-language via `query: { lang }`
|
|
114
118
|
|
|
115
|
-
|
|
119
|
+
Ten languages: `en`, `tr`, `de`, `es`, `fr`, `hi`, `pt`, `ru`, `zh-Hans`, `zh-Hant`. Defaults to `en`.
|
|
116
120
|
|
|
117
121
|
```typescript
|
|
118
122
|
await roxy.tarot.getDailyCard({ body: { date: '2026-04-22' }, query: { lang: 'es' } });
|
|
@@ -122,7 +126,7 @@ await roxy.numerology.calculateLifePath({
|
|
|
122
126
|
});
|
|
123
127
|
```
|
|
124
128
|
|
|
125
|
-
Supported: `astrology`, `vedicAstrology`, `forecast`, `humanDesign`, `chineseAstrology`, `fengShui`, `numerology`, `tarot`, `biorhythm`, `iching`, `crystals`, `angelNumbers`. English-only: `dreams`, `location`, `usage`, `languages`. The two Chinese scripts (`zh-Hans`, `zh-Hant`) currently ship on Chinese astrology and feng shui; every other domain answers those codes in English per field. To list supported codes at runtime, call `roxy.languages.listLanguages()`.
|
|
129
|
+
Supported: `astrology`, `vedicAstrology`, `forecast`, `humanDesign`, `chineseAstrology`, `fengShui`, `mesoamericanAstrology`, `vastu`, `numerology`, `kabbalah`, `tarot`, `biorhythm`, `ayurveda`, `iching`, `crystals`, `angelNumbers`. English-only: `dreams`, `location`, `usage`, `languages`. The two Chinese scripts (`zh-Hans`, `zh-Hant`) currently ship on Chinese astrology and feng shui; every other domain answers those codes in English per field. To list supported codes at runtime, call `roxy.languages.listLanguages()`.
|
|
126
130
|
|
|
127
131
|
### Error handling
|
|
128
132
|
|
package/README.md
CHANGED
|
@@ -15,7 +15,7 @@ TypeScript SDK for astrology, Vedic astrology, numerology, tarot, and more.
|
|
|
15
15
|
|
|
16
16
|
One API key. Fully typed. Verified against NASA JPL Horizons.
|
|
17
17
|
|
|
18
|
-
The fastest way to add natal charts, daily horoscopes, synastry, Vedic kundli, tarot spreads, numerology, human design bodygraphs, and transit forecasts to Node.js apps, backends, and AI agents.
|
|
18
|
+
The fastest way to add natal charts, daily horoscopes, synastry, Vedic kundli, tarot spreads, numerology, human design bodygraphs, and transit forecasts to Node.js apps, backends, and AI agents. 18+ domains behind a single [Roxy](https://roxyapi.com) subscription, interpretations in 10+ languages.
|
|
19
19
|
|
|
20
20
|
## Install
|
|
21
21
|
|
|
@@ -91,9 +91,13 @@ const { latitude, longitude, timezone } = data.cities[0];
|
|
|
91
91
|
| `roxy.humanDesign` | Generate the full Human Design bodygraph from a birth moment: type, strategy, inner authority, profile, definition, i... |
|
|
92
92
|
| `roxy.chineseAstrology` | Calculate BaZi Four Pillars charts, Chinese zodiac signs, and the Chinese lunisolar calendar from any birth moment: y... |
|
|
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
|
+
| `roxy.mesoamericanAstrology` | Calculate Mayan astrology day signs, the Tzolkin sacred round, the Haab year, the full Long Count and the Aztec tonal... |
|
|
95
|
+
| `roxy.vastu` | Vastu Shastra API for directional home and plot analysis: entrance padas with the classical effect of each of the 32... |
|
|
94
96
|
| `roxy.numerology` | Numerology API to calculate life path, expression, soul urge, personality, and maturity numbers, with Pinnacle and Ch... |
|
|
97
|
+
| `roxy.kabbalah` | Kabbalah API for gematria, the 72 names, the Tree of Life and the Hebrew birthday, from one key |
|
|
95
98
|
| `roxy.tarot` | Tarot reading API with the complete 78-card Rider-Waite-Smith deck and card meanings for love, career, health, and sp... |
|
|
96
99
|
| `roxy.biorhythm` | The most complete biorhythm API: 10 cycle types across 3 primary (physical, emotional, intellectual), 4 secondary (in... |
|
|
100
|
+
| `roxy.ayurveda` | Ayurveda API for dosha profiles, the dinacharya daily routine and the ritucharya seasonal regimen, with a verse cited... |
|
|
97
101
|
| `roxy.iching` | I-Ching oracle API with all 64 hexagrams, 384 changing lines, 8 trigrams, and modern interpretations for love, career... |
|
|
98
102
|
| `roxy.crystals` | Crystal healing API covering the most popular and widely-searched healing crystals and gemstones, from Amethyst and R... |
|
|
99
103
|
| `roxy.dreams` | Dream interpretation API with a 2,000+ symbol dream dictionary and psychological meanings covering animals, objects,... |
|
|
@@ -439,7 +443,7 @@ const { data } = await roxy.tarot.getDailyCard({
|
|
|
439
443
|
});
|
|
440
444
|
```
|
|
441
445
|
|
|
442
|
-
Supported: `astrology`, `vedicAstrology`, `forecast`, `humanDesign`, `chineseAstrology`, `fengShui`, `numerology`, `tarot`, `biorhythm`, `iching`, `crystals`, `angelNumbers`. English-only: `dreams`, `location`, `usage`. The two Chinese scripts (`zh-Hans`, `zh-Hant`) currently ship on Chinese astrology and feng shui; every other domain answers those codes in English per field. Untranslated fields fall back to English.
|
|
446
|
+
Supported: `astrology`, `vedicAstrology`, `forecast`, `humanDesign`, `chineseAstrology`, `fengShui`, `mesoamericanAstrology`, `vastu`, `numerology`, `kabbalah`, `tarot`, `biorhythm`, `ayurveda`, `iching`, `crystals`, `angelNumbers`. English-only: `dreams`, `location`, `usage`. The two Chinese scripts (`zh-Hans`, `zh-Hant`) currently ship on Chinese astrology and feng shui; every other domain answers those codes in English per field. Untranslated fields fall back to English.
|
|
443
447
|
|
|
444
448
|
## Error handling
|
|
445
449
|
|