Skip to content

Commit e1a2b95

Browse files
committed
docs: demonstrate chinese astrology and feng shui
The generated domain table already listed both, because sync-docs rewrites what sits between the DOMAINS markers. Everything outside them is written by hand and had gone stale: the breadth counts, the endpoint and language figures, the per-domain coverage lines, and the most-used endpoint blocks, which stopped at the domains that existed when they were written. Every method, argument and response field added here is checked against the generated types rather than the reference doc, which is how the zodiac response turned out to nest the animal in an object and to report the year stem element beside it.
1 parent e833a34 commit e1a2b95

2 files changed

Lines changed: 59 additions & 12 deletions

File tree

AGENTS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @roxyapi/sdk - Agent Guide
22

3-
TypeScript SDK for RoxyAPI. 12+ domains (Western astrology, Vedic astrology, numerology, tarot, human design, forecast, biorhythm, I Ching, crystals, dreams, angel numbers, location) plus utility namespaces (usage, languages). One API key, fully typed, zero runtime dependencies.
3+
TypeScript SDK for RoxyAPI. 14+ domains (Western astrology, Vedic astrology, forecast, human design, Chinese astrology, feng shui, numerology, tarot, biorhythm, I Ching, crystals, dreams, angel numbers, location) plus utility namespaces (usage, languages). One API key, fully typed, zero runtime dependencies.
44

55
> Before writing any code with this SDK, read `docs/llms-full.txt` in this package for the complete method reference with examples.
66
@@ -59,7 +59,7 @@ Type `roxy.` to see all available namespaces. Type `roxy.{domain}.` to see every
5959
| `roxy.languages` | List the response languages accepted by the `lang` query parameter on every i18n-aware endpoint |
6060
<!-- END:DOMAINS -->
6161

62-
**Total:** 160+ endpoints across 12+ product domains plus usage and languages. The table above auto-syncs from `specs/openapi.json` at release time.
62+
**Total:** 209+ endpoints across 14+ product domains plus usage and languages. The table above auto-syncs from `specs/openapi.json` at release time.
6363

6464
## Quality guidelines for agents
6565

@@ -122,7 +122,7 @@ await roxy.numerology.calculateLifePath({
122122
});
123123
```
124124

125-
Supported: `astrology`, `vedicAstrology`, `numerology`, `tarot`, `biorhythm`, `iching`, `crystals`, `angelNumbers`. English-only: `dreams`, `location`, `usage`, `languages`. To list supported codes at runtime, call `roxy.languages.listLanguages()`.
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()`.
126126

127127
### Error handling
128128

@@ -153,7 +153,7 @@ console.log(data.sign, data.overview);
153153

154154
## Common tasks
155155

156-
Ordered by domain priority (Western, Vedic, Numerology, Tarot, Biorhythm, I Ching, Crystals, Dreams, Angel Numbers, Location, Usage, Languages).
156+
Ordered by domain priority (Western, Vedic, Forecast, Human Design, Chinese Astrology, Feng Shui, Numerology, Tarot, Biorhythm, I Ching, Crystals, Dreams, Angel Numbers, Location, Usage, Languages).
157157

158158
| Task | Code |
159159
|------|------|

README.md

Lines changed: 55 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ TypeScript SDK for astrology, Vedic astrology, numerology, tarot, and more.
1515

1616
One API key. Fully typed. Verified against NASA JPL Horizons.
1717

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. 12+ domains behind a single [Roxy](https://roxyapi.com) subscription, interpretations in eight languages.
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. 14+ domains behind a single [Roxy](https://roxyapi.com) subscription, interpretations in 10+ languages.
1919

2020
## Install
2121

@@ -261,7 +261,54 @@ const { data: timeline } = await roxy.forecast.generateTimeline({
261261
// timeline.events[0].date, timeline.events[0].domain, timeline.events[0].description, timeline.events[0].significance
262262
```
263263

264-
### 7. Biorhythm API (daily check-in, forecast, compatibility)
264+
### 7. Chinese astrology API (BaZi four pillars, zodiac sign)
265+
266+
BaZi (Four Pillars of Destiny), the twelve-animal zodiac, and the lunisolar calendar with its almanac. The school splits that make two calculators disagree are typed request parameters with named defaults, echoed back in a `conventions` object on every response, so a chart can be reproduced rather than guessed at. The zodiac routes answer the high-volume consumer questions; BaZi and the almanac are where an app goes deeper.
267+
268+
```typescript
269+
// BaZi Four Pillars. The anchor call: the rest of the domain reads off these four pillars.
270+
// `timezone` takes the IANA name, resolved to the DST-correct offset for the birth date.
271+
const { data: bazi } = await roxy.chineseAstrology.generateBaziChart({
272+
body: { date: '1990-07-04', time: '10:12:00', timezone: 'America/New_York' },
273+
});
274+
// bazi.pillars[n].position ('year' | 'month' | 'day' | 'hour'), .stem.element, .branch.animal
275+
// bazi.pillars[n].tenGod.name, .hiddenStems, .naYin
276+
// bazi.dayMaster.element, bazi.zodiacAnimal, bazi.fiveElements, bazi.conventions, bazi.summary
277+
278+
// Chinese zodiac sign. Defaults `yearBoundary` to 'lunar-new-year', the folk rule people mean
279+
// when they say which animal they are. Pass 'li-chun' to match the classical BaZi boundary.
280+
const { data: sign } = await roxy.chineseAstrology.calculateZodiacAnimal({
281+
body: { date: '1990-07-04' },
282+
});
283+
// sign.animal.name ('Horse'), sign.animal.element ('Fire'), sign.animal.polarity
284+
// sign.element is the YEAR STEM element ('Metal'), not the element of the animal
285+
// sign.yearPillar, sign.interpretation
286+
```
287+
288+
### 8. Feng shui API (Kua number, flying star chart)
289+
290+
Kua numbers with the full Eight Mansions map ranked best to worst, Xuan Kong flying star natal charts for any of the nine periods and 24 mountains, annual and monthly star plates, and the four annual afflictions with exact degree spans. Chinese years resolve at Li Chun, computed astronomically rather than assumed, so the annual charts change over on the real boundary.
291+
292+
```typescript
293+
// Kua number: one birth date and a gender gives the personal directions everything else reads off.
294+
const { data: kua } = await roxy.fengShui.calculateKuaNumber({
295+
body: { date: '1990-07-04', gender: 'female' },
296+
});
297+
// kua.kua (8), kua.group ('east' | 'west'), kua.trigram.english ('Mountain')
298+
// kua.sectors[n].direction, .starName, .nature ('auspicious' | 'inauspicious'), .rank, .domain
299+
300+
// Flying star natal chart. Period plus facing gives the nine palaces with base, mountain
301+
// and water stars. Send `facing` (a mountain id like 'bing' or a compass label like 'S2')
302+
// or `facingDegrees`, not neither.
303+
const { data: chart } = await roxy.fengShui.generateFlyingStarChart({
304+
body: { period: 9, facing: 'S2' },
305+
});
306+
// chart.facing.label ('S2'), chart.sitting.label, chart.structure.name ('Double Star at Sitting')
307+
// chart.palaces[n].palace, .base, .mountain, .water, .reading
308+
// chart.mountainCenterStar, chart.waterCenterStar, chart.straddling
309+
```
310+
311+
### 9. Biorhythm API (daily check-in, forecast, compatibility)
265312

266313
Zero competition domain. Steady search volume with the top Google result being a static calculator page. Pure land-grab for wellness, productivity, sports, and couples apps.
267314

@@ -277,7 +324,7 @@ const { data: forecast } = await roxy.biorhythm.getForecast({
277324
});
278325
```
279326

280-
### 8. I Ching API (daily hexagram, coin cast, 64-hexagram catalog)
327+
### 10. I Ching API (daily hexagram, coin cast, 64-hexagram catalog)
281328

282329
Meditation apps, decision-making tools, and wisdom chatbots. `i ching API` and `hexagram API` are the keywords.
283330

@@ -291,7 +338,7 @@ const { data: hexagrams } = await roxy.iching.listHexagrams({});
291338
// hexagrams.hexagrams has 64 entries
292339
```
293340

294-
### 9. Crystals API (by zodiac, by chakra, birthstone)
341+
### 11. Crystals API (by zodiac, by chakra, birthstone)
295342

296343
Crystal retail and metaphysical shops use these to build "crystals for [sign]" and "[chakra] chakra stones" pages.
297344

@@ -307,7 +354,7 @@ const { data: byChakra } = await roxy.crystals.getCrystalsByChakra({ path: { cha
307354
const { data: birthstone } = await roxy.crystals.getBirthstones({ path: { month: 4 } });
308355
```
309356

310-
### 10. Dream interpretation API (symbol dictionary, search)
357+
### 12. Dream interpretation API (symbol dictionary, search)
311358

312359
Thousands of dream symbols. `dream meaning` is among the highest-volume spiritual searches on Google. Journal apps, AI therapy chatbots, and self-discovery products are the buyers.
313360

@@ -321,7 +368,7 @@ const { data: results } = await roxy.dreams.searchDreamSymbols({ query: { q: 'fl
321368
// results.symbols is an array of matching symbols
322369
```
323370

324-
### 11. Angel Numbers API (1111, 222, 333 meanings plus universal lookup)
371+
### 13. Angel Numbers API (1111, 222, 333 meanings plus universal lookup)
325372

326373
Gen Z spiritual-tok fuel. `111 meaning`, `222 meaning`, `333 angel number` are evergreen viral queries with massive shareability.
327374

@@ -383,7 +430,7 @@ const roxy = new Roxy({ client });
383430

384431
## Multi-language responses
385432

386-
Interpretations and editorial text are available in eight languages: English (`en`), Turkish (`tr`), German (`de`), Spanish (`es`), French (`fr`), Hindi (`hi`), Portuguese (`pt`), Russian (`ru`). Pass `query: { lang }` on any supported endpoint:
433+
Interpretations and editorial text are available in 10 languages: English (`en`), Turkish (`tr`), German (`de`), Spanish (`es`), French (`fr`), Hindi (`hi`), Portuguese (`pt`), Russian (`ru`), Chinese Simplified (`zh-Hans`), Chinese Traditional (`zh-Hant`). Pass `query: { lang }` on any supported endpoint:
387434

388435
```typescript
389436
const { data } = await roxy.tarot.getDailyCard({
@@ -392,7 +439,7 @@ const { data } = await roxy.tarot.getDailyCard({
392439
});
393440
```
394441

395-
Supported: `astrology`, `vedicAstrology`, `numerology`, `tarot`, `biorhythm`, `iching`, `crystals`, `angelNumbers`. English-only: `dreams`, `location`, `usage`. Untranslated fields fall back to English.
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.
396443

397444
## Error handling
398445

0 commit comments

Comments
 (0)