@roxyapi/sdk 1.2.74 → 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 +4 -4
- package/README.md +2 -2
- package/dist/factory.cjs +1 -1
- package/dist/factory.js +1 -1
- package/dist/types.gen.d.ts +12 -12
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/package.json +1 -1
- package/src/types.gen.ts +12 -12
- 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
|
|
|
@@ -63,7 +63,7 @@ Type `roxy.` to see all available namespaces. Type `roxy.{domain}.` to see every
|
|
|
63
63
|
| `roxy.languages` | List the response languages accepted by the `lang` query parameter on every i18n-aware endpoint |
|
|
64
64
|
<!-- END:DOMAINS -->
|
|
65
65
|
|
|
66
|
-
**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.
|
|
67
67
|
|
|
68
68
|
## Quality guidelines for agents
|
|
69
69
|
|
|
@@ -116,7 +116,7 @@ await roxy.numerology.calculateLifePath({ body: { year: 1990, month: 1, day: 15
|
|
|
116
116
|
|
|
117
117
|
### Multi-language via `query: { lang }`
|
|
118
118
|
|
|
119
|
-
|
|
119
|
+
Ten languages: `en`, `tr`, `de`, `es`, `fr`, `hi`, `pt`, `ru`, `zh-Hans`, `zh-Hant`. Defaults to `en`.
|
|
120
120
|
|
|
121
121
|
```typescript
|
|
122
122
|
await roxy.tarot.getDailyCard({ body: { date: '2026-04-22' }, query: { lang: 'es' } });
|
|
@@ -126,7 +126,7 @@ await roxy.numerology.calculateLifePath({
|
|
|
126
126
|
});
|
|
127
127
|
```
|
|
128
128
|
|
|
129
|
-
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()`.
|
|
130
130
|
|
|
131
131
|
### Error handling
|
|
132
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
|
|
|
@@ -443,7 +443,7 @@ const { data } = await roxy.tarot.getDailyCard({
|
|
|
443
443
|
});
|
|
444
444
|
```
|
|
445
445
|
|
|
446
|
-
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.
|
|
447
447
|
|
|
448
448
|
## Error handling
|
|
449
449
|
|
package/dist/factory.cjs
CHANGED
package/dist/factory.js
CHANGED
package/dist/types.gen.d.ts
CHANGED
|
@@ -39871,9 +39871,9 @@ export type PostMesoamericanAstrologyMayanTzolkinData = {
|
|
|
39871
39871
|
*/
|
|
39872
39872
|
date: string;
|
|
39873
39873
|
/**
|
|
39874
|
-
* Which correlation constant ties the day count to a civil date. This is the single choice that shifts every value in the response, so it is a parameter rather than a hidden default, and the resolved value comes back under conventions. "gmt-584283" is the commonly accepted constant and the default, and it is the one the major institutional converter runs on. "martinez-
|
|
39874
|
+
* Which correlation constant ties the day count to a civil date. This is the single choice that shifts every value in the response, so it is a parameter rather than a hidden default, and the resolved value comes back under conventions. "gmt-584283" is the commonly accepted constant and the default, and it is the one the major institutional converter runs on. "martinez-hernandez-584281" sits two days earlier, "astronomical-584285" two days later, and "martin-skidmore-584286" three days later, each shifting the Long Count by exactly its difference in days. Four of the eight published constants are offered: the other four sit tens of thousands of days away and are of historical interest only. The 584281 constant is the Martínez Hernández correlation, after Juan Martínez Hernández.
|
|
39875
39875
|
*/
|
|
39876
|
-
correlation?: 'gmt-584283' | 'martinez-
|
|
39876
|
+
correlation?: 'gmt-584283' | 'martinez-hernandez-584281' | 'astronomical-584285' | 'martin-skidmore-584286';
|
|
39877
39877
|
};
|
|
39878
39878
|
path?: never;
|
|
39879
39879
|
query?: {
|
|
@@ -40084,9 +40084,9 @@ export type PostMesoamericanAstrologyMayanChartData = {
|
|
|
40084
40084
|
*/
|
|
40085
40085
|
date: string;
|
|
40086
40086
|
/**
|
|
40087
|
-
* Which correlation constant ties the day count to a civil date. This is the single choice that shifts every value in the response, so it is a parameter rather than a hidden default, and the resolved value comes back under conventions. "gmt-584283" is the commonly accepted constant and the default, and it is the one the major institutional converter runs on. "martinez-
|
|
40087
|
+
* Which correlation constant ties the day count to a civil date. This is the single choice that shifts every value in the response, so it is a parameter rather than a hidden default, and the resolved value comes back under conventions. "gmt-584283" is the commonly accepted constant and the default, and it is the one the major institutional converter runs on. "martinez-hernandez-584281" sits two days earlier, "astronomical-584285" two days later, and "martin-skidmore-584286" three days later, each shifting the Long Count by exactly its difference in days. Four of the eight published constants are offered: the other four sit tens of thousands of days away and are of historical interest only. The 584281 constant is the Martínez Hernández correlation, after Juan Martínez Hernández.
|
|
40088
40088
|
*/
|
|
40089
|
-
correlation?: 'gmt-584283' | 'martinez-
|
|
40089
|
+
correlation?: 'gmt-584283' | 'martinez-hernandez-584281' | 'astronomical-584285' | 'martin-skidmore-584286';
|
|
40090
40090
|
/**
|
|
40091
40091
|
* Which Haab day is read as the start of the year when naming its Year Bearer. Only four of the twenty day signs can ever carry a year, and which four depends entirely on this choice, so the three schools never agree. "classic" reads the seating of Pop and is the default, because it is the set highland daykeepers still use; its four bearers are Ikʼ, Manikʼ, Ebʼ and Kabʼan. "campeche" reads 1 Pop and gives Akʼbʼal, Lamat, Bʼen and Etzʼnabʼ. "colonial-yucatec" reads 2 Pop and gives Kʼan, Muluk, Ix and Kawak. The three sets share no member, so a bearer alone tells you which school produced it.
|
|
40092
40092
|
*/
|
|
@@ -40455,9 +40455,9 @@ export type PostMesoamericanAstrologyMayanLongCountConvertData = {
|
|
|
40455
40455
|
*/
|
|
40456
40456
|
longCount?: string;
|
|
40457
40457
|
/**
|
|
40458
|
-
* Which correlation constant ties the day count to a civil date. This is the single choice that shifts every value in the response, so it is a parameter rather than a hidden default, and the resolved value comes back under conventions. "gmt-584283" is the commonly accepted constant and the default, and it is the one the major institutional converter runs on. "martinez-
|
|
40458
|
+
* Which correlation constant ties the day count to a civil date. This is the single choice that shifts every value in the response, so it is a parameter rather than a hidden default, and the resolved value comes back under conventions. "gmt-584283" is the commonly accepted constant and the default, and it is the one the major institutional converter runs on. "martinez-hernandez-584281" sits two days earlier, "astronomical-584285" two days later, and "martin-skidmore-584286" three days later, each shifting the Long Count by exactly its difference in days. Four of the eight published constants are offered: the other four sit tens of thousands of days away and are of historical interest only. The 584281 constant is the Martínez Hernández correlation, after Juan Martínez Hernández.
|
|
40459
40459
|
*/
|
|
40460
|
-
correlation?: 'gmt-584283' | 'martinez-
|
|
40460
|
+
correlation?: 'gmt-584283' | 'martinez-hernandez-584281' | 'astronomical-584285' | 'martin-skidmore-584286';
|
|
40461
40461
|
};
|
|
40462
40462
|
path?: never;
|
|
40463
40463
|
query?: {
|
|
@@ -40628,9 +40628,9 @@ export type GetMesoamericanAstrologyMayanDailyData = {
|
|
|
40628
40628
|
*/
|
|
40629
40629
|
date?: string;
|
|
40630
40630
|
/**
|
|
40631
|
-
* Which correlation constant ties the day count to a civil date. This is the single choice that shifts every value in the response, so it is a parameter rather than a hidden default, and the resolved value comes back under conventions. "gmt-584283" is the commonly accepted constant and the default, and it is the one the major institutional converter runs on. "martinez-
|
|
40631
|
+
* Which correlation constant ties the day count to a civil date. This is the single choice that shifts every value in the response, so it is a parameter rather than a hidden default, and the resolved value comes back under conventions. "gmt-584283" is the commonly accepted constant and the default, and it is the one the major institutional converter runs on. "martinez-hernandez-584281" sits two days earlier, "astronomical-584285" two days later, and "martin-skidmore-584286" three days later, each shifting the Long Count by exactly its difference in days. Four of the eight published constants are offered: the other four sit tens of thousands of days away and are of historical interest only. The 584281 constant is the Martínez Hernández correlation, after Juan Martínez Hernández.
|
|
40632
40632
|
*/
|
|
40633
|
-
correlation?: 'gmt-584283' | 'martinez-
|
|
40633
|
+
correlation?: 'gmt-584283' | 'martinez-hernandez-584281' | 'astronomical-584285' | 'martin-skidmore-584286';
|
|
40634
40634
|
};
|
|
40635
40635
|
url: '/mesoamerican-astrology/mayan/daily';
|
|
40636
40636
|
};
|
|
@@ -40848,9 +40848,9 @@ export type GetMesoamericanAstrologyMayanCalendarMonthlyData = {
|
|
|
40848
40848
|
*/
|
|
40849
40849
|
month?: number;
|
|
40850
40850
|
/**
|
|
40851
|
-
* Which correlation constant ties the day count to a civil date. This is the single choice that shifts every value in the response, so it is a parameter rather than a hidden default, and the resolved value comes back under conventions. "gmt-584283" is the commonly accepted constant and the default, and it is the one the major institutional converter runs on. "martinez-
|
|
40851
|
+
* Which correlation constant ties the day count to a civil date. This is the single choice that shifts every value in the response, so it is a parameter rather than a hidden default, and the resolved value comes back under conventions. "gmt-584283" is the commonly accepted constant and the default, and it is the one the major institutional converter runs on. "martinez-hernandez-584281" sits two days earlier, "astronomical-584285" two days later, and "martin-skidmore-584286" three days later, each shifting the Long Count by exactly its difference in days. Four of the eight published constants are offered: the other four sit tens of thousands of days away and are of historical interest only. The 584281 constant is the Martínez Hernández correlation, after Juan Martínez Hernández.
|
|
40852
40852
|
*/
|
|
40853
|
-
correlation?: 'gmt-584283' | 'martinez-
|
|
40853
|
+
correlation?: 'gmt-584283' | 'martinez-hernandez-584281' | 'astronomical-584285' | 'martin-skidmore-584286';
|
|
40854
40854
|
};
|
|
40855
40855
|
url: '/mesoamerican-astrology/mayan/calendar/monthly';
|
|
40856
40856
|
};
|
|
@@ -41039,9 +41039,9 @@ export type PostMesoamericanAstrologyMayanCompatibilityData = {
|
|
|
41039
41039
|
date: string;
|
|
41040
41040
|
};
|
|
41041
41041
|
/**
|
|
41042
|
-
* Which correlation constant ties the day count to a civil date. This is the single choice that shifts every value in the response, so it is a parameter rather than a hidden default, and the resolved value comes back under conventions. "gmt-584283" is the commonly accepted constant and the default, and it is the one the major institutional converter runs on. "martinez-
|
|
41042
|
+
* Which correlation constant ties the day count to a civil date. This is the single choice that shifts every value in the response, so it is a parameter rather than a hidden default, and the resolved value comes back under conventions. "gmt-584283" is the commonly accepted constant and the default, and it is the one the major institutional converter runs on. "martinez-hernandez-584281" sits two days earlier, "astronomical-584285" two days later, and "martin-skidmore-584286" three days later, each shifting the Long Count by exactly its difference in days. Four of the eight published constants are offered: the other four sit tens of thousands of days away and are of historical interest only. The 584281 constant is the Martínez Hernández correlation, after Juan Martínez Hernández.
|
|
41043
41043
|
*/
|
|
41044
|
-
correlation?: 'gmt-584283' | 'martinez-
|
|
41044
|
+
correlation?: 'gmt-584283' | 'martinez-hernandez-584281' | 'astronomical-584285' | 'martin-skidmore-584286';
|
|
41045
41045
|
/**
|
|
41046
41046
|
* Which reading of the world direction and colour to serve for a day sign. The two published assignments differ by exactly one quarter turn on all twenty signs, so neither is a rounding of the other and a silent pick would be a school choice. "madrid-codex" is the codex reading and the default; "landa" is the sixteenth century assignment recorded beside it.
|
|
41047
41047
|
*/
|