Skip to content

Commit 19d1ec9

Browse files
committed
docs: add human design and forecast examples, sync domain table and counts
1 parent 91ed99e commit 19d1ec9

2 files changed

Lines changed: 48 additions & 8 deletions

File tree

AGENTS.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# roxy-sdk (Python) - Agent Guide
22

3-
Python SDK for RoxyAPI. Twelve domains (Western astrology, Vedic astrology, numerology, tarot, biorhythm, I Ching, crystals, dreams, angel numbers, location, usage, languages). One API key, sync and async.
3+
Python SDK for RoxyAPI. Spiritual domains (Western astrology, Vedic astrology, numerology, tarot, Human Design, forecast, biorhythm, I Ching, crystals, dreams, angel numbers) plus utility namespaces (location, usage, languages). One API key, sync and async.
44

55
## Install and initialize
66

@@ -52,6 +52,8 @@ Type `roxy.` to see all available namespaces. Type `roxy.{domain}.` in an IDE wi
5252
| `roxy.vedic_astrology` | Vedic / Jyotish: kundli, panchang, Vimshottari dasha, nakshatras, Mangal / Kaal Sarp / Sade Sati doshas, Guna Milan, navamsa, KP chart and ruling planets |
5353
| `roxy.numerology` | Life path, expression, soul urge, personal year, full chart, compatibility, karmic lessons |
5454
| `roxy.tarot` | Daily card, custom draws, three-card, Celtic Cross, yes / no, love spread, 78-card catalog |
55+
| `roxy.human_design` | Full bodygraph: type, strategy, authority, profile, definition, centers, channels, gates. No coordinates needed |
56+
| `roxy.forecast` | Cross-domain timeline: transits, ingresses, retrograde stations, dasha changes, biorhythm critical days |
5557
| `roxy.biorhythm` | Daily check-in, multi-day forecast, critical days, couples compatibility, phases |
5658
| `roxy.iching` | Daily hexagram, three-coin cast, 64 hexagrams, trigrams |
5759
| `roxy.crystals` | By zodiac, by chakra, birthstone, search, daily, pairings |
@@ -154,7 +156,7 @@ except RoxyAPIError as e:
154156

155157
## Common tasks
156158

157-
Ordered by domain priority (Western, Vedic, Numerology, Tarot, Biorhythm, I Ching, Crystals, Dreams, Angel Numbers, Location, Usage, Languages).
159+
Ordered by domain priority (Western, Vedic, Numerology, Tarot, Human Design, Forecast, Biorhythm, I Ching, Crystals, Dreams, Angel Numbers, Location, Usage, Languages).
158160

159161
| Task | Code |
160162
|------|------|
@@ -180,6 +182,8 @@ Ordered by domain priority (Western, Vedic, Numerology, Tarot, Biorhythm, I Chin
180182
| Three-card spread | `roxy.tarot.cast_three_card(question="...")` |
181183
| Celtic Cross | `roxy.tarot.cast_celtic_cross(question="...")` |
182184
| Yes / no tarot | `roxy.tarot.cast_yes_no(question="...")` |
185+
| Human Design bodygraph | `roxy.human_design.generate_bodygraph(date, time, timezone)` |
186+
| Forecast timeline | `roxy.forecast.generate_timeline(birth_data=...)` |
183187
| Daily biorhythm | `roxy.biorhythm.get_daily_biorhythm(seed="user-123")` |
184188
| Biorhythm forecast | `roxy.biorhythm.get_forecast(birth_date="1990-01-15")` |
185189
| Biorhythm compatibility | `roxy.biorhythm.calculate_bio_compatibility(person1, person2)` |

README.md

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Python SDK for astrology, Vedic astrology, tarot, numerology, and more.
1616

1717
One API key. Sync and async (every method has an `_async` suffix). Verified against NASA JPL Horizons.
1818

19-
The fastest way to add natal charts, kundli matching, daily horoscopes, tarot readings, and spiritual insights to FastAPI, Django, Flask, or any Python project. Ten domains behind a single [Roxy](https://roxyapi.com) subscription, interpretations in eight languages.
19+
The fastest way to add natal charts, kundli matching, daily horoscopes, tarot readings, and spiritual insights to FastAPI, Django, Flask, or any Python project. Twelve domains behind a single [Roxy](https://roxyapi.com) subscription, interpretations in eight languages.
2020

2121
## Install
2222

@@ -94,6 +94,8 @@ lat, lng, tz = city["latitude"], city["longitude"], city["timezone"]
9494
| Vedic Astrology | `roxy.vedic_astrology` | Kundli, panchang, Vimshottari dasha, nakshatras, Mangal / Kaal Sarp / Sade Sati doshas, Guna Milan, navamsa, KP chart and ruling planets |
9595
| Numerology | `roxy.numerology` | Life path, expression, soul urge, personal year, full chart, compatibility, karmic lessons |
9696
| Tarot | `roxy.tarot` | Daily card, custom draws, three-card, Celtic Cross, yes / no, love spread, 78-card catalog |
97+
| Human Design | `roxy.human_design` | Full bodygraph: type, strategy, authority, profile, definition, centers, channels, gates |
98+
| Forecast | `roxy.forecast` | Cross-domain timeline: transits, ingresses, stations, dasha changes, critical days |
9799
| Biorhythm | `roxy.biorhythm` | Daily check-in, multi-day forecast, critical days, couples compatibility, phases |
98100
| I Ching | `roxy.iching` | Daily hexagram, three-coin cast, 64 hexagrams, trigrams |
99101
| Crystals | `roxy.crystals` | By zodiac, by chakra, birthstone, search, daily, pairings |
@@ -210,7 +212,41 @@ answer = roxy.tarot.cast_yes_no(question="Should I take the offer?")
210212
# answer["answer"] ("Yes" | "No" | "Maybe"), answer["strength"]
211213
```
212214

213-
### 5. Biorhythm API (daily check-in, forecast, compatibility)
215+
### 5. Human Design API (full bodygraph: type, strategy, authority, profile)
216+
217+
The breakout 2026 spiritual category, computed from the same ephemeris as Western astrology plus the I Ching gate wheel and chakra-style centers. Self-discovery apps, dating and compatibility products, and AI coaching bots are the buyers. The full bodygraph is the chart, returned in one call. No coordinates needed: Human Design uses the birth instant and ecliptic longitudes, so there is no city-search setup step.
218+
219+
```python
220+
# Full bodygraph. The #1 Human Design query, the whole chart in one call.
221+
# `timezone` is the IANA string ("Asia/Kolkata"), same as the chart endpoints.
222+
bodygraph = roxy.human_design.generate_bodygraph(
223+
date="1990-07-04", time="10:12:00", timezone="Asia/Kolkata",
224+
)
225+
# bodygraph["type"] ("Generator", "Projector", "Manifestor", ...)
226+
print(bodygraph["type"], bodygraph["strategy"], bodygraph["profile"], bodygraph["definition"])
227+
# bodygraph["authority"], bodygraph["centers"], bodygraph["channels"], bodygraph["gates"]
228+
```
229+
230+
### 6. Forecast API (cross-domain transit timeline, significance-scored)
231+
232+
The first cross-domain, stateless forecast in the catalog. One call merges Western transit-to-natal aspects, sign ingresses, retrograde stations, Vedic Vimshottari dasha boundaries, and biorhythm critical days into a single significance-scored, time-ordered timeline. Forecast feeds, transit alerts, and timing tools are the buyers. The window is clamped to a 90-day horizon.
233+
234+
```python
235+
# Cross-domain timeline. Acquire on the transit keyword, convert on this breadth.
236+
# Response keys are camelCase passthrough: result["count"], result["events"].
237+
timeline = roxy.forecast.generate_timeline(
238+
birth_data={
239+
"date": "1990-07-04", "time": "10:12:00", "timezone": "Asia/Kolkata",
240+
"latitude": 28.6139, "longitude": 77.209,
241+
},
242+
start_date="2026-06-01", end_date="2026-06-30",
243+
)
244+
print(timeline["count"]) # number of events in the window
245+
event = timeline["events"][0]
246+
print(event["date"], event["domain"], event["type"], event["description"], event["significance"])
247+
```
248+
249+
### 7. Biorhythm API (daily check-in, forecast, compatibility)
214250

215251
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.
216252

@@ -224,7 +260,7 @@ forecast = roxy.biorhythm.get_forecast(
224260
)
225261
```
226262

227-
### 6. I Ching API (daily hexagram, coin cast, 64-hexagram catalog)
263+
### 8. I Ching API (daily hexagram, coin cast, 64-hexagram catalog)
228264

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

@@ -238,7 +274,7 @@ hexagrams = roxy.iching.list_hexagrams()
238274
# hexagrams["hexagrams"] has 64 entries
239275
```
240276

241-
### 7. Crystals API (by zodiac, by chakra, birthstone)
277+
### 9. Crystals API (by zodiac, by chakra, birthstone)
242278

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

@@ -254,7 +290,7 @@ by_chakra = roxy.crystals.get_crystals_by_chakra(chakra="heart")
254290
birthstone = roxy.crystals.get_birthstones(month="4")
255291
```
256292

257-
### 8. Dream interpretation API (symbol dictionary, search)
293+
### 10. Dream interpretation API (symbol dictionary, search)
258294

259295
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.
260296

@@ -268,7 +304,7 @@ results = roxy.dreams.search_dream_symbols(q="flying")
268304
# results["symbols"] is an array of matching symbols
269305
```
270306

271-
### 9. Angel Numbers API (1111, 222, 333 meanings plus universal lookup)
307+
### 11. Angel Numbers API (1111, 222, 333 meanings plus universal lookup)
272308

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

0 commit comments

Comments
 (0)