Skip to content

Commit 85d18f8

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 9a4c7c4 commit 85d18f8

3 files changed

Lines changed: 48 additions & 10 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RoxyAPI Go SDK - Agent Guide
22

3-
Go 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+
Go 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
> `docs/llms-full.txt` in this module is the method index (operation id, HTTP method, path, summary for every endpoint). Response and request field names come from the typed Go structs: use editor autocomplete, https://pkg.go.dev/github.com/RoxyAPI/sdk-go, or the JSON shapes at https://roxyapi.com/api-reference.
66
@@ -130,7 +130,7 @@ Western charts require `Timezone`; Vedic charts make it an optional pointer (`Ti
130130

131131
### Multi-language via the params pointer
132132

133-
Eight languages: `en`, `tr`, `de`, `es`, `fr`, `hi`, `pt`, `ru`. Defaults to `en`. Each endpoint has its own `Lang` type; set it with `roxyapi.Ptr(...)`. Call `roxy.Languages.ListLanguages(ctx)` for the live list. Supported domains: astrology, vedicAstrology, numerology, tarot, biorhythm, iching, crystals, angelNumbers. English only: dreams, location, usage, languages.
133+
Ten languages: `en`, `tr`, `de`, `es`, `fr`, `hi`, `pt`, `ru`, `zh-Hans`, `zh-Hant`. The two Chinese scripts currently ship on Chinese astrology and feng shui; every other domain answers those codes in English per field. Defaults to `en`. Each endpoint has its own `Lang` type; set it with `roxyapi.Ptr(...)`. Call `roxy.Languages.ListLanguages(ctx)` for the live list. Supported domains: astrology, vedicAstrology, numerology, tarot, biorhythm, iching, crystals, angelNumbers. English only: dreams, location, usage, languages.
134134

135135
### Error handling
136136

README.md

Lines changed: 45 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![CI](https://github.com/RoxyAPI/sdk-go/actions/workflows/ci.yml/badge.svg)](https://github.com/RoxyAPI/sdk-go/actions/workflows/ci.yml)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
77

8-
The official **Go SDK for [RoxyAPI](https://roxyapi.com)**, the typed astrology API for Go: 12+ insight domains and 160+ endpoints behind one API key, with ephemeris output [verified against NASA JPL Horizons](https://roxyapi.com/methodology) across 210 reference points. Western and Vedic astrology, numerology, tarot, human design, biorhythm, I Ching, crystals, dreams, and angel numbers, all from one `go get`. **Build anything, fast.**
8+
The official **Go SDK for [RoxyAPI](https://roxyapi.com)**, the typed astrology API for Go: 14+ insight domains and 209+ endpoints behind one API key, with ephemeris output [verified against NASA JPL Horizons](https://roxyapi.com/methodology) across 210 reference points. Western and Vedic astrology, forecast, human design, Chinese astrology, feng shui, numerology, tarot, biorhythm, I Ching, crystals, dreams, and angel numbers, all from one `go get`. **Build anything, fast.**
99

1010
A fully typed, idiomatic golang client generated from the live OpenAPI spec: one direct runtime dependency, the standard library `net/http` underneath, autocomplete on every endpoint and field, and bundled docs for AI coding agents.
1111

@@ -197,15 +197,53 @@ hd, err := roxy.HumanDesign.GenerateBodygraph(ctx, nil, roxyapi.GenerateBodygrap
197197
})
198198
```
199199

200-
### 6. Biorhythm (daily check-in)
200+
### 6. Chinese astrology (BaZi four pillars, zodiac sign)
201+
202+
The school splits that make two calculators disagree are typed parameters with named defaults, echoed back in `conventions` on every response.
203+
204+
```go
205+
// BaZi Four Pillars: the anchor call, the rest of the domain reads off these four pillars.
206+
// Timezone union: inline-body endpoints name the type JSONBody, not JSONRequestBody (see Gotchas).
207+
var btz roxyapi.GenerateBaziChartJSONBody_Timezone
208+
_ = btz.FromGenerateBaziChartJSONBodyTimezone1("America/New_York")
209+
bazi, err := roxy.ChineseAstrology.GenerateBaziChart(ctx, nil, roxyapi.GenerateBaziChartJSONRequestBody{
210+
Date: roxyapi.Date(1990, time.July, 4), Time: "10:12:00", Timezone: btz,
211+
})
212+
213+
// Chinese zodiac sign. Defaults yearBoundary to "lunar-new-year", the folk rule people mean
214+
// when they say which animal they are. Pass "li-chun" for the classical BaZi boundary.
215+
sign, err := roxy.ChineseAstrology.CalculateZodiacAnimal(ctx, nil, roxyapi.CalculateZodiacAnimalJSONRequestBody{
216+
Date: roxyapi.Date(1990, time.July, 4),
217+
})
218+
```
219+
220+
### 7. Feng shui (Kua number, flying star chart)
221+
222+
Chinese years resolve at Li Chun, computed astronomically, so the annual charts change over on the real boundary.
223+
224+
```go
225+
// Kua number: one birth date and a gender gives the personal directions everything else reads off.
226+
kua, err := roxy.FengShui.CalculateKuaNumber(ctx, nil, roxyapi.CalculateKuaNumberJSONRequestBody{
227+
Date: roxyapi.Date(1990, time.July, 4), Gender: roxyapi.CalculateKuaNumberJSONBodyGenderFemale,
228+
})
229+
230+
// Flying star natal chart: period plus facing gives the nine palaces with base, mountain
231+
// and water stars. Send Facing (mountain id like roxyapi.Bing, or compass label roxyapi.S2)
232+
// or FacingDegrees, not neither.
233+
chart, err := roxy.FengShui.GenerateFlyingStarChart(ctx, nil, roxyapi.GenerateFlyingStarChartJSONRequestBody{
234+
Period: roxyapi.Ptr(9), Facing: roxyapi.Ptr(roxyapi.S2),
235+
})
236+
```
237+
238+
### 8. Biorhythm (daily check-in)
201239

202240
```go
203241
// Physical, emotional, intellectual, intuitive, plus extended cycles.
204242
bio, err := roxy.Biorhythm.GetDailyBiorhythm(ctx, nil,
205243
roxyapi.GetDailyBiorhythmJSONRequestBody{Seed: roxyapi.Ptr("user-1"), Date: roxyapi.Ptr(roxyapi.Date(2026, time.April, 23))})
206244
```
207245

208-
### 7. I Ching (cast a reading, hexagram catalog)
246+
### 9. I Ching (cast a reading, hexagram catalog)
209247

210248
```go
211249
// Cast a reading: primary hexagram, changing lines, transformed hexagram.
@@ -215,21 +253,21 @@ reading, err := roxy.Iching.CastReading(ctx, nil)
215253
hexes, err := roxy.Iching.ListHexagrams(ctx, nil)
216254
```
217255

218-
### 8. Crystals (by zodiac, birthstone)
256+
### 10. Crystals (by zodiac, birthstone)
219257

220258
```go
221259
byZodiac, err := roxy.Crystals.GetCrystalsByZodiac(ctx, "scorpio", nil)
222260
birthstone, err := roxy.Crystals.GetBirthstones(ctx, 4, nil) // month number
223261
```
224262

225-
### 9. Dreams (symbol lookup, search)
263+
### 11. Dreams (symbol lookup, search)
226264

227265
```go
228266
symbol, err := roxy.Dreams.GetDreamSymbol(ctx, "flying") // no params argument
229267
results, err := roxy.Dreams.SearchDreamSymbols(ctx, &roxyapi.SearchDreamSymbolsParams{Q: roxyapi.Ptr("water")})
230268
```
231269

232-
### 10. Angel numbers (meaning, universal lookup)
270+
### 12. Angel numbers (meaning, universal lookup)
233271

234272
```go
235273
angel, err := roxy.AngelNumbers.GetAngelNumber(ctx, "1111", nil)
@@ -302,7 +340,7 @@ roxy, err := roxyapi.NewRoxy(key, roxyapi.WithHTTPClient(&http.Client{Timeout: 1
302340

303341
## Keywords
304342

305-
go sdk, golang api client, astrology api, vedic astrology api, kundli api, horoscope api, numerology api, tarot api, human design api, biorhythm api, i ching api, dream interpretation api, angel numbers api, geocoding api, rest api client, ai agent sdk, mcp server.
343+
go sdk, golang api client, astrology api, vedic astrology api, kundli api, horoscope api, numerology api, tarot api, human design api, chinese astrology api, bazi api, feng shui api, biorhythm api, i ching api, dream interpretation api, angel numbers api, geocoding api, rest api client, ai agent sdk, mcp server.
306344

307345
## License
308346

docs/llms-full.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RoxyAPI Go SDK - Full Method Reference
22

3-
The official Go SDK for RoxyAPI. Astrology, Vedic astrology, numerology, tarot, human design, forecasting and more, one API key, fully typed, generated from the OpenAPI spec.
3+
The official Go SDK for RoxyAPI. Astrology, Vedic astrology, forecast, human design, Chinese astrology, feng shui, numerology, tarot and more, one API key, fully typed, generated from the OpenAPI spec.
44

55
## How to call
66

0 commit comments

Comments
 (0)