Skip to content

Commit 5a21d62

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 f4c9f02 commit 5a21d62

3 files changed

Lines changed: 67 additions & 12 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RoxyApi .NET SDK - Agent Guide
22

3-
.NET 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, generated from the OpenAPI spec.
3+
.NET 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, generated from the OpenAPI spec.
44

55
> Before writing code with this SDK, read `docs/llms-full.txt` in this package for the complete method reference with one example per endpoint.
66
@@ -115,7 +115,7 @@ await roxy.Tarot.Daily.PostAsync(new() { Date = new Date(2026, 4, 22) }, c => c.
115115
await roxy.Numerology.LifePath.PostAsync(new() { Year = 1990, Month = 1, Day = 15 }, c => c.QueryParameters.Lang = "hi");
116116
```
117117

118-
Supported: astrology, vedicAstrology, numerology, tarot, biorhythm, iching, crystals, angelNumbers. English-only: dreams, location, usage, languages. Call `roxy.Languages.GetAsync()` for the live list.
118+
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 chineseAstrology and fengShui; every other domain answers those codes in English per field. Call `roxy.Languages.GetAsync()` for the live list.
119119

120120
### Error handling
121121

@@ -162,7 +162,7 @@ foreach (var p in chart!.Planets!)
162162

163163
## Common tasks
164164

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

167167
| Task | Code |
168168
|------|------|

README.md

Lines changed: 63 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The .NET SDK for astrology, Vedic astrology, numerology, tarot, and more.
1111

1212
One API key. Fully typed. Verified against NASA JPL Horizons.
1313

14-
The fastest way to add natal charts, daily horoscopes, synastry, Vedic kundli, tarot spreads, numerology, human design bodygraphs, and transit forecasts to ASP.NET Core, Blazor, MAUI, Unity, and AI agents. 12+ domains behind a single [Roxy](https://roxyapi.com) subscription, interpretations in eight languages, generated from the OpenAPI spec so new endpoints appear the day they ship.
14+
The fastest way to add natal charts, daily horoscopes, synastry, Vedic kundli, tarot spreads, numerology, human design bodygraphs, and transit forecasts to ASP.NET Core, Blazor, MAUI, Unity, and AI agents. 14+ domains behind a single [Roxy](https://roxyapi.com) subscription, interpretations in 10+ languages, generated from the OpenAPI spec so new endpoints appear the day they ship.
1515

1616
## Install
1717

@@ -270,7 +270,62 @@ var timeline = await roxy.Forecast.Timeline.PostAsync(new()
270270
// timeline.Count, timeline.Events[0].Date, timeline.Events[0].Domain, timeline.Events[0].Significance
271271
```
272272

273-
### 7. Biorhythm API (daily check-in, forecast, compatibility)
273+
### 7. Chinese astrology API (BaZi four pillars, zodiac sign)
274+
275+
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.
276+
277+
```csharp
278+
// BaZi Four Pillars. The anchor call: the rest of the domain reads off these four pillars.
279+
// Timezone takes the IANA name, resolved to the DST-correct offset for the birth date.
280+
var bazi = await roxy.ChineseAstrology.Bazi.Chart.PostAsync(new()
281+
{
282+
Date = new Date(1990, 7, 4), Time = new Time(10, 12, 0),
283+
Timezone = new() { String = "America/New_York" },
284+
});
285+
// bazi.Pillars[n].Position ("year" | "month" | "day" | "hour"), .Stem.Element, .Branch.Animal
286+
// bazi.Pillars[n].TenGod.Name, .HiddenStems, .NaYin
287+
// bazi.DayMaster.Element, bazi.ZodiacAnimal, bazi.FiveElements, bazi.Conventions, bazi.Summary
288+
289+
// Chinese zodiac sign. Defaults YearBoundary to "lunar-new-year", the folk rule people mean
290+
// when they say which animal they are. Pass "li-chun" to match the classical BaZi boundary.
291+
var sign = await roxy.ChineseAstrology.Zodiac.Sign.PostAsync(new()
292+
{
293+
Date = new Date(1990, 7, 4),
294+
});
295+
// sign.Animal.Name ("Horse"), sign.Animal.Element ("Fire"), sign.Animal.Polarity
296+
// sign.Element is the YEAR STEM element ("Metal"), not the element of the animal
297+
// sign.YearPillar, sign.Interpretation
298+
```
299+
300+
### 8. Feng shui API (Kua number, flying star chart)
301+
302+
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.
303+
304+
```csharp
305+
// Kua number: one birth date and a gender gives the personal directions everything else reads off.
306+
// Gender is required. The enums live with their request bodies:
307+
// using RoxyApi.FengShui.Kua; and using RoxyApi.FengShui.FlyingStars.Natal;
308+
var kua = await roxy.FengShui.Kua.PostAsync(new()
309+
{
310+
Date = new Date(1990, 7, 4),
311+
Gender = KuaPostRequestBody_gender.Female,
312+
});
313+
// kua.Kua (8), kua.Group ("east" | "west"), kua.Trigram.English ("Mountain")
314+
// kua.Sectors[n].Direction, .StarName, .Nature ("auspicious" | "inauspicious"), .Rank, .Domain
315+
316+
// Flying star natal chart. Period plus facing gives the nine palaces with base, mountain
317+
// and water stars. Send Facing (a mountain id like "bing" or a compass label like "S2")
318+
// or FacingDegrees, not neither.
319+
var chart = await roxy.FengShui.FlyingStars.Natal.PostAsync(new()
320+
{
321+
Period = 9, Facing = NatalPostRequestBody_facing.S2,
322+
});
323+
// chart.Facing.Label ("S2"), chart.Sitting.Label, chart.Structure.Name
324+
// chart.Palaces[n].Palace, .Base, .Mountain, .Water, .Reading
325+
// chart.MountainCenterStar, chart.WaterCenterStar, chart.Straddling
326+
```
327+
328+
### 9. Biorhythm API (daily check-in, forecast, compatibility)
274329

275330
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.
276331

@@ -285,7 +340,7 @@ var forecast = await roxy.Biorhythm.Forecast.PostAsync(new()
285340
});
286341
```
287342

288-
### 8. I Ching API (cast a reading, 64-hexagram catalog)
343+
### 10. I Ching API (cast a reading, 64-hexagram catalog)
289344

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

@@ -298,7 +353,7 @@ var reading = await roxy.Iching.Cast.GetAsync(c => c.QueryParameters.Seed = "use
298353
var hexagrams = await roxy.Iching.Hexagrams.GetAsync();
299354
```
300355

301-
### 9. Crystals API (by zodiac, by chakra, birthstone)
356+
### 11. Crystals API (by zodiac, by chakra, birthstone)
302357

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

@@ -313,7 +368,7 @@ var byChakra = await roxy.Crystals.Chakra["Heart"].GetAsync();
313368
var birthstone = await roxy.Crystals.Birthstone[4].GetAsync();
314369
```
315370

316-
### 10. Dream interpretation API (symbol dictionary, search)
371+
### 12. Dream interpretation API (symbol dictionary, search)
317372

318373
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.
319374

@@ -326,7 +381,7 @@ var symbol = await roxy.Dreams.Symbols["snake"].GetAsync();
326381
var results = await roxy.Dreams.Symbols.GetAsync(c => c.QueryParameters.Q = "water");
327382
```
328383

329-
### 11. Angel Numbers API (111, 222, 333 meanings plus universal lookup)
384+
### 13. Angel Numbers API (111, 222, 333 meanings plus universal lookup)
330385

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

@@ -378,15 +433,15 @@ var roxy = new RoxyClient(adapter);
378433

379434
## Multi-language responses
380435

381-
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 `Lang` on any supported endpoint through the query configuration:
436+
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 `Lang` on any supported endpoint through the query configuration:
382437

383438
```csharp
384439
var card = await roxy.Tarot.Daily.PostAsync(
385440
new() { Date = new Date(2026, 4, 22) },
386441
c => c.QueryParameters.Lang = "es");
387442
```
388443

389-
Supported: astrology, Vedic astrology, numerology, tarot, biorhythm, I Ching, crystals, angel numbers. English-only: dreams, location. Untranslated fields fall back to English. Call `roxy.Languages.GetAsync()` for the live list.
444+
Supported: astrology, Vedic astrology, forecast, human design, Chinese astrology, feng shui, numerology, tarot, biorhythm, I Ching, crystals, angel numbers. English-only: dreams, location. 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. Call `roxy.Languages.GetAsync()` for the live list.
390445

391446
## Error handling
392447

docs/llms-full.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ How the calls below map to the API:
1919
- **`Timezone` is a union:** `new() { Double = -5 }` (decimal offset) or `new() { String = "America/New_York" }` (IANA name, resolved to the DST-correct offset).
2020
- **Every call is async and throws `RoxyError` on a 4xx or 5xx.** Capture the result directly: `var chart = await roxy.Astrology.NatalChart.PostAsync(new() { ... });`
2121

22-
**Multi-language responses.** Interpretations are available in eight languages: en, tr, de, es, fr, hi, pt, ru. Add `c => c.QueryParameters.Lang = "es"` to any supported endpoint. Supported: astrology, vedicAstrology, numerology, tarot, biorhythm, iching, crystals, angelNumbers. English-only: dreams, location, usage, languages. Untranslated fields fall back to English.
22+
**Multi-language responses.** Interpretations are available in 10 languages: en, tr, de, es, fr, hi, pt, ru, zh-Hans, zh-Hant. Add `c => c.QueryParameters.Lang = "es"` to any supported endpoint. Supported: astrology, vedicAstrology, forecast, humanDesign, chineseAstrology, fengShui, numerology, tarot, biorhythm, iching, crystals, angelNumbers. English-only: dreams, location, usage, languages. The two Chinese scripts currently ship on chineseAstrology and fengShui. Untranslated fields fall back to English.
2323

2424
---
2525

0 commit comments

Comments
 (0)