sdk-typescript
llms.txt1 starsChanged 16 days agoMITView on GitHub
TypeScript SDK for RoxyAPI. Multi-domain spiritual and metaphysical intelligence API. Fully typed, zero runtime dependencies. Install: npm install @roxyapi/sdk Every method returns { data, error, response }. Parameters use { path } for URL segments, { body } for POST data, { query } for query strings. Western astrology API for natal birth charts, daily, weekly, monthly, and yearly horoscopes with unique content per s... API reference
- Reads credentials
- Installs packages
In this repositoryOne other file it gives its agents.
- AGENTS.mdAGENTS.md
The file
We split this llms-full.txt into the rules it gives an agent
3 rules. About 0 are common, 0 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 5
Every method returns { data, error, response }.
- Very specific: line 2654
Every method returns { data, error, response }.
- Very specific: line 2682
Every error returns { error, code, doc_url }.
≈ “Common” is an estimate: at least 1 in 5 of the 3,592 llms.txt files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Keep what fits and drop the rest. Your version, ready for your agents.
Files
llms-full.txt
# @roxyapi/sdk: Complete Method Reference
> TypeScript SDK for RoxyAPI. Multi-domain spiritual and metaphysical intelligence API. Fully typed, zero runtime dependencies. Install: `npm install @roxyapi/sdk`
Every method returns `{ data, error, response }`. Parameters use `{ path }` for URL segments, `{ body }` for POST data, `{ query }` for query strings.
```typescript
import { createRoxy } from '@roxyapi/sdk';
const roxy = createRoxy(process.env.ROXY_API_KEY!);
```
<!-- BEGIN:LANGS -->
**Multi-language responses.** Interpretations are available in 10 languages: `en`, `tr`, `de`, `es`, `hi`, `pt`, `fr`, `ru`, `zh-Hans`, `zh-Hant`. Pass `query: { lang }` on any supported endpoint. Supported: astrology, vedicAstrology, forecast, humanDesign, chineseAstrology, fengShui, mesoamericanAstrology, vastu, numerology, kabbalah, tarot, biorhythm, ayurveda, iching, crystals, angelNumbers, reports, languages. English-only: dreams, location, usage. Languages without translations yet fall back to English.
<!-- END:LANGS -->
```typescript
const { data } = await roxy.astrology.getDailyHoroscope({
path: { sign: 'aries' },
query: { lang: 'es' },
});
```
---
<!-- Method sections below are generated from the OpenAPI spec by scripts/sync-docs.ts. Do not hand-edit between the BEGIN/END:METHODS markers; edit the spec instead. The intro above and the Error Handling / Advanced / Links sections below are curated. -->
<!-- BEGIN:METHODS -->
## Western Astrology: `roxy.astrology`
Western astrology API for natal birth charts, daily, weekly, monthly, and yearly horoscopes with unique content per s...
[API reference](https://roxyapi.com/api-reference/western-astrology)
```typescript
// Get all zodiac signs - Complete zodiac signs list with dates and elements
const { data } = await roxy.astrology.listZodiacSigns();
// Get zodiac sign details - Complete astrology sign profile with personality traits
const { data } = await roxy.astrology.getZodiacSign({ path: { id: 'aries' } });
// Get all planet meanings - Complete astrology planet interpretations list
const { data } = await roxy.astrology.listPlanetMeanings();
// Get planet meaning details - Complete astrology planet interpretation
const { data } = await roxy.astrology.getPlanetMeaning({ path: { id: 'sun' } });
// Generate natal chart - Birth chart calculator API with houses and aspects
const { data } = await roxy.astrology.generateNatalChart({
body: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
houseSystem: 'placidus',
},
});
// Get planetary positions - Ephemeris calculator for all planets
const { data } = await roxy.astrology.getPlanetaryPositions({
body: {
date: '2025-12-18',
time: '12:00:00',
nodeType: 'true',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
},
});
// Monthly Ephemeris - Daily tropical planetary positions for a month
const { data } = await roxy.astrology.getMonthlyTropicalEphemeris({ body: { year: 2026, month: 8 } });
// Get current moon phase - Lunar phase calculator with zodiac sign
const { data } = await roxy.astrology.getCurrentMoonPhase({
query: {
date: '2025-12-18',
time: '12:00:00',
timezone: 'America/New_York',
},
});
// Get upcoming moon phases - Next new moon, full moon, quarters
const { data } = await roxy.astrology.getUpcomingMoonPhases({ query: { startDate: '2025-12-18', count: 8 } });
// Get lunar calendar - Moon phases for entire month
const { data } = await roxy.astrology.getMoonCalendar({ path: { year: 2026, month: 3 } });
// Calculate synastry - Relationship compatibility analysis API
const { data } = await roxy.astrology.calculateSynastry({
body: {
person1: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
name: 'Alex',
},
person2: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
name: 'Alex',
},
houseSystem: 'placidus',
},
});
// Calculate house cusps - House system calculator with comparison
const { data } = await roxy.astrology.calculateHouses({
body: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
houseSystem: 'placidus',
},
});
// Calculate planetary aspects - Aspect finder for any date and time
const { data } = await roxy.astrology.calculateAspects({
body: {
date: '1990-07-15',
time: '14:30:00',
timezone: 'America/New_York',
planets: ['Sun', 'Moon', 'Mercury', 'Venus', 'Mars'],
aspectTypes: ['CONJUNCTION', 'OPPOSITION', 'TRINE', 'SQUARE'],
},
});
// Monthly Aspects - Tropical aspect calendar for an entire month
const { data } = await roxy.astrology.getMonthlyTropicalAspects({
body: {
year: 2026,
month: 3,
timezone: 'America/New_York',
nodeType: 'true',
},
});
// Detect aspect patterns - Grand Trine, Kite, T-Square, Grand Cross, Yod, Mystic Rectangle, Stellium
const { data } = await roxy.astrology.detectAspectPatterns({
query: { strictOrbs: 'false', include: '' },
body: {
date: '1955-02-24',
time: '19:15:00',
latitude: 37.77,
longitude: -122.42,
timezone: -8,
},
});
// Calculate planetary transits - Current transits with natal chart comparison
const { data } = await roxy.astrology.calculateTransits({
body: {
date: '2025-12-19',
time: '12:00:00',
timezone: 0,
nodeType: 'true',
},
});
// Monthly Transits - Tropical sign ingresses for an entire month
const { data } = await roxy.astrology.getMonthlyTropicalTransits({
body: {
year: 2026,
month: 3,
timezone: 'America/New_York',
nodeType: 'true',
},
});
// Transit Aspects - Detailed transit-to-natal aspect analysis with interpretations
const { data } = await roxy.astrology.calculateTransitAspects({
body: {
natalChart: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
},
transitDate: '2026-02-03',
transitTime: '12:00:00',
planets: ['Jupiter', 'Saturn', 'Pluto'],
aspectTypes: ['CONJUNCTION', 'OPPOSITION', 'TRINE', 'SQUARE'],
minStrength: 50,
houseSystem: 'placidus',
},
});
// Monthly Parallels - Declination contacts for an entire month
const { data } = await roxy.astrology.getMonthlyDeclinationParallels({
body: {
year: 2026,
month: 3,
timezone: 'America/New_York',
orb: 1.5,
nodeType: 'true',
},
});
// Ecliptic Crossings - Node passages for a whole year
const { data } = await roxy.astrology.getPlanetaryNodePassages({ body: { year: 2026, timezone: 'America/New_York' } });
// Solar Return Chart - Annual birthday forecast with relocated chart
const { data } = await roxy.astrology.generateSolarReturn({
body: {
birthDate: '1990-07-15',
birthTime: '14:30:00',
returnYear: 2026,
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
houseSystem: 'placidus',
},
});
// Lunar Return Chart - Monthly emotional forecast with Moon cycle chart
const { data } = await roxy.astrology.generateLunarReturn({
body: {
birthDate: '1990-07-15',
birthTime: '14:30:00',
returnDate: '2026-02-12',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
houseSystem: 'placidus',
},
});
// Composite Chart - Midpoint relationship chart with interpretations
const { data } = await roxy.astrology.generateCompositeChart({
body: {
person1: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
},
person2: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
},
houseSystem: 'placidus',
},
});
// Compatibility score - Relationship compatibility API
const { data } = await roxy.astrology.calculateCompatibility({
body: {
person1: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
},
person2: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
},
},
});
// Daily horoscope by zodiac sign - Transit-based editorial columns
const { data } = await roxy.astrology.getDailyHoroscope({
path: { sign: 'aries' },
query: { date: '2026-04-03', timezone: 'America/New_York' },
});
// Weekly horoscope by zodiac sign - Seven-day editorial column
const { data } = await roxy.astrology.getWeeklyHoroscope({
path: { sign: 'aries' },
query: { date: '2026-04-03', timezone: 'America/New_York' },
});
// Monthly horoscope by zodiac sign - Editorial column with key dates
const { data } = await roxy.astrology.getMonthlyHoroscope({
path: { sign: 'aries' },
query: { date: '2026-04-03', timezone: 'America/New_York' },
});
// Yearly horoscope by zodiac sign - Year ahead forecast with themes, key periods, eclipses and retrogrades
const { data } = await roxy.astrology.getYearlyHoroscope({
path: { sign: 'aries' },
query: { year: 2026, timezone: 'America/New_York' },
});
// Planetary Return Chart - Saturn return, Jupiter return, and inner planet cycles
const { data } = await roxy.astrology.generatePlanetaryReturn({
body: {
birthDate: '1990-07-15',
birthTime: '14:30:00',
planet: 'Jupiter',
approximateDate: '2026-08-15',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
houseSystem: 'placidus',
},
});
// Astrocartography map - planetary lines and relocation calculator
const { data } = await roxy.astrology.generateAstrocartography({
query: { include: 'chiron' },
body: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
},
});
// Generate relocation chart - Relocated birth chart calculator with shifted houses and angles
const { data } = await roxy.astrology.generateRelocationChart({
body: {
date: '1961-08-04',
time: '19:24:00',
timezone: -10,
birthLatitude: 21.3069,
birthLongitude: -157.8583,
relocationLatitude: 40.7167,
relocationLongitude: -74.006,
houseSystem: 'placidus',
},
});
// Local space astrology map - Directional planetary compass lines
const { data } = await roxy.astrology.generateLocalSpace({
query: { include: 'chiron,lilith' },
body: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
},
});
// Fixed stars and star conjunctions calculator - Regulus, Spica, Algol natal report
const { data } = await roxy.astrology.generateFixedStars({
query: { orb: 1 },
body: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
},
});
// Arabic lots calculator - seven Hermetic parts including Part of Fortune and Spirit
const { data } = await roxy.astrology.calculateArabicLots({
body: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
houseSystem: 'placidus',
},
});
// Asteroid goddesses calculator - Ceres, Pallas, Juno, and Vesta natal positions
const { data } = await roxy.astrology.generateAsteroids({
body: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
houseSystem: 'placidus',
},
});
// Black Moon Lilith calculator - mean and true lunar apogee in the natal chart
const { data } = await roxy.astrology.generateLilith({
body: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
houseSystem: 'placidus',
},
});
// Secondary progressions calculator - progressed chart, progressed Sun and Moon
const { data } = await roxy.astrology.generateProgressions({
body: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
targetDate: '2025-07-15',
houseSystem: 'placidus',
},
});
// Solar arc directions calculator - directed chart at one degree per year
const { data } = await roxy.astrology.generateSolarArc({
body: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
targetDate: '2025-07-15',
},
});
// Annual profections calculator - lord of the year and yearly time lord by age
const { data } = await roxy.astrology.generateProfections({
body: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
targetDate: '2025-08-04',
houseSystem: 'placidus',
},
});
```
---
## Vedic Astrology: `roxy.vedicAstrology`
Vedic astrology (Jyotish) and KP API for kundli generation with the sixteen Shodasavarga divisional charts (D1 to D60...
[API reference](https://roxyapi.com/api-reference/vedic-astrology)
```typescript
// Get birth chart (D1 Rashi chart) - Kundli Calculator API
const { data } = await roxy.vedicAstrology.generateBirthChart({
query: { focus: 'general' },
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
avasthaInfo: true,
modernPlanets: true,
},
});
// Get Navamsa chart (D9) - Marriage Compatibility Calculator
const { data } = await roxy.vedicAstrology.generateNavamsa({
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
},
});
// Get divisional chart (Varga) - D2 to D60 Calculator
const { data } = await roxy.vedicAstrology.generateDivisionalChart({
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
division: 10,
},
});
// Calculate compatibility score - Gun Milan API (Ashtakoot Matching)
const { data } = await roxy.vedicAstrology.calculateGunMilan({
body: {
person1: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
},
person2: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
},
ayanamsa: 'lahiri',
ayanamsaValue: 24,
},
});
// Calculate ten porutham match - Dashakoot South Indian Kundli Matching API
const { data } = await roxy.vedicAstrology.calculateDashakoot({
body: {
person1: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
},
person2: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
},
ayanamsa: 'lahiri',
ayanamsaValue: 24,
},
});
// Compare malefic affliction - Papasamyam Kundli Matching API
const { data } = await roxy.vedicAstrology.calculatePapasamyam({
body: {
person1: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
},
person2: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
},
ayanamsa: 'lahiri',
ayanamsaValue: 24,
},
});
// Get planetary positions - Graha Positions API
const { data } = await roxy.vedicAstrology.getPlanetPositions({
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
},
});
// Monthly Ephemeris - Daily sidereal planetary positions for a month
const { data } = await roxy.vedicAstrology.getMonthlyEphemeris({
body: { year: 2026, month: 2, coordinateSystem: 'sidereal' },
});
// Get current Mahadasha, Antardasha, Pratyantardasha, Sookshma, Prana - Dasha Calculator API
const { data } = await roxy.vedicAstrology.getCurrentDasha({
query: { focus: 'general' },
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
significators: false,
nodeType: 'mean',
datetime: '2026-08-23T13:47:46Z',
},
});
// Get all 9 Mahadasha periods (120-year cycle)
const { data } = await roxy.vedicAstrology.getMajorDashas({
query: { focus: 'general' },
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
significators: false,
nodeType: 'mean',
},
});
// Get all Antardashas (sub-periods) for a specific Mahadasha
const { data } = await roxy.vedicAstrology.getSubDashas({
path: { mahadasha: 'Jupiter' },
query: { focus: 'general' },
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
significators: false,
nodeType: 'mean',
},
});
// Get all Pratyantardashas (antara periods) for a Mahadasha and Antardasha
const { data } = await roxy.vedicAstrology.getPratyantardashas({
path: { mahadasha: 'Saturn', antardasha: 'Venus' },
query: { focus: 'general' },
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
significators: false,
nodeType: 'mean',
},
});
// Get all Sookshma dashas for a Mahadasha, Antardasha and Pratyantardasha
const { data } = await roxy.vedicAstrology.getSookshmaDashas({
path: {
mahadasha: 'Saturn',
antardasha: 'Venus',
pratyantardasha: 'Rahu',
},
query: { focus: 'general' },
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
significators: false,
nodeType: 'mean',
},
});
// Get all Prana dashas for a Mahadasha, Antardasha, Pratyantardasha and Sookshma
const { data } = await roxy.vedicAstrology.getPranaDashas({
path: {
mahadasha: 'Saturn',
antardasha: 'Venus',
pratyantardasha: 'Rahu',
sookshma: 'Jupiter',
},
query: { focus: 'general' },
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
significators: false,
nodeType: 'mean',
},
});
// Daily Reading - Composed Gochara, Panchanga and Dasha for one native on one day
const { data } = await roxy.vedicAstrology.getVedicDailyReading({
query: { focus: 'general' },
body: {
birthDate: '1984-11-03',
birthTime: '01:35:00',
latitude: 28.8944,
longitude: 76.5894,
timezone: 5.5,
date: '2026-06-21',
nodeType: 'mean',
},
});
// Get basic Panchang - Tithi Nakshatra Yoga Karana Calculator
const { data } = await roxy.vedicAstrology.getBasicPanchang({
body: {
date: '2025-12-17',
time: '12:00:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
},
});
// Get detailed Panchang with Rahu Kaal, Yamaganda, Gulika
const { data } = await roxy.vedicAstrology.getDetailedPanchang({
body: {
date: '2026-02-03',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
},
});
// Get Choghadiya - 8 Muhurta divisions of day and night
const { data } = await roxy.vedicAstrology.getChoghadiya({
body: {
date: '2026-02-03',
latitude: 17.385044,
longitude: 78.486671,
timezone: 5.5,
},
});
// Get Hora - 24 Planetary Hours (12 day + 12 night)
const { data } = await roxy.vedicAstrology.getHora({
body: {
date: '2026-02-03',
latitude: 17.385044,
longitude: 78.486671,
timezone: 5.5,
},
});
// Check Manglik Dosha - Mangal Dosha Calculator API
const { data } = await roxy.vedicAstrology.checkManglikDosha({
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
},
});
// Check Kalsarpa Dosha - Kalsarpa Yoga Calculator API
const { data } = await roxy.vedicAstrology.checkKalsarpaDosha({
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
},
});
// Check Sadhesati - Sade Sati Calculator API (Saturn Transit)
const { data } = await roxy.vedicAstrology.checkSadhesati({
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
},
});
// List all planetary yogas - 301 entry Vedic Yoga Glossary
const { data } = await roxy.vedicAstrology.listYogas({ query: { family: 'akriti' } });
// Get yoga details by ID - Vedic Yoga Glossary Entry
const { data } = await roxy.vedicAstrology.getYoga({ path: { id: 'gajakesari' } });
// Detect classical Vedic yogas in a birth chart
const { data } = await roxy.vedicAstrology.detectYogas({
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
},
});
// Get KP-Newcomb ayanamsa - Dynamic daily calculation
const { data } = await roxy.vedicAstrology.getKpAyanamsa({
query: {
date: '2025-12-26',
time: '09:00:00',
timezone: 'Asia/Kolkata',
},
});
// Get KP planetary positions with sub-lords
const { data } = await roxy.vedicAstrology.getKpPlanets({
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'kp-newcomb',
ayanamsaValue: 24,
nodeType: 'mean',
},
});
// Get KP Placidus house cusps with sub-lords
const { data } = await roxy.vedicAstrology.getKpCusps({
query: { focus: 'general' },
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'kp-newcomb',
ayanamsaValue: 24,
},
});
// Generate complete KP birth chart
const { data } = await roxy.vedicAstrology.generateKpChart({
query: { focus: 'general' },
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'kp-newcomb',
ayanamsaValue: 24,
nodeType: 'mean',
},
});
// Get KP ruling planets with optional significators
const { data } = await roxy.vedicAstrology.getKpRulingPlanets({
query: { focus: 'general' },
body: {
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
datetime: '2025-01-15T10:30:00Z',
birthDate: '1990-07-04',
birthTime: '10:12:00',
nodeType: 'mean',
},
});
// Get KP ruling planets with significators at intervals
const { data } = await roxy.vedicAstrology.getKpRulingInterval({
query: { focus: 'general' },
body: {
startDatetime: '2026-02-03T00:00:00Z',
endDatetime: '2026-02-03T01:00:00Z',
intervalMinutes: 5,
latitude: 17.385044,
longitude: 78.486671,
timezone: 5.5,
ayanamsa: 'kp-newcomb',
nodeType: 'mean',
},
});
// Find KP sublord changes
const { data } = await roxy.vedicAstrology.getKpSublordChanges({
body: {
planet: 'Moon',
startDate: '2025-01-01',
endDate: '2025-01-31',
timezone: 5.5,
ayanamsa: 'kp-newcomb',
nodeType: 'mean',
},
});
// Find KP rasi ingress times
const { data } = await roxy.vedicAstrology.getKpRasiChanges({
body: {
planet: 'Sun',
startDate: '2025-01-01',
endDate: '2025-12-31',
timezone: 5.5,
ayanamsa: 'kp-newcomb',
nodeType: 'mean',
},
});
// Get KP planets at time intervals
const { data } = await roxy.vedicAstrology.getKpPlanetsInterval({
body: {
startDatetime: '2025-01-15T00:00:00Z',
endDatetime: '2025-01-15T23:59:00Z',
intervalMinutes: 60,
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'kp-newcomb',
nodeType: 'mean',
},
});
// Cast a KP horary (Prashna) chart from a number 1-249 - KP Horary API
const { data } = await roxy.vedicAstrology.castKpHoraryChart({
query: { focus: 'general' },
body: {
horaryNumber: 108,
date: '2026-03-08',
time: '14:30:00',
latitude: 19.076,
longitude: 72.8777,
timezone: 5.5,
ayanamsa: 'kp-newcomb',
ayanamsaValue: 24,
nodeType: 'mean',
},
});
// Daily finance score from four KP sub lord layers - KP Daily Finance API
const { data } = await roxy.vedicAstrology.getKpDailyFinance({
body: {
birthDate: '1990-06-15',
birthTime: '07:30:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
date: '2026-09-14',
time: '12:00:00',
ayanamsa: 'kp-newcomb',
nodeType: 'mean',
gainHouses: [2, 11],
lossHouses: [6, 8, 12],
weights: { cusps: 30, dasha: 40, rulingPlanets: 15, moonWindows: 15 },
},
});
// Get planetary aspects (Drishti) - Mutual aspects between all planets
const { data } = await roxy.vedicAstrology.calculateDrishti({
body: {
date: '2026-02-03',
time: '12:00:00',
latitude: 17.385044,
longitude: 78.486671,
timezone: 5.5,
coordinateSystem: 'sidereal',
},
});
// Monthly Planetary Aspects - Major and minor aspect events for a month
const { data } = await roxy.vedicAstrology.getMonthlyAspects({
body: {
year: 2026,
month: 2,
timezone: 5.5,
coordinateSystem: 'sidereal',
},
});
// Monthly Lunar Aspects - Moon aspect events with all planets for a month
const { data } = await roxy.vedicAstrology.getLunarAspects({
body: {
year: 2026,
month: 2,
timezone: 5.5,
coordinateSystem: 'sidereal',
},
});
// Transit Analysis - Compare current planets to natal chart (Gochar)
const { data } = await roxy.vedicAstrology.calculateTransit({
body: {
birthDate: '1990-07-04',
birthTime: '10:12:00',
transitDate: '2026-02-03',
transitTime: '12:00:00',
latitude: 17.385044,
longitude: 78.486671,
timezone: 5.5,
coordinateSystem: 'sidereal',
},
});
// Monthly Transit - Planetary sign changes for an entire month
const { data } = await roxy.vedicAstrology.getMonthlyTransits({
body: {
year: 2026,
month: 2,
timezone: 5.5,
coordinateSystem: 'sidereal',
},
});
// Declination Parallels - Planets at same or opposite declination
const { data } = await roxy.vedicAstrology.calculateParallels({
body: {
date: '2026-02-03',
time: '12:00:00',
latitude: 17.385044,
longitude: 78.486671,
timezone: 5.5,
orb: 1.5,
},
});
// Monthly Declination Parallels - Parallel and contraparallel events for a month
const { data } = await roxy.vedicAstrology.getMonthlyParallels({ body: { year: 2026, month: 2, timezone: 5.5 } });
// Ecliptic Crossings - When planets cross the ecliptic plane
const { data } = await roxy.vedicAstrology.getEclipticCrossings({
body: { year: 2026, timezone: 5.5, coordinateSystem: 'sidereal' },
});
// List all 12 Rashis - Vedic Zodiac Signs Reference
const { data } = await roxy.vedicAstrology.listRashis();
// Get Rashi by ID - Vedic Zodiac Sign Detail
const { data } = await roxy.vedicAstrology.getRashi({ path: { id: 'mesha' } });
// List all 27 Nakshatras - Lunar Mansions Reference
const { data } = await roxy.vedicAstrology.listNakshatras();
// Get Nakshatra by ID - Lunar Mansion Detail
const { data } = await roxy.vedicAstrology.getNakshatra({ path: { id: 'ashwini' } });
// Get upagraha (sub-planet) positions - Upagraha Calculator API
const { data } = await roxy.vedicAstrology.getUpagrahaPositions({
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
},
});
// Get Ashtakavarga (planetary strength) analysis - Ashtakavarga Calculator API
const { data } = await roxy.vedicAstrology.calculateAshtakavarga({
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
},
});
// Get Shadbala (six-fold planetary strength) analysis - Shadbala Calculator API
const { data } = await roxy.vedicAstrology.calculateShadbala({
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
},
});
// List all 17 avastha states - Planetary State Reference
const { data } = await roxy.vedicAstrology.listAvasthas({ query: { system: 'deeptadi' } });
// Get avastha by ID - Planetary State Detail
const { data } = await roxy.vedicAstrology.getAvastha({ path: { id: 'dipta' } });
// Get the twelve Arudha padas - Arudha Lagna Calculator API
const { data } = await roxy.vedicAstrology.calculateArudhaPadas({
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
},
});
// Get Chara Karakas including Atmakaraka - Jaimini Karaka Calculator API
const { data } = await roxy.vedicAstrology.calculateCharaKarakas({
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
scheme: 'eight',
},
});
// Get Bhava Bala (house strength) for all twelve houses - Bhava Bala Calculator API
const { data } = await roxy.vedicAstrology.calculateBhavaBala({
query: { focus: 'general' },
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
},
});
// Get the Bhav Chalit (Chalit Kundli) cusp-based house chart - Bhav Chalit API
const { data } = await roxy.vedicAstrology.calculateBhavChalit({
query: { focus: 'general' },
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
},
});
// Heliacal rising and setting (udaya and asta) - Graha Asta Calculator API
const { data } = await roxy.vedicAstrology.getHeliacalVisibility({
body: {
date: '2026-07-25',
latitude: 19.076,
longitude: 72.8777,
timezone: 5.5,
},
});
```
---
## Forecast: `roxy.forecast`
Astrology forecast API that merges upcoming transit aspects, sign ingresses, retrograde stations, new and full moons,...
[API reference](https://roxyapi.com/api-reference/forecast)
```typescript
// Cross-domain forecast timeline - Transits, ingresses, stations, dasha changes, critical days
const { data } = await roxy.forecast.generateTimeline({
body: {
birthData: {
date: '1990-07-15',
time: '13:30:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 0,
},
startDate: '2026-06-01',
endDate: '2026-08-30',
domains: ['western', 'vedic', 'biorhythm'],
minSignificance: 0,
domainWeights: { vedic: 1.5, biorhythm: 0.5 },
},
});
// Western astrology forecast - aspects, ingresses, stations, eclipses, moon phases
const { data } = await roxy.forecast.forecastTransits({
body: {
birthData: {
date: '1990-07-15',
time: '13:30:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 0,
},
startDate: '2026-06-01',
endDate: '2026-08-30',
minSignificance: 0,
},
});
// Significant dates - High-significance cross-domain forecast highlights
const { data } = await roxy.forecast.findSignificantDates({
body: {
birthData: {
date: '1990-07-15',
time: '13:30:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 0,
},
startDate: '2026-06-01',
endDate: '2026-08-30',
domains: ['western', 'vedic', 'biorhythm'],
minSignificance: 70,
domainWeights: { vedic: 1.5, biorhythm: 0.5 },
},
});
// Forecast digest - Pre-summarized next 24h, 7d, 30d, and 90d rollups
const { data } = await roxy.forecast.generateDigest({
body: {
birthData: {
date: '1990-07-15',
time: '13:30:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 0,
},
startDate: '2026-06-01',
domains: ['western', 'vedic', 'biorhythm'],
minSignificance: 0,
domainWeights: { vedic: 1.5, biorhythm: 0.5 },
top: 3,
},
});
// Solar return chart - Annual birthday forecast chart for a single subject
const { data } = await roxy.forecast.forecastSolarReturn({
body: {
date: '1990-07-15',
time: '14:30:00',
year: 2026,
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
houseSystem: 'placidus',
},
});
```
---
## Human Design: `roxy.humanDesign`
Human Design API that generates the full bodygraph from a birth moment: type, strategy, inner authority, profile, def...
[API reference](https://roxyapi.com/api-reference/human-design)
```typescript
// Generate full Human Design bodygraph - Type, authority, profile, centers, channels, gates
const { data } = await roxy.humanDesign.generateBodygraph({
body: {
date: '1990-07-15',
time: '13:00:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 0,
nodeType: 'true',
},
});
// Calculate Human Design connection chart - Two-person composite bodygraph compatibility
const { data } = await roxy.humanDesign.calculateConnection({
body: {
personA: {
date: '1990-07-15',
time: '13:00:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 0,
nodeType: 'true',
},
personB: {
date: '1990-07-15',
time: '13:00:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 0,
nodeType: 'true',
},
},
});
// Calculate Human Design Penta - Small-group BG5 operating system for three to five people
const { data } = await roxy.humanDesign.calculatePenta({
body: {
members: [
{
date: '1990-07-15',
time: '13:00:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 0,
nodeType: 'true',
},
],
},
});
// Generate Human Design transit overlay - Current planetary activations on a natal bodygraph
const { data } = await roxy.humanDesign.generateTransit({
body: {
birthData: {
date: '1990-07-15',
time: '13:00:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 0,
nodeType: 'true',
},
date: '2026-05-23',
time: '12:00:00',
},
});
// Calculate Human Design type, authority and profile
const { data } = await roxy.humanDesign.calculateType({
body: {
date: '1990-07-15',
time: '13:00:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 0,
nodeType: 'true',
},
});
// Calculate the 26 Human Design gate activations
const { data } = await roxy.humanDesign.calculateGates({
body: {
date: '1990-07-15',
time: '13:00:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 0,
nodeType: 'true',
},
});
// Look up a Human Design gate by number
const { data } = await roxy.humanDesign.getGate({ path: { number: 34 } });
// Calculate the defined Human Design channels
const { data } = await roxy.humanDesign.calculateChannels({
body: {
date: '1990-07-15',
time: '13:00:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 0,
nodeType: 'true',
},
});
// Calculate the nine Human Design centers
const { data } = await roxy.humanDesign.calculateCenters({
body: {
date: '1990-07-15',
time: '13:00:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 0,
nodeType: 'true',
},
});
// Look up a Human Design center by id
const { data } = await roxy.humanDesign.getCenter({ path: { id: 'sacral' } });
// Calculate the Human Design profile and line keynotes
const { data } = await roxy.humanDesign.calculateProfile({
body: {
date: '1990-07-15',
time: '13:00:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 0,
nodeType: 'true',
},
});
// Calculate Human Design Variables - The four arrows and Color, Tone, Base substructure
const { data } = await roxy.humanDesign.calculateVariables({
body: {
date: '1990-07-15',
time: '13:00:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 0,
nodeType: 'true',
},
});
```
---
## Chinese Astrology: `roxy.chineseAstrology`
Chinese zodiac and BaZi astrology API: Four Pillars charts, Chinese zodiac signs and the Chinese lunisolar calendar f...
[API reference](https://roxyapi.com/api-reference/chinese-astrology)
```typescript
// Generate BaZi chart - Four Pillars of Destiny calculator API
const { data } = await roxy.chineseAstrology.generateBaziChart({
body: {
date: '1990-06-15',
time: '14:30:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 116.4,
dayBoundary: 'split-zi',
yearBoundary: 'li-chun',
hourClock: 'clock',
},
});
// Calculate luck pillars - BaZi Da Yun ten-year cycle API
const { data } = await roxy.chineseAstrology.calculateLuckPillars({
body: {
date: '1990-06-15',
time: '14:30:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 116.4,
dayBoundary: 'split-zi',
yearBoundary: 'li-chun',
hourClock: 'clock',
gender: 'male',
count: 8,
annualFromYear: 2026,
annualYears: 10,
},
});
// Calculate Day Master strength - BaZi favorable element API
const { data } = await roxy.chineseAstrology.calculateDayMasterStrength({
body: {
date: '1990-06-15',
time: '14:30:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 116.4,
dayBoundary: 'split-zi',
yearBoundary: 'li-chun',
hourClock: 'clock',
},
});
// Calculate BaZi compatibility - Four Pillars matchmaking API
const { data } = await roxy.chineseAstrology.calculateBaziCompatibility({
body: {
personA: {
date: '1990-06-15',
time: '14:30:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 116.4,
dayBoundary: 'split-zi',
yearBoundary: 'li-chun',
hourClock: 'clock',
},
personB: {
date: '1990-06-15',
time: '14:30:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 116.4,
dayBoundary: 'split-zi',
yearBoundary: 'li-chun',
hourClock: 'clock',
},
},
});
// Calculate BaZi annual forecast - Liu Nian yearly pillar API
const { data } = await roxy.chineseAstrology.calculateAnnualForecast({
body: {
date: '1990-06-15',
time: '14:30:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 116.4,
dayBoundary: 'split-zi',
yearBoundary: 'li-chun',
hourClock: 'clock',
year: 2026,
},
});
// List the 12 Chinese zodiac animals - Sheng Xiao sign catalogue
const { data } = await roxy.chineseAstrology.listZodiacAnimals({ query: { limit: 12, offset: 0 } });
// Get one Chinese zodiac animal - Full sign profile with compatibility partners
const { data } = await roxy.chineseAstrology.getZodiacAnimal({ path: { id: 'rat' } });
// Find the Chinese zodiac animal for a birth date - Sheng Xiao calculator
const { data } = await roxy.chineseAstrology.calculateZodiacAnimal({
body: { date: '1990-06-15', yearBoundary: 'lunar-new-year' },
});
// Chinese zodiac compatibility - Trine, six harmony, clash and harm analysis
const { data } = await roxy.chineseAstrology.getZodiacCompatibility({ path: { sign1: 'rat', sign2: 'dragon' } });
// Daily Chinese zodiac reading - Day pillar forecast by animal sign
const { data } = await roxy.chineseAstrology.getDailyZodiacReading({
path: { id: 'rat' },
query: { date: '2026-04-03', timezone: 'America/New_York' },
});
// List the 24 solar terms - Jie Qi calendar API with exact instants
const { data } = await roxy.chineseAstrology.listSolarTerms({ path: { year: 2026 } });
// Convert lunar and Gregorian dates - Chinese lunisolar calendar API
const { data } = await roxy.chineseAstrology.calculateLunarDate({ body: { date: '1990-06-15' } });
// Get the almanac for a day - Tong Shu API with day officers and mansions
const { data } = await roxy.chineseAstrology.getAlmanacDay({ path: { date: '1990-06-15' } });
// Get a month of almanac days - Chinese calendar month view API
const { data } = await roxy.chineseAstrology.getMonthlyAlmanac({ query: { year: 1990, month: 6 } });
// Find auspicious days - Chinese date selection API for weddings and openings
const { data } = await roxy.chineseAstrology.lookupAuspiciousDays({
body: {
activity: 'wedding',
startDate: '2026-03-01',
endDate: '2026-04-30',
avoidAnimal: 'rat',
},
});
// List the five elements - Wu Xing API with generating and controlling cycles
const { data } = await roxy.chineseAstrology.listFiveElements({ query: { limit: 5, offset: 0 } });
```
---
## Feng Shui: `roxy.fengShui`
Compute classical feng shui from one API: Xuan Kong flying star natal charts for any of the nine periods and 24 mount...
[API reference](https://roxyapi.com/api-reference/feng-shui)
```typescript
// Calculate Kua number - Feng shui personal direction calculator API
const { data } = await roxy.fengShui.calculateKuaNumber({
body: {
date: '1985-07-15',
gender: 'male',
yearBoundary: 'li-chun',
},
});
// Look up a Kua number - Eight Mansions reference API
const { data } = await roxy.fengShui.getKuaNumber({ path: { number: 8 } });
// Generate Eight Mansions map - Ba Zhai lucky direction API
const { data } = await roxy.fengShui.generateEightMansions({
body: {
kua: 6,
date: '1985-07-15',
gender: 'male',
yearBoundary: 'li-chun',
facing: 'Southeast',
},
});
// Generate flying star natal chart - Xuan Kong Fei Xing API
const { data } = await roxy.fengShui.generateFlyingStarChart({ body: { period: 9, facing: 'wu', facingDegrees: 180 } });
// Annual flying stars - Yearly feng shui star chart API
const { data } = await roxy.fengShui.getAnnualFlyingStars({ path: { year: 2026 } });
// Monthly flying stars - Month by month feng shui overlay API
const { data } = await roxy.fengShui.getMonthlyFlyingStars({ query: { year: 2026, month: 1 } });
// List the nine flying stars - Xuan Kong star reference API
const { data } = await roxy.fengShui.listFlyingStars({ query: { limit: 9, offset: 0 } });
// Annual afflictions - Tai Sui, San Sha and Five Yellow API
const { data } = await roxy.fengShui.getAnnualAfflictions({ path: { year: 2026 } });
// List Bagua sectors - Feng shui bagua map API
const { data } = await roxy.fengShui.listBaguaSectors({ query: { limit: 9, offset: 0 } });
// Look up a Bagua sector - Life area reference API
const { data } = await roxy.fengShui.getBaguaSector({ path: { id: 'wealth' } });
// List the nine periods - San Yuan period table API
const { data } = await roxy.fengShui.listNinePeriods({ query: { date: '2026-08-23' } });
```
---
## Mesoamerican Astrology: `roxy.mesoamericanAstrology`
Calculate Mayan astrology day signs, the Tzolkin sacred round, the Haab year, the full Long Count and the Aztec tonal...
[API reference](https://roxyapi.com/api-reference/mesoamerican-astrology)
```typescript
// Mayan day sign for a date - Tzolkin calculator API
const { data } = await roxy.mesoamericanAstrology.calculateTzolkin({ body: { date: '2012-12-21', correlation: 'gmt-584283' } });
// Generate a Mayan chart - Tzolkin, Haab and Long Count calculator API
const { data } = await roxy.mesoamericanAstrology.generateMayanChart({
body: {
date: '2012-12-21',
correlation: 'gmt-584283',
yearBearerSystem: 'classic',
},
});
// Convert a Maya Long Count - Long Count calendar converter API
const { data } = await roxy.mesoamericanAstrology.convertLongCount({ body: { date: '2012-12-21' } });
// Daily Mayan energy reading - Tzolkin day sign of the day API
const { data } = await roxy.mesoamericanAstrology.getDailyMayanReading({ query: { date: '2026-09-02', correlation: 'gmt-584283' } });
// Monthly Tzolkin calendar grid - Maya calendar month API
const { data } = await roxy.mesoamericanAstrology.getMonthlyTzolkinCalendar({
query: { year: 2026, month: 9, correlation: 'gmt-584283' },
});
// Mayan nawal compatibility - Tzolkin pair analysis API
const { data } = await roxy.mesoamericanAstrology.calculateMayanCompatibility({
body: {
personA: { date: '2012-12-21' },
personB: { date: '2012-12-21' },
correlation: 'gmt-584283',
directionScheme: 'madrid-codex',
},
});
// List the 20 Mayan day signs - Tzolkin nawal catalogue API
const { data } = await roxy.mesoamericanAstrology.listMayanDaySigns({
query: { directionScheme: 'madrid-codex', limit: 20, offset: 0 },
});
// Get one Mayan day sign - Nawal profile API
const { data } = await roxy.mesoamericanAstrology.getMayanDaySign({
path: { id: 'imix' },
query: { directionScheme: 'madrid-codex' },
});
// List the 20 Mayan trecenas - Tzolkin thirteen day period API
const { data } = await roxy.mesoamericanAstrology.listTrecenas({ query: { limit: 20, offset: 0 } });
// Get one Mayan trecena - Thirteen day period profile API
const { data } = await roxy.mesoamericanAstrology.getTrecena({ path: { number: 1 } });
// List the 19 Haab periods - Maya solar calendar month API
const { data } = await roxy.mesoamericanAstrology.listHaabMonths({ query: { limit: 19, offset: 0 } });
// Get one Haab period - Maya solar calendar month profile API
const { data } = await roxy.mesoamericanAstrology.getHaabMonth({ path: { id: 'pop' } });
// Aztec day sign for a date - Tonalpohualli calculator API
const { data } = await roxy.mesoamericanAstrology.calculateTonalpohualli({ body: { date: '2012-12-21' } });
// Daily Aztec energy reading - Tonalpohualli day sign of the day API
const { data } = await roxy.mesoamericanAstrology.getDailyAztecReading({ query: { date: '2026-09-02' } });
// List the 20 Aztec day signs - Tonalpohualli sign catalogue API
const { data } = await roxy.mesoamericanAstrology.listAztecDaySigns({ query: { limit: 20, offset: 0 } });
// Get one Aztec day sign - Tonalpohualli sign profile API
const { data } = await roxy.mesoamericanAstrology.getAztecDaySign({ path: { id: 'cipactli' } });
// List the 20 Aztec trecenas - Tonalpohualli thirteen day period API
const { data } = await roxy.mesoamericanAstrology.listAztecTrecenas({ query: { limit: 20, offset: 0 } });
// Get one Aztec trecena - Tonalpohualli period profile API
const { data } = await roxy.mesoamericanAstrology.getAztecTrecena({ path: { number: 1 } });
```
---
## Vastu: `roxy.vastu`
Vastu Shastra API for directional home and plot analysis: entrance padas with the classical effect of each of the 32...
[API reference](https://roxyapi.com/api-reference/vastu)
```typescript
// Calculate entrance pada - Vastu main door direction API
const { data } = await roxy.vastu.calculateEntrancePada({
body: {
plot: { width: 30, depth: 40, unit: 'feet' },
facing: 'North',
doorPosition: 0.4,
},
});
// Generate Vastu Purusha Mandala - 81 pada and 64 pada grid API
const { data } = await roxy.vastu.generateMandala({
body: {
plot: { width: 30, depth: 40, unit: 'feet' },
grid: '81-pada',
},
});
// Analyse a plot - Vastu land and site assessment API
const { data } = await roxy.vastu.calculatePlotAnalysis({
body: {
plot: { width: 30, depth: 40, unit: 'feet' },
facing: 'North',
slopeLowDirection: 'Northeast',
road: 'North',
extensions: ['Northeast'],
cuts: ['Southwest'],
water: 'Northeast',
},
});
// Calculate Ayadi shadvarga - Vastu proportion and yoni calculator API
const { data } = await roxy.vastu.calculateAyadi({
body: {
length: 11,
breadth: 11,
perimeter: 11,
circumference: 11,
unit: 'hasta',
hastaInches: 18,
ayadiText: 'manasara',
vyayaFormula: 'p9-10',
},
});
// Check room placement - Vastu room direction compliance API
const { data } = await roxy.vastu.calculateRoomCompliance({
body: {
plot: { width: 30, depth: 40, unit: 'feet' },
facing: 'North',
rooms: [
{ type: 'kitchen', direction: 'Southeast' },
{ type: 'master-bedroom', direction: 'Southwest' },
],
},
});
// Find griha pravesh dates - Vastu house warming muhurta API
const { data } = await roxy.vastu.findGrihaPraveshDates({
body: {
startDate: '2027-01-20',
endDate: '2027-03-20',
latitude: 28.6139,
longitude: 77.209,
timezone: 'America/New_York',
muhurtaText: 'muhurta-chintamani',
},
});
// List the eight directions - Vastu dikpala and direction reference API
const { data } = await roxy.vastu.listDikpalaDirections({ query: { limit: 8, offset: 0 } });
// Look up one direction - Vastu dikpala reference API
const { data } = await roxy.vastu.getDikpalaDirection({ path: { id: 'Northeast' } });
// List the 45 devatas - Vastu Purusha Mandala reference API
const { data } = await roxy.vastu.listDevatas({ query: { limit: 45, offset: 0 } });
// Look up one devata - Vastu mandala devata reference API
const { data } = await roxy.vastu.getDevata({ path: { id: 'jayanta' } });
```
---
## Numerology: `roxy.numerology`
Numerology API for life path numbers, complete numerology charts and compatibility, in both Pythagorean and Chaldean...
[API reference](https://roxyapi.com/api-reference/numerology)
```typescript
// Calculate Life Path number - Calculator and meaning API
const { data } = await roxy.numerology.calculateLifePath({ body: { year: 1990, month: 7, day: 15 } });
// Calculate Expression number - Destiny number calculator API
const { data } = await roxy.numerology.calculateExpression({ body: { fullName: 'John William Smith' } });
// Calculate Bridge Numbers - Numerology bridge numbers API
const { data } = await roxy.numerology.calculateBridgeNumbers({
body: {
fullName: 'John William Smith',
year: 1990,
month: 7,
day: 15,
},
});
// Calculate Soul Urge number - Heart Desire number calculator API
const { data } = await roxy.numerology.calculateSoulUrge({ body: { fullName: 'John William Smith' } });
// Calculate Personality number - Outer personality numerology API
const { data } = await roxy.numerology.calculatePersonality({ body: { fullName: 'John William Smith' } });
// Calculate Birth Day number - Birthday numerology API
const { data } = await roxy.numerology.calculateBirthDay({ body: { day: 23 } });
// Calculate Maturity number - Realization number numerology API
const { data } = await roxy.numerology.calculateMaturity({
body: {
lifePath: 5,
expression: 7,
fullName: 'John William Smith',
year: 1990,
month: 7,
day: 15,
},
});
// Analyze Karmic Lessons - Missing numbers numerology API
const { data } = await roxy.numerology.analyzeKarmicLessons({ body: { fullName: 'John William Smith' } });
// Detect Karmic Debt numbers - Karmic debt 13, 14, 16, 19 API
const { data } = await roxy.numerology.checkKarmicDebt({
body: {
year: 1990,
month: 7,
day: 15,
fullName: 'John William Smith',
},
});
// Calculate Personal Day - Daily numerology forecast API
const { data } = await roxy.numerology.calculatePersonalDay({ body: { month: 7, day: 18, targetDate: '2026-04-04' } });
// Calculate Personal Month - Monthly numerology forecast API
const { data } = await roxy.numerology.calculatePersonalMonth({ body: { month: 7, day: 18, year: 2026, targetMonth: 4 } });
// Calculate Personal Year - Personal Year number forecast API
const { data } = await roxy.numerology.calculatePersonalYear({ body: { month: 7, day: 15, year: 2025 } });
// Calculate numerology compatibility - Love match scoring API
const { data } = await roxy.numerology.calculateNumCompatibility({
body: {
person1: {
fullName: 'John William Smith',
year: 1990,
month: 7,
day: 15,
lifePath: 5,
expression: 7,
soulUrge: 6,
},
person2: {
fullName: 'Jane Marie Doe',
year: 1992,
month: 3,
day: 22,
lifePath: 3,
expression: 9,
soulUrge: 2,
},
},
});
// Generate numerology chart - Complete numerology reading API
const { data } = await roxy.numerology.generateNumerologyChart({
body: {
fullName: 'John William Smith',
year: 1990,
month: 7,
day: 15,
currentYear: 2025,
targetDate: '2026-10-28',
},
});
// Get number meaning - Numerology number meanings API
const { data } = await roxy.numerology.getNumberMeaning({ path: { number: '5' } });
// Get daily numerology number - Number of the Day API
const { data } = await roxy.numerology.getDailyNumber({ body: { seed: 'user123', date: '2026-03-06' } });
// Calculate Chaldean numerology - Chaldean name number calculator API
const { data } = await roxy.numerology.calculateChaldean({ body: { name: 'Helen' } });
// Get compound number meaning - Chaldean compound numbers 10 to 52 API
const { data } = await roxy.numerology.getCompoundNumber({ path: { number: '23' } });
// Calculate dual numerology - Pythagorean and Chaldean name number API
const { data } = await roxy.numerology.calculateDual({ body: { name: 'David' } });
// Calculate business name numerology - Brand name numerology API
const { data } = await roxy.numerology.calculateBusinessName({ body: { name: 'Ford' } });
```
---
## Kabbalah: `roxy.kabbalah`
Kabbalah API for gematria, the 72 names, the Tree of Life and the Hebrew birthday
[API reference](https://roxyapi.com/api-reference/kabbalah)
```typescript
// Calculate gematria - Hebrew gematria calculator API with every spelling shown
const { data } = await roxy.kabbalah.calculateGematria({
body: {
text: 'Sarah',
ciphers: ['mispar-hechrachi', 'mispar-gadol'],
},
});
// List gematria ciphers - gematria methods API with provenance on every row
const { data } = await roxy.kabbalah.listGematriaCiphers();
// Generate a name profile - Kabbalah name numerology API with the spelling shown
const { data } = await roxy.kabbalah.generateNameProfile({ body: { name: 'Sarah' } });
// Generate a birth profile - Hebrew birthday and birth angel API
const { data } = await roxy.kabbalah.generateBirthProfile({
body: {
date: '1990-06-15',
time: '14:30:00',
timezone: 'America/New_York',
angelDating: 'solar-longitude',
yearStart: 'march-21',
leapDayPolicy: 'extend-previous',
afterSunset: false,
targetDate: '2026-10-28',
},
});
// List the 72 names - Shem HaMephorash API derived from the verses
const { data } = await roxy.kabbalah.listShemNames({ query: { limit: 20, offset: 0, longitude: 131.18 } });
// Get one of the 72 names - 72 names of God API by index
const { data } = await roxy.kabbalah.getShemName({ path: { number: 27 } });
// Get the Tree of Life - sephirot and 22 paths API with typed school variants
const { data } = await roxy.kabbalah.getTreeOfLife({
query: {
treeVariant: 'kircher',
sephirotSystem: 'classical',
letterAttribution: 'sefer-yetzirah-gra',
},
});
// Get one sephirah - sefirot meaning API with the paths that touch it
const { data } = await roxy.kabbalah.getSephirah({
path: { id: 'tiferet' },
query: {
sephirotSystem: 'classical',
letterAttribution: 'sefer-yetzirah-gra',
},
});
// List the Hebrew letters - Hebrew alphabet API with the Sefer Yetzirah attributions
const { data } = await roxy.kabbalah.listHebrewLetters({ query: { letterAttribution: 'sefer-yetzirah-gra' } });
// Get one Hebrew letter - Hebrew letter meaning API
const { data } = await roxy.kabbalah.getHebrewLetter({
path: { id: 'shin' },
query: { letterAttribution: 'sefer-yetzirah-gra' },
});
// Compare two names - gematria name compatibility API with every component published
const { data } = await roxy.kabbalah.calculateNameCompatibility({ body: { firstName: 'Sarah', secondName: 'David' } });
// Get the sephirah of the day - Omer count API with the sephirot pairing
const { data } = await roxy.kabbalah.getDailySephirah({
query: {
date: '2026-04-04',
timezone: 'Asia/Jerusalem',
afterSunset: 'false',
},
});
```
---
## Tarot: `roxy.tarot`
Tarot reading API with the complete 78-card Rider-Waite-Smith deck and card meanings for love, career, health, and sp...
[API reference](https://roxyapi.com/api-reference/tarot)
```typescript
// List all 78 tarot cards - Tarot deck catalog API
const { data } = await roxy.tarot.listCards({
query: {
limit: 20,
offset: 0,
arcana: 'major',
suit: 'cups',
number: 1,
},
});
// Get tarot card by id - Tarot card meaning API
const { data } = await roxy.tarot.getCard({ path: { id: 'fool' } });
// Draw tarot cards - Seeded tarot draw API
const { data } = await roxy.tarot.drawCards({
body: {
count: 3,
seed: 'user123-2025-12-27',
allowReversals: true,
allowDuplicates: false,
},
});
// Daily tarot card - Card of the day API
const { data } = await roxy.tarot.getDailyCard({ body: { seed: 'user123', date: '2026-03-06' } });
// Yes or no answer - Yes no tarot reading API
const { data } = await roxy.tarot.castYesNo({
body: {
question: 'Should I accept the job offer?',
seed: 'reading-2f9c1a',
},
});
// Three card spread, past present future - Tarot spread API
const { data } = await roxy.tarot.castThreeCard({
body: {
question: 'What do I need to know about my career?',
seed: 'reading-2f9c1a',
},
});
// Celtic Cross spread, 10 cards - Tarot spread API
const { data } = await roxy.tarot.castCelticCross({
body: {
question: 'What should I know about this situation?',
seed: 'reading-2f9c1a',
},
});
// Love spread, 5 cards - Relationship tarot reading API
const { data } = await roxy.tarot.castLoveSpread({
body: {
question: 'What do I need to know about my relationship?',
seed: 'reading-2f9c1a',
},
});
// Career spread, 7 cards - Career tarot reading API
const { data } = await roxy.tarot.castCareerSpread({
body: {
question: 'What do I need to know about my career path?',
seed: 'reading-2f9c1a',
},
});
// Custom spread builder - Configurable tarot spread API
const { data } = await roxy.tarot.castCustomSpread({
body: {
spreadName: 'My Custom Spread',
positions: [
{
name: 'Core Issue',
interpretation: 'What is really going on',
},
{
name: 'Hidden Factor',
interpretation: 'What you cannot see',
},
{ name: 'Best Action', interpretation: 'What to do next' },
],
question: 'How do I move forward with this project?',
seed: 'reading-2f9c1a',
},
});
```
---
## Biorhythm: `roxy.biorhythm`
Biorhythm API for entertainment and reflection, with 10 model cycle types across 3 primary (physical, emotional, inte...
[API reference](https://roxyapi.com/api-reference/biorhythm)
```typescript
// Get biorhythm reading - Complete cycle analysis for any date
const { data } = await roxy.biorhythm.getReading({
body: { birthDate: '1990-07-15', targetDate: '2026-04-10' },
});
// Get biorhythm forecast - Multi-day cycle predictions with best and worst days
const { data } = await roxy.biorhythm.getForecast({
body: {
birthDate: '1990-07-15',
startDate: '2026-04-01',
endDate: '2026-04-30',
},
});
// Find critical days - Zero crossing detection for any date range
const { data } = await roxy.biorhythm.getCriticalDays({
body: {
birthDate: '1990-07-15',
startDate: '2026-04-01',
endDate: '2026-06-30',
},
});
// Calculate compatibility - Biorhythm alignment between two people
const { data } = await roxy.biorhythm.calculateBioCompatibility({
body: {
person1: { birthDate: '1990-07-15' },
person2: { birthDate: '1992-03-22' },
targetDate: '2026-04-10',
},
});
// Get phase info - Lightweight cycle status for dashboards and widgets
const { data } = await roxy.biorhythm.getPhases({
body: { birthDate: '1990-07-15', targetDate: '2026-04-10' },
});
// Get daily biorhythm - Seeded reading for daily check-in features
const { data } = await roxy.biorhythm.getDailyBiorhythm({ body: { seed: 'user123', date: '2026-03-06' } });
```
---
## Ayurveda: `roxy.ayurveda`
Ayurveda API for dosha profiles, the dinacharya daily routine and the ritucharya seasonal regimen, with a verse cited...
[API reference](https://roxyapi.com/api-reference/ayurveda)
```typescript
// Ayurvedic constitution from a birth chart - Dosha profile API
const { data } = await roxy.ayurveda.calculateAyurvedicConstitution({
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
signDoshaScheme: 'satyacharya',
},
});
// Dinacharya daily routine - Brahma muhurta and dosha clock API
const { data } = await roxy.ayurveda.getDinacharyaSchedule({
body: {
date: '2026-06-21',
latitude: 51.5074,
longitude: -0.1278,
timezone: 'Europe/London',
doshaClock: 'sunrise-anchored',
},
});
// Ayurveda seasonal regimen - Ritucharya and ritu resolution API
const { data } = await roxy.ayurveda.getRitucharya({
body: {
date: '2026-03-01',
ritucharyaScheme: 'sutrasthana-6',
rituZodiac: 'sayana',
hemisphere: 'northern',
},
});
// Daily Ayurveda reading - Dosha clock and brahma muhurta by location API
const { data } = await roxy.ayurveda.getDailyAyurvedaReading({
query: {
date: '2026-06-21',
latitude: 51.5074,
longitude: -0.1278,
timezone: 'Europe/London',
},
});
// List the three doshas - Dosha catalogue API
const { data } = await roxy.ayurveda.listDoshas({ query: { limit: 3, offset: 0 } });
// Get one dosha - Vata pitta kapha profile API
const { data } = await roxy.ayurveda.getDosha({ path: { id: 'vata' } });
// List the six tastes - Ayurveda rasa and dosha matrix API
const { data } = await roxy.ayurveda.listRasas({ query: { limit: 6, offset: 0 } });
// List the twenty qualities - Ayurveda guna pairs API
const { data } = await roxy.ayurveda.listGunas({ query: { limit: 10, offset: 0 } });
```
---
## I-Ching: `roxy.iching`
I-Ching oracle API with all 64 hexagrams, 384 changing lines, 8 trigrams, and modern interpretations for love, career...
[API reference](https://roxyapi.com/api-reference/i-ching)
```typescript
// Daily hexagram - Daily I-Ching oracle API
const { data } = await roxy.iching.getDailyHexagram({ body: { seed: 'user123', date: '2026-03-06' } });
// Cast daily reading with changing lines - I-Ching divination API
const { data } = await roxy.iching.castDailyReading({ body: { seed: 'user123', date: '2026-03-06' } });
// List all 64 hexagrams - I-Ching hexagram catalog API
const { data } = await roxy.iching.listHexagrams({ query: { limit: 20, offset: 0 } });
// Random hexagram - I-Ching hexagram picker API
const { data } = await roxy.iching.getRandomHexagram();
// Lookup hexagram by line pattern - I-Ching binary lookup API
const { data } = await roxy.iching.lookupHexagram({ query: { lines: '111111' } });
// Get hexagram by number - I-Ching hexagram detail API
const { data } = await roxy.iching.getHexagram({ path: { number: 1 } });
// Cast an I-Ching reading - Hexagram divination API
const { data } = await roxy.iching.castReading({ query: { seed: 'user123-question1' } });
// List all 8 trigrams - Bagua trigram catalog API
const { data } = await roxy.iching.listTrigrams();
// Get trigram by number or name - Bagua trigram detail API
const { data } = await roxy.iching.getTrigram({ path: { id: 'Heaven' } });
```
---
## Crystals and Healing Stones: `roxy.crystals`
Crystal healing API covering the most popular and widely-searched healing crystals and gemstones, from Amethyst and R...
[API reference](https://roxyapi.com/api-reference/crystals-and-healing-stones)
```typescript
// Crystals by zodiac sign - Zodiac birthstone API
const { data } = await roxy.crystals.getCrystalsByZodiac({
path: { sign: 'pisces' },
query: { limit: 20, offset: 0 },
});
// Crystals by chakra - Chakra healing stones API
const { data } = await roxy.crystals.getCrystalsByChakra({
path: { chakra: 'Heart' },
query: { limit: 20, offset: 0 },
});
// Crystals by element - Elemental crystal lookup API
const { data } = await roxy.crystals.getCrystalsByElement({
path: { element: 'Water' },
query: { limit: 20, offset: 0 },
});
// Birthstones by month - Birthstone lookup API
const { data } = await roxy.crystals.getBirthstones({ path: { month: 2 } });
// Search crystals - Crystal search API
const { data } = await roxy.crystals.searchCrystals({ query: { q: 'love', limit: 20, offset: 0 } });
// Crystal pairings - Crystal combination API
const { data } = await roxy.crystals.getCrystalPairings({ path: { id: 'amethyst' } });
// Daily crystal - Crystal of the day API
const { data } = await roxy.crystals.getDailyCrystal({ body: { seed: 'user123', date: '2026-03-06' } });
// Random crystal - Crystal discovery API
const { data } = await roxy.crystals.getRandomCrystal();
// List crystal colors - Crystal color filter API
const { data } = await roxy.crystals.listCrystalColors();
// List crystal planets - Planetary ruler filter API
const { data } = await roxy.crystals.listCrystalPlanets();
// List all crystals - Crystal healing database API
const { data } = await roxy.crystals.listCrystals({
query: {
chakra: 'Heart',
zodiac: 'pisces',
element: 'Water',
color: 'pink',
planet: 'Venus',
limit: 20,
offset: 0,
},
});
// Get crystal by id - Crystal healing properties API
const { data } = await roxy.crystals.getCrystal({ path: { id: 'amethyst' } });
```
---
## Dreams: `roxy.dreams`
Dream interpretation API with a 2,200+ symbol dream dictionary and psychological meanings covering animals, objects,...
[API reference](https://roxyapi.com/api-reference/dreams)
```typescript
// List and search dream symbols - Dream dictionary API
const { data } = await roxy.dreams.searchDreamSymbols({ query: { q: 'water', letter: 'a', limit: 20, offset: 0 } });
// Random dream symbols - Dream symbol discovery API
const { data } = await roxy.dreams.getRandomSymbols({ query: { count: 1 } });
// Symbol counts by letter - Dream dictionary index API
const { data } = await roxy.dreams.getSymbolLetterCounts();
// Get dream symbol by id - Dream interpretation API
const { data } = await roxy.dreams.getDreamSymbol({ path: { id: 'snake' } });
// Daily dream symbol - Dream symbol of the day API
const { data } = await roxy.dreams.getDailyDreamSymbol({ body: { seed: 'user123', date: '2026-03-06' } });
```
---
## Angel Numbers: `roxy.angelNumbers`
Angel numbers API with meanings for 111, 222, 333, 444, 555, 666, 777, 888, 999, 1111, and 75+ sequences covering eve...
[API reference](https://roxyapi.com/api-reference/angel-numbers)
```typescript
// List all angel numbers - Angel number catalog API
const { data } = await roxy.angelNumbers.listAngelNumbers({ query: { limit: 20, offset: 0, type: 'repeating' } });
// Get angel number meaning - Angel number lookup API
const { data } = await roxy.angelNumbers.getAngelNumber({ path: { number: '444' } });
// Analyze any number sequence - Angel number analysis API
const { data } = await roxy.angelNumbers.analyzeNumberSequence({ query: { number: '1234', context: 'clock' } });
// Daily angel number - Angel number of the day API
const { data } = await roxy.angelNumbers.getDailyAngelNumber({ body: { seed: 'user123', date: '2026-03-06' } });
```
---
## Location and Timezone: `roxy.location`
Timezone and location API with city search and geocoding across 5,180,000+ cities, towns and villages in 240+ countri...
[API reference](https://roxyapi.com/api-reference/location-and-timezone)
```typescript
// Search cities worldwide - Geocoding autocomplete with coordinates and timezone
const { data } = await roxy.location.searchCities({ query: { q: 'berlin', limit: 10, offset: 0 } });
// List all countries - ISO codes and city coverage
const { data } = await roxy.location.listCountries({ query: { limit: 50, offset: 0 } });
// Get cities in a country - Geocoding directory sorted by population
const { data } = await roxy.location.getCitiesByCountry({ path: { iso2: 'DE' }, query: { limit: 20, offset: 0 } });
```
---
## Usage: `roxy.usage`
Monitor your API usage, check rate limits, and track request consumption
[API reference](https://roxyapi.com/api-reference/usage)
```typescript
// Get API usage statistics
const { data } = await roxy.usage.getUsageStats();
```
---
## Reports: `roxy.reports`
Branded reports built from the API: a natal chart and more as a print-ready PDF, self-contained HTML or Markdown, whi...
[API reference](https://roxyapi.com/api-reference/reports)
```typescript
// Natal chart report - Branded PDF report API
const { data } = await roxy.reports.generateNatalReport({
body: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
houseSystem: 'placidus',
format: 'pdf',
branding: {
name: 'Luna Rivera Astrology',
footer: 'For reflection and entertainment. Book a reading at example.com.',
website: 'https://example.com',
email: 'hello@example.com',
colors: { primary: '#1e293b', accent: '#b45309' },
font: 'fraunces-jost',
theme: 'practitioner',
},
readings: true,
},
});
// Synastry report - Branded PDF report API
const { data } = await roxy.reports.generateSynastryReport({
body: {
person1: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
name: 'Alex',
},
person2: {
date: '1990-07-15',
time: '14:30:00',
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
nodeType: 'true',
name: 'Alex',
},
houseSystem: 'placidus',
format: 'pdf',
branding: {
name: 'Luna Rivera Astrology',
footer: 'For reflection and entertainment. Book a reading at example.com.',
website: 'https://example.com',
email: 'hello@example.com',
colors: { primary: '#1e293b', accent: '#b45309' },
font: 'fraunces-jost',
theme: 'practitioner',
},
readings: true,
},
});
// Kundli report - Branded PDF report API
const { data } = await roxy.reports.generateKundliReport({
body: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
ayanamsa: 'lahiri',
ayanamsaValue: 24,
format: 'pdf',
branding: {
name: 'Luna Rivera Astrology',
footer: 'For reflection and entertainment. Book a reading at example.com.',
website: 'https://example.com',
email: 'hello@example.com',
colors: { primary: '#1e293b', accent: '#b45309' },
font: 'fraunces-jost',
theme: 'practitioner',
},
readings: true,
},
});
// Kundli matching report - Branded PDF report API
const { data } = await roxy.reports.generateMatchmakingReport({
body: {
person1: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
},
person2: {
date: '1990-07-04',
time: '10:12:00',
latitude: 28.6139,
longitude: 77.209,
timezone: 5.5,
},
ayanamsa: 'lahiri',
ayanamsaValue: 24,
format: 'pdf',
branding: {
name: 'Luna Rivera Astrology',
footer: 'For reflection and entertainment. Book a reading at example.com.',
website: 'https://example.com',
email: 'hello@example.com',
colors: { primary: '#1e293b', accent: '#b45309' },
font: 'fraunces-jost',
theme: 'practitioner',
},
readings: true,
},
});
// Yearly forecast report - Branded PDF report API
const { data } = await roxy.reports.generateYearlyForecastReport({
body: {
date: '1990-07-15',
time: '14:30:00',
year: 2026,
latitude: 40.7128,
longitude: -74.006,
timezone: 'America/New_York',
houseSystem: 'placidus',
format: 'pdf',
branding: {
name: 'Luna Rivera Astrology',
footer: 'For reflection and entertainment. Book a reading at example.com.',
website: 'https://example.com',
email: 'hello@example.com',
colors: { primary: '#1e293b', accent: '#b45309' },
font: 'fraunces-jost',
theme: 'practitioner',
},
readings: true,
},
});
// Human Design report - Branded PDF report API
const { data } = await roxy.reports.generateHumanDesignReport({
body: {
date: '1990-07-15',
time: '13:00:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 0,
nodeType: 'true',
format: 'pdf',
branding: {
name: 'Luna Rivera Astrology',
footer: 'For reflection and entertainment. Book a reading at example.com.',
website: 'https://example.com',
email: 'hello@example.com',
colors: { primary: '#1e293b', accent: '#b45309' },
font: 'fraunces-jost',
theme: 'practitioner',
},
readings: true,
},
});
// BaZi report - Branded PDF report API
const { data } = await roxy.reports.generateBaziReport({
body: {
date: '1990-06-15',
time: '14:30:00',
timezone: 'America/New_York',
latitude: 0,
longitude: 116.4,
dayBoundary: 'split-zi',
yearBoundary: 'li-chun',
hourClock: 'clock',
gender: 'male',
year: 2027,
format: 'pdf',
branding: {
name: 'Luna Rivera Astrology',
footer: 'For reflection and entertainment. Book a reading at example.com.',
website: 'https://example.com',
email: 'hello@example.com',
colors: { primary: '#1e293b', accent: '#b45309' },
font: 'fraunces-jost',
theme: 'practitioner',
},
readings: true,
},
});
// Numerology report - Branded PDF report API
const { data } = await roxy.reports.generateNumerologyReport({
body: {
fullName: 'John William Smith',
year: 1990,
month: 7,
day: 15,
currentYear: 2025,
targetDate: '2026-10-28',
format: 'pdf',
branding: {
name: 'Luna Rivera Astrology',
footer: 'For reflection and entertainment. Book a reading at example.com.',
website: 'https://example.com',
email: 'hello@example.com',
colors: { primary: '#1e293b', accent: '#b45309' },
font: 'fraunces-jost',
theme: 'practitioner',
},
readings: true,
},
});
// Tarot reading report - Branded PDF report API
const { data } = await roxy.reports.generateTarotReport({
body: {
spread: 'celtic-cross',
question: 'What should I know about this situation?',
seed: 'reading-2f9c1a',
format: 'pdf',
branding: {
name: 'Luna Rivera Astrology',
footer: 'For reflection and entertainment. Book a reading at example.com.',
website: 'https://example.com',
email: 'hello@example.com',
colors: { primary: '#1e293b', accent: '#b45309' },
font: 'fraunces-jost',
theme: 'practitioner',
},
readings: true,
},
});
```
---
## Languages: `roxy.languages`
List the response languages accepted by the `lang` query parameter on every i18n-aware endpoint
[API reference](https://roxyapi.com/api-reference/languages)
```typescript
// Get field labels for a language
const { data } = await roxy.languages.getFieldLabels();
// List supported response languages
const { data } = await roxy.languages.listLanguages();
```
<!-- END:METHODS -->
---
## Error Handling
Every method returns `{ data, error, response }`. All errors have `{ error, code, doc_url }`:
- `error` is the human-readable message (may change wording, do not parse)
- `code` is the machine-readable identifier (stable, safe to switch on)
- `doc_url` links the documentation page for that code
- The HTTP status and the `Retry-After` header are on `response`; `retryAfterSeconds(response)` reads the wait in seconds
`data` and `error` are a discriminated pair: `data` is typed as possibly undefined until `error` is checked, so narrow with `if (error)` first, or pass `throwOnError: true` in the call options to have failures throw and `data` typed as always present.
```typescript
const { data, error, response } = await roxy.astrology.getDailyHoroscope({
path: { sign: 'aries' },
});
if (error) {
// Switch on error.code for programmatic handling
if (error.code === 'rate_limit_exceeded') {
// monthly allowance used up, see retryAfterSeconds(response)
}
console.error('Code:', error.code, 'Message:', error.error);
console.error('Status:', response?.status);
return;
}
// data is fully typed after error check
console.log(data.sign, data.overview);
```
<!-- BEGIN:ERRORS -->
Every error returns `{ error, code, doc_url }`. Switch on `code`; `error` is readable text and may change. Each meaning below says whether and when to retry, and `Retry-After` carries the wait when the response sends it. Every code is documented at https://roxyapi.com/docs/errors.
| Status | Code | Meaning |
|--------|------|---------|
| 400 | `validation_error` | A field is missing or invalid. The body lists every failing field at once in issues, each with its path and the expected shape. |
| 400 | `bad_request` | The request was rejected as a whole, for example a body that is not valid JSON or a date range that ends before it starts. |
| 400 | `date_out_of_range` | A date lies outside the span the planetary positions are served for. The error names the supported dates. |
| 400 | `invalid_branding` | The report branding cannot be used, for example a logo that is not a PNG, JPEG, WebP or SVG image. |
| 400 | `logo_fetch_failed` | The report logo could not be fetched: it must be an HTTPS URL on a public host that answers within the size limit. |
| 400 | `unsupported_character` | The report text holds a character no report font draws. The error names it: remove or replace it. |
| 401 | `api_key_required` | No API key was sent. |
| 401 | `invalid_api_key` | The key sent is malformed or cannot be verified. |
| 401 | `api_key_revoked` | The key was valid once and has since been revoked from the account page. |
| 401 | `subscription_not_found` | The key verifies, but the subscription behind it no longer exists. |
| 401 | `subscription_inactive` | The subscription behind the key is cancelled, expired or suspended, or a trial is past its end date. |
| 401 | `publishable_key_not_allowed_on_mcp` | A publishable key was used on a Remote MCP server, which takes a secret key. |
| 401 | `invalid_client_ip` | A keyless request could not be attributed to a caller. |
| 401 | `unauthorized` | Authentication failed with no more specific reason to give. |
| 403 | `forbidden` | The key is valid, but this request is not permitted. |
| 403 | `origin_required` | A publishable key with an origin allowlist was used with no Origin header, as from a server or a native app. |
| 403 | `origin_not_allowed` | The calling site is not on the origin allowlist of this publishable key. |
| 404 | `not_found` | Nothing is served at this path, or the identifier in it does not exist. A path miss adds suggestions, the closest real endpoints. |
| 405 | `method_not_allowed` | The path exists for a different HTTP method. The body lists the accepted methods in allow, as does the Allow header. |
| 409 | `conflict` | The request cannot be applied in the current state. |
| 410 | `gone` | The path was removed permanently. |
| 413 | `payload_too_large` | The request body is larger than the API accepts. A body far over the cap is refused before it reaches the API and returns a bare 413 with no JSON body. |
| 415 | `unsupported_media_type` | A request with a body was sent without Content-Type: application/json. |
| 422 | `unprocessable_entity` | Every field is valid, but the combination cannot be computed. |
| 429 | `rate_limit_exceeded` | The monthly request allowance is used up. Retry-After gives the seconds to the reset. |
| 429 | `rate_limit_per_minute` | The per-minute limit of the plan was reached. Retry-After gives the seconds to the next minute, and the monthly allowance is not charged. |
| 429 | `rate_limited` | A rate limit was reached, reported without the plan detail. |
| 429 | `free_tier_exhausted` | A keyless request has used up its trial allowance. |
| 429 | `reports_rate_limited` | Too many reports were requested this minute. Retry-After gives the seconds to the next minute. |
| 500 | `internal_error` | The request failed inside our service. Retry with exponential backoff. |
| 503 | `compute_saturated` | Heavy calculations are briefly at capacity. Send the same request again after Retry-After seconds. |
| 503 | `reports_busy` | Report rendering is briefly at capacity. Send the same request again after Retry-After seconds. |
| 503 | `report_render_timeout` | The report took too long to render. Send the same request again. |
| Any | `error` | A fallback for a status with no more specific code. The status and the error field carry the signal. |
<!-- END:ERRORS -->
Retries are on by default: `createRoxy(key)` resends a request up to twice after a 429, 500, 502, 503 or 504, or a connection that was never made, waiting for `Retry-After` when present (up to `maxDelayMs`, default 30000) and a jittered backoff otherwise. `createRoxy(key, { maxRetries: 0 })` turns retries off. A read timeout is never retried. On a persistent failure the total is 1 + `maxRetries` requests, so 3 by default and exactly 1 with `maxRetries: 0`. A network failure (DNS, timeout, connection reset) throws instead of returning `error`, so use `try`/`catch` where that matters.
## Advanced Client Configuration
```typescript
import { Roxy } from '@roxyapi/sdk';
import { createClient, createConfig } from '@roxyapi/sdk/client';
const client = createClient(
createConfig({
baseUrl: 'https://roxyapi.com/api/v2',
auth: process.env.ROXY_API_KEY,
}),
);
const roxy = new Roxy({ client });
```
## Links
- Documentation: https://roxyapi.com/docs
- Interactive API docs: https://roxyapi.com/api-reference
- Pricing and API keys: https://roxyapi.com/pricing
- MCP for AI agents: https://roxyapi.com/docs/mcp
- Templates: https://roxyapi.com/templates
- Source and issues: https://github.com/RoxyAPI/sdk-typescript
- Other SDKs: Python https://pypi.org/project/roxy-sdk/, PHP https://packagist.org/packages/roxyapi/sdk, .NET https://www.nuget.org/packages/RoxyApi.Sdk, Go https://pkg.go.dev/github.com/RoxyAPI/sdk-go, Rust https://crates.io/crates/roxyapi
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.