@roxyapi/sdk 1.2.55 → 1.2.57
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{chunk-HCC4GID6.js → chunk-25Y6CPVU.js} +19 -11
- package/dist/client/index.cjs +19 -11
- package/dist/client/index.d.ts +2 -0
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +1 -1
- package/dist/client/utils.gen.d.ts +1 -1
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client.gen.d.ts +2 -2
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/core/auth.gen.d.ts +7 -0
- package/dist/core/auth.gen.d.ts.map +1 -1
- package/dist/core/params.gen.d.ts +2 -2
- package/dist/core/params.gen.d.ts.map +1 -1
- package/dist/core/pathSerializer.gen.d.ts.map +1 -1
- package/dist/core/queryKeySerializer.gen.d.ts +1 -1
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -1
- package/dist/core/types.gen.d.ts +5 -0
- package/dist/core/types.gen.d.ts.map +1 -1
- package/dist/core/utils.gen.d.ts.map +1 -1
- package/dist/factory.cjs +66 -2
- package/dist/factory.js +67 -3
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/sdk.gen.d.ts +199 -175
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/types.gen.d.ts +2335 -608
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/docs/llms-full.txt +92 -7
- package/package.json +4 -4
- package/src/client/index.ts +2 -0
- package/src/client/utils.gen.ts +2 -2
- package/src/client.gen.ts +2 -2
- package/src/core/auth.gen.ts +7 -0
- package/src/core/params.gen.ts +21 -12
- package/src/core/pathSerializer.gen.ts +6 -6
- package/src/core/queryKeySerializer.gen.ts +1 -1
- package/src/core/types.gen.ts +6 -0
- package/src/core/utils.gen.ts +4 -4
- package/src/index.ts +1 -1
- package/src/sdk.gen.ts +244 -176
- package/src/types.gen.ts +2921 -1166
- package/src/version.ts +1 -1
package/dist/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { Client, Options as Options2, TDataShape } from './client';
|
|
2
|
-
import type { GetAngelNumbersLookupData, GetAngelNumbersLookupErrors, GetAngelNumbersLookupResponses, GetAngelNumbersNumbersByNumberData, GetAngelNumbersNumbersByNumberErrors, GetAngelNumbersNumbersByNumberResponses, GetAngelNumbersNumbersData, GetAngelNumbersNumbersErrors, GetAngelNumbersNumbersResponses, GetAstrologyHoroscopeBySignDailyData, GetAstrologyHoroscopeBySignDailyErrors, GetAstrologyHoroscopeBySignDailyResponses, GetAstrologyHoroscopeBySignMonthlyData, GetAstrologyHoroscopeBySignMonthlyErrors, GetAstrologyHoroscopeBySignMonthlyResponses, GetAstrologyHoroscopeBySignWeeklyData, GetAstrologyHoroscopeBySignWeeklyErrors, GetAstrologyHoroscopeBySignWeeklyResponses, GetAstrologyMoonPhaseCalendarByYearByMonthData, GetAstrologyMoonPhaseCalendarByYearByMonthErrors, GetAstrologyMoonPhaseCalendarByYearByMonthResponses, GetAstrologyMoonPhaseCurrentData, GetAstrologyMoonPhaseCurrentErrors, GetAstrologyMoonPhaseCurrentResponses, GetAstrologyMoonPhaseUpcomingData, GetAstrologyMoonPhaseUpcomingErrors, GetAstrologyMoonPhaseUpcomingResponses, GetAstrologyPlanetMeaningsByIdData, GetAstrologyPlanetMeaningsByIdErrors, GetAstrologyPlanetMeaningsByIdResponses, GetAstrologyPlanetMeaningsData, GetAstrologyPlanetMeaningsErrors, GetAstrologyPlanetMeaningsResponses, GetAstrologySignsByIdData, GetAstrologySignsByIdErrors, GetAstrologySignsByIdResponses, GetAstrologySignsData, GetAstrologySignsErrors, GetAstrologySignsResponses, GetCrystalsBirthstoneByMonthData, GetCrystalsBirthstoneByMonthErrors, GetCrystalsBirthstoneByMonthResponses, GetCrystalsByIdData, GetCrystalsByIdErrors, GetCrystalsByIdResponses, GetCrystalsChakraByChakraData, GetCrystalsChakraByChakraErrors, GetCrystalsChakraByChakraResponses, GetCrystalsColorsData, GetCrystalsColorsErrors, GetCrystalsColorsResponses, GetCrystalsData, GetCrystalsElementByElementData, GetCrystalsElementByElementErrors, GetCrystalsElementByElementResponses, GetCrystalsErrors, GetCrystalsPairingsByIdData, GetCrystalsPairingsByIdErrors, GetCrystalsPairingsByIdResponses, GetCrystalsPlanetsData, GetCrystalsPlanetsErrors, GetCrystalsPlanetsResponses, GetCrystalsRandomData, GetCrystalsRandomErrors, GetCrystalsRandomResponses, GetCrystalsResponses, GetCrystalsSearchData, GetCrystalsSearchErrors, GetCrystalsSearchResponses, GetCrystalsZodiacBySignData, GetCrystalsZodiacBySignErrors, GetCrystalsZodiacBySignResponses, GetDreamsSymbolsByIdData, GetDreamsSymbolsByIdErrors, GetDreamsSymbolsByIdResponses, GetDreamsSymbolsData, GetDreamsSymbolsErrors, GetDreamsSymbolsLettersData, GetDreamsSymbolsLettersErrors, GetDreamsSymbolsLettersResponses, GetDreamsSymbolsRandomData, GetDreamsSymbolsRandomErrors, GetDreamsSymbolsRandomResponses, GetDreamsSymbolsResponses, GetHumanDesignCentersByIdData, GetHumanDesignCentersByIdErrors, GetHumanDesignCentersByIdResponses, GetHumanDesignGatesByNumberData, GetHumanDesignGatesByNumberErrors, GetHumanDesignGatesByNumberResponses, GetIchingCastData, GetIchingCastErrors, GetIchingCastResponses, GetIchingHexagramsByNumberData, GetIchingHexagramsByNumberErrors, GetIchingHexagramsByNumberResponses, GetIchingHexagramsData, GetIchingHexagramsErrors, GetIchingHexagramsLookupData, GetIchingHexagramsLookupErrors, GetIchingHexagramsLookupResponses, GetIchingHexagramsRandomData, GetIchingHexagramsRandomErrors, GetIchingHexagramsRandomResponses, GetIchingHexagramsResponses, GetIchingTrigramsByIdData, GetIchingTrigramsByIdErrors, GetIchingTrigramsByIdResponses, GetIchingTrigramsData, GetIchingTrigramsErrors, GetIchingTrigramsResponses, GetLanguagesData, GetLanguagesErrors, GetLanguagesResponses, GetLocationCountriesByIso2Data, GetLocationCountriesByIso2Errors, GetLocationCountriesByIso2Responses, GetLocationCountriesData, GetLocationCountriesErrors, GetLocationCountriesResponses, GetLocationSearchData, GetLocationSearchErrors, GetLocationSearchResponses, GetNumerologyCompoundNumberByNumberData, GetNumerologyCompoundNumberByNumberErrors, GetNumerologyCompoundNumberByNumberResponses, GetNumerologyMeaningsByNumberData, GetNumerologyMeaningsByNumberErrors, GetNumerologyMeaningsByNumberResponses, GetTarotCardsByIdData, GetTarotCardsByIdErrors, GetTarotCardsByIdResponses, GetTarotCardsData, GetTarotCardsErrors, GetTarotCardsResponses, GetUsageData, GetUsageErrors, GetUsageResponses, GetVedicAstrologyAvasthasByIdData, GetVedicAstrologyAvasthasByIdErrors, GetVedicAstrologyAvasthasByIdResponses, GetVedicAstrologyAvasthasData, GetVedicAstrologyAvasthasErrors, GetVedicAstrologyAvasthasResponses, GetVedicAstrologyKpAyanamsaData, GetVedicAstrologyKpAyanamsaErrors, GetVedicAstrologyKpAyanamsaResponses, GetVedicAstrologyNakshatrasByIdData, GetVedicAstrologyNakshatrasByIdErrors, GetVedicAstrologyNakshatrasByIdResponses, GetVedicAstrologyNakshatrasData, GetVedicAstrologyNakshatrasErrors, GetVedicAstrologyNakshatrasResponses, GetVedicAstrologyRashisByIdData, GetVedicAstrologyRashisByIdErrors, GetVedicAstrologyRashisByIdResponses, GetVedicAstrologyRashisData, GetVedicAstrologyRashisErrors, GetVedicAstrologyRashisResponses, GetVedicAstrologyYogaByIdData, GetVedicAstrologyYogaByIdErrors, GetVedicAstrologyYogaByIdResponses, GetVedicAstrologyYogaData, GetVedicAstrologyYogaErrors, GetVedicAstrologyYogaResponses, PostAngelNumbersDailyData, PostAngelNumbersDailyErrors, PostAngelNumbersDailyResponses, PostAstrologyArabicLotsData, PostAstrologyArabicLotsErrors, PostAstrologyArabicLotsResponses, PostAstrologyAspectPatternsData, PostAstrologyAspectPatternsErrors, PostAstrologyAspectPatternsResponses, PostAstrologyAspectsData, PostAstrologyAspectsErrors, PostAstrologyAspectsResponses, PostAstrologyAsteroidsData, PostAstrologyAsteroidsErrors, PostAstrologyAsteroidsResponses, PostAstrologyAstrocartographyData, PostAstrologyAstrocartographyErrors, PostAstrologyAstrocartographyResponses, PostAstrologyCompatibilityScoreData, PostAstrologyCompatibilityScoreErrors, PostAstrologyCompatibilityScoreResponses, PostAstrologyCompositeChartData, PostAstrologyCompositeChartErrors, PostAstrologyCompositeChartResponses, PostAstrologyFixedStarsData, PostAstrologyFixedStarsErrors, PostAstrologyFixedStarsResponses, PostAstrologyHousesData, PostAstrologyHousesErrors, PostAstrologyHousesResponses, PostAstrologyLilithData, PostAstrologyLilithErrors, PostAstrologyLilithResponses, PostAstrologyLocalSpaceData, PostAstrologyLocalSpaceErrors, PostAstrologyLocalSpaceResponses, PostAstrologyLunarReturnData, PostAstrologyLunarReturnErrors, PostAstrologyLunarReturnResponses, PostAstrologyNatalChartData, PostAstrologyNatalChartErrors, PostAstrologyNatalChartResponses, PostAstrologyPlanetaryReturnsData, PostAstrologyPlanetaryReturnsErrors, PostAstrologyPlanetaryReturnsResponses, PostAstrologyPlanetsData, PostAstrologyPlanetsErrors, PostAstrologyPlanetsResponses, PostAstrologyProfectionsData, PostAstrologyProfectionsErrors, PostAstrologyProfectionsResponses, PostAstrologyProgressionsData, PostAstrologyProgressionsErrors, PostAstrologyProgressionsResponses, PostAstrologyRelocationChartData, PostAstrologyRelocationChartErrors, PostAstrologyRelocationChartResponses, PostAstrologySolarArcData, PostAstrologySolarArcErrors, PostAstrologySolarArcResponses, PostAstrologySolarReturnData, PostAstrologySolarReturnErrors, PostAstrologySolarReturnResponses, PostAstrologySynastryData, PostAstrologySynastryErrors, PostAstrologySynastryResponses, PostAstrologyTransitAspectsData, PostAstrologyTransitAspectsErrors, PostAstrologyTransitAspectsResponses, PostAstrologyTransitsData, PostAstrologyTransitsErrors, PostAstrologyTransitsResponses, PostBiorhythmCompatibilityData, PostBiorhythmCompatibilityErrors, PostBiorhythmCompatibilityResponses, PostBiorhythmCriticalDaysData, PostBiorhythmCriticalDaysErrors, PostBiorhythmCriticalDaysResponses, PostBiorhythmDailyData, PostBiorhythmDailyErrors, PostBiorhythmDailyResponses, PostBiorhythmForecastData, PostBiorhythmForecastErrors, PostBiorhythmForecastResponses, PostBiorhythmPhasesData, PostBiorhythmPhasesErrors, PostBiorhythmPhasesResponses, PostBiorhythmReadingData, PostBiorhythmReadingErrors, PostBiorhythmReadingResponses, PostCrystalsDailyData, PostCrystalsDailyErrors, PostCrystalsDailyResponses, PostDreamsDailyData, PostDreamsDailyErrors, PostDreamsDailyResponses, PostForecastDigestData, PostForecastDigestErrors, PostForecastDigestResponses, PostForecastSignificantDatesData, PostForecastSignificantDatesErrors, PostForecastSignificantDatesResponses, PostForecastSolarReturnData, PostForecastSolarReturnErrors, PostForecastSolarReturnResponses, PostForecastTimelineData, PostForecastTimelineErrors, PostForecastTimelineResponses, PostForecastTransitsData, PostForecastTransitsErrors, PostForecastTransitsResponses, PostHumanDesignBodygraphData, PostHumanDesignBodygraphErrors, PostHumanDesignBodygraphResponses, PostHumanDesignCentersData, PostHumanDesignCentersErrors, PostHumanDesignCentersResponses, PostHumanDesignChannelsData, PostHumanDesignChannelsErrors, PostHumanDesignChannelsResponses, PostHumanDesignConnectionData, PostHumanDesignConnectionErrors, PostHumanDesignConnectionResponses, PostHumanDesignGatesData, PostHumanDesignGatesErrors, PostHumanDesignGatesResponses, PostHumanDesignPentaData, PostHumanDesignPentaErrors, PostHumanDesignPentaResponses, PostHumanDesignProfileData, PostHumanDesignProfileErrors, PostHumanDesignProfileResponses, PostHumanDesignTransitData, PostHumanDesignTransitErrors, PostHumanDesignTransitResponses, PostHumanDesignTypeData, PostHumanDesignTypeErrors, PostHumanDesignTypeResponses, PostHumanDesignVariablesData, PostHumanDesignVariablesErrors, PostHumanDesignVariablesResponses, PostIchingDailyCastData, PostIchingDailyCastErrors, PostIchingDailyCastResponses, PostIchingDailyData, PostIchingDailyErrors, PostIchingDailyResponses, PostNumerologyBirthDayData, PostNumerologyBirthDayErrors, PostNumerologyBirthDayResponses, PostNumerologyBridgeData, PostNumerologyBridgeErrors, PostNumerologyBridgeResponses, PostNumerologyBusinessNameData, PostNumerologyBusinessNameErrors, PostNumerologyBusinessNameResponses, PostNumerologyChaldeanData, PostNumerologyChaldeanErrors, PostNumerologyChaldeanResponses, PostNumerologyChartData, PostNumerologyChartErrors, PostNumerologyChartResponses, PostNumerologyCompatibilityData, PostNumerologyCompatibilityErrors, PostNumerologyCompatibilityResponses, PostNumerologyDailyData, PostNumerologyDailyErrors, PostNumerologyDailyResponses, PostNumerologyDualData, PostNumerologyDualErrors, PostNumerologyDualResponses, PostNumerologyExpressionData, PostNumerologyExpressionErrors, PostNumerologyExpressionResponses, PostNumerologyKarmicDebtData, PostNumerologyKarmicDebtErrors, PostNumerologyKarmicDebtResponses, PostNumerologyKarmicLessonsData, PostNumerologyKarmicLessonsErrors, PostNumerologyKarmicLessonsResponses, PostNumerologyLifePathData, PostNumerologyLifePathErrors, PostNumerologyLifePathResponses, PostNumerologyMaturityData, PostNumerologyMaturityErrors, PostNumerologyMaturityResponses, PostNumerologyPersonalDayData, PostNumerologyPersonalDayErrors, PostNumerologyPersonalDayResponses, PostNumerologyPersonalityData, PostNumerologyPersonalityErrors, PostNumerologyPersonalityResponses, PostNumerologyPersonalMonthData, PostNumerologyPersonalMonthErrors, PostNumerologyPersonalMonthResponses, PostNumerologyPersonalYearData, PostNumerologyPersonalYearErrors, PostNumerologyPersonalYearResponses, PostNumerologySoulUrgeData, PostNumerologySoulUrgeErrors, PostNumerologySoulUrgeResponses, PostTarotDailyData, PostTarotDailyErrors, PostTarotDailyResponses, PostTarotDrawData, PostTarotDrawErrors, PostTarotDrawResponses, PostTarotSpreadsCareerData, PostTarotSpreadsCareerErrors, PostTarotSpreadsCareerResponses, PostTarotSpreadsCelticCrossData, PostTarotSpreadsCelticCrossErrors, PostTarotSpreadsCelticCrossResponses, PostTarotSpreadsCustomData, PostTarotSpreadsCustomErrors, PostTarotSpreadsCustomResponses, PostTarotSpreadsLoveData, PostTarotSpreadsLoveErrors, PostTarotSpreadsLoveResponses, PostTarotSpreadsThreeCardData, PostTarotSpreadsThreeCardErrors, PostTarotSpreadsThreeCardResponses, PostTarotYesNoData, PostTarotYesNoErrors, PostTarotYesNoResponses, PostVedicAstrologyArudhaData, PostVedicAstrologyArudhaErrors, PostVedicAstrologyArudhaResponses, PostVedicAstrologyAshtakavargaData, PostVedicAstrologyAshtakavargaErrors, PostVedicAstrologyAshtakavargaResponses, PostVedicAstrologyAspectsData, PostVedicAstrologyAspectsErrors, PostVedicAstrologyAspectsLunarData, PostVedicAstrologyAspectsLunarErrors, PostVedicAstrologyAspectsLunarResponses, PostVedicAstrologyAspectsMonthlyData, PostVedicAstrologyAspectsMonthlyErrors, PostVedicAstrologyAspectsMonthlyResponses, PostVedicAstrologyAspectsResponses, PostVedicAstrologyBirthChartData, PostVedicAstrologyBirthChartErrors, PostVedicAstrologyBirthChartResponses, PostVedicAstrologyCharaKarakasData, PostVedicAstrologyCharaKarakasErrors, PostVedicAstrologyCharaKarakasResponses, PostVedicAstrologyCompatibilityData, PostVedicAstrologyCompatibilityErrors, PostVedicAstrologyCompatibilityResponses, PostVedicAstrologyDashaCurrentData, PostVedicAstrologyDashaCurrentErrors, PostVedicAstrologyDashaCurrentResponses, PostVedicAstrologyDashaMajorData, PostVedicAstrologyDashaMajorErrors, PostVedicAstrologyDashaMajorResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaData, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaErrors, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaData, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaErrors, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaData, PostVedicAstrologyDashaSubByMahadashaByAntardashaErrors, PostVedicAstrologyDashaSubByMahadashaByAntardashaResponses, PostVedicAstrologyDashaSubByMahadashaData, PostVedicAstrologyDashaSubByMahadashaErrors, PostVedicAstrologyDashaSubByMahadashaResponses, PostVedicAstrologyDivisionalChartData, PostVedicAstrologyDivisionalChartErrors, PostVedicAstrologyDivisionalChartResponses, PostVedicAstrologyDoshaKalsarpaData, PostVedicAstrologyDoshaKalsarpaErrors, PostVedicAstrologyDoshaKalsarpaResponses, PostVedicAstrologyDoshaManglikData, PostVedicAstrologyDoshaManglikErrors, PostVedicAstrologyDoshaManglikResponses, PostVedicAstrologyDoshaSadhesatiData, PostVedicAstrologyDoshaSadhesatiErrors, PostVedicAstrologyDoshaSadhesatiResponses, PostVedicAstrologyEclipticCrossingsData, PostVedicAstrologyEclipticCrossingsErrors, PostVedicAstrologyEclipticCrossingsResponses, PostVedicAstrologyKpChartData, PostVedicAstrologyKpChartErrors, PostVedicAstrologyKpChartResponses, PostVedicAstrologyKpCuspsData, PostVedicAstrologyKpCuspsErrors, PostVedicAstrologyKpCuspsResponses, PostVedicAstrologyKpPlanetsData, PostVedicAstrologyKpPlanetsErrors, PostVedicAstrologyKpPlanetsIntervalData, PostVedicAstrologyKpPlanetsIntervalErrors, PostVedicAstrologyKpPlanetsIntervalResponses, PostVedicAstrologyKpPlanetsResponses, PostVedicAstrologyKpRasiChangesData, PostVedicAstrologyKpRasiChangesErrors, PostVedicAstrologyKpRasiChangesResponses, PostVedicAstrologyKpRulingPlanetsData, PostVedicAstrologyKpRulingPlanetsErrors, PostVedicAstrologyKpRulingPlanetsIntervalData, PostVedicAstrologyKpRulingPlanetsIntervalErrors, PostVedicAstrologyKpRulingPlanetsIntervalResponses, PostVedicAstrologyKpRulingPlanetsResponses, PostVedicAstrologyKpSublordChangesData, PostVedicAstrologyKpSublordChangesErrors, PostVedicAstrologyKpSublordChangesResponses, PostVedicAstrologyNavamsaData, PostVedicAstrologyNavamsaErrors, PostVedicAstrologyNavamsaResponses, PostVedicAstrologyPanchangBasicData, PostVedicAstrologyPanchangBasicErrors, PostVedicAstrologyPanchangBasicResponses, PostVedicAstrologyPanchangChoghadiyaData, PostVedicAstrologyPanchangChoghadiyaErrors, PostVedicAstrologyPanchangChoghadiyaResponses, PostVedicAstrologyPanchangDetailedData, PostVedicAstrologyPanchangDetailedErrors, PostVedicAstrologyPanchangDetailedResponses, PostVedicAstrologyPanchangHoraData, PostVedicAstrologyPanchangHoraErrors, PostVedicAstrologyPanchangHoraResponses, PostVedicAstrologyParallelsData, PostVedicAstrologyParallelsErrors, PostVedicAstrologyParallelsMonthlyData, PostVedicAstrologyParallelsMonthlyErrors, PostVedicAstrologyParallelsMonthlyResponses, PostVedicAstrologyParallelsResponses, PostVedicAstrologyPlanetaryPositionsData, PostVedicAstrologyPlanetaryPositionsErrors, PostVedicAstrologyPlanetaryPositionsMonthlyData, PostVedicAstrologyPlanetaryPositionsMonthlyErrors, PostVedicAstrologyPlanetaryPositionsMonthlyResponses, PostVedicAstrologyPlanetaryPositionsResponses, PostVedicAstrologyShadbalaData, PostVedicAstrologyShadbalaErrors, PostVedicAstrologyShadbalaResponses, PostVedicAstrologyTransitData, PostVedicAstrologyTransitErrors, PostVedicAstrologyTransitMonthlyData, PostVedicAstrologyTransitMonthlyErrors, PostVedicAstrologyTransitMonthlyResponses, PostVedicAstrologyTransitResponses, PostVedicAstrologyUpagrahaData, PostVedicAstrologyUpagrahaErrors, PostVedicAstrologyUpagrahaResponses, PostVedicAstrologyYogaDetectData, PostVedicAstrologyYogaDetectErrors, PostVedicAstrologyYogaDetectResponses } from './types.gen';
|
|
1
|
+
import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client';
|
|
2
|
+
import type { GetAngelNumbersLookupData, GetAngelNumbersLookupErrors, GetAngelNumbersLookupResponses, GetAngelNumbersNumbersByNumberData, GetAngelNumbersNumbersByNumberErrors, GetAngelNumbersNumbersByNumberResponses, GetAngelNumbersNumbersData, GetAngelNumbersNumbersErrors, GetAngelNumbersNumbersResponses, GetAstrologyHoroscopeBySignDailyData, GetAstrologyHoroscopeBySignDailyErrors, GetAstrologyHoroscopeBySignDailyResponses, GetAstrologyHoroscopeBySignMonthlyData, GetAstrologyHoroscopeBySignMonthlyErrors, GetAstrologyHoroscopeBySignMonthlyResponses, GetAstrologyHoroscopeBySignWeeklyData, GetAstrologyHoroscopeBySignWeeklyErrors, GetAstrologyHoroscopeBySignWeeklyResponses, GetAstrologyMoonPhaseCalendarByYearByMonthData, GetAstrologyMoonPhaseCalendarByYearByMonthErrors, GetAstrologyMoonPhaseCalendarByYearByMonthResponses, GetAstrologyMoonPhaseCurrentData, GetAstrologyMoonPhaseCurrentErrors, GetAstrologyMoonPhaseCurrentResponses, GetAstrologyMoonPhaseUpcomingData, GetAstrologyMoonPhaseUpcomingErrors, GetAstrologyMoonPhaseUpcomingResponses, GetAstrologyPlanetMeaningsByIdData, GetAstrologyPlanetMeaningsByIdErrors, GetAstrologyPlanetMeaningsByIdResponses, GetAstrologyPlanetMeaningsData, GetAstrologyPlanetMeaningsErrors, GetAstrologyPlanetMeaningsResponses, GetAstrologySignsByIdData, GetAstrologySignsByIdErrors, GetAstrologySignsByIdResponses, GetAstrologySignsData, GetAstrologySignsErrors, GetAstrologySignsResponses, GetCrystalsBirthstoneByMonthData, GetCrystalsBirthstoneByMonthErrors, GetCrystalsBirthstoneByMonthResponses, GetCrystalsByIdData, GetCrystalsByIdErrors, GetCrystalsByIdResponses, GetCrystalsChakraByChakraData, GetCrystalsChakraByChakraErrors, GetCrystalsChakraByChakraResponses, GetCrystalsColorsData, GetCrystalsColorsErrors, GetCrystalsColorsResponses, GetCrystalsData, GetCrystalsElementByElementData, GetCrystalsElementByElementErrors, GetCrystalsElementByElementResponses, GetCrystalsErrors, GetCrystalsPairingsByIdData, GetCrystalsPairingsByIdErrors, GetCrystalsPairingsByIdResponses, GetCrystalsPlanetsData, GetCrystalsPlanetsErrors, GetCrystalsPlanetsResponses, GetCrystalsRandomData, GetCrystalsRandomErrors, GetCrystalsRandomResponses, GetCrystalsResponses, GetCrystalsSearchData, GetCrystalsSearchErrors, GetCrystalsSearchResponses, GetCrystalsZodiacBySignData, GetCrystalsZodiacBySignErrors, GetCrystalsZodiacBySignResponses, GetDreamsSymbolsByIdData, GetDreamsSymbolsByIdErrors, GetDreamsSymbolsByIdResponses, GetDreamsSymbolsData, GetDreamsSymbolsErrors, GetDreamsSymbolsLettersData, GetDreamsSymbolsLettersErrors, GetDreamsSymbolsLettersResponses, GetDreamsSymbolsRandomData, GetDreamsSymbolsRandomErrors, GetDreamsSymbolsRandomResponses, GetDreamsSymbolsResponses, GetHumanDesignCentersByIdData, GetHumanDesignCentersByIdErrors, GetHumanDesignCentersByIdResponses, GetHumanDesignGatesByNumberData, GetHumanDesignGatesByNumberErrors, GetHumanDesignGatesByNumberResponses, GetIchingCastData, GetIchingCastErrors, GetIchingCastResponses, GetIchingHexagramsByNumberData, GetIchingHexagramsByNumberErrors, GetIchingHexagramsByNumberResponses, GetIchingHexagramsData, GetIchingHexagramsErrors, GetIchingHexagramsLookupData, GetIchingHexagramsLookupErrors, GetIchingHexagramsLookupResponses, GetIchingHexagramsRandomData, GetIchingHexagramsRandomErrors, GetIchingHexagramsRandomResponses, GetIchingHexagramsResponses, GetIchingTrigramsByIdData, GetIchingTrigramsByIdErrors, GetIchingTrigramsByIdResponses, GetIchingTrigramsData, GetIchingTrigramsErrors, GetIchingTrigramsResponses, GetLanguagesData, GetLanguagesErrors, GetLanguagesResponses, GetLocationCountriesByIso2Data, GetLocationCountriesByIso2Errors, GetLocationCountriesByIso2Responses, GetLocationCountriesData, GetLocationCountriesErrors, GetLocationCountriesResponses, GetLocationSearchData, GetLocationSearchErrors, GetLocationSearchResponses, GetNumerologyCompoundNumberByNumberData, GetNumerologyCompoundNumberByNumberErrors, GetNumerologyCompoundNumberByNumberResponses, GetNumerologyMeaningsByNumberData, GetNumerologyMeaningsByNumberErrors, GetNumerologyMeaningsByNumberResponses, GetTarotCardsByIdData, GetTarotCardsByIdErrors, GetTarotCardsByIdResponses, GetTarotCardsData, GetTarotCardsErrors, GetTarotCardsResponses, GetUsageData, GetUsageErrors, GetUsageResponses, GetVedicAstrologyAvasthasByIdData, GetVedicAstrologyAvasthasByIdErrors, GetVedicAstrologyAvasthasByIdResponses, GetVedicAstrologyAvasthasData, GetVedicAstrologyAvasthasErrors, GetVedicAstrologyAvasthasResponses, GetVedicAstrologyKpAyanamsaData, GetVedicAstrologyKpAyanamsaErrors, GetVedicAstrologyKpAyanamsaResponses, GetVedicAstrologyNakshatrasByIdData, GetVedicAstrologyNakshatrasByIdErrors, GetVedicAstrologyNakshatrasByIdResponses, GetVedicAstrologyNakshatrasData, GetVedicAstrologyNakshatrasErrors, GetVedicAstrologyNakshatrasResponses, GetVedicAstrologyRashisByIdData, GetVedicAstrologyRashisByIdErrors, GetVedicAstrologyRashisByIdResponses, GetVedicAstrologyRashisData, GetVedicAstrologyRashisErrors, GetVedicAstrologyRashisResponses, GetVedicAstrologyYogaByIdData, GetVedicAstrologyYogaByIdErrors, GetVedicAstrologyYogaByIdResponses, GetVedicAstrologyYogaData, GetVedicAstrologyYogaErrors, GetVedicAstrologyYogaResponses, PostAngelNumbersDailyData, PostAngelNumbersDailyErrors, PostAngelNumbersDailyResponses, PostAstrologyArabicLotsData, PostAstrologyArabicLotsErrors, PostAstrologyArabicLotsResponses, PostAstrologyAspectPatternsData, PostAstrologyAspectPatternsErrors, PostAstrologyAspectPatternsResponses, PostAstrologyAspectsData, PostAstrologyAspectsErrors, PostAstrologyAspectsResponses, PostAstrologyAsteroidsData, PostAstrologyAsteroidsErrors, PostAstrologyAsteroidsResponses, PostAstrologyAstrocartographyData, PostAstrologyAstrocartographyErrors, PostAstrologyAstrocartographyResponses, PostAstrologyCompatibilityScoreData, PostAstrologyCompatibilityScoreErrors, PostAstrologyCompatibilityScoreResponses, PostAstrologyCompositeChartData, PostAstrologyCompositeChartErrors, PostAstrologyCompositeChartResponses, PostAstrologyFixedStarsData, PostAstrologyFixedStarsErrors, PostAstrologyFixedStarsResponses, PostAstrologyHousesData, PostAstrologyHousesErrors, PostAstrologyHousesResponses, PostAstrologyLilithData, PostAstrologyLilithErrors, PostAstrologyLilithResponses, PostAstrologyLocalSpaceData, PostAstrologyLocalSpaceErrors, PostAstrologyLocalSpaceResponses, PostAstrologyLunarReturnData, PostAstrologyLunarReturnErrors, PostAstrologyLunarReturnResponses, PostAstrologyNatalChartData, PostAstrologyNatalChartErrors, PostAstrologyNatalChartResponses, PostAstrologyPlanetaryReturnsData, PostAstrologyPlanetaryReturnsErrors, PostAstrologyPlanetaryReturnsResponses, PostAstrologyPlanetsData, PostAstrologyPlanetsErrors, PostAstrologyPlanetsResponses, PostAstrologyProfectionsData, PostAstrologyProfectionsErrors, PostAstrologyProfectionsResponses, PostAstrologyProgressionsData, PostAstrologyProgressionsErrors, PostAstrologyProgressionsResponses, PostAstrologyRelocationChartData, PostAstrologyRelocationChartErrors, PostAstrologyRelocationChartResponses, PostAstrologySolarArcData, PostAstrologySolarArcErrors, PostAstrologySolarArcResponses, PostAstrologySolarReturnData, PostAstrologySolarReturnErrors, PostAstrologySolarReturnResponses, PostAstrologySynastryData, PostAstrologySynastryErrors, PostAstrologySynastryResponses, PostAstrologyTransitAspectsData, PostAstrologyTransitAspectsErrors, PostAstrologyTransitAspectsResponses, PostAstrologyTransitsData, PostAstrologyTransitsErrors, PostAstrologyTransitsResponses, PostBiorhythmCompatibilityData, PostBiorhythmCompatibilityErrors, PostBiorhythmCompatibilityResponses, PostBiorhythmCriticalDaysData, PostBiorhythmCriticalDaysErrors, PostBiorhythmCriticalDaysResponses, PostBiorhythmDailyData, PostBiorhythmDailyErrors, PostBiorhythmDailyResponses, PostBiorhythmForecastData, PostBiorhythmForecastErrors, PostBiorhythmForecastResponses, PostBiorhythmPhasesData, PostBiorhythmPhasesErrors, PostBiorhythmPhasesResponses, PostBiorhythmReadingData, PostBiorhythmReadingErrors, PostBiorhythmReadingResponses, PostCrystalsDailyData, PostCrystalsDailyErrors, PostCrystalsDailyResponses, PostDreamsDailyData, PostDreamsDailyErrors, PostDreamsDailyResponses, PostForecastDigestData, PostForecastDigestErrors, PostForecastDigestResponses, PostForecastSignificantDatesData, PostForecastSignificantDatesErrors, PostForecastSignificantDatesResponses, PostForecastSolarReturnData, PostForecastSolarReturnErrors, PostForecastSolarReturnResponses, PostForecastTimelineData, PostForecastTimelineErrors, PostForecastTimelineResponses, PostForecastTransitsData, PostForecastTransitsErrors, PostForecastTransitsResponses, PostHumanDesignBodygraphData, PostHumanDesignBodygraphErrors, PostHumanDesignBodygraphResponses, PostHumanDesignCentersData, PostHumanDesignCentersErrors, PostHumanDesignCentersResponses, PostHumanDesignChannelsData, PostHumanDesignChannelsErrors, PostHumanDesignChannelsResponses, PostHumanDesignConnectionData, PostHumanDesignConnectionErrors, PostHumanDesignConnectionResponses, PostHumanDesignGatesData, PostHumanDesignGatesErrors, PostHumanDesignGatesResponses, PostHumanDesignPentaData, PostHumanDesignPentaErrors, PostHumanDesignPentaResponses, PostHumanDesignProfileData, PostHumanDesignProfileErrors, PostHumanDesignProfileResponses, PostHumanDesignTransitData, PostHumanDesignTransitErrors, PostHumanDesignTransitResponses, PostHumanDesignTypeData, PostHumanDesignTypeErrors, PostHumanDesignTypeResponses, PostHumanDesignVariablesData, PostHumanDesignVariablesErrors, PostHumanDesignVariablesResponses, PostIchingDailyCastData, PostIchingDailyCastErrors, PostIchingDailyCastResponses, PostIchingDailyData, PostIchingDailyErrors, PostIchingDailyResponses, PostNumerologyBirthDayData, PostNumerologyBirthDayErrors, PostNumerologyBirthDayResponses, PostNumerologyBridgeData, PostNumerologyBridgeErrors, PostNumerologyBridgeResponses, PostNumerologyBusinessNameData, PostNumerologyBusinessNameErrors, PostNumerologyBusinessNameResponses, PostNumerologyChaldeanData, PostNumerologyChaldeanErrors, PostNumerologyChaldeanResponses, PostNumerologyChartData, PostNumerologyChartErrors, PostNumerologyChartResponses, PostNumerologyCompatibilityData, PostNumerologyCompatibilityErrors, PostNumerologyCompatibilityResponses, PostNumerologyDailyData, PostNumerologyDailyErrors, PostNumerologyDailyResponses, PostNumerologyDualData, PostNumerologyDualErrors, PostNumerologyDualResponses, PostNumerologyExpressionData, PostNumerologyExpressionErrors, PostNumerologyExpressionResponses, PostNumerologyKarmicDebtData, PostNumerologyKarmicDebtErrors, PostNumerologyKarmicDebtResponses, PostNumerologyKarmicLessonsData, PostNumerologyKarmicLessonsErrors, PostNumerologyKarmicLessonsResponses, PostNumerologyLifePathData, PostNumerologyLifePathErrors, PostNumerologyLifePathResponses, PostNumerologyMaturityData, PostNumerologyMaturityErrors, PostNumerologyMaturityResponses, PostNumerologyPersonalDayData, PostNumerologyPersonalDayErrors, PostNumerologyPersonalDayResponses, PostNumerologyPersonalityData, PostNumerologyPersonalityErrors, PostNumerologyPersonalityResponses, PostNumerologyPersonalMonthData, PostNumerologyPersonalMonthErrors, PostNumerologyPersonalMonthResponses, PostNumerologyPersonalYearData, PostNumerologyPersonalYearErrors, PostNumerologyPersonalYearResponses, PostNumerologySoulUrgeData, PostNumerologySoulUrgeErrors, PostNumerologySoulUrgeResponses, PostTarotDailyData, PostTarotDailyErrors, PostTarotDailyResponses, PostTarotDrawData, PostTarotDrawErrors, PostTarotDrawResponses, PostTarotSpreadsCareerData, PostTarotSpreadsCareerErrors, PostTarotSpreadsCareerResponses, PostTarotSpreadsCelticCrossData, PostTarotSpreadsCelticCrossErrors, PostTarotSpreadsCelticCrossResponses, PostTarotSpreadsCustomData, PostTarotSpreadsCustomErrors, PostTarotSpreadsCustomResponses, PostTarotSpreadsLoveData, PostTarotSpreadsLoveErrors, PostTarotSpreadsLoveResponses, PostTarotSpreadsThreeCardData, PostTarotSpreadsThreeCardErrors, PostTarotSpreadsThreeCardResponses, PostTarotYesNoData, PostTarotYesNoErrors, PostTarotYesNoResponses, PostVedicAstrologyArudhaData, PostVedicAstrologyArudhaErrors, PostVedicAstrologyArudhaResponses, PostVedicAstrologyAshtakavargaData, PostVedicAstrologyAshtakavargaErrors, PostVedicAstrologyAshtakavargaResponses, PostVedicAstrologyAspectsData, PostVedicAstrologyAspectsErrors, PostVedicAstrologyAspectsLunarData, PostVedicAstrologyAspectsLunarErrors, PostVedicAstrologyAspectsLunarResponses, PostVedicAstrologyAspectsMonthlyData, PostVedicAstrologyAspectsMonthlyErrors, PostVedicAstrologyAspectsMonthlyResponses, PostVedicAstrologyAspectsResponses, PostVedicAstrologyBhavaBalaData, PostVedicAstrologyBhavaBalaErrors, PostVedicAstrologyBhavaBalaResponses, PostVedicAstrologyBhavChalitData, PostVedicAstrologyBhavChalitErrors, PostVedicAstrologyBhavChalitResponses, PostVedicAstrologyBirthChartData, PostVedicAstrologyBirthChartErrors, PostVedicAstrologyBirthChartResponses, PostVedicAstrologyCharaKarakasData, PostVedicAstrologyCharaKarakasErrors, PostVedicAstrologyCharaKarakasResponses, PostVedicAstrologyCompatibilityData, PostVedicAstrologyCompatibilityErrors, PostVedicAstrologyCompatibilityResponses, PostVedicAstrologyDashaCurrentData, PostVedicAstrologyDashaCurrentErrors, PostVedicAstrologyDashaCurrentResponses, PostVedicAstrologyDashaMajorData, PostVedicAstrologyDashaMajorErrors, PostVedicAstrologyDashaMajorResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaData, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaErrors, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaData, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaErrors, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaData, PostVedicAstrologyDashaSubByMahadashaByAntardashaErrors, PostVedicAstrologyDashaSubByMahadashaByAntardashaResponses, PostVedicAstrologyDashaSubByMahadashaData, PostVedicAstrologyDashaSubByMahadashaErrors, PostVedicAstrologyDashaSubByMahadashaResponses, PostVedicAstrologyDivisionalChartData, PostVedicAstrologyDivisionalChartErrors, PostVedicAstrologyDivisionalChartResponses, PostVedicAstrologyDoshaKalsarpaData, PostVedicAstrologyDoshaKalsarpaErrors, PostVedicAstrologyDoshaKalsarpaResponses, PostVedicAstrologyDoshaManglikData, PostVedicAstrologyDoshaManglikErrors, PostVedicAstrologyDoshaManglikResponses, PostVedicAstrologyDoshaSadhesatiData, PostVedicAstrologyDoshaSadhesatiErrors, PostVedicAstrologyDoshaSadhesatiResponses, PostVedicAstrologyEclipticCrossingsData, PostVedicAstrologyEclipticCrossingsErrors, PostVedicAstrologyEclipticCrossingsResponses, PostVedicAstrologyHeliacalData, PostVedicAstrologyHeliacalErrors, PostVedicAstrologyHeliacalResponses, PostVedicAstrologyKpChartData, PostVedicAstrologyKpChartErrors, PostVedicAstrologyKpChartResponses, PostVedicAstrologyKpCuspsData, PostVedicAstrologyKpCuspsErrors, PostVedicAstrologyKpCuspsResponses, PostVedicAstrologyKpHoraryData, PostVedicAstrologyKpHoraryErrors, PostVedicAstrologyKpHoraryResponses, PostVedicAstrologyKpPlanetsData, PostVedicAstrologyKpPlanetsErrors, PostVedicAstrologyKpPlanetsIntervalData, PostVedicAstrologyKpPlanetsIntervalErrors, PostVedicAstrologyKpPlanetsIntervalResponses, PostVedicAstrologyKpPlanetsResponses, PostVedicAstrologyKpRasiChangesData, PostVedicAstrologyKpRasiChangesErrors, PostVedicAstrologyKpRasiChangesResponses, PostVedicAstrologyKpRulingPlanetsData, PostVedicAstrologyKpRulingPlanetsErrors, PostVedicAstrologyKpRulingPlanetsIntervalData, PostVedicAstrologyKpRulingPlanetsIntervalErrors, PostVedicAstrologyKpRulingPlanetsIntervalResponses, PostVedicAstrologyKpRulingPlanetsResponses, PostVedicAstrologyKpSublordChangesData, PostVedicAstrologyKpSublordChangesErrors, PostVedicAstrologyKpSublordChangesResponses, PostVedicAstrologyNavamsaData, PostVedicAstrologyNavamsaErrors, PostVedicAstrologyNavamsaResponses, PostVedicAstrologyPanchangBasicData, PostVedicAstrologyPanchangBasicErrors, PostVedicAstrologyPanchangBasicResponses, PostVedicAstrologyPanchangChoghadiyaData, PostVedicAstrologyPanchangChoghadiyaErrors, PostVedicAstrologyPanchangChoghadiyaResponses, PostVedicAstrologyPanchangDetailedData, PostVedicAstrologyPanchangDetailedErrors, PostVedicAstrologyPanchangDetailedResponses, PostVedicAstrologyPanchangHoraData, PostVedicAstrologyPanchangHoraErrors, PostVedicAstrologyPanchangHoraResponses, PostVedicAstrologyParallelsData, PostVedicAstrologyParallelsErrors, PostVedicAstrologyParallelsMonthlyData, PostVedicAstrologyParallelsMonthlyErrors, PostVedicAstrologyParallelsMonthlyResponses, PostVedicAstrologyParallelsResponses, PostVedicAstrologyPlanetaryPositionsData, PostVedicAstrologyPlanetaryPositionsErrors, PostVedicAstrologyPlanetaryPositionsMonthlyData, PostVedicAstrologyPlanetaryPositionsMonthlyErrors, PostVedicAstrologyPlanetaryPositionsMonthlyResponses, PostVedicAstrologyPlanetaryPositionsResponses, PostVedicAstrologyShadbalaData, PostVedicAstrologyShadbalaErrors, PostVedicAstrologyShadbalaResponses, PostVedicAstrologyTransitData, PostVedicAstrologyTransitErrors, PostVedicAstrologyTransitMonthlyData, PostVedicAstrologyTransitMonthlyErrors, PostVedicAstrologyTransitMonthlyResponses, PostVedicAstrologyTransitResponses, PostVedicAstrologyUpagrahaData, PostVedicAstrologyUpagrahaErrors, PostVedicAstrologyUpagrahaResponses, PostVedicAstrologyYogaDetectData, PostVedicAstrologyYogaDetectErrors, PostVedicAstrologyYogaDetectResponses } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -11,7 +11,7 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
11
11
|
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
12
|
* used to access values that aren't defined as part of the SDK function.
|
|
13
13
|
*/
|
|
14
|
-
meta?: Record<string, unknown
|
|
14
|
+
meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
|
|
15
15
|
};
|
|
16
16
|
declare class HeyApiClient {
|
|
17
17
|
protected client: Client;
|
|
@@ -31,199 +31,199 @@ export declare class Astrology extends HeyApiClient {
|
|
|
31
31
|
*
|
|
32
32
|
* Returns all 12 tropical zodiac signs (Aries, Taurus, Gemini, Cancer, Leo, Virgo, Libra, Scorpio, Sagittarius, Capricorn, Aquarius, Pisces) with essential information: name, symbol, element (fire, earth, air, water), date ranges, and short descriptions. Perfect for zodiac sign lists, horoscope widgets, birth chart calculators, astrology apps, star sign selectors, and zodiac reference tools. Use GET /signs/{id} for complete zodiac sign profiles with personality traits, compatibility, and detailed characteristics.
|
|
33
33
|
*/
|
|
34
|
-
listZodiacSigns<ThrowOnError extends boolean = false>(options?: Options<GetAstrologySignsData, ThrowOnError>):
|
|
34
|
+
listZodiacSigns<ThrowOnError extends boolean = false>(options?: Options<GetAstrologySignsData, ThrowOnError>): RequestResult<GetAstrologySignsResponses, GetAstrologySignsErrors, ThrowOnError>;
|
|
35
35
|
/**
|
|
36
36
|
* Get zodiac sign details - Complete astrology sign profile with personality traits
|
|
37
37
|
*
|
|
38
38
|
* Retrieve comprehensive zodiac sign information for any astrological sign using lowercase ID (e.g., "aries") or case-insensitive name (e.g., "Aries", "ARIES"). Returns complete astrology profile including: element (fire, earth, air, water), modality (cardinal, fixed, mutable), ruling planet, birth date ranges, personality traits (positive, negative, keywords), zodiac sign descriptions, famous people with this sign, key strengths and qualities, sign motto, greatest gifts, challenges, and secret weapon. Perfect for horoscope readings, zodiac compatibility checks, birth chart interpretations, astrology blogs, star sign personality analysis, and zodiac meaning databases.
|
|
39
39
|
*/
|
|
40
|
-
getZodiacSign<ThrowOnError extends boolean = false>(options: Options<GetAstrologySignsByIdData, ThrowOnError>):
|
|
40
|
+
getZodiacSign<ThrowOnError extends boolean = false>(options: Options<GetAstrologySignsByIdData, ThrowOnError>): RequestResult<GetAstrologySignsByIdResponses, GetAstrologySignsByIdErrors, ThrowOnError>;
|
|
41
41
|
/**
|
|
42
42
|
* Get all planet meanings - Complete astrology planet interpretations list
|
|
43
43
|
*
|
|
44
44
|
* Returns all 14 astrological bodies (the 10 classical planets Sun through Pluto, the lunar nodes, Chiron, and Black Moon Lilith) with essential meanings: name, symbol, tagline, category (personal/social/generational), ruling sign, and short descriptions. Perfect for astrology reference apps, planet meaning widgets, birth chart interpretation tools, astrology learning platforms, planetary keywords reference, and zodiac planet guides. Use GET /planet-meanings/{id} for complete profiles with detailed interpretations, keywords, temperature, and dignities (rulership/detriment/exaltation/fall).
|
|
45
45
|
*/
|
|
46
|
-
listPlanetMeanings<ThrowOnError extends boolean = false>(options?: Options<GetAstrologyPlanetMeaningsData, ThrowOnError>):
|
|
46
|
+
listPlanetMeanings<ThrowOnError extends boolean = false>(options?: Options<GetAstrologyPlanetMeaningsData, ThrowOnError>): RequestResult<GetAstrologyPlanetMeaningsResponses, GetAstrologyPlanetMeaningsErrors, ThrowOnError>;
|
|
47
47
|
/**
|
|
48
48
|
* Get planet meaning details - Complete astrology planet interpretation
|
|
49
49
|
*
|
|
50
50
|
* Retrieve comprehensive planet interpretation for any astrological planet using lowercase ID (e.g., "sun", "moon") or case-insensitive name (e.g., "Sun", "MOON"). Returns complete astrology meaning including: symbol, tagline, category (personal/social/generational), temperature, orbital period, retrograde status, dignities (rulership/detriment/exaltation/fall), positive and negative keywords, and short/long descriptions. Perfect for birth chart readings, planet meaning lookups, astrology education, natal chart interpretation, transit meanings, planetary symbolism reference, and keyword-based interpretations.
|
|
51
51
|
*/
|
|
52
|
-
getPlanetMeaning<ThrowOnError extends boolean = false>(options: Options<GetAstrologyPlanetMeaningsByIdData, ThrowOnError>):
|
|
52
|
+
getPlanetMeaning<ThrowOnError extends boolean = false>(options: Options<GetAstrologyPlanetMeaningsByIdData, ThrowOnError>): RequestResult<GetAstrologyPlanetMeaningsByIdResponses, GetAstrologyPlanetMeaningsByIdErrors, ThrowOnError>;
|
|
53
53
|
/**
|
|
54
54
|
* Generate natal chart - Birth chart calculator API with houses and aspects
|
|
55
55
|
*
|
|
56
56
|
* Calculate complete Western astrology natal chart (birth chart) with tropical zodiac. Returns all 14 celestial bodies (the 10 classical planets Sun through Pluto, the lunar nodes, Chiron, and Black Moon Lilith), 12 house cusps with customizable house systems (Placidus, Whole Sign, Equal, Koch), major and minor aspects, Ascendant, Midheaven, dominant elements and modalities. Perfect for astrology apps, birth chart generators, horoscope websites, and astrological consultation tools. Verified against NASA JPL Horizons.
|
|
57
57
|
*/
|
|
58
|
-
generateNatalChart<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyNatalChartData, ThrowOnError>):
|
|
58
|
+
generateNatalChart<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyNatalChartData, ThrowOnError>): RequestResult<PostAstrologyNatalChartResponses, PostAstrologyNatalChartErrors, ThrowOnError>;
|
|
59
59
|
/**
|
|
60
60
|
* Get planetary positions - Ephemeris calculator for all planets
|
|
61
61
|
*
|
|
62
62
|
* Calculate accurate tropical zodiac positions for all 14 celestial bodies (the 10 classical planets Sun through Pluto, the lunar nodes, Chiron, and Black Moon Lilith) for any date, time, and location. Returns longitude, latitude, zodiac sign, degree within sign, daily motion speed, and retrograde status. Perfect for transit tracking, ephemeris tables, astrology apps, and planetary position widgets. Verified against NASA JPL Horizons.
|
|
63
63
|
*/
|
|
64
|
-
getPlanetaryPositions<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyPlanetsData, ThrowOnError>):
|
|
64
|
+
getPlanetaryPositions<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyPlanetsData, ThrowOnError>): RequestResult<PostAstrologyPlanetsResponses, PostAstrologyPlanetsErrors, ThrowOnError>;
|
|
65
65
|
/**
|
|
66
66
|
* Get current moon phase - Lunar phase calculator with zodiac sign
|
|
67
67
|
*
|
|
68
68
|
* Get current moon phase with illumination percentage, lunar age (days since new moon), zodiac sign, and distance from Earth. Returns phase name (New Moon, Waxing Crescent Moon, First Quarter Moon, Waxing Gibbous Moon, Full Moon, Waning Gibbous Moon, Last Quarter Moon, Waning Crescent Moon) plus exact lunar position. Perfect for moon tracking apps, lunar calendars, astrology widgets, and gardening by moon phase tools.
|
|
69
69
|
*/
|
|
70
|
-
getCurrentMoonPhase<ThrowOnError extends boolean = false>(options?: Options<GetAstrologyMoonPhaseCurrentData, ThrowOnError>):
|
|
70
|
+
getCurrentMoonPhase<ThrowOnError extends boolean = false>(options?: Options<GetAstrologyMoonPhaseCurrentData, ThrowOnError>): RequestResult<GetAstrologyMoonPhaseCurrentResponses, GetAstrologyMoonPhaseCurrentErrors, ThrowOnError>;
|
|
71
71
|
/**
|
|
72
72
|
* Get upcoming moon phases - Next new moon, full moon, quarters
|
|
73
73
|
*
|
|
74
74
|
* Get upcoming moon phase transitions (New Moon, First Quarter, Full Moon, Last Quarter) for the next weeks/months. Returns dates and phase names for each lunar quarter. Perfect for lunar event calendars, moon phase widgets, and astrology planning tools.
|
|
75
75
|
*/
|
|
76
|
-
getUpcomingMoonPhases<ThrowOnError extends boolean = false>(options?: Options<GetAstrologyMoonPhaseUpcomingData, ThrowOnError>):
|
|
76
|
+
getUpcomingMoonPhases<ThrowOnError extends boolean = false>(options?: Options<GetAstrologyMoonPhaseUpcomingData, ThrowOnError>): RequestResult<GetAstrologyMoonPhaseUpcomingResponses, GetAstrologyMoonPhaseUpcomingErrors, ThrowOnError>;
|
|
77
77
|
/**
|
|
78
78
|
* Get lunar calendar - Moon phases for entire month
|
|
79
79
|
*
|
|
80
80
|
* Get complete lunar calendar showing moon phase and illumination for every day of a specific month. Perfect for creating moon phase calendars, lunar planners, and astrology event schedules.
|
|
81
81
|
*/
|
|
82
|
-
getMoonCalendar<ThrowOnError extends boolean = false>(options: Options<GetAstrologyMoonPhaseCalendarByYearByMonthData, ThrowOnError>):
|
|
82
|
+
getMoonCalendar<ThrowOnError extends boolean = false>(options: Options<GetAstrologyMoonPhaseCalendarByYearByMonthData, ThrowOnError>): RequestResult<GetAstrologyMoonPhaseCalendarByYearByMonthResponses, GetAstrologyMoonPhaseCalendarByYearByMonthErrors, ThrowOnError>;
|
|
83
83
|
/**
|
|
84
84
|
* Calculate synastry - Relationship compatibility analysis API
|
|
85
85
|
*
|
|
86
86
|
* Calculate complete synastry (relationship compatibility) between two natal charts using Western tropical astrology. Analyzes inter-chart aspects between all planets to determine romantic, friendship, and karmic compatibility. Returns compatibility score (0-100), detailed inter-aspects with strength ratings, harmonious vs challenging aspect counts, and relationship dynamics analysis. Perfect for dating apps, matrimonial sites, relationship counseling tools, and astrology compatibility features. Based on professional astrological techniques.
|
|
87
87
|
*/
|
|
88
|
-
calculateSynastry<ThrowOnError extends boolean = false>(options?: Options<PostAstrologySynastryData, ThrowOnError>):
|
|
88
|
+
calculateSynastry<ThrowOnError extends boolean = false>(options?: Options<PostAstrologySynastryData, ThrowOnError>): RequestResult<PostAstrologySynastryResponses, PostAstrologySynastryErrors, ThrowOnError>;
|
|
89
89
|
/**
|
|
90
90
|
* Calculate house cusps - House system calculator with comparison
|
|
91
91
|
*
|
|
92
92
|
* Calculate astrological house cusps using Placidus, Whole Sign, Equal, or Koch house systems. Returns all 12 house cusps with zodiac signs, degrees, Ascendant, and Midheaven. Use "all" parameter to compare all 4 house systems side-by-side. Perfect for astrology charts, house cusp tables, and educational tools showing house system differences. Includes accurate Ascendant and MC calculations.
|
|
93
93
|
*/
|
|
94
|
-
calculateHouses<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyHousesData, ThrowOnError>):
|
|
94
|
+
calculateHouses<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyHousesData, ThrowOnError>): RequestResult<PostAstrologyHousesResponses, PostAstrologyHousesErrors, ThrowOnError>;
|
|
95
95
|
/**
|
|
96
96
|
* Calculate planetary aspects - Aspect finder for any date and time
|
|
97
97
|
*
|
|
98
98
|
* Calculate all major and minor aspects between planets for any date and time. Finds conjunctions (0°), oppositions (180°), trines (120°), squares (90°), sextiles (60°), and minor aspects. Returns aspect type, exact angle, orb, applying/separating status, and strength (0-100). Filter by specific planets or aspect types. Perfect for aspect tables, transit analysis, and aspect pattern detection. Uses standard Western astrology orbs.
|
|
99
99
|
*/
|
|
100
|
-
calculateAspects<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAspectsData, ThrowOnError>):
|
|
100
|
+
calculateAspects<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAspectsData, ThrowOnError>): RequestResult<PostAstrologyAspectsResponses, PostAstrologyAspectsErrors, ThrowOnError>;
|
|
101
101
|
/**
|
|
102
102
|
* Detect aspect patterns - Grand Trine, Kite, T-Square, Grand Cross, Yod, Mystic Rectangle, Stellium
|
|
103
103
|
*
|
|
104
104
|
* Identify classical Western astrology multi-planet configurations in a birth chart. Returns Grand Trines (with element), Kites (with apex), T-Squares (with apex and modality), Grand Crosses (with modality), Yods (Finger of Fate, with apex), Mystic Rectangles, and Stelliums. Each pattern carries a tightness score (0-100), dissociate flag for out-of-sign configurations, and a one-line interpretation suitable for chart reports. Disambiguation is built in: a Grand Cross suppresses its contained T-Squares, a Kite suppresses its underlying Grand Trine. Useful for personalized natal report engines, astrology chatbots, AI agents that interpret chart geometry, and editorial chart-pattern callouts.
|
|
105
105
|
*/
|
|
106
|
-
detectAspectPatterns<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAspectPatternsData, ThrowOnError>):
|
|
106
|
+
detectAspectPatterns<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAspectPatternsData, ThrowOnError>): RequestResult<PostAstrologyAspectPatternsResponses, PostAstrologyAspectPatternsErrors, ThrowOnError>;
|
|
107
107
|
/**
|
|
108
108
|
* Calculate planetary transits - Current transits with natal chart comparison
|
|
109
109
|
*
|
|
110
110
|
* Calculate current or future planetary transits (positions of all bodies now). Optionally compare transits to natal chart to find transit-to-natal aspects. Returns all 14 celestial bodies (the 10 classical planets, the lunar nodes, Chiron, and Black Moon Lilith) with signs, degrees, and speeds. When natal chart provided, includes transit aspects (transiting Sun conjunct natal Mars, etc.) with orbs and applying/separating status. Perfect for daily transit forecasts, aspect alerts, and personalized transit reports.
|
|
111
111
|
*/
|
|
112
|
-
calculateTransits<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyTransitsData, ThrowOnError>):
|
|
112
|
+
calculateTransits<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyTransitsData, ThrowOnError>): RequestResult<PostAstrologyTransitsResponses, PostAstrologyTransitsErrors, ThrowOnError>;
|
|
113
113
|
/**
|
|
114
114
|
* Transit Aspects - Detailed transit-to-natal aspect analysis with interpretations
|
|
115
115
|
*
|
|
116
116
|
* Calculate all transit-to-natal aspects with detailed interpretations, strength ratings, and timing guidance. Compares current (or future) planetary positions against your natal chart to identify active transits. Returns aspect type, orb, applying/separating status, narrative interpretation, impact rating, and practical guidance for each transit. Supports planet and aspect-type filtering. More detailed than the /transits endpoint — includes AI-friendly interpretation fields. Transit aspects API, transit-to-natal analysis, predictive astrology, personalized transit forecast.
|
|
117
117
|
*/
|
|
118
|
-
calculateTransitAspects<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyTransitAspectsData, ThrowOnError>):
|
|
118
|
+
calculateTransitAspects<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyTransitAspectsData, ThrowOnError>): RequestResult<PostAstrologyTransitAspectsResponses, PostAstrologyTransitAspectsErrors, ThrowOnError>;
|
|
119
119
|
/**
|
|
120
120
|
* Solar Return Chart - Annual birthday forecast with relocated chart
|
|
121
121
|
*
|
|
122
122
|
* Generate a solar return chart for any year, the foundational technique for annual astrological forecasting. The chart is cast for the exact moment the transiting Sun returns to its natal ecliptic longitude (your astrological birthday). Returns full tropical zodiac chart with planetary positions, house cusps, aspects, Ascendant, and Midheaven. Location-sensitive: relocating your solar return chart to a different city changes the houses and Ascendant. Solar return chart API, annual horoscope forecast, birthday chart calculator, yearly astrology prediction, relocated solar return.
|
|
123
123
|
*/
|
|
124
|
-
generateSolarReturn<ThrowOnError extends boolean = false>(options?: Options<PostAstrologySolarReturnData, ThrowOnError>):
|
|
124
|
+
generateSolarReturn<ThrowOnError extends boolean = false>(options?: Options<PostAstrologySolarReturnData, ThrowOnError>): RequestResult<PostAstrologySolarReturnResponses, PostAstrologySolarReturnErrors, ThrowOnError>;
|
|
125
125
|
/**
|
|
126
126
|
* Lunar Return Chart - Monthly emotional forecast with Moon cycle chart
|
|
127
127
|
*
|
|
128
128
|
* Generate a lunar return chart for any month, cast for the exact moment the transiting Moon returns to its natal ecliptic longitude. The Moon completes one sidereal orbit every ~27.3 days, making this the primary technique for monthly astrological forecasting. Returns full tropical zodiac chart with planetary positions, house cusps, aspects, Ascendant, and Midheaven. Reveals emotional patterns, domestic focus, and intuitive themes for the coming month. Lunar return chart API, monthly horoscope forecast, Moon cycle chart, emotional astrology prediction.
|
|
129
129
|
*/
|
|
130
|
-
generateLunarReturn<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyLunarReturnData, ThrowOnError>):
|
|
130
|
+
generateLunarReturn<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyLunarReturnData, ThrowOnError>): RequestResult<PostAstrologyLunarReturnResponses, PostAstrologyLunarReturnErrors, ThrowOnError>;
|
|
131
131
|
/**
|
|
132
132
|
* Composite Chart - Midpoint relationship chart with interpretations
|
|
133
133
|
*
|
|
134
134
|
* Generate a composite chart by calculating midpoints between two natal charts. The composite chart represents the relationship as a single entity, showing its core identity, emotional bond, communication style, and growth direction. Returns composite planetary positions, house cusps, Ascendant, Midheaven, aspects, and relationship interpretation. Composite chart API, midpoint chart calculator, relationship astrology, couple chart analysis.
|
|
135
135
|
*/
|
|
136
|
-
generateCompositeChart<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyCompositeChartData, ThrowOnError>):
|
|
136
|
+
generateCompositeChart<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyCompositeChartData, ThrowOnError>): RequestResult<PostAstrologyCompositeChartResponses, PostAstrologyCompositeChartErrors, ThrowOnError>;
|
|
137
137
|
/**
|
|
138
138
|
* Compatibility Score. Relationship compatibility analysis with category breakdown
|
|
139
139
|
*
|
|
140
140
|
* Calculate a detailed compatibility score between two birth charts using Western synastry (inter-chart aspects). Returns overall score (0-100) plus category breakdowns for romantic, emotional, intellectual, physical, and spiritual compatibility. Each category analyzes specific planetary pairs: Venus-Mars for romance, Moon-Moon for emotions, Mercury-Mercury for intellect. Includes Sun, Moon, Venus, and Mars sign compatibility narratives, element balance analysis, relationship archetype classification, and the most significant inter-chart aspects with relationship-specific interpretations.
|
|
141
141
|
*/
|
|
142
|
-
calculateCompatibility<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyCompatibilityScoreData, ThrowOnError>):
|
|
142
|
+
calculateCompatibility<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyCompatibilityScoreData, ThrowOnError>): RequestResult<PostAstrologyCompatibilityScoreResponses, PostAstrologyCompatibilityScoreErrors, ThrowOnError>;
|
|
143
143
|
/**
|
|
144
144
|
* Daily horoscope by zodiac sign - Transit-based forecast with house activations
|
|
145
145
|
*
|
|
146
146
|
* Get the daily horoscope for any zodiac sign. Forecast is generated from real-time planetary transits using whole-sign house positions, so every sign receives unique content. Returns love, career, health, finance, overview with active transits, Moon sign, Moon phase, energy rating, lucky number, lucky color, and compatible signs. Content is fixed for a given date and rolls over at midnight, by default UTC. Pass date for editorial scheduling, or timezone to roll over on a local clock. Daily horoscope API, zodiac forecast, sun sign horoscope, astrology prediction.
|
|
147
147
|
*/
|
|
148
|
-
getDailyHoroscope<ThrowOnError extends boolean = false>(options: Options<GetAstrologyHoroscopeBySignDailyData, ThrowOnError>):
|
|
148
|
+
getDailyHoroscope<ThrowOnError extends boolean = false>(options: Options<GetAstrologyHoroscopeBySignDailyData, ThrowOnError>): RequestResult<GetAstrologyHoroscopeBySignDailyResponses, GetAstrologyHoroscopeBySignDailyErrors, ThrowOnError>;
|
|
149
149
|
/**
|
|
150
150
|
* Weekly horoscope by zodiac sign - 7-day transit forecast
|
|
151
151
|
*
|
|
152
152
|
* Get weekly horoscope for any zodiac sign. Forecast covers a full Monday to Sunday period based on planetary transits with house-based content unique to each sign, with love, career, health, finance guidance plus lucky days, lucky numbers, and compatible signs. Pass any date inside a week to retrieve that week, or timezone to roll over on a local clock. Weekly horoscope API, zodiac weekly forecast, astrology weekly prediction.
|
|
153
153
|
*/
|
|
154
|
-
getWeeklyHoroscope<ThrowOnError extends boolean = false>(options: Options<GetAstrologyHoroscopeBySignWeeklyData, ThrowOnError>):
|
|
154
|
+
getWeeklyHoroscope<ThrowOnError extends boolean = false>(options: Options<GetAstrologyHoroscopeBySignWeeklyData, ThrowOnError>): RequestResult<GetAstrologyHoroscopeBySignWeeklyResponses, GetAstrologyHoroscopeBySignWeeklyErrors, ThrowOnError>;
|
|
155
155
|
/**
|
|
156
156
|
* Monthly horoscope by zodiac sign - 30-day transit forecast with key dates
|
|
157
157
|
*
|
|
158
158
|
* Get monthly horoscope for any zodiac sign with sign-specific week-by-week breakdown and real lunar phase key dates. Based on planetary transits with house activations unique to each sign, covering love, career, health, and finance for the entire month. Key dates include actual New Moon, Full Moon, and retrograde dates from ephemeris calculations. Pass any date inside a month to retrieve that month, or timezone to roll over on a local clock. Monthly horoscope API, zodiac monthly forecast, astrology monthly prediction.
|
|
159
159
|
*/
|
|
160
|
-
getMonthlyHoroscope<ThrowOnError extends boolean = false>(options: Options<GetAstrologyHoroscopeBySignMonthlyData, ThrowOnError>):
|
|
160
|
+
getMonthlyHoroscope<ThrowOnError extends boolean = false>(options: Options<GetAstrologyHoroscopeBySignMonthlyData, ThrowOnError>): RequestResult<GetAstrologyHoroscopeBySignMonthlyResponses, GetAstrologyHoroscopeBySignMonthlyErrors, ThrowOnError>;
|
|
161
161
|
/**
|
|
162
162
|
* Planetary Return Chart - Saturn return, Jupiter return, and inner planet cycles
|
|
163
163
|
*
|
|
164
164
|
* Generate a planetary return chart for Mercury, Venus, Mars, Jupiter, or Saturn. A planetary return occurs when a transiting planet conjuncts its natal longitude, marking the beginning of a new cycle. Saturn return (~29 years) is the most significant life milestone in Western astrology. Jupiter return (~12 years) signals expansion and growth phases. Mars return (~2 years) resets energy and drive. Returns full tropical zodiac chart with all planetary positions, house cusps, and aspects. Planetary return chart API, Saturn return calculator, Jupiter return chart, Mars return forecast.
|
|
165
165
|
*/
|
|
166
|
-
generatePlanetaryReturn<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyPlanetaryReturnsData, ThrowOnError>):
|
|
166
|
+
generatePlanetaryReturn<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyPlanetaryReturnsData, ThrowOnError>): RequestResult<PostAstrologyPlanetaryReturnsResponses, PostAstrologyPlanetaryReturnsErrors, ThrowOnError>;
|
|
167
167
|
/**
|
|
168
168
|
* Astrocartography map - planetary lines and relocation calculator
|
|
169
169
|
*
|
|
170
170
|
* Generate an astrocartography map of Midheaven, Imum Coeli, Ascendant, and Descendant planetary lines for any birth moment. Each line marks where a planet turns angular across the world, the core of relocation astrology and astro mapping. Returns right ascension, declination, the two meridian line longitudes, and sampled rising and setting curves ready to plot, with a short interpretation per line.
|
|
171
171
|
*/
|
|
172
|
-
generateAstrocartography<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAstrocartographyData, ThrowOnError>):
|
|
172
|
+
generateAstrocartography<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAstrocartographyData, ThrowOnError>): RequestResult<PostAstrologyAstrocartographyResponses, PostAstrologyAstrocartographyErrors, ThrowOnError>;
|
|
173
173
|
/**
|
|
174
174
|
* Generate relocation chart - Relocated birth chart calculator with shifted houses and angles
|
|
175
175
|
*
|
|
176
176
|
* Calculate a relocation chart (relocated birth chart) for a new place on Earth. The birth moment stays the same, so every planet keeps its natal sign and degree, while the Ascendant, Midheaven, Vertex, and all twelve house cusps are recomputed for the new latitude and longitude. Returns the relocated houses and angles, the planets that change house, the angular planets activated at the new place, and the distance and compass direction from the birthplace. Built for relocation astrology readings, astrocartography style move planning, and travel charts. Verified against NASA JPL Horizons.
|
|
177
177
|
*/
|
|
178
|
-
generateRelocationChart<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyRelocationChartData, ThrowOnError>):
|
|
178
|
+
generateRelocationChart<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyRelocationChartData, ThrowOnError>): RequestResult<PostAstrologyRelocationChartResponses, PostAstrologyRelocationChartErrors, ThrowOnError>;
|
|
179
179
|
/**
|
|
180
180
|
* Local space astrology map - Directional planetary compass lines
|
|
181
181
|
*
|
|
182
182
|
* Generate a local space astrology map that projects the natal planets onto the local horizon as compass directions and great-circle lines radiating from the birthplace. Returns each body azimuth (degrees clockwise from true north), altitude, 16-point compass direction, whether it sits above the horizon, and the latitude and longitude waypoints of its directional line. Ideal for relocation planning, directional astrology, and travel-direction maps.
|
|
183
183
|
*/
|
|
184
|
-
generateLocalSpace<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyLocalSpaceData, ThrowOnError>):
|
|
184
|
+
generateLocalSpace<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyLocalSpaceData, ThrowOnError>): RequestResult<PostAstrologyLocalSpaceResponses, PostAstrologyLocalSpaceErrors, ThrowOnError>;
|
|
185
185
|
/**
|
|
186
186
|
* Fixed stars and star conjunctions calculator - Regulus, Spica, Algol natal report
|
|
187
187
|
*
|
|
188
188
|
* Calculate the tropical zodiac positions of the major named fixed stars for any birth moment, including the four Royal stars and the fifteen Behenian stars, then detect conjunctions to the natal planets, Ascendant, and Midheaven. Each star returns its precessed ecliptic longitude, zodiac sign, visual magnitude, and traditional planetary nature, with a plain language interpretation for every conjunction inside the chosen orb. A focused tool for natal reports that weigh Regulus, Spica, Aldebaran, Antares, and Algol against the chart.
|
|
189
189
|
*/
|
|
190
|
-
generateFixedStars<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyFixedStarsData, ThrowOnError>):
|
|
190
|
+
generateFixedStars<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyFixedStarsData, ThrowOnError>): RequestResult<PostAstrologyFixedStarsResponses, PostAstrologyFixedStarsErrors, ThrowOnError>;
|
|
191
191
|
/**
|
|
192
192
|
* Arabic lots calculator - seven Hermetic parts including Part of Fortune and Spirit
|
|
193
193
|
*
|
|
194
194
|
* Calculate the seven Hermetic lots (Arabic parts) for any birth moment: Part of Fortune, Part of Spirit, Eros, Necessity, Courage, Victory, and Nemesis. Each lot is a sensitive point projected by arc from the Ascendant, with the day or night formula applied automatically from the chart sect. Returns the zodiac sign, degree, exact longitude, the arc used, and a plain language interpretation per lot, for Hellenistic and traditional astrology apps. Built on accurate tropical chart positions, no astronomy expertise needed.
|
|
195
195
|
*/
|
|
196
|
-
calculateArabicLots<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyArabicLotsData, ThrowOnError>):
|
|
196
|
+
calculateArabicLots<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyArabicLotsData, ThrowOnError>): RequestResult<PostAstrologyArabicLotsResponses, PostAstrologyArabicLotsErrors, ThrowOnError>;
|
|
197
197
|
/**
|
|
198
198
|
* Asteroid goddesses calculator - Ceres, Pallas, Juno, and Vesta natal positions
|
|
199
199
|
*
|
|
200
200
|
* Calculate the natal positions of the four classical asteroid goddesses, Ceres, Pallas, Juno, and Vesta, for any birth moment. Each asteroid returns its tropical zodiac sign, degree, house placement, daily speed, retrograde status, and a plain language interpretation of its meaning in the chart. Chiron is available through the natal chart endpoint, so this endpoint stays focused on the four asteroid goddesses for natal reports and relationship astrology.
|
|
201
201
|
*/
|
|
202
|
-
generateAsteroids<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAsteroidsData, ThrowOnError>):
|
|
202
|
+
generateAsteroids<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyAsteroidsData, ThrowOnError>): RequestResult<PostAstrologyAsteroidsResponses, PostAstrologyAsteroidsErrors, ThrowOnError>;
|
|
203
203
|
/**
|
|
204
204
|
* Black Moon Lilith calculator - mean and true lunar apogee in the natal chart
|
|
205
205
|
*
|
|
206
206
|
* Calculate Black Moon Lilith for any birth chart, both the mean lunar apogee, the steady and most widely used point, and the true or osculating apogee, the exact position that can shift sign and turn retrograde. Returns the zodiac sign, degree, house, ecliptic longitude and latitude, daily speed, retrograde flag, and a plain language interpretation for each variant. Built for natal astrology apps and AI agents exploring the wild, suppressed, and reclaimed self that Lilith represents.
|
|
207
207
|
*/
|
|
208
|
-
generateLilith<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyLilithData, ThrowOnError>):
|
|
208
|
+
generateLilith<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyLilithData, ThrowOnError>): RequestResult<PostAstrologyLilithResponses, PostAstrologyLilithErrors, ThrowOnError>;
|
|
209
209
|
/**
|
|
210
210
|
* Secondary progressions calculator - progressed chart, progressed Sun and Moon
|
|
211
211
|
*
|
|
212
212
|
* Generate the secondary progressed chart for any date using the day-for-a-year key, where each day of ephemeris motion after birth stands in for one year of life. Returns every progressed body with its sign, degree, whole-sign house, motion, and retrograde state, plus the progressed Ascendant and Midheaven via the Naibod arc. The progressed Sun and progressed Moon are the headline timing markers for inner growth and emotional chapters. Secondary progressions API, progressed chart calculator, progressed Sun and Moon, progressed Ascendant and Midheaven.
|
|
213
213
|
*/
|
|
214
|
-
generateProgressions<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyProgressionsData, ThrowOnError>):
|
|
214
|
+
generateProgressions<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyProgressionsData, ThrowOnError>): RequestResult<PostAstrologyProgressionsResponses, PostAstrologyProgressionsErrors, ThrowOnError>;
|
|
215
215
|
/**
|
|
216
216
|
* Solar arc directions calculator - directed chart at one degree per year
|
|
217
217
|
*
|
|
218
218
|
* Calculate a solar arc directed chart for any birth moment and target date. The solar arc is the secondary-progressed Sun longitude minus the natal Sun longitude, about one degree for each year of life, and every natal point including the Ascendant and Midheaven is advanced forward by that same arc. Returns the solar arc, each directed point with its natal and directed longitude, zodiac sign, degree, and a plain language interpretation, for predictive astrology apps timing major life events. Built on accurate tropical chart positions, no astronomy expertise needed.
|
|
219
219
|
*/
|
|
220
|
-
generateSolarArc<ThrowOnError extends boolean = false>(options?: Options<PostAstrologySolarArcData, ThrowOnError>):
|
|
220
|
+
generateSolarArc<ThrowOnError extends boolean = false>(options?: Options<PostAstrologySolarArcData, ThrowOnError>): RequestResult<PostAstrologySolarArcResponses, PostAstrologySolarArcErrors, ThrowOnError>;
|
|
221
221
|
/**
|
|
222
222
|
* Annual profections calculator - lord of the year and yearly time lord by age
|
|
223
223
|
*
|
|
224
224
|
* Calculate the annual profection and lord of the year for any birth chart and target date using the Hellenistic time lord technique. Each completed year of life advances the rising sign by one whole sign house, activating a new profected house, profected sign, and ruling planet that sets the tone of the year. Returns the age, profected house and sign, the lord of the year with its natal sign and house placement, and a plain language interpretation for traditional and Hellenistic astrology apps.
|
|
225
225
|
*/
|
|
226
|
-
generateProfections<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyProfectionsData, ThrowOnError>):
|
|
226
|
+
generateProfections<ThrowOnError extends boolean = false>(options?: Options<PostAstrologyProfectionsData, ThrowOnError>): RequestResult<PostAstrologyProfectionsResponses, PostAstrologyProfectionsErrors, ThrowOnError>;
|
|
227
227
|
}
|
|
228
228
|
export declare class VedicAstrology extends HeyApiClient {
|
|
229
229
|
/**
|
|
@@ -231,301 +231,325 @@ export declare class VedicAstrology extends HeyApiClient {
|
|
|
231
231
|
*
|
|
232
232
|
* Calculate complete Vedic birth chart (Janam Kundli, natal chart) with all 9 planetary positions (Sun through Ketu) plus Ascendant (Lagna). Kundli calculator API for astrology apps, matrimonial sites. Returns accurate graha positions grouped by zodiac signs (rashis) with nakshatra details and pada. Perfect for kundli generation, horoscope matching, and Vedic astrology software integration.
|
|
233
233
|
*/
|
|
234
|
-
generateBirthChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyBirthChartData, ThrowOnError>):
|
|
234
|
+
generateBirthChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyBirthChartData, ThrowOnError>): RequestResult<PostVedicAstrologyBirthChartResponses, PostVedicAstrologyBirthChartErrors, ThrowOnError>;
|
|
235
235
|
/**
|
|
236
236
|
* Get Navamsa chart (D9) - Marriage Compatibility Calculator
|
|
237
237
|
*
|
|
238
238
|
* Calculate Navamsa (D9 divisional chart) for marriage compatibility analysis, spouse prediction, and spiritual life assessment. Navamsa calculator API reveals planetary strength in married life. Each planetary position is divided into 9 parts for accurate marriage astrology. Detects Vargottama planets (exalted status). Essential for matrimonial matching, relationship prediction, and marital harmony analysis in Vedic astrology.
|
|
239
239
|
*/
|
|
240
|
-
generateNavamsa<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyNavamsaData, ThrowOnError>):
|
|
240
|
+
generateNavamsa<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyNavamsaData, ThrowOnError>): RequestResult<PostVedicAstrologyNavamsaResponses, PostVedicAstrologyNavamsaErrors, ThrowOnError>;
|
|
241
241
|
/**
|
|
242
242
|
* Get divisional chart (Varga) - D2 to D60 Calculator
|
|
243
243
|
*
|
|
244
244
|
* Calculate any Vedic divisional chart (Varga) from D2 Hora to D60 Shashtiamsa. Divisional charts divide each zodiac sign into smaller segments to reveal detailed insights about specific life areas: wealth (D2), siblings (D3), property (D4), children (D7), marriage (D9), career (D10), parents (D12), vehicles (D16), spirituality (D20), education (D24), strength (D27), misfortunes (D30), merit (D40), character (D45), and past life karma (D60). Based on Brihat Parashara Hora Shastra (BPHS) Shodasha Varga system. Detects Vargottama planets (same sign in D1 and selected chart).
|
|
245
245
|
*/
|
|
246
|
-
generateDivisionalChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDivisionalChartData, ThrowOnError>):
|
|
246
|
+
generateDivisionalChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDivisionalChartData, ThrowOnError>): RequestResult<PostVedicAstrologyDivisionalChartResponses, PostVedicAstrologyDivisionalChartErrors, ThrowOnError>;
|
|
247
247
|
/**
|
|
248
248
|
* Calculate compatibility score - Gun Milan API (Ashtakoot Matching)
|
|
249
249
|
*
|
|
250
250
|
* Calculate detailed Ashtakoot compatibility (Gun Milan) for kundli matching between two people. Returns accurate 36-point Guna Milan scale with breakdown across all 8 kootas (Varna, Vashya, Tara, Yoni, Graha Maitri, Gana, Bhakoot, Nadi), Nadi and Bhakoot dosha detection with classical cancellation analysis per Muhurta Martanda and BPHS rules, and marriage recommendation. Perfect for kundli matching for marriage, matrimonial platforms, horoscope compatibility, and Vedic matchmaking services.
|
|
251
251
|
*/
|
|
252
|
-
calculateGunMilan<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyCompatibilityData, ThrowOnError>):
|
|
252
|
+
calculateGunMilan<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyCompatibilityData, ThrowOnError>): RequestResult<PostVedicAstrologyCompatibilityResponses, PostVedicAstrologyCompatibilityErrors, ThrowOnError>;
|
|
253
253
|
/**
|
|
254
254
|
* Get planetary positions - Graha Positions API
|
|
255
255
|
*
|
|
256
256
|
* Get simplified planetary positions (graha positions) for all 9 planets (Sun through Ketu) plus Ascendant (Lagna). Real-time planet transit calculator for Vedic astrology. Navagraha positions API with nakshatra, pada, and rashi details. Includes house number placement using Whole Sign house system from Lagna. Faster response for basic planetary data without full chart structure. Perfect for planetary alignment tracking, daily transit updates, and astrology widgets.
|
|
257
257
|
*/
|
|
258
|
-
getPlanetPositions<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPlanetaryPositionsData, ThrowOnError>):
|
|
258
|
+
getPlanetPositions<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPlanetaryPositionsData, ThrowOnError>): RequestResult<PostVedicAstrologyPlanetaryPositionsResponses, PostVedicAstrologyPlanetaryPositionsErrors, ThrowOnError>;
|
|
259
259
|
/**
|
|
260
260
|
* Monthly Ephemeris - Daily sidereal planetary positions for a month
|
|
261
261
|
*
|
|
262
262
|
* Get daily sidereal ecliptic positions for all 9 Vedic planets (Navagraha) for an entire month. Returns longitude, zodiac sign, degree within sign, and retrograde status for each planet on each day. Calculated at noon UTC. Essential for ephemeris generation, transit tracking, and planetary movement visualization. Monthly planetary ephemeris API, sidereal position table, daily graha gochara positions, ecliptic longitude calculator.
|
|
263
263
|
*/
|
|
264
|
-
getMonthlyEphemeris<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPlanetaryPositionsMonthlyData, ThrowOnError>):
|
|
264
|
+
getMonthlyEphemeris<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPlanetaryPositionsMonthlyData, ThrowOnError>): RequestResult<PostVedicAstrologyPlanetaryPositionsMonthlyResponses, PostVedicAstrologyPlanetaryPositionsMonthlyErrors, ThrowOnError>;
|
|
265
265
|
/**
|
|
266
266
|
* Get current Mahadasha, Antardasha, Pratyantardasha, Sookshma, Prana - Dasha Calculator API
|
|
267
267
|
*
|
|
268
268
|
* Calculate all five running Vimshottari Dasha levels (Mahadasha, Antardasha, Pratyantardasha, Sookshma, Prana) with remaining time in each. Accurate dasha calculator API for life phase prediction and planetary period analysis. Returns the dasha timeline with start/end dates for every level, ready for a current DBA readout down to hour-level timing. Set significators true to add the KP star lord, sub lord, signified houses and strength grade of each running lord, plus the houses they have in common. Essential for understanding current planetary influences, dasha transitions, and timing events in Vedic astrology. 120-year dasha system based on moon nakshatra at birth, with selectable Lahiri or KP ayanamsa.
|
|
269
269
|
*/
|
|
270
|
-
getCurrentDasha<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDashaCurrentData, ThrowOnError>):
|
|
270
|
+
getCurrentDasha<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDashaCurrentData, ThrowOnError>): RequestResult<PostVedicAstrologyDashaCurrentResponses, PostVedicAstrologyDashaCurrentErrors, ThrowOnError>;
|
|
271
271
|
/**
|
|
272
272
|
* Get all 9 Mahadasha periods (120-year cycle)
|
|
273
273
|
*
|
|
274
274
|
* Returns complete Vimshottari Dasha cycle starting from birth. Shows all major planetary periods from birth through 120 years.
|
|
275
275
|
*/
|
|
276
|
-
getMajorDashas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDashaMajorData, ThrowOnError>):
|
|
276
|
+
getMajorDashas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDashaMajorData, ThrowOnError>): RequestResult<PostVedicAstrologyDashaMajorResponses, PostVedicAstrologyDashaMajorErrors, ThrowOnError>;
|
|
277
277
|
/**
|
|
278
278
|
* Get all Antardashas (sub-periods) for a specific Mahadasha
|
|
279
279
|
*
|
|
280
280
|
* Returns 9 Antardasha sub-periods within a Mahadasha. Each Mahadasha is divided into 9 proportional sub-periods.
|
|
281
281
|
*/
|
|
282
|
-
getSubDashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaData, ThrowOnError>):
|
|
282
|
+
getSubDashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaData, ThrowOnError>): RequestResult<PostVedicAstrologyDashaSubByMahadashaResponses, PostVedicAstrologyDashaSubByMahadashaErrors, ThrowOnError>;
|
|
283
283
|
/**
|
|
284
284
|
* Get all Pratyantardashas (antara periods) for a Mahadasha and Antardasha
|
|
285
285
|
*
|
|
286
286
|
* Pratyantardasha calculator API. Returns the 9 Pratyantardasha (antara) periods inside a chosen Antardasha, the third level of the Vimshottari dasha hierarchy. Use it to drill from a Mahadasha into month level timing for event prediction, muhurta selection, and dasha timeline UIs. Each period is proportional to the Vimshottari years of its lord.
|
|
287
287
|
*/
|
|
288
|
-
getPratyantardashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaByAntardashaData, ThrowOnError>):
|
|
288
|
+
getPratyantardashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaByAntardashaData, ThrowOnError>): RequestResult<PostVedicAstrologyDashaSubByMahadashaByAntardashaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaErrors, ThrowOnError>;
|
|
289
289
|
/**
|
|
290
290
|
* Get all Sookshma dashas for a Mahadasha, Antardasha and Pratyantardasha
|
|
291
291
|
*
|
|
292
292
|
* Sookshma dasha API. Returns the 9 Sookshma periods inside a chosen Pratyantardasha, the fourth and finest level of the Vimshottari dasha hierarchy. Completes a full vimshottari drill down from the 120-year cycle to day level timing, typically 3 to 30 days per period. Built for dasha drill down tables, current DBA readouts, and precise event timing in Vedic astrology software.
|
|
293
293
|
*/
|
|
294
|
-
getSookshmaDashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaData, ThrowOnError>):
|
|
294
|
+
getSookshmaDashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaData, ThrowOnError>): RequestResult<PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaErrors, ThrowOnError>;
|
|
295
295
|
/**
|
|
296
296
|
* Get all Prana dashas for a Mahadasha, Antardasha, Pratyantardasha and Sookshma
|
|
297
297
|
*
|
|
298
298
|
* Prana dasha API. Returns the 9 Prana periods inside a chosen Sookshma dasha, the fifth and finest level of the Vimshottari dasha hierarchy. Completes the full vimshottari drill down from the 120-year cycle to hour level timing, typically 20 minutes to 4 days per period depending on the parent Mahadasha. Built for five column dasha drill down tables, muhurta selection, and pinpointing the trigger moment inside an event window already found at the Sookshma level.
|
|
299
299
|
*/
|
|
300
|
-
getPranaDashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaData, ThrowOnError>):
|
|
300
|
+
getPranaDashas<ThrowOnError extends boolean = false>(options: Options<PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaData, ThrowOnError>): RequestResult<PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaResponses, PostVedicAstrologyDashaSubByMahadashaByAntardashaByPratyantardashaBySookshmaErrors, ThrowOnError>;
|
|
301
301
|
/**
|
|
302
302
|
* Get basic Panchang - Tithi Nakshatra Yoga Karana Calculator
|
|
303
303
|
*
|
|
304
304
|
* Calculate Panchang elements (Hindu calendar) for any date: Tithi (lunar day), Nakshatra (lunar mansion), Yoga, and Karana. Daily panchang API for determining auspicious timings (muhurta), festival dates, and planetary influences. Tithi calculator with Shukla/Krishna paksha. Accurate nakshatra today with ruling planet. Essential for Hindu calendar integration, muhurta selection, and Vedic timekeeping in astrology apps.
|
|
305
305
|
*/
|
|
306
|
-
getBasicPanchang<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangBasicData, ThrowOnError>):
|
|
306
|
+
getBasicPanchang<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangBasicData, ThrowOnError>): RequestResult<PostVedicAstrologyPanchangBasicResponses, PostVedicAstrologyPanchangBasicErrors, ThrowOnError>;
|
|
307
307
|
/**
|
|
308
308
|
* Get detailed Panchang with Rahu Kaal, Yamaganda, Gulika
|
|
309
309
|
*
|
|
310
310
|
* Complete daily panchang with all five limbs (Tithi, Nakshatra, Yoga, Karana, Vara) plus sunrise, sunset, moonrise, moonset times. Includes inauspicious periods (Rahu Kaal, Yamaganda, Gulika Kaal) and auspicious windows (Abhijit Muhurta, Brahma Muhurta). Current planetary hora with start/end times. Essential for muhurta selection, daily horoscope apps, Hindu calendar integration, and electional astrology. Accurate calculations based on observer location.
|
|
311
311
|
*/
|
|
312
|
-
getDetailedPanchang<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangDetailedData, ThrowOnError>):
|
|
312
|
+
getDetailedPanchang<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangDetailedData, ThrowOnError>): RequestResult<PostVedicAstrologyPanchangDetailedResponses, PostVedicAstrologyPanchangDetailedErrors, ThrowOnError>;
|
|
313
313
|
/**
|
|
314
314
|
* Get Choghadiya - 8 Muhurta divisions of day and night
|
|
315
315
|
*
|
|
316
316
|
* Calculate Choghadiya (Chaughadia) muhurta timings for any date and location. Divides day (sunrise to sunset) and night (sunset to next sunrise) into 8 equal auspicious/inauspicious periods. Each period ruled by a planet: Udveg (Sun, bad), Amrit (Moon, good), Rog (Mars, bad), Labh (Mercury, good), Shubh (Jupiter, good), Char (Venus, good), Kaal (Saturn, bad). Essential for muhurta selection, daily planning, and traditional Hindu timekeeping. Choghadiya calculator API, daily muhurat timings, auspicious time finder.
|
|
317
317
|
*/
|
|
318
|
-
getChoghadiya<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangChoghadiyaData, ThrowOnError>):
|
|
318
|
+
getChoghadiya<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangChoghadiyaData, ThrowOnError>): RequestResult<PostVedicAstrologyPanchangChoghadiyaResponses, PostVedicAstrologyPanchangChoghadiyaErrors, ThrowOnError>;
|
|
319
319
|
/**
|
|
320
320
|
* Get Hora - 24 Planetary Hours (12 day + 12 night)
|
|
321
321
|
*
|
|
322
322
|
* Calculate all 24 Hora (planetary hour) periods for any date and location. Day is divided into 12 equal horas from sunrise to sunset, night into 12 equal horas from sunset to next sunrise. Each hora is ruled by a planet in the Chaldean sequence starting from the day lord. Hora timings API, planetary hours calculator, Vedic hora chart, electional astrology timing.
|
|
323
323
|
*/
|
|
324
|
-
getHora<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangHoraData, ThrowOnError>):
|
|
324
|
+
getHora<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyPanchangHoraData, ThrowOnError>): RequestResult<PostVedicAstrologyPanchangHoraResponses, PostVedicAstrologyPanchangHoraErrors, ThrowOnError>;
|
|
325
325
|
/**
|
|
326
326
|
* Check Manglik Dosha - Mangal Dosha Calculator API
|
|
327
327
|
*
|
|
328
328
|
* Detect Manglik dosha (Kuja dosha, Mars dosha) based on Mars position in inauspicious houses (1, 2, 4, 7, 8, 12) from Lagna. Accurate mangal dosha calculator for matrimonial compatibility checks in Vedic astrology. Returns severity levels (Mild/Moderate/Severe) and cancellation factors. Essential for kundli matching for marriage, manglik compatibility, and marriage astrology in matrimonial sites. Includes exceptions that reduce manglik dosha effects.
|
|
329
329
|
*/
|
|
330
|
-
checkManglikDosha<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDoshaManglikData, ThrowOnError>):
|
|
330
|
+
checkManglikDosha<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDoshaManglikData, ThrowOnError>): RequestResult<PostVedicAstrologyDoshaManglikResponses, PostVedicAstrologyDoshaManglikErrors, ThrowOnError>;
|
|
331
331
|
/**
|
|
332
332
|
* Check Kalsarpa Dosha - Kalsarpa Yoga Calculator API
|
|
333
333
|
*
|
|
334
334
|
* Detect Kalsarpa dosha (Kalsarpa yoga) when all 7 planets are hemmed between Rahu-Ketu axis. Accurate kalsarpa dosha calculator identifying 12 types (Ananta, Kulik, Vasuki, Shankhapala, Padma, Mahapadma, Takshak, Karkotak, Shankhachud, Ghatak, Vishdhar, Sheshnag). Returns severity and effects based on Rahu house position. Essential for Vedic astrology dosha analysis, birth chart evaluation, and matrimonial compatibility. Considered significant dosha affecting life obstacles and spiritual growth.
|
|
335
335
|
*/
|
|
336
|
-
checkKalsarpaDosha<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDoshaKalsarpaData, ThrowOnError>):
|
|
336
|
+
checkKalsarpaDosha<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDoshaKalsarpaData, ThrowOnError>): RequestResult<PostVedicAstrologyDoshaKalsarpaResponses, PostVedicAstrologyDoshaKalsarpaErrors, ThrowOnError>;
|
|
337
337
|
/**
|
|
338
338
|
* Check Sadhesati - Sade Sati Calculator API (Saturn Transit)
|
|
339
339
|
*
|
|
340
340
|
* Calculate Sadhesati (Sade Sati) periods when Saturn transits 12th, 1st, and 2nd houses from natal Moon. Accurate sade sati calculator with current status and phase identification (Rising/Peak/Setting). Shani sadhesati 7.5 year period tracker. Returns Saturn transit dates and effects on life. Essential for Saturn transit analysis, sadhesati remedies timing, and understanding challenging Saturn periods in Vedic astrology. Important for timing major life decisions.
|
|
341
341
|
*/
|
|
342
|
-
checkSadhesati<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDoshaSadhesatiData, ThrowOnError>):
|
|
342
|
+
checkSadhesati<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyDoshaSadhesatiData, ThrowOnError>): RequestResult<PostVedicAstrologyDoshaSadhesatiResponses, PostVedicAstrologyDoshaSadhesatiErrors, ThrowOnError>;
|
|
343
343
|
/**
|
|
344
344
|
* List all planetary yogas - 300+ Vedic Yoga Glossary
|
|
345
345
|
*
|
|
346
346
|
* Browse the 300+ entry Vedic planetary-yoga glossary. Returns id and name for every cataloged yoga (Raja, Dhana, Pancha Mahapurusha, Nabhasa, Chandra-Mangala, and more). This is a dictionary lookup, not chart-driven detection: it does not inspect a birth chart. Use GET /yoga/{id} for the full glossary entry, or POST /yoga/detect to run all 44 detection rules against a specific kundli. Ideal for yoga-browser UIs, search, and progressive data loading.
|
|
347
347
|
*/
|
|
348
|
-
listYogas<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyYogaData, ThrowOnError>):
|
|
348
|
+
listYogas<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyYogaData, ThrowOnError>): RequestResult<GetVedicAstrologyYogaResponses, GetVedicAstrologyYogaErrors, ThrowOnError>;
|
|
349
349
|
/**
|
|
350
350
|
* Get yoga details by ID - Vedic Yoga Glossary Entry
|
|
351
351
|
*
|
|
352
|
-
* Look up the dictionary entry for a specific named yoga from the
|
|
352
|
+
* Look up the dictionary entry for a specific named yoga from the 301-entry Vedic planetary-yoga glossary. Returns formation conditions, life results, and quality classification (Positive/Negative/Both). This is a glossary lookup against the static catalog; it does NOT analyze a birth chart. For chart-driven present/absent verdicts on the 44 detection-grade yogas (Gajakesari, the Pancha Mahapurusha set, and all 32 Nabhasa distribution yogas) call POST /yoga/detect with birth data.
|
|
353
353
|
*/
|
|
354
|
-
getYoga<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyYogaByIdData, ThrowOnError>):
|
|
354
|
+
getYoga<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyYogaByIdData, ThrowOnError>): RequestResult<GetVedicAstrologyYogaByIdResponses, GetVedicAstrologyYogaByIdErrors, ThrowOnError>;
|
|
355
355
|
/**
|
|
356
356
|
* Detect classical Vedic yogas in a birth chart
|
|
357
357
|
*
|
|
358
358
|
* Chart-driven detection of 44 classical Vedic yogas. Twelve conjunction and dignity yogas: Gajakesari (parashara three-rule definition), Sunapha, Anapha, Dhurdhura, Kemadruma, Chandra Mangala, Budha-Aditya, and the five Pancha Mahapurusha yogas (Ruchaka, Bhadra, Hamsa, Malavya, Sasa). Plus all 32 Nabhasa distribution yogas, which describe how the seven visible grahas are spread across the whole chart rather than any single conjunction, across four families: Asraya (Rajju, Musala, Nala), Dala (Mala, Sarpa), Akriti (Gada, Shakata, Vihaga, Shringataka, Hala, Vajra, Yava, Kamala, Vapi, Yupa, Shara, Shakti, Danda, Nauka, Kuta, Chhatra, Dhanusha, Ardhachandra, Chakra, Samudra) and Sankhya (Gola, Yuga, Shoola, Kedara, Pasa, Damini, Veena). Each yoga is returned with an `id`, `name`, a `present` boolean, a `quality` (Positive, Negative, or Both, i.e. auspicious, inauspicious, or context-dependent), and a classical-text `evidence` string naming the rule that triggered or failed (kendra position, dignity, malefic drishti, lordship, retrograde state, sign modality, bhava distribution). Nabhasa results also apply the four classical precedence norms, so a yoga that matched its own rule but was outranked by a stronger family is returned as absent with evidence naming the norm that silenced it, letting you explain a verdict rather than only report it. There is no separate major/minor flag; `quality` is the auspiciousness axis. Unlike GET /yoga and GET /yoga/{id} which are dictionary lookups, this endpoint computes the kundli from birth data and runs the detection rules. Sources: BPHS ch. 35 and ch. 75, Mantreswara Phaladeepika ch. 6, B.V. Raman Three Hundred Important Combinations.
|
|
359
359
|
*/
|
|
360
|
-
detectYogas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyYogaDetectData, ThrowOnError>):
|
|
360
|
+
detectYogas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyYogaDetectData, ThrowOnError>): RequestResult<PostVedicAstrologyYogaDetectResponses, PostVedicAstrologyYogaDetectErrors, ThrowOnError>;
|
|
361
361
|
/**
|
|
362
362
|
* Get KP-Newcomb ayanamsa - Dynamic daily calculation
|
|
363
363
|
*
|
|
364
364
|
* Get the KP-Newcomb (Krishnamurti) ayanamsa for any instant, computed continuously from Newcomb precession theory rather than looked up in a preset table, so it tracks the exact moment you ask for instead of the calendar year. Supply date alone for midnight UTC, or add time and timezone to pin a birth moment exactly. This is the precession offset subtracted from a tropical longitude to obtain the sidereal one, and it is what makes a KP chart reproduce the reference software your practitioners already use. Returns the same value every KP endpoint applies internally. KP Newcomb ayanamsa API, dynamic ayanamsa calculator, Krishnamurti ayanamsa today, current KP ayanamsa
|
|
365
365
|
*/
|
|
366
|
-
getKpAyanamsa<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyKpAyanamsaData, ThrowOnError>):
|
|
366
|
+
getKpAyanamsa<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyKpAyanamsaData, ThrowOnError>): RequestResult<GetVedicAstrologyKpAyanamsaResponses, GetVedicAstrologyKpAyanamsaErrors, ThrowOnError>;
|
|
367
367
|
/**
|
|
368
368
|
* Get KP planetary positions with sub-lords
|
|
369
369
|
*
|
|
370
370
|
* Get planetary positions with detailed KP star-lord and sub-lord calculations for precise event timing and significator analysis. Returns all 9 planets (Sun through Ketu) with nakshatra, star-lord, sub-lord, and KP horary numbers (1-249). Essential for KP astrology software, significator analysis, and event prediction. KP planet positions API, star lord sub lord calculator, KP significator API, Krishnamurti Paddhati planets
|
|
371
371
|
*/
|
|
372
|
-
getKpPlanets<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpPlanetsData, ThrowOnError>):
|
|
372
|
+
getKpPlanets<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpPlanetsData, ThrowOnError>): RequestResult<PostVedicAstrologyKpPlanetsResponses, PostVedicAstrologyKpPlanetsErrors, ThrowOnError>;
|
|
373
373
|
/**
|
|
374
374
|
* Get KP Placidus house cusps with sub-lords
|
|
375
375
|
*
|
|
376
376
|
* Calculate unequal Placidus house cusps with ruling sign-lord, nakshatra-lord, and sub-lord for each cusp. Dynamic KP-Newcomb or custom ayanamsa support. Used in KP horary astrology, cusp sub-lord analysis, and birth chart rectification. Returns all 12 house cusps with KP sub-division details. SEO: Placidus house cusps API, KP cusp calculator, house cusps star sub lord, KP horary cusps
|
|
377
377
|
*/
|
|
378
|
-
getKpCusps<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpCuspsData, ThrowOnError>):
|
|
378
|
+
getKpCusps<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpCuspsData, ThrowOnError>): RequestResult<PostVedicAstrologyKpCuspsResponses, PostVedicAstrologyKpCuspsErrors, ThrowOnError>;
|
|
379
379
|
/**
|
|
380
380
|
* Generate complete KP birth chart
|
|
381
381
|
*
|
|
382
382
|
* Generate authentic Krishnamurti Paddhati birth charts with Placidus house cusps, star-lord and sub-lord calculations. Supports custom ayanamsa and dynamic KP-Newcomb ayanamsa calculation. Returns complete chart with all 9 planets (Sun through Ketu), Ascendant, 12 Placidus house cusps, nakshatra details, star-lords, sub-lords, and KP horary numbers (1-249). Perfect for KP astrology software, horary prediction apps, and event timing analysis. SEO: KP astrology chart API, Placidus house cusps planets, Krishnamurti Paddhati chart generator, KP birth chart calculator
|
|
383
383
|
*/
|
|
384
|
-
generateKpChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpChartData, ThrowOnError>):
|
|
384
|
+
generateKpChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpChartData, ThrowOnError>): RequestResult<PostVedicAstrologyKpChartResponses, PostVedicAstrologyKpChartErrors, ThrowOnError>;
|
|
385
385
|
/**
|
|
386
386
|
* Get KP ruling planets with optional significators
|
|
387
387
|
*
|
|
388
388
|
* Calculate the 5 ruling planets at any moment using Krishnamurti Paddhati horary astrology. Returns Day Lord, Moon Sign/Star/Sub Lord, Lagna Sign/Star/Sub Lord. Optionally provide birth data (birthDate, birthTime) to include significators showing which houses each ruling planet signifies in the birth chart - essential for KP prediction.
|
|
389
389
|
*/
|
|
390
|
-
getKpRulingPlanets<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpRulingPlanetsData, ThrowOnError>):
|
|
390
|
+
getKpRulingPlanets<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpRulingPlanetsData, ThrowOnError>): RequestResult<PostVedicAstrologyKpRulingPlanetsResponses, PostVedicAstrologyKpRulingPlanetsErrors, ThrowOnError>;
|
|
391
391
|
/**
|
|
392
392
|
* Get KP ruling planets with significators at intervals
|
|
393
393
|
*
|
|
394
394
|
* Calculate ruling planets and their KP significators at regular time intervals using Krishnamurti Paddhati prashna (horary) astrology. For each interval, a full Placidus house chart is erected and significators are computed using the 4-level KP hierarchy: Level 1 (strongest) planets in star of house occupant, Level 2 occupants, Level 3 planets in star of house owner, Level 4 house owner. Returns Day Lord (sunrise-based Hindu Vara), Moon Sign/Star/Sub/Sub-Sub Lords, Lagna Sign/Star/Sub/Sub-Sub Lords, unique ruling planets set, and per-ruling-planet house significations. No birth data needed, significators come from each moments sky chart. Use for birth time rectification, muhurta selection, and KP horary number analysis.
|
|
395
395
|
*/
|
|
396
|
-
getKpRulingInterval<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpRulingPlanetsIntervalData, ThrowOnError>):
|
|
396
|
+
getKpRulingInterval<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpRulingPlanetsIntervalData, ThrowOnError>): RequestResult<PostVedicAstrologyKpRulingPlanetsIntervalResponses, PostVedicAstrologyKpRulingPlanetsIntervalErrors, ThrowOnError>;
|
|
397
397
|
/**
|
|
398
398
|
* Find KP sublord changes
|
|
399
399
|
*
|
|
400
400
|
* Track when planets cross KP sublord boundaries (1-249 divisions) for precise Krishnamurti Paddhati event timing. Returns exact timestamps when a planet transitions between sublords, essential for prashna kundali analysis and dasha predictions. Use this to find favorable windows when benefic sublords are active. Supports Sun, Moon, Mars, Mercury, Jupiter, Venus, and Saturn tracking over any date range.
|
|
401
401
|
*/
|
|
402
|
-
getKpSublordChanges<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpSublordChangesData, ThrowOnError>):
|
|
402
|
+
getKpSublordChanges<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpSublordChangesData, ThrowOnError>): RequestResult<PostVedicAstrologyKpSublordChangesResponses, PostVedicAstrologyKpSublordChangesErrors, ThrowOnError>;
|
|
403
403
|
/**
|
|
404
404
|
* Find KP rasi ingress times
|
|
405
405
|
*
|
|
406
406
|
* Track when planets enter new zodiac signs (rasi) with precise ingress timestamps. Essential for Vedic astrology transit analysis, muhurta selection, and predictive horoscope readings. Returns exact times when planets cross sign boundaries (0, 30, 60 degrees etc). Use for tracking Sun sankranti dates, Moon sign changes for panchang, or outer planet transits for yearly predictions.
|
|
407
407
|
*/
|
|
408
|
-
getKpRasiChanges<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpRasiChangesData, ThrowOnError>):
|
|
408
|
+
getKpRasiChanges<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpRasiChangesData, ThrowOnError>): RequestResult<PostVedicAstrologyKpRasiChangesResponses, PostVedicAstrologyKpRasiChangesErrors, ThrowOnError>;
|
|
409
409
|
/**
|
|
410
410
|
* Get KP planets at time intervals
|
|
411
411
|
*
|
|
412
412
|
* Calculate positions of all 9 planets (Sun through Saturn, Rahu, Ketu) at regular time intervals with full KP hierarchy: sign lord, star lord, sublord, and sub-sublord. Returns longitude, zodiac sign, nakshatra, sublord, sub-sublord, and KP number (1-249) for each planet at each timestamp. Ideal for tracking planetary motion, finding optimal muhurta windows, analyzing transit patterns, and building KP ephemeris tables. Maximum range of 7 days with 15-minute to 24-hour intervals.
|
|
413
413
|
*/
|
|
414
|
-
getKpPlanetsInterval<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpPlanetsIntervalData, ThrowOnError>):
|
|
414
|
+
getKpPlanetsInterval<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpPlanetsIntervalData, ThrowOnError>): RequestResult<PostVedicAstrologyKpPlanetsIntervalResponses, PostVedicAstrologyKpPlanetsIntervalErrors, ThrowOnError>;
|
|
415
|
+
/**
|
|
416
|
+
* Cast a KP horary (Prashna) chart from a number 1-249 - KP Horary API
|
|
417
|
+
*
|
|
418
|
+
* Cast a Krishnamurti Paddhati horary chart, also called Prashna, from a number between 1 and 249 given by the querent plus the moment and place the question is judged. NO BIRTH DETAILS ARE NEEDED, which is what makes horary the KP answer when birth time is unknown or unreliable. The number maps to one of the 249 KP sub divisions and sets the Ascendant; the twelve Placidus cusps follow from that Ascendant at the given latitude, and every planetary position comes from the real sky at the moment of the question. Returns the Ascendant with its sub lord, all twelve cusps with star lord and sub lord, the nine grahas placed against those cusps, the five ruling planets for validating the chart, and four-level significators for judging which houses each graha supports. KP horary API, Prashna kundali calculator, 249 horary number chart, Krishnamurti Paddhati horary, cusp sub lord question answering.
|
|
419
|
+
*/
|
|
420
|
+
castKpHoraryChart<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyKpHoraryData, ThrowOnError>): RequestResult<PostVedicAstrologyKpHoraryResponses, PostVedicAstrologyKpHoraryErrors, ThrowOnError>;
|
|
415
421
|
/**
|
|
416
422
|
* Get planetary aspects (Drishti) - Mutual aspects between all planets
|
|
417
423
|
*
|
|
418
424
|
* Calculate all planetary aspects (Drishti) for a given time. Returns full aspects (7th house for all planets) and special aspects (Mars 4th/8th, Jupiter 5th/9th, Saturn 3rd/10th). Includes aspect table grouped by planet, mutual aspects, and individual aspect details with orb calculation. Essential for birth chart analysis, compatibility checking, and transit predictions. Planetary aspects API, drishti calculator, vedic astrology aspects, graha drishti.
|
|
419
425
|
*/
|
|
420
|
-
calculateDrishti<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAspectsData, ThrowOnError>):
|
|
426
|
+
calculateDrishti<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAspectsData, ThrowOnError>): RequestResult<PostVedicAstrologyAspectsResponses, PostVedicAstrologyAspectsErrors, ThrowOnError>;
|
|
421
427
|
/**
|
|
422
428
|
* Monthly Planetary Aspects - Major and minor aspect events for a month
|
|
423
429
|
*
|
|
424
430
|
* Calculate all planetary aspect events (excluding Moon) for a given month. Detects 22 aspect types. 5 major (conjunction, opposition, trine, square, sextile) and 17 minor (vigintile, semi-sextile, undecile, semi-quintile, novile, semi-square, septile, quintile, binovile, centile, biseptile, tredecile, sesqui-square, bi-quintile, quincunx, triseptile, quadranovile). Returns exact date and time of closest approach using ternary search refinement. Uses degree-based aspect methodology on sidereal positions (Lahiri ayanamsa). For Moon-specific aspects, use the /aspects/lunar endpoint. Essential for transit timing, muhurta selection, and monthly astrological forecasting. Monthly planetary aspects API, graha drishti calendar, mutual aspect ephemeris, minor aspects.
|
|
425
431
|
*/
|
|
426
|
-
getMonthlyAspects<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAspectsMonthlyData, ThrowOnError>):
|
|
432
|
+
getMonthlyAspects<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAspectsMonthlyData, ThrowOnError>): RequestResult<PostVedicAstrologyAspectsMonthlyResponses, PostVedicAstrologyAspectsMonthlyErrors, ThrowOnError>;
|
|
427
433
|
/**
|
|
428
434
|
* Monthly Lunar Aspects - Moon aspect events with all planets for a month
|
|
429
435
|
*
|
|
430
436
|
* Track all lunar aspect events for a given month including major and minor aspects. The Moon traverses approximately 13 degrees per day, forming 22 aspect types with each planet. 5 major (conjunction, opposition, trine, square, sextile) and 17 minor (vigintile, semi-sextile, undecile, semi-quintile, novile, semi-square, septile, quintile, binovile, centile, biseptile, tredecile, sesqui-square, bi-quintile, quincunx, triseptile, quadranovile). Returns exact date and time of each Moon aspect event with ternary search refinement to the minute. Essential for muhurta selection, daily panchang analysis, and chandra gochar predictions. Monthly lunar aspects API, Moon transit calendar, chandra drishti ephemeris, minor lunar aspects.
|
|
431
437
|
*/
|
|
432
|
-
getLunarAspects<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAspectsLunarData, ThrowOnError>):
|
|
438
|
+
getLunarAspects<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAspectsLunarData, ThrowOnError>): RequestResult<PostVedicAstrologyAspectsLunarResponses, PostVedicAstrologyAspectsLunarErrors, ThrowOnError>;
|
|
433
439
|
/**
|
|
434
440
|
* Transit Analysis - Compare current planets to natal chart (Gochar)
|
|
435
441
|
*
|
|
436
442
|
* Analyze planetary transits (Gochar) over natal chart positions. Returns transiting planets with their natal house positions, aspects to natal planets, and highlights key transits from slow-moving planets (Jupiter, Saturn, Rahu, Ketu). Essential for timing predictions, event forecasting, and understanding current planetary influences. Transit analysis API, gochar calculator, vedic transit predictions.
|
|
437
443
|
*/
|
|
438
|
-
calculateTransit<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyTransitData, ThrowOnError>):
|
|
444
|
+
calculateTransit<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyTransitData, ThrowOnError>): RequestResult<PostVedicAstrologyTransitResponses, PostVedicAstrologyTransitErrors, ThrowOnError>;
|
|
439
445
|
/**
|
|
440
446
|
* Monthly Transit - Planetary sign changes for an entire month
|
|
441
447
|
*
|
|
442
448
|
* Get all planetary sign (rashi) changes for a given month. Shows when each planet transitions from one zodiac sign to another. Covers all 9 Vedic planets: Sun, Moon, Mars, Mercury, Jupiter, Venus, Saturn, Rahu, Ketu. Includes starting positions at the beginning of the month. Essential for transit prediction, monthly horoscope generation, and muhurta planning. Monthly planetary transit API, gochar calendar, rashi parivartan dates.
|
|
443
449
|
*/
|
|
444
|
-
getMonthlyTransits<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyTransitMonthlyData, ThrowOnError>):
|
|
450
|
+
getMonthlyTransits<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyTransitMonthlyData, ThrowOnError>): RequestResult<PostVedicAstrologyTransitMonthlyResponses, PostVedicAstrologyTransitMonthlyErrors, ThrowOnError>;
|
|
445
451
|
/**
|
|
446
452
|
* Declination Parallels - Planets at same or opposite declination
|
|
447
453
|
*
|
|
448
454
|
* Calculate planetary declinations and find parallels (same declination) and contraparallels (opposite declination). Parallels are considered equivalent to conjunctions in strength, contraparallels to oppositions. Returns declination for each planet and all parallel/contraparallel aspects. Declination parallels API, planetary declination calculator, contraparallel aspects.
|
|
449
455
|
*/
|
|
450
|
-
calculateParallels<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyParallelsData, ThrowOnError>):
|
|
456
|
+
calculateParallels<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyParallelsData, ThrowOnError>): RequestResult<PostVedicAstrologyParallelsResponses, PostVedicAstrologyParallelsErrors, ThrowOnError>;
|
|
451
457
|
/**
|
|
452
458
|
* Monthly Declination Parallels - Parallel and contraparallel events for a month
|
|
453
459
|
*
|
|
454
460
|
* Find all declination parallel and contraparallel events between the 7 visible planets for a given month. Parallels occur when two planets share the same celestial declination (equivalent to conjunction in strength). Contraparallels occur at opposite declinations (equivalent to opposition). Scanned daily at noon UTC. Essential for advanced transit analysis and hidden aspect discovery. Monthly declination parallels API, planetary parallel ephemeris, contraparallel event calendar.
|
|
455
461
|
*/
|
|
456
|
-
getMonthlyParallels<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyParallelsMonthlyData, ThrowOnError>):
|
|
462
|
+
getMonthlyParallels<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyParallelsMonthlyData, ThrowOnError>): RequestResult<PostVedicAstrologyParallelsMonthlyResponses, PostVedicAstrologyParallelsMonthlyErrors, ThrowOnError>;
|
|
457
463
|
/**
|
|
458
464
|
* Ecliptic Crossings - When planets cross the ecliptic plane
|
|
459
465
|
*
|
|
460
466
|
* Find all ecliptic plane crossings for visible planets during a given year. An ecliptic crossing occurs when a planetary celestial latitude passes through 0 degrees, crossing from one side of the ecliptic to the other. Ascending crossings (south to north) correspond to the ascending node, descending crossings (north to south) to the descending node. Moon crosses ~2 times per month, outer planets cross less frequently. Returns exact date, time, direction, sidereal longitude, and zodiac sign. Ecliptic crossing API, planetary node crossing, ascending descending node ephemeris.
|
|
461
467
|
*/
|
|
462
|
-
getEclipticCrossings<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyEclipticCrossingsData, ThrowOnError>):
|
|
468
|
+
getEclipticCrossings<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyEclipticCrossingsData, ThrowOnError>): RequestResult<PostVedicAstrologyEclipticCrossingsResponses, PostVedicAstrologyEclipticCrossingsErrors, ThrowOnError>;
|
|
463
469
|
/**
|
|
464
470
|
* List all 12 Rashis - Vedic Zodiac Signs Reference
|
|
465
471
|
*
|
|
466
472
|
* Get the complete list of 12 rashis (zodiac signs) in Vedic astrology. Returns Sanskrit names, Western equivalents, sidereal date ranges, symbols, governing Adityas, and personality characteristics for each rashi. Reference data for Mesha through Meen. Essential for zodiac sign lookup tables, astrology apps, and rashi-based UI components.
|
|
467
473
|
*/
|
|
468
|
-
listRashis<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyRashisData, ThrowOnError>):
|
|
474
|
+
listRashis<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyRashisData, ThrowOnError>): RequestResult<GetVedicAstrologyRashisResponses, GetVedicAstrologyRashisErrors, ThrowOnError>;
|
|
469
475
|
/**
|
|
470
476
|
* Get Rashi by ID - Vedic Zodiac Sign Detail
|
|
471
477
|
*
|
|
472
478
|
* Get detailed information for a single rashi (zodiac sign) by its Vedic ID slug. Returns Sanskrit name, Western equivalent, sidereal date range, symbol, governing Aditya, and personality characteristics.
|
|
473
479
|
*/
|
|
474
|
-
getRashi<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyRashisByIdData, ThrowOnError>):
|
|
480
|
+
getRashi<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyRashisByIdData, ThrowOnError>): RequestResult<GetVedicAstrologyRashisByIdResponses, GetVedicAstrologyRashisByIdErrors, ThrowOnError>;
|
|
475
481
|
/**
|
|
476
482
|
* List all 27 Nakshatras - Lunar Mansions Reference
|
|
477
483
|
*
|
|
478
484
|
* Get the complete list of 27 nakshatras (lunar mansions) in Vedic astrology. Returns names, zodiac ranges, ruling planets, presiding deities, symbols, personality characteristics, and traditional remedies (mantras, gemstones, rituals) for each nakshatra from Ashwini to Revati. Essential for nakshatra lookup tables, dasha period calculations, muhurta selection, and astrology app reference data.
|
|
479
485
|
*/
|
|
480
|
-
listNakshatras<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyNakshatrasData, ThrowOnError>):
|
|
486
|
+
listNakshatras<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyNakshatrasData, ThrowOnError>): RequestResult<GetVedicAstrologyNakshatrasResponses, GetVedicAstrologyNakshatrasErrors, ThrowOnError>;
|
|
481
487
|
/**
|
|
482
488
|
* Get Nakshatra by ID - Lunar Mansion Detail
|
|
483
489
|
*
|
|
484
490
|
* Get detailed information for a single nakshatra (lunar mansion) by its ID slug. Returns name, zodiac range, ruling planet, presiding deity, symbol, personality characteristics, and traditional remedies including mantras, gemstones, and rituals.
|
|
485
491
|
*/
|
|
486
|
-
getNakshatra<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyNakshatrasByIdData, ThrowOnError>):
|
|
492
|
+
getNakshatra<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyNakshatrasByIdData, ThrowOnError>): RequestResult<GetVedicAstrologyNakshatrasByIdResponses, GetVedicAstrologyNakshatrasByIdErrors, ThrowOnError>;
|
|
487
493
|
/**
|
|
488
494
|
* Get upagraha (sub-planet) positions - Upagraha Calculator API
|
|
489
495
|
*
|
|
490
496
|
* Calculate all 11 Vedic upagraha (sub-planet) positions per Brihat Parashara Hora Shastra (BPHS). Returns 6 time-based upagrahas (Gulika, Mandi, Kala, Mrityu, Ardhaprahara, Yamaghantaka) derived from the 8-part day/night division, plus 5 Sun-longitude-based upagrahas (Dhuma, Vyatipata, Parivesha, Indra Chapa, Upaketu). Essential for complete kundli analysis, dosha assessment, and advanced chart interpretation. Upagraha calculator API, Gulika Mandi position, sub-planet Vedic astrology.
|
|
491
497
|
*/
|
|
492
|
-
getUpagrahaPositions<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyUpagrahaData, ThrowOnError>):
|
|
498
|
+
getUpagrahaPositions<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyUpagrahaData, ThrowOnError>): RequestResult<PostVedicAstrologyUpagrahaResponses, PostVedicAstrologyUpagrahaErrors, ThrowOnError>;
|
|
493
499
|
/**
|
|
494
500
|
* Get Ashtakavarga (planetary strength) analysis - Ashtakavarga Calculator API
|
|
495
501
|
*
|
|
496
502
|
* Calculate complete Ashtakavarga analysis per Brihat Parashara Hora Shastra (BPHS). Returns Bhinnashtakavarga (BAV), Sarvashtakavarga (SAV, total 337), Reduced Ashtakavarga (Trikona + Ekadipati Shodhana per Ch. 67-68), and Shodhya Pinda planetary strength (Rashi Pinda + Graha Pinda per Ch. 69). Essential for transit prediction timing, house strength analysis, dasha result evaluation, and planetary strength comparison. Ashtakavarga calculator API, bindu rekha points, Shodhya Pinda, Vedic astrology.
|
|
497
503
|
*/
|
|
498
|
-
calculateAshtakavarga<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAshtakavargaData, ThrowOnError>):
|
|
504
|
+
calculateAshtakavarga<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyAshtakavargaData, ThrowOnError>): RequestResult<PostVedicAstrologyAshtakavargaResponses, PostVedicAstrologyAshtakavargaErrors, ThrowOnError>;
|
|
499
505
|
/**
|
|
500
506
|
* Get Shadbala (six-fold planetary strength) analysis - Shadbala Calculator API
|
|
501
507
|
*
|
|
502
508
|
* Calculate complete Shadbala (six-fold planetary strength) per Brihat Parashara Hora Shastra (BPHS) and BV Raman Graha and Bhava Balas. Returns all 6 strength components (Sthana Bala, Dig Bala, Kala Bala, Chesta Bala, Naisargika Bala, Drik Bala) plus Ishta Phala, Kashta Phala, strength ratio, and relative ranking for all 7 classical planets. Essential for evaluating planetary strength in Vedic birth chart analysis, dasha prediction, transit interpretation, and yoga assessment. Shadbala calculator API, planetary strength Vedic astrology, graha bala, Ishta Kashta Phala.
|
|
503
509
|
*/
|
|
504
|
-
calculateShadbala<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyShadbalaData, ThrowOnError>):
|
|
510
|
+
calculateShadbala<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyShadbalaData, ThrowOnError>): RequestResult<PostVedicAstrologyShadbalaResponses, PostVedicAstrologyShadbalaErrors, ThrowOnError>;
|
|
505
511
|
/**
|
|
506
512
|
* List all 17 avastha states - Planetary State Reference
|
|
507
513
|
*
|
|
508
514
|
* Reference list of every avastha (planetary state) across the three classical systems: the five Baladi age states, the three Jagradadi waking states, and the nine Deeptadi dispositional states. Each carries a short label and what the state means for the results the graha can deliver. Use it to turn the bare state names a birth chart returns into readable output, filtered by system if you only need one. Avastha meaning API, Baladi avastha, Jagradadi, Deeptadi, planetary state Vedic astrology.
|
|
509
515
|
*/
|
|
510
|
-
listAvasthas<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyAvasthasData, ThrowOnError>):
|
|
516
|
+
listAvasthas<ThrowOnError extends boolean = false>(options?: Options<GetVedicAstrologyAvasthasData, ThrowOnError>): RequestResult<GetVedicAstrologyAvasthasResponses, GetVedicAstrologyAvasthasErrors, ThrowOnError>;
|
|
511
517
|
/**
|
|
512
518
|
* Get avastha by ID - Planetary State Detail
|
|
513
519
|
*
|
|
514
520
|
* Look up a single avastha state by its slug, which is the lowercased state name a birth chart returns in `awastha`, `jagradadi` or `deeptadi`. Returns the system it belongs to, a short label, and what the state means for the results the graha delivers.
|
|
515
521
|
*/
|
|
516
|
-
getAvastha<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyAvasthasByIdData, ThrowOnError>):
|
|
522
|
+
getAvastha<ThrowOnError extends boolean = false>(options: Options<GetVedicAstrologyAvasthasByIdData, ThrowOnError>): RequestResult<GetVedicAstrologyAvasthasByIdResponses, GetVedicAstrologyAvasthasByIdErrors, ThrowOnError>;
|
|
517
523
|
/**
|
|
518
524
|
* Get the twelve Arudha padas - Arudha Lagna Calculator API
|
|
519
525
|
*
|
|
520
526
|
* Calculate the Arudha Lagna (AL) and all twelve Arudha padas of Jaimini astrology from birth details. An Arudha pada is the perceived or projected form of a bhava, so where the Lagna shows what a person is, the Arudha Lagna shows the image and status the world attaches to them. Returns each pada with the bhava lord and the count that produced it, the sign it lands in, its house from the Lagna, and a flag showing whether the classical exception moved it. Includes the Upapada (UL) read for marriage. Arudha Lagna calculator API, Jaimini pada, Upapada Lagna, Vedic astrology public image.
|
|
521
527
|
*/
|
|
522
|
-
calculateArudhaPadas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyArudhaData, ThrowOnError>):
|
|
528
|
+
calculateArudhaPadas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyArudhaData, ThrowOnError>): RequestResult<PostVedicAstrologyArudhaResponses, PostVedicAstrologyArudhaErrors, ThrowOnError>;
|
|
523
529
|
/**
|
|
524
530
|
* Get Chara Karakas including Atmakaraka - Jaimini Karaka Calculator API
|
|
525
531
|
*
|
|
526
532
|
* Calculate the Chara Karakas of Jaimini astrology from birth details: the movable significators assigned by ranking each graha on how far it has advanced into its sign. The highest becomes the Atmakaraka, the soul significator and the strongest influence in the chart, and the rest take the Amatya, Bhratri, Matri, Pitri, Putra, Gnati and Dara offices in descending order. Supports both the eight-karaka scheme, where Rahu is included with its degree reversed, and the seven-karaka scheme that excludes the nodes, because the two can name a different Atmakaraka for the same chart. Atmakaraka calculator API, Darakaraka, Jaimini chara karaka, Vedic astrology soul significator.
|
|
527
533
|
*/
|
|
528
|
-
calculateCharaKarakas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyCharaKarakasData, ThrowOnError>):
|
|
534
|
+
calculateCharaKarakas<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyCharaKarakasData, ThrowOnError>): RequestResult<PostVedicAstrologyCharaKarakasResponses, PostVedicAstrologyCharaKarakasErrors, ThrowOnError>;
|
|
535
|
+
/**
|
|
536
|
+
* Get Bhava Bala (house strength) for all twelve houses - Bhava Bala Calculator API
|
|
537
|
+
*
|
|
538
|
+
* Calculate Bhava Bala (house strength) for all twelve bhavas per Brihat Parashara Hora Shastra (BPHS) and BV Raman Graha and Bhava Balas. Returns the three classical components (Bhavadhipati Bala from the house lord Shadbala, Bhava Digbala from the rashi class and direction, Bhava Drishti Bala from aspects on the bhava madhya) plus totals in virupas and rupas and a strength ranking. Bhavas are built on unequal Sripati mid-cusps, so a house near a sign boundary is measured where it actually falls. Shadbala measures which graha is strong, Bhava Bala measures which life area is strong, and reading both together is how a practitioner separates a strong planet in a weak house from a weak planet in a strong one. Bhava Bala calculator API, house strength Vedic astrology, bhava bala virupas, Bhavadhipati Bala, Bhava Digbala, Sripati bhava madhya.
|
|
539
|
+
*/
|
|
540
|
+
calculateBhavaBala<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyBhavaBalaData, ThrowOnError>): RequestResult<PostVedicAstrologyBhavaBalaResponses, PostVedicAstrologyBhavaBalaErrors, ThrowOnError>;
|
|
541
|
+
/**
|
|
542
|
+
* Get the Bhav Chalit (Chalit Kundli) cusp-based house chart - Bhav Chalit API
|
|
543
|
+
*
|
|
544
|
+
* Calculate the Bhav Chalit chart, also written Bhava Chalit or Chalit Kundli, placing every graha by unequal Sripati bhava cusps instead of by whole sign. The Rashi (D1) chart treats a whole sign as a house, so a graha a degree from a sign boundary is shown in a house it does not actually occupy; the Chalit chart resolves that by measuring from the bhava sandhis, which is why practitioners check it before reading house results, house lordship strength or transit effects. Returns the twelve bhava boundaries with their madhyas and spans, every graha in both frames, and a moved flag on the placements that differ. Bhav Chalit API, Chalit Kundli calculator, bhava chalit chart, Sripati house cusps, cusp based house chart Vedic astrology.
|
|
545
|
+
*/
|
|
546
|
+
calculateBhavChalit<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyBhavChalitData, ThrowOnError>): RequestResult<PostVedicAstrologyBhavChalitResponses, PostVedicAstrologyBhavChalitErrors, ThrowOnError>;
|
|
547
|
+
/**
|
|
548
|
+
* Heliacal rising and setting (udaya and asta) - Graha Asta Calculator API
|
|
549
|
+
*
|
|
550
|
+
* Calculate heliacal rising (udaya) and setting (asta) of the six visible grahas for any date and place, by the Surya Siddhanta rule. Returns whether each graha currently clears the solar glare, its separation from the Sun in classical degrees of time, and the dates its visibility last changed and next changes. This is the calculation behind Guru Asta and Shukra Asta, the periods classical muhurta withholds marriage and other auspicious ceremonies. Unlike a birth chart combustion flag it is location aware, because the angle the ecliptic makes with the local horizon decides how long a graha lingers after the Sun. Graha asta API, Guru Asta Shukra Asta dates, heliacal rising calculator, planetary combustion muhurta.
|
|
551
|
+
*/
|
|
552
|
+
getHeliacalVisibility<ThrowOnError extends boolean = false>(options?: Options<PostVedicAstrologyHeliacalData, ThrowOnError>): RequestResult<PostVedicAstrologyHeliacalResponses, PostVedicAstrologyHeliacalErrors, ThrowOnError>;
|
|
529
553
|
}
|
|
530
554
|
export declare class Forecast extends HeyApiClient {
|
|
531
555
|
/**
|
|
@@ -533,31 +557,31 @@ export declare class Forecast extends HeyApiClient {
|
|
|
533
557
|
*
|
|
534
558
|
* Build one time-ordered forecast for a single birth subject by merging upcoming events across three domains: western transit-to-natal aspects, sign ingresses, retrograde stations, eclipses, and new and full moons; biorhythm critical days; and vedic Vimshottari mahadasha, antardasha, and pratyantardasha boundaries. The window is clamped to 90 days and events are capped and scored by significance. Built for what-is-coming dashboards, daily and weekly forecast feeds, and timing tools.
|
|
535
559
|
*/
|
|
536
|
-
generateTimeline<ThrowOnError extends boolean = false>(options?: Options<PostForecastTimelineData, ThrowOnError>):
|
|
560
|
+
generateTimeline<ThrowOnError extends boolean = false>(options?: Options<PostForecastTimelineData, ThrowOnError>): RequestResult<PostForecastTimelineResponses, PostForecastTimelineErrors, ThrowOnError>;
|
|
537
561
|
/**
|
|
538
562
|
* Western astrology forecast - aspects, ingresses, stations, eclipses, moon phases
|
|
539
563
|
*
|
|
540
564
|
* Forecast the western astrology events for a single birth chart over a window up to 90 days: every transit-to-natal major aspect refined to its exact instant, every transiting planet sign ingress, every retrograde or direct station, every solar and lunar eclipse, and every New and Full Moon. Returns a time-ordered, significance-scored timeline. Built for astrology forecast feeds, transit alerts, and timing tools.
|
|
541
565
|
*/
|
|
542
|
-
forecastTransits<ThrowOnError extends boolean = false>(options?: Options<PostForecastTransitsData, ThrowOnError>):
|
|
566
|
+
forecastTransits<ThrowOnError extends boolean = false>(options?: Options<PostForecastTransitsData, ThrowOnError>): RequestResult<PostForecastTransitsResponses, PostForecastTransitsErrors, ThrowOnError>;
|
|
543
567
|
/**
|
|
544
568
|
* Significant dates - High-significance cross-domain forecast highlights
|
|
545
569
|
*
|
|
546
570
|
* Return only the high-significance dates from the merged cross-domain forecast for a single birth subject: the rare outer-planet exact transit aspects, slow-planet sign ingresses, retrograde stations, and Vimshottari mahadasha and antardasha changes that mark genuine turning points. Defaults to a significance floor of 70 so the response is a short list of the most meaningful upcoming dates. Built for what-is-coming highlights, timing alerts, and at-a-glance forecast strips.
|
|
547
571
|
*/
|
|
548
|
-
findSignificantDates<ThrowOnError extends boolean = false>(options?: Options<PostForecastSignificantDatesData, ThrowOnError>):
|
|
572
|
+
findSignificantDates<ThrowOnError extends boolean = false>(options?: Options<PostForecastSignificantDatesData, ThrowOnError>): RequestResult<PostForecastSignificantDatesResponses, PostForecastSignificantDatesErrors, ThrowOnError>;
|
|
549
573
|
/**
|
|
550
574
|
* Forecast digest - Pre-summarized next 24h, 7d, 30d, and 90d rollups
|
|
551
575
|
*
|
|
552
576
|
* Roll the cross-domain forecast for a single birth subject into four pre-summarized windows: the next 24 hours, 7 days, 30 days, and 90 days from the start date. Each window returns its event count, a per-domain count breakdown, a per-type count breakdown, and the top highest-significance events. Built for a glanceable what-is-coming strip so a caller can render the upcoming highlights without scanning the full event list.
|
|
553
577
|
*/
|
|
554
|
-
generateDigest<ThrowOnError extends boolean = false>(options?: Options<PostForecastDigestData, ThrowOnError>):
|
|
578
|
+
generateDigest<ThrowOnError extends boolean = false>(options?: Options<PostForecastDigestData, ThrowOnError>): RequestResult<PostForecastDigestResponses, PostForecastDigestErrors, ThrowOnError>;
|
|
555
579
|
/**
|
|
556
580
|
* Solar return chart - Annual birthday forecast chart for a single subject
|
|
557
581
|
*
|
|
558
582
|
* Cast the solar return chart for one subject and year: the chart erected for the exact moment the transiting Sun returns to its natal ecliptic longitude, the foundational technique for annual astrological forecasting. Returns the full tropical chart with planetary positions, house cusps, aspects, Ascendant, and Midheaven. Location-sensitive: pass the birthplace to anchor the chart to natal geography, or the current city for a relocated solar return where the houses and Ascendant shift to where you are on your birthday. Built for year-ahead forecast tools, birthday charts, and annual horoscope features.
|
|
559
583
|
*/
|
|
560
|
-
forecastSolarReturn<ThrowOnError extends boolean = false>(options?: Options<PostForecastSolarReturnData, ThrowOnError>):
|
|
584
|
+
forecastSolarReturn<ThrowOnError extends boolean = false>(options?: Options<PostForecastSolarReturnData, ThrowOnError>): RequestResult<PostForecastSolarReturnResponses, PostForecastSolarReturnErrors, ThrowOnError>;
|
|
561
585
|
}
|
|
562
586
|
export declare class HumanDesign extends HeyApiClient {
|
|
563
587
|
/**
|
|
@@ -565,73 +589,73 @@ export declare class HumanDesign extends HeyApiClient {
|
|
|
565
589
|
*
|
|
566
590
|
* Generate a complete Human Design bodygraph from a birth date, time, and timezone. Returns the energy type, strategy, inner authority, signature, not-self theme, profile, definition, incarnation cross, all nine centers with defined state and active gates, the defined channels, and all 26 planetary activations across the Personality and Design sides. The single endpoint for a full chart in one call, built for Human Design apps, readings, and coaching tools.
|
|
567
591
|
*/
|
|
568
|
-
generateBodygraph<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignBodygraphData, ThrowOnError>):
|
|
592
|
+
generateBodygraph<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignBodygraphData, ThrowOnError>): RequestResult<PostHumanDesignBodygraphResponses, PostHumanDesignBodygraphErrors, ThrowOnError>;
|
|
569
593
|
/**
|
|
570
594
|
* Calculate Human Design connection chart - Two-person composite bodygraph compatibility
|
|
571
595
|
*
|
|
572
596
|
* Calculate a Human Design connection chart by overlaying two bodygraphs. For each of the 36 channels the dynamic between the two people is classified as electromagnetic, dominance, compromise, or companionship, the four mechanics of how two designs meet. Also returns the nine centers as defined or open in the combined bodygraph with which person defines each, the combined definition, and a count of each dynamic. Built for relationship, dating, and coaching tools.
|
|
573
597
|
*/
|
|
574
|
-
calculateConnection<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignConnectionData, ThrowOnError>):
|
|
598
|
+
calculateConnection<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignConnectionData, ThrowOnError>): RequestResult<PostHumanDesignConnectionResponses, PostHumanDesignConnectionErrors, ThrowOnError>;
|
|
575
599
|
/**
|
|
576
600
|
* Calculate Human Design Penta - Small-group BG5 operating system for three to five people
|
|
577
601
|
*
|
|
578
602
|
* Calculate the Human Design Penta (BG5, Base Group 5) for a small group of three to five people. The Penta is a trans-auric form built from a fixed set of six channels running only between the Sacral, the G Center, and the Throat. It reports which of the twelve Penta gates are filled and by whom, which of the six channels are defined Strengths, the upper leadership channels versus the lower generative channels, the 2/14 material core, and the functional gaps where no member supplies a role. Built for team, family, and group analysis tools. Below three people no Penta forms and above five a second Penta emerges, so the group size must be three to five.
|
|
579
603
|
*/
|
|
580
|
-
calculatePenta<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignPentaData, ThrowOnError>):
|
|
604
|
+
calculatePenta<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignPentaData, ThrowOnError>): RequestResult<PostHumanDesignPentaResponses, PostHumanDesignPentaErrors, ThrowOnError>;
|
|
581
605
|
/**
|
|
582
606
|
* Generate Human Design transit overlay - Current planetary activations on a natal bodygraph
|
|
583
607
|
*
|
|
584
608
|
* Overlay the current or any given planetary positions on a natal Human Design bodygraph to see which channels the transit temporarily completes. Returns the 13 transiting body activations with gate and line, the channels the transit completes beyond the natal definition split into personal channels where the transit supplies the partner gate of a natal gate and educational channels where the transit supplies both gates, the natally open centers those channels temporarily define, and a short factual summary. A transit is a single moment, so there is no Design side. When date and time are omitted the overlay is computed for now in UTC. Built for daily Human Design apps, transit widgets, and notification tools.
|
|
585
609
|
*/
|
|
586
|
-
generateTransit<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignTransitData, ThrowOnError>):
|
|
610
|
+
generateTransit<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignTransitData, ThrowOnError>): RequestResult<PostHumanDesignTransitResponses, PostHumanDesignTransitErrors, ThrowOnError>;
|
|
587
611
|
/**
|
|
588
612
|
* Calculate Human Design type, authority and profile
|
|
589
613
|
*
|
|
590
614
|
* Calculate the core Human Design identity from a birth moment: the energy type, the aura strategy, the inner authority, the signature and not-self themes, and the profile. The fast lookup for type-and-authority features without the full bodygraph payload. Verified against NASA JPL Horizons positions.
|
|
591
615
|
*/
|
|
592
|
-
calculateType<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignTypeData, ThrowOnError>):
|
|
616
|
+
calculateType<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignTypeData, ThrowOnError>): RequestResult<PostHumanDesignTypeResponses, PostHumanDesignTypeErrors, ThrowOnError>;
|
|
593
617
|
/**
|
|
594
618
|
* Calculate the 26 Human Design gate activations
|
|
595
619
|
*
|
|
596
620
|
* Calculate the 26 gate activations for a birth moment, split into the 13 conscious Personality activations at birth and the 13 unconscious Design activations 88 degrees of solar arc earlier. Each activation reports the planet, gate, line, gate keynote, and the matching I-Ching hexagram. Built for activation columns and detailed chart views.
|
|
597
621
|
*/
|
|
598
|
-
calculateGates<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignGatesData, ThrowOnError>):
|
|
622
|
+
calculateGates<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignGatesData, ThrowOnError>): RequestResult<PostHumanDesignGatesResponses, PostHumanDesignGatesErrors, ThrowOnError>;
|
|
599
623
|
/**
|
|
600
624
|
* Look up a Human Design gate by number
|
|
601
625
|
*
|
|
602
626
|
* Look up the static reference data for a Human Design gate by its number from 1 to 64: the gate keynote name, the center it sits in, the matching I-Ching hexagram, and the gates that form a channel with it. A pure reference endpoint with no birth data required.
|
|
603
627
|
*/
|
|
604
|
-
getGate<ThrowOnError extends boolean = false>(options: Options<GetHumanDesignGatesByNumberData, ThrowOnError>):
|
|
628
|
+
getGate<ThrowOnError extends boolean = false>(options: Options<GetHumanDesignGatesByNumberData, ThrowOnError>): RequestResult<GetHumanDesignGatesByNumberResponses, GetHumanDesignGatesByNumberErrors, ThrowOnError>;
|
|
605
629
|
/**
|
|
606
630
|
* Calculate the defined Human Design channels
|
|
607
631
|
*
|
|
608
632
|
* Calculate the defined channels for a birth moment. A channel is defined when both of its gates are activated, and it wires together the two centers it connects. Returns each defined channel with its gates, name, circuit family, and connected centers, plus the full set of centers those channels define. Built for bodygraph rendering and definition analysis.
|
|
609
633
|
*/
|
|
610
|
-
calculateChannels<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignChannelsData, ThrowOnError>):
|
|
634
|
+
calculateChannels<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignChannelsData, ThrowOnError>): RequestResult<PostHumanDesignChannelsResponses, PostHumanDesignChannelsErrors, ThrowOnError>;
|
|
611
635
|
/**
|
|
612
636
|
* Calculate the nine Human Design centers
|
|
613
637
|
*
|
|
614
638
|
* Calculate the state of all nine Human Design centers for a birth moment: whether each is defined or open, whether it is a motor or an awareness center, its theme, and the active gates it holds. The data layer behind a rendered bodygraph where defined centers are colored and open centers are white.
|
|
615
639
|
*/
|
|
616
|
-
calculateCenters<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignCentersData, ThrowOnError>):
|
|
640
|
+
calculateCenters<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignCentersData, ThrowOnError>): RequestResult<PostHumanDesignCentersResponses, PostHumanDesignCentersErrors, ThrowOnError>;
|
|
617
641
|
/**
|
|
618
642
|
* Look up a Human Design center by id
|
|
619
643
|
*
|
|
620
644
|
* Look up the static reference data for one of the nine Human Design centers by its id: the display name, whether it is a motor or awareness center, and what it means both defined and undefined. A pure reference endpoint with no birth data required.
|
|
621
645
|
*/
|
|
622
|
-
getCenter<ThrowOnError extends boolean = false>(options: Options<GetHumanDesignCentersByIdData, ThrowOnError>):
|
|
646
|
+
getCenter<ThrowOnError extends boolean = false>(options: Options<GetHumanDesignCentersByIdData, ThrowOnError>): RequestResult<GetHumanDesignCentersByIdResponses, GetHumanDesignCentersByIdErrors, ThrowOnError>;
|
|
623
647
|
/**
|
|
624
648
|
* Calculate the Human Design profile and line keynotes
|
|
625
649
|
*
|
|
626
650
|
* Calculate the Human Design profile for a birth moment: the conscious Personality Sun line over the unconscious Design Sun line, with the keynote for each. The profile is the geometry of the life role, for example 5/1 the Heretic Investigator. Verified against NASA JPL Horizons positions.
|
|
627
651
|
*/
|
|
628
|
-
calculateProfile<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignProfileData, ThrowOnError>):
|
|
652
|
+
calculateProfile<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignProfileData, ThrowOnError>): RequestResult<PostHumanDesignProfileResponses, PostHumanDesignProfileErrors, ThrowOnError>;
|
|
629
653
|
/**
|
|
630
654
|
* Calculate Human Design Variables - The four arrows and Color, Tone, Base substructure
|
|
631
655
|
*
|
|
632
656
|
* Calculate the four Human Design Variable arrows for a birth moment: Determination and Environment on the design side, Perspective and Motivation on the personality side. Each arrow returns its Color, Tone, and Base numbers from the hexagram-line substructure, the left or right direction set by the Tone, and the sourced Color and direction labels. This is the advanced Rave Variables and Primary Health System layer beneath Type, Strategy, Authority, and Profile. Color, Tone, and Base shift with tiny differences in birth time, so each arrow carries a confidence flag that turns false near a Color or Tone boundary, and a precise birth time is essential. Built for Human Design apps offering PHS, diet, environment, and Rave Psychology readings.
|
|
633
657
|
*/
|
|
634
|
-
calculateVariables<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignVariablesData, ThrowOnError>):
|
|
658
|
+
calculateVariables<ThrowOnError extends boolean = false>(options?: Options<PostHumanDesignVariablesData, ThrowOnError>): RequestResult<PostHumanDesignVariablesResponses, PostHumanDesignVariablesErrors, ThrowOnError>;
|
|
635
659
|
}
|
|
636
660
|
export declare class Numerology extends HeyApiClient {
|
|
637
661
|
/**
|
|
@@ -639,121 +663,121 @@ export declare class Numerology extends HeyApiClient {
|
|
|
639
663
|
*
|
|
640
664
|
* Calculate your Life Path number from your birth date using Pythagorean numerology. This is the most significant number in your numerology chart, revealing your life purpose, natural talents, and destiny path. Automatically detects Master Numbers (11, 22, 33) and Karmic Debt numbers (13, 14, 16, 19). Returns comprehensive interpretation including personality traits, strengths, challenges, career guidance, relationship compatibility, and spiritual insights. Perfect for numerology apps, birth chart calculators, life purpose discovery tools, personal development platforms, and astrology services. Get detailed 300-500 word meanings for all numbers 1-9, 11, 22, and 33.
|
|
641
665
|
*/
|
|
642
|
-
calculateLifePath<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyLifePathData, ThrowOnError>):
|
|
666
|
+
calculateLifePath<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyLifePathData, ThrowOnError>): RequestResult<PostNumerologyLifePathResponses, PostNumerologyLifePathErrors, ThrowOnError>;
|
|
643
667
|
/**
|
|
644
668
|
* Calculate Expression number - Natural talents and life goals
|
|
645
669
|
*
|
|
646
670
|
* Calculate your Expression (Destiny) number from your full birth name using Pythagorean numerology. This number reveals your natural talents, abilities, and life goals. It shows what you came here to do and what tools you have to accomplish your life purpose. Returns comprehensive interpretation including personality traits, career paths, relationship dynamics, and spiritual insights. Automatically detects Master Numbers (11, 22, 33). Perfect for name numerology apps, career guidance tools, personal development platforms, and talent assessment services. Get detailed 300-500 word meanings for all numbers 1-9, 11, 22, and 33.
|
|
647
671
|
*/
|
|
648
|
-
calculateExpression<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyExpressionData, ThrowOnError>):
|
|
672
|
+
calculateExpression<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyExpressionData, ThrowOnError>): RequestResult<PostNumerologyExpressionResponses, PostNumerologyExpressionErrors, ThrowOnError>;
|
|
649
673
|
/**
|
|
650
674
|
* Calculate Bridge Numbers - Harmonize different aspects of personality
|
|
651
675
|
*
|
|
652
676
|
* Calculate three Bridge Numbers that reveal the adjustments needed to create harmony between different aspects of your numerology profile. Bridge Numbers are the absolute difference between pairs of core numbers: Life Path and Expression, Expression and Personality, Expression and Soul Urge. A Bridge of 0 means the two aspects are already aligned. Higher bridges (1 to 8) indicate greater tension and provide specific guidance on what changes to make. Bridge Numbers are essential for personal development, coaching applications, self-improvement platforms, and AI-powered personality analysis tools. Requires both a full birth name and birth date to calculate all four core numbers (Life Path, Expression, Soul Urge, Personality) internally before deriving the bridges.
|
|
653
677
|
*/
|
|
654
|
-
calculateBridgeNumbers<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyBridgeData, ThrowOnError>):
|
|
678
|
+
calculateBridgeNumbers<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyBridgeData, ThrowOnError>): RequestResult<PostNumerologyBridgeResponses, PostNumerologyBridgeErrors, ThrowOnError>;
|
|
655
679
|
/**
|
|
656
680
|
* Calculate Soul Urge number - Inner motivations and desires
|
|
657
681
|
*
|
|
658
682
|
* Calculate your Soul Urge (Heart Desire) number from the vowels in your birth name using Pythagorean numerology. This number reveals your innermost desires, motivations, and what your soul truly wants to experience. It shows what drives you from within, your emotional needs, and what brings you fulfillment. Returns comprehensive interpretation including personality traits, emotional needs, relationship desires, and spiritual longings. Automatically detects Master Numbers (11, 22, 33). Perfect for self-discovery apps, emotional intelligence tools, relationship counseling platforms, and personal development services. Get detailed 300-500 word meanings for all numbers 1-9, 11, 22, and 33.
|
|
659
683
|
*/
|
|
660
|
-
calculateSoulUrge<ThrowOnError extends boolean = false>(options?: Options<PostNumerologySoulUrgeData, ThrowOnError>):
|
|
684
|
+
calculateSoulUrge<ThrowOnError extends boolean = false>(options?: Options<PostNumerologySoulUrgeData, ThrowOnError>): RequestResult<PostNumerologySoulUrgeResponses, PostNumerologySoulUrgeErrors, ThrowOnError>;
|
|
661
685
|
/**
|
|
662
686
|
* Calculate Personality number - How others perceive you
|
|
663
687
|
*
|
|
664
688
|
* Calculate your Personality number from the consonants in your birth name using Pythagorean numerology. This number reveals how others perceive you, your outer personality, and first impressions you make. It represents the mask you show the world and your social persona. Returns comprehensive interpretation including public image, social dynamics, professional presence, and relationship first impressions. Automatically detects Master Numbers (11, 22, 33). Perfect for personal branding apps, social skills training, professional development platforms, and communication coaching services. Get detailed 300-500 word meanings for all numbers 1-9, 11, 22, and 33.
|
|
665
689
|
*/
|
|
666
|
-
calculatePersonality<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalityData, ThrowOnError>):
|
|
690
|
+
calculatePersonality<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalityData, ThrowOnError>): RequestResult<PostNumerologyPersonalityResponses, PostNumerologyPersonalityErrors, ThrowOnError>;
|
|
667
691
|
/**
|
|
668
692
|
* Calculate Birth Day number - Special talents from day of birth
|
|
669
693
|
*
|
|
670
694
|
* Calculate your Birth Day number from the day you were born (1-31) using Pythagorean numerology. This number reveals special talents and abilities you possess from birth. It shows natural gifts that can help you achieve your life purpose. Returns comprehensive interpretation including innate talents, natural abilities, career advantages, and how to leverage your special gifts. Automatically detects Master Numbers (11, 22) and reduces double-digit days. Perfect for talent discovery apps, career counseling platforms, personal development services, and skill assessment tools. Get detailed 300-500 word meanings for all numbers 1-9, 11, and 22.
|
|
671
695
|
*/
|
|
672
|
-
calculateBirthDay<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyBirthDayData, ThrowOnError>):
|
|
696
|
+
calculateBirthDay<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyBirthDayData, ThrowOnError>): RequestResult<PostNumerologyBirthDayResponses, PostNumerologyBirthDayErrors, ThrowOnError>;
|
|
673
697
|
/**
|
|
674
698
|
* Calculate Maturity number - Who you become in later life
|
|
675
699
|
*
|
|
676
700
|
* Calculate your Maturity (Realization) number by adding Life Path and Expression numbers using Pythagorean numerology. This number reveals who you become in the second half of life, typically manifesting after age 35-40. It shows the ultimate goal of personal development and mature self-expression. Returns comprehensive interpretation including life transformation, mature personality, later-life purpose, and wisdom development. Automatically detects Master Numbers (11, 22, 33). Perfect for life coaching apps, midlife guidance platforms, personal development services, and aging wisdom tools. Get detailed 300-500 word meanings for all numbers 1-9, 11, 22, and 33.
|
|
677
701
|
*/
|
|
678
|
-
calculateMaturity<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyMaturityData, ThrowOnError>):
|
|
702
|
+
calculateMaturity<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyMaturityData, ThrowOnError>): RequestResult<PostNumerologyMaturityResponses, PostNumerologyMaturityErrors, ThrowOnError>;
|
|
679
703
|
/**
|
|
680
704
|
* Analyze Karmic Lessons - Life lessons from missing numbers
|
|
681
705
|
*
|
|
682
706
|
* Analyze your Karmic Lessons from your birth name using Pythagorean numerology. Karmic lessons are indicated by numbers missing from your name (numbers 1-9 that do not appear). These represent challenges you came to learn and skills you need to develop in this lifetime. Returns comprehensive analysis including missing numbers, specific lessons for each, challenges to overcome, and practical guidance for development. Perfect for spiritual growth apps, personal development platforms, life coaching services, and self-improvement tools. Get detailed lesson descriptions, development strategies, and practical exercises for each missing number.
|
|
683
707
|
*/
|
|
684
|
-
analyzeKarmicLessons<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyKarmicLessonsData, ThrowOnError>):
|
|
708
|
+
analyzeKarmicLessons<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyKarmicLessonsData, ThrowOnError>): RequestResult<PostNumerologyKarmicLessonsResponses, PostNumerologyKarmicLessonsErrors, ThrowOnError>;
|
|
685
709
|
/**
|
|
686
710
|
* Detect Karmic Debt numbers - Past life challenges (13, 14, 16, 19)
|
|
687
711
|
*
|
|
688
712
|
* Check for Karmic Debt numbers (13, 14, 16, 19) in Life Path, Expression, Soul Urge, or Personality calculations using Pythagorean numerology. Karmic debt indicates challenges carried from past lives that must be resolved in this lifetime. These numbers appear during reduction and represent specific lessons and tests. Returns comprehensive analysis including debt descriptions, challenges to overcome, and resolution guidance. Perfect for spiritual growth apps, karmic astrology platforms, past life exploration services, and personal transformation tools. Get detailed meanings for all four karmic debt numbers with practical resolution strategies.
|
|
689
713
|
*/
|
|
690
|
-
checkKarmicDebt<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyKarmicDebtData, ThrowOnError>):
|
|
714
|
+
checkKarmicDebt<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyKarmicDebtData, ThrowOnError>): RequestResult<PostNumerologyKarmicDebtResponses, PostNumerologyKarmicDebtErrors, ThrowOnError>;
|
|
691
715
|
/**
|
|
692
716
|
* Calculate Personal Day - Daily personalized numerology forecast
|
|
693
717
|
*
|
|
694
718
|
* Calculate your Personal Day number from birth month, day, and a target date. Personal Day is the most granular cycle in Pythagorean numerology, revealing the specific energy and theme for a single calendar day personalized to you. Unlike generic daily numbers, this is based on YOUR birth data combined with the calendar date. Returns the daily theme, actionable guidance, and parent month and year context. Perfect for daily push notifications, morning briefings, calendar widget integrations, daily content generation, and life coaching tools.
|
|
695
719
|
*/
|
|
696
|
-
calculatePersonalDay<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalDayData, ThrowOnError>):
|
|
720
|
+
calculatePersonalDay<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalDayData, ThrowOnError>): RequestResult<PostNumerologyPersonalDayResponses, PostNumerologyPersonalDayErrors, ThrowOnError>;
|
|
697
721
|
/**
|
|
698
722
|
* Calculate Personal Month - Monthly numerology forecast
|
|
699
723
|
*
|
|
700
724
|
* Calculate your Personal Month number from birth month, day, and a target year and month. Personal Month reveals the specific theme and energy influencing each calendar month within your Personal Year cycle. Returns the monthly theme, practical focus guidance, and the parent Personal Year context. Perfect for monthly forecast features, push notification content, calendar integrations, editorial monthly columns, and life coaching tools.
|
|
701
725
|
*/
|
|
702
|
-
calculatePersonalMonth<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalMonthData, ThrowOnError>):
|
|
726
|
+
calculatePersonalMonth<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalMonthData, ThrowOnError>): RequestResult<PostNumerologyPersonalMonthResponses, PostNumerologyPersonalMonthErrors, ThrowOnError>;
|
|
703
727
|
/**
|
|
704
728
|
* Calculate Personal Year - Annual cycle and forecast for current year
|
|
705
729
|
*
|
|
706
730
|
* Calculate your Personal Year number from your birth month, day, and current year using Pythagorean numerology. Personal Year runs in 9-year cycles (1-9) and reveals the theme, opportunities, and challenges for the current year. Each year has a specific energy and lessons. Returns comprehensive annual forecast including year theme, opportunities, challenges, and actionable advice. Perfect for yearly planning apps, life coaching platforms, astrology services, and personal development tools. Get detailed forecasts for all 9 Personal Year cycles with practical guidance.
|
|
707
731
|
*/
|
|
708
|
-
calculatePersonalYear<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalYearData, ThrowOnError>):
|
|
732
|
+
calculatePersonalYear<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyPersonalYearData, ThrowOnError>): RequestResult<PostNumerologyPersonalYearResponses, PostNumerologyPersonalYearErrors, ThrowOnError>;
|
|
709
733
|
/**
|
|
710
734
|
* Calculate Compatibility - Relationship dynamics between two people
|
|
711
735
|
*
|
|
712
736
|
* Calculate numerology compatibility between two people using Pythagorean numerology. Accepts two input modes per person: pre-calculated Life Path, Expression, and Soul Urge numbers, or raw name and birthdate for automatic calculation. You can mix modes across persons (e.g. numbers for person1, raw inputs for person2). Provides comprehensive relationship analysis with overall compatibility score (0-100), individual aspect compatibility (Life Path 50% weight, Expression 30%, Soul Urge 20%), relationship strengths, challenges, and practical advice. Uses detailed compatibility matrix for all number combinations. Perfect for dating apps, relationship counseling platforms, matchmaking services, and compatibility tools. Get actionable insights for improving relationship dynamics.
|
|
713
737
|
*/
|
|
714
|
-
calculateNumCompatibility<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyCompatibilityData, ThrowOnError>):
|
|
738
|
+
calculateNumCompatibility<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyCompatibilityData, ThrowOnError>): RequestResult<PostNumerologyCompatibilityResponses, PostNumerologyCompatibilityErrors, ThrowOnError>;
|
|
715
739
|
/**
|
|
716
740
|
* Generate Complete Numerology Chart - Full profile analysis
|
|
717
741
|
*
|
|
718
742
|
* Generate a comprehensive numerology chart combining all major calculations: Life Path, Expression, Soul Urge, Personality, Birth Day, Maturity, Karmic Lessons, Karmic Debt, and Personal Year. This single endpoint provides everything needed for a full numerology reading. Returns detailed interpretations for all numbers, karmic analysis, yearly forecast, and holistic summary. Perfect for numerology apps, complete reading services, birth chart generators, and comprehensive analysis tools. Save multiple API calls by getting the full chart in one request. Ideal for generating PDF reports or detailed user profiles.
|
|
719
743
|
*/
|
|
720
|
-
generateNumerologyChart<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyChartData, ThrowOnError>):
|
|
744
|
+
generateNumerologyChart<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyChartData, ThrowOnError>): RequestResult<PostNumerologyChartResponses, PostNumerologyChartErrors, ThrowOnError>;
|
|
721
745
|
/**
|
|
722
746
|
* Get Number Meaning - Interpretation for any number 1-9, 11, 22, 33
|
|
723
747
|
*
|
|
724
748
|
* Get the complete meaning and interpretation for any numerology number (1-9, 11, 22, 33) using Pythagorean numerology. Returns comprehensive description including archetype title, keywords, personality traits, strengths, weaknesses, career guidance, relationship dynamics, and spiritual insights. Master numbers (11, 22, 33) include amplified meanings with their reduced base number. Perfect for numerology reference tools, educational apps, quick lookups, and building custom numerology calculators. Get detailed 300-500 word expert-written meanings for all 12 valid numerology numbers.
|
|
725
749
|
*/
|
|
726
|
-
getNumberMeaning<ThrowOnError extends boolean = false>(options: Options<GetNumerologyMeaningsByNumberData, ThrowOnError>):
|
|
750
|
+
getNumberMeaning<ThrowOnError extends boolean = false>(options: Options<GetNumerologyMeaningsByNumberData, ThrowOnError>): RequestResult<GetNumerologyMeaningsByNumberResponses, GetNumerologyMeaningsByNumberErrors, ThrowOnError>;
|
|
727
751
|
/**
|
|
728
752
|
* Get daily numerology number - Number of the Day with interpretation
|
|
729
753
|
*
|
|
730
754
|
* Receive a daily numerology number (1-9, 11, 22, 33) for guidance and reflection. Uses seeded randomness so the same seed gets the same number on the same date, perfect for "Number of the Day" features in numerology apps, wellness platforms, and daily guidance tools. Returns the number with full interpretation including archetype, keywords, strengths, challenges, career, relationships, and spiritual insights. Ideal for daily push notifications, morning briefings, and personalized numerology experiences.
|
|
731
755
|
*/
|
|
732
|
-
getDailyNumber<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyDailyData, ThrowOnError>):
|
|
756
|
+
getDailyNumber<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyDailyData, ThrowOnError>): RequestResult<PostNumerologyDailyResponses, PostNumerologyDailyErrors, ThrowOnError>;
|
|
733
757
|
/**
|
|
734
758
|
* Chaldean numerology name reading - Destiny, compound number, planetary ruler
|
|
735
759
|
*
|
|
736
760
|
* Calculate a complete Chaldean numerology reading for a name. The older Chaldean system maps letters to values 1 to 8 by vibration (the number 9 is sacred and never assigned to a letter) and reads the unreduced two-digit compound number (10 to 52, also called a fadic number, defined by Cheiro) in addition to the single-digit root. Returns the Destiny or name number from all letters, the Soul Urge from vowels, and the Personality from consonants, each with its compound number, root, and Cheiro compound interpretation, plus the planetary ruler of the Destiny root and a caution flag for the karmic numbers 4 and 8. Perfect for Chaldean numerology calculators, name analysis tools, and AI numerology assistants that need both the compound and root layers in one call.
|
|
737
761
|
*/
|
|
738
|
-
calculateChaldean<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyChaldeanData, ThrowOnError>):
|
|
762
|
+
calculateChaldean<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyChaldeanData, ThrowOnError>): RequestResult<PostNumerologyChaldeanResponses, PostNumerologyChaldeanErrors, ThrowOnError>;
|
|
739
763
|
/**
|
|
740
764
|
* Compound number meaning - Cheiro Chaldean interpretation 10 to 52
|
|
741
765
|
*
|
|
742
766
|
* Get the classical Chaldean interpretation of a compound number (also called a fadic number) from 10 to 52, as defined by Cheiro in the Book of Numbers. Compound numbers are the unreduced two-digit numbers that reveal the hidden influence behind a name or date, beyond the single-digit root. Each returns its symbolic title (such as The Wheel of Fortune for 10, The Star of the Magi for 17, or The Crown of the Magi for 21), its nature (fortunate, unfortunate, or mixed), and a full interpretation. Numbers 33 to 52 share the meaning of a lower number in their series, returned with a sameAs pointer. Perfect for Chaldean numerology references, compound number lookups, and AI numerology tools.
|
|
743
767
|
*/
|
|
744
|
-
getCompoundNumber<ThrowOnError extends boolean = false>(options: Options<GetNumerologyCompoundNumberByNumberData, ThrowOnError>):
|
|
768
|
+
getCompoundNumber<ThrowOnError extends boolean = false>(options: Options<GetNumerologyCompoundNumberByNumberData, ThrowOnError>): RequestResult<GetNumerologyCompoundNumberByNumberResponses, GetNumerologyCompoundNumberByNumberErrors, ThrowOnError>;
|
|
745
769
|
/**
|
|
746
770
|
* Dual numerology - Pythagorean and Chaldean name numbers in one call
|
|
747
771
|
*
|
|
748
772
|
* Calculate a name number in both major numerology systems at once and compare them. The Pythagorean system maps letters 1 to 9 in alphabetical order and preserves master numbers (11, 22, 33), giving the Expression or Destiny number used in modern Western numerology. The Chaldean system maps letters 1 to 8 by vibration, reads the compound number (10 to 52), and reduces to a root 1 to 9. Returns both results with their interpretations, plus an agreement flag showing whether the two systems point to the same single-digit energy. The only numerology API that returns Pythagorean and Chaldean for a name in a single request, ideal for comparison tools and AI numerology assistants.
|
|
749
773
|
*/
|
|
750
|
-
calculateDual<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyDualData, ThrowOnError>):
|
|
774
|
+
calculateDual<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyDualData, ThrowOnError>): RequestResult<PostNumerologyDualResponses, PostNumerologyDualErrors, ThrowOnError>;
|
|
751
775
|
/**
|
|
752
776
|
* Business name numerology - Chaldean brand name analysis and lucky numbers
|
|
753
777
|
*
|
|
754
778
|
* Analyze a business or brand name with Chaldean numerology, the system practitioners use for trade names. Returns the name number (compound and root), its planetary ruler, an overall business rating, the industries the number favors, and whether the compound is one of Cheiro fortunate compounds. The most favorable business roots are 1 (leadership), 3 (expansion), 5 (commerce) and 6 (beauty and hospitality); the numbers 4 and 8 carry caution as the karmic numbers of instability and heavy demand. Use it to vet a company name, compare brand options, or guide a naming decision. This is positioning guidance layered over the fundamentals of a memorable, available name, not a guarantee.
|
|
755
779
|
*/
|
|
756
|
-
calculateBusinessName<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyBusinessNameData, ThrowOnError>):
|
|
780
|
+
calculateBusinessName<ThrowOnError extends boolean = false>(options?: Options<PostNumerologyBusinessNameData, ThrowOnError>): RequestResult<PostNumerologyBusinessNameResponses, PostNumerologyBusinessNameErrors, ThrowOnError>;
|
|
757
781
|
}
|
|
758
782
|
export declare class Tarot extends HeyApiClient {
|
|
759
783
|
/**
|
|
@@ -761,61 +785,61 @@ export declare class Tarot extends HeyApiClient {
|
|
|
761
785
|
*
|
|
762
786
|
* Retrieve the complete Rider-Waite-Smith tarot deck of 78 cards: 22 Major Arcana (numbered 0-21, representing life lessons, spiritual themes, and karmic influences like The Fool, Death, The Tower) plus 56 Minor Arcana (4 suits × 14 cards each for daily situations and practical matters). Filter by arcana type (major for spiritual guidance, minor for everyday concerns), suit (cups for emotions and relationships, wands for creativity and passion, swords for intellect and conflict, pentacles for material wealth and finances), or card number (Ace=1 for new beginnings, 2-10 for progression, Page=11 for messages, Knight=12 for action, Queen=13 for mastery, King=14 for authority). Returns lightweight basic card data - use GET /cards/:id for full upright and reversed interpretations with keywords. Perfect for building tarot reference libraries, card databases, learning applications, or browsing the complete traditional deck used by professional tarot readers worldwide.
|
|
763
787
|
*/
|
|
764
|
-
listCards<ThrowOnError extends boolean = false>(options?: Options<GetTarotCardsData, ThrowOnError>):
|
|
788
|
+
listCards<ThrowOnError extends boolean = false>(options?: Options<GetTarotCardsData, ThrowOnError>): RequestResult<GetTarotCardsResponses, GetTarotCardsErrors, ThrowOnError>;
|
|
765
789
|
/**
|
|
766
790
|
* Get detailed tarot card information
|
|
767
791
|
*
|
|
768
792
|
* Retrieve comprehensive details for a specific tarot card from the traditional Rider-Waite-Smith deck including complete upright meanings (card drawn normally) and reversed meanings (inverted/upside down interpretations for nuanced guidance). Each card provides keywords for quick reference, full interpretations (400+ words each for upright and reversed orientations), and guidance across life domains: love and relationships, career and professional growth, finances and material success, health and wellbeing, spirituality and personal development. Major Arcana cards (0-21) reveal deep spiritual lessons and life-changing themes. Minor Arcana cards (Ace through King in Cups, Wands, Swords, Pentacles) address practical daily situations and specific challenges. Use card ID in kebab-case format: Major Arcana like "fool", "magician", "death", "tower", or Minor Arcana like "ace-of-cups", "seven-of-wands", "queen-of-swords", "king-of-pentacles". Essential for detailed tarot study, reading interpretations, divination apps, fortune-telling platforms, spiritual guidance tools, and professional tarot learning applications.
|
|
769
793
|
*/
|
|
770
|
-
getCard<ThrowOnError extends boolean = false>(options: Options<GetTarotCardsByIdData, ThrowOnError>):
|
|
794
|
+
getCard<ThrowOnError extends boolean = false>(options: Options<GetTarotCardsByIdData, ThrowOnError>): RequestResult<GetTarotCardsByIdResponses, GetTarotCardsByIdErrors, ThrowOnError>;
|
|
771
795
|
/**
|
|
772
796
|
* Draw random tarot cards with reproducible results
|
|
773
797
|
*
|
|
774
798
|
* Draw 1-78 tarot cards from the complete Rider-Waite-Smith deck with seeded reproducibility for consistent personalized readings. Provide an optional seed string (like "user123-2025-12-27" or "readingId") to ensure the same seed always returns identical cards in the exact same order - essential for daily tarot features, personalized user experiences, shareable readings, or reproducible testing. Omit seed for true random draws each time. Control card reversals (upright vs reversed/inverted orientations - reversed cards provide alternative meanings when drawn upside down) and duplicates (traditional deck draws each of 78 cards once, or oracle-style allows repeating same card). Each drawn card includes position number, reversal state (boolean), keywords for quick interpretation, full meaning text (400+ words), authentic Rider-Waite imagery, and card metadata. Perfect for custom spread builders, random card generators, automated tarot reading platforms, daily card features, meditation apps, journaling prompts, divination tools, and any application requiring reproducible or random tarot draws from the industry-standard 78-card deck (22 Major Arcana spiritual lessons + 56 Minor Arcana practical guidance across 4 suits).
|
|
775
799
|
*/
|
|
776
|
-
drawCards<ThrowOnError extends boolean = false>(options: Options<PostTarotDrawData, ThrowOnError>):
|
|
800
|
+
drawCards<ThrowOnError extends boolean = false>(options: Options<PostTarotDrawData, ThrowOnError>): RequestResult<PostTarotDrawResponses, PostTarotDrawErrors, ThrowOnError>;
|
|
777
801
|
/**
|
|
778
802
|
* Get daily tarot card reading
|
|
779
803
|
*
|
|
780
804
|
* Receive a single tarot card for daily guidance and reflection. This endpoint uses seeded randomness to ensure the same seed gets the same card on the same day - perfect for "Card of the Day" features. Provide a seed (userId, email hash, session token) for reproducible consistency, or omit for anonymous daily draws. Returns card with keywords, full meaning, and a daily message summary. Great for tarot apps, wellness platforms, morning ritual apps, and journaling tools.
|
|
781
805
|
*/
|
|
782
|
-
getDailyCard<ThrowOnError extends boolean = false>(options?: Options<PostTarotDailyData, ThrowOnError>):
|
|
806
|
+
getDailyCard<ThrowOnError extends boolean = false>(options?: Options<PostTarotDailyData, ThrowOnError>): RequestResult<PostTarotDailyResponses, PostTarotDailyErrors, ThrowOnError>;
|
|
783
807
|
/**
|
|
784
808
|
* Get yes/no answer to your question
|
|
785
809
|
*
|
|
786
810
|
* Ask a specific question and receive a yes, no, or maybe answer based on a single tarot card draw. Upright cards indicate "Yes" with positive energy, reversed cards indicate "No" with caution, and certain inherently ambiguous cards (The Hanged Man, Wheel of Fortune, Temperance, Two of Swords, Four of Swords) return "Maybe" regardless of orientation since their energy signals pause, reflection, or shifting circumstances. Major Arcana cards give strong definitive answers, Minor Arcana cards give qualified nuanced answers. Returns the answer, strength level, drawn card details, and a contextual interpretation explaining why. Perfect for decision-making apps, quick guidance tools, fortune-telling chatbots, and interactive tarot experiences. Optionally provide a seed for reproducible answers.
|
|
787
811
|
*/
|
|
788
|
-
castYesNo<ThrowOnError extends boolean = false>(options: Options<PostTarotYesNoData, ThrowOnError>):
|
|
812
|
+
castYesNo<ThrowOnError extends boolean = false>(options: Options<PostTarotYesNoData, ThrowOnError>): RequestResult<PostTarotYesNoResponses, PostTarotYesNoErrors, ThrowOnError>;
|
|
789
813
|
/**
|
|
790
814
|
* Three-Card Spread: Past, Present, Future
|
|
791
815
|
*
|
|
792
816
|
* Perform the classic three-card tarot spread revealing Past (what led to this situation), Present (current energy and circumstances), and Future (likely outcome if current path continues). The most popular beginner-friendly spread, perfect for quick insights, daily guidance, or exploring specific questions. Each position includes a drawn card with reversal state, keywords, full meaning, and position-specific interpretation. Returns a summary connecting all three cards. Ideal for tarot reading apps, decision-making tools, and personal growth platforms. Optionally provide a seed for reproducible readings.
|
|
793
817
|
*/
|
|
794
|
-
castThreeCard<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsThreeCardData, ThrowOnError>):
|
|
818
|
+
castThreeCard<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsThreeCardData, ThrowOnError>): RequestResult<PostTarotSpreadsThreeCardResponses, PostTarotSpreadsThreeCardErrors, ThrowOnError>;
|
|
795
819
|
/**
|
|
796
820
|
* Celtic Cross Spread (10 cards)
|
|
797
821
|
*
|
|
798
822
|
* Perform the legendary Celtic Cross spread - the most comprehensive and detailed tarot reading available, used by professional tarot readers worldwide for over a century. This 10-card layout reveals the complete picture of any situation through distinct positions: Present Situation (what is happening now), Challenge (obstacles crossing your path), Distant Past (root causes), Recent Past (recent influences), Best Outcome (potential positive result), Near Future (what is approaching in weeks ahead), Your Approach (your attitude and self-perception), External Influences (environment and other people impact), Hopes and Fears (your desires and anxieties), and Final Outcome (where everything is headed). Perfect for life-changing decisions, complex relationship questions, career transitions, spiritual guidance, and deep self-discovery. Ideal for professional tarot apps, life coaching platforms, spiritual wellness websites, and divination tools requiring authoritative comprehensive readings. Each card position provides layered insight combining traditional tarot wisdom with modern psychological interpretation for actionable guidance.
|
|
799
823
|
*/
|
|
800
|
-
castCelticCross<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCelticCrossData, ThrowOnError>):
|
|
824
|
+
castCelticCross<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCelticCrossData, ThrowOnError>): RequestResult<PostTarotSpreadsCelticCrossResponses, PostTarotSpreadsCelticCrossErrors, ThrowOnError>;
|
|
801
825
|
/**
|
|
802
826
|
* Love Spread (5 cards)
|
|
803
827
|
*
|
|
804
828
|
* Perform a specialized 5-card relationship tarot spread analyzing romantic connections, emotional dynamics, and partnership potential. This love-focused reading examines five crucial relationship aspects: You (your current emotional state, needs, and what you bring to the relationship), Partner/Other (their emotional perspective, desires, and energy), Relationship Dynamic (the current energy and connection between you both), Challenge (obstacles needing attention, healing, or communication), and Outcome (where this romantic connection is naturally heading). Perfect for dating apps, relationship counseling platforms, matchmaking services, wellness apps, and romantic guidance tools. Provides deep insight into new relationships, existing partnerships, potential connections, breakup recovery, or self-love journeys. Ideal for understanding compatibility, resolving conflicts, strengthening bonds, or deciding whether to pursue or continue a relationship. Each position reveals emotional truths combining traditional tarot relationship wisdom with modern relationship psychology. Use for individual readings or couples readings to gain perspective on romantic situations from singleness to marriage.
|
|
805
829
|
*/
|
|
806
|
-
castLoveSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsLoveData, ThrowOnError>):
|
|
830
|
+
castLoveSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsLoveData, ThrowOnError>): RequestResult<PostTarotSpreadsLoveResponses, PostTarotSpreadsLoveErrors, ThrowOnError>;
|
|
807
831
|
/**
|
|
808
832
|
* Career Spread (7 cards)
|
|
809
833
|
*
|
|
810
834
|
* Perform a comprehensive 7-card career tarot spread using SWOT analysis framework (Strengths, Weaknesses, Opportunities, Threats) for professional guidance, business decisions, and vocational clarity. This career-focused reading examines seven strategic business aspects: Current Situation (your present professional position and workplace energy), Strengths (your professional assets, talents, and competitive advantages), Weaknesses (areas needing development, skill gaps, or limiting beliefs), Opportunities (potential growth paths, new ventures, or doors opening), Threats (obstacles, competition, or external challenges), Advice (actionable guidance for navigating your career path), and Outcome (where your professional journey is heading if you follow the guidance). Perfect for career coaching platforms, professional development apps, business consulting tools, job search websites, entrepreneurship platforms, and executive coaching services. Use for career transitions, job offers evaluation, promotion decisions, starting a business, workplace conflicts, finding your calling, or strategic career planning. Combines traditional tarot wisdom with modern SWOT business analysis for practical professional insight. Ideal for employees, entrepreneurs, freelancers, career changers, and anyone seeking vocational direction.
|
|
811
835
|
*/
|
|
812
|
-
castCareerSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCareerData, ThrowOnError>):
|
|
836
|
+
castCareerSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCareerData, ThrowOnError>): RequestResult<PostTarotSpreadsCareerResponses, PostTarotSpreadsCareerErrors, ThrowOnError>;
|
|
813
837
|
/**
|
|
814
838
|
* Custom Spread Builder
|
|
815
839
|
*
|
|
816
840
|
* Build and perform your own custom tarot spread with personalized positions and interpretations (1-10 cards). This flexible endpoint lets you create unique spread layouts for any purpose - define your own position names, meanings, and card count to match your specific needs or therapeutic framework. Perfect for therapists using tarot in counseling, coaches creating signature spreads, app developers building custom reading features, spiritual practitioners with proprietary methods, or anyone wanting to design specialized layouts beyond traditional spreads. Create spreads for specific themes like chakra readings (7 cards), lunar phases (8 cards), elements (4 cards), goals setting (any count), shadow work, inner child healing, decision matrices, or creative problem-solving. Each position requires a name and interpretation - you define what each card position represents in your reading. The API draws the exact number of cards you specify and maps them to your custom positions. No pre-generated summary provided - you interpret the reading based on your framework. Ideal for innovative tarot apps, therapeutic tools, personal development platforms, spiritual coaching services, or experimental divination methods. Maximum 10 positions to maintain reading clarity and practical interpretation time.
|
|
817
841
|
*/
|
|
818
|
-
castCustomSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCustomData, ThrowOnError>):
|
|
842
|
+
castCustomSpread<ThrowOnError extends boolean = false>(options: Options<PostTarotSpreadsCustomData, ThrowOnError>): RequestResult<PostTarotSpreadsCustomResponses, PostTarotSpreadsCustomErrors, ThrowOnError>;
|
|
819
843
|
}
|
|
820
844
|
export declare class Biorhythm extends HeyApiClient {
|
|
821
845
|
/**
|
|
@@ -823,37 +847,37 @@ export declare class Biorhythm extends HeyApiClient {
|
|
|
823
847
|
*
|
|
824
848
|
* Calculate a complete biorhythm reading for a given birth date and target date. Returns all 10 cycle values (physical, emotional, intellectual, intuitive, aesthetic, awareness, spiritual, passion, mastery, wisdom), phase detection with 8 distinct states, energy rating (1-10), overall phase assessment, editorial-grade interpretation, actionable advice, and critical day alerts. Perfect for wellness apps, dating platforms, productivity tools, and AI chatbot integrations that need structured biorhythm data.
|
|
825
849
|
*/
|
|
826
|
-
getReading<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmReadingData, ThrowOnError>):
|
|
850
|
+
getReading<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmReadingData, ThrowOnError>): RequestResult<PostBiorhythmReadingResponses, PostBiorhythmReadingErrors, ThrowOnError>;
|
|
827
851
|
/**
|
|
828
852
|
* Get biorhythm forecast - Multi-day cycle predictions with best and worst days
|
|
829
853
|
*
|
|
830
854
|
* Generate a biorhythm forecast for a date range up to 90 days. Returns daily cycle values for physical, emotional, intellectual, and intuitive cycles, daily energy ratings, critical day identification, and a summary with best day, worst day, average energy, and period-level guidance. Ideal for wellness apps, productivity planners, scheduling tools, and calendar integrations that need forward-looking biorhythm data.
|
|
831
855
|
*/
|
|
832
|
-
getForecast<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmForecastData, ThrowOnError>):
|
|
856
|
+
getForecast<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmForecastData, ThrowOnError>): RequestResult<PostBiorhythmForecastResponses, PostBiorhythmForecastErrors, ThrowOnError>;
|
|
833
857
|
/**
|
|
834
858
|
* Find critical days - Zero crossing detection for any date range
|
|
835
859
|
*
|
|
836
860
|
* Find all critical days (zero crossings) within a date range up to 180 days. Returns each critical day with cycle name, period, direction (ascending or descending), severity (single, double, or triple), and advisory text. Highlights rare double critical days where two primary cycles cross zero simultaneously and extremely rare triple critical days where all three primary cycles cross zero on the same date. Ideal for calendar integrations, push notification systems, alert engines, and wellness scheduling tools.
|
|
837
861
|
*/
|
|
838
|
-
getCriticalDays<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmCriticalDaysData, ThrowOnError>):
|
|
862
|
+
getCriticalDays<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmCriticalDaysData, ThrowOnError>): RequestResult<PostBiorhythmCriticalDaysResponses, PostBiorhythmCriticalDaysErrors, ThrowOnError>;
|
|
839
863
|
/**
|
|
840
864
|
* Calculate compatibility - Biorhythm alignment between two people
|
|
841
865
|
*
|
|
842
866
|
* Calculate biorhythm compatibility between two people by overlaying their cycle profiles on a target date. Returns per-cycle alignment scores (0-100) for physical, emotional, and intellectual cycles, an overall compatibility score, relationship rating, strengths, challenges, practical advice, and a daily sync snapshot showing the absolute difference in each primary cycle. Perfect for dating apps, relationship platforms, team-building tools, and couples coaching applications.
|
|
843
867
|
*/
|
|
844
|
-
calculateBioCompatibility<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmCompatibilityData, ThrowOnError>):
|
|
868
|
+
calculateBioCompatibility<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmCompatibilityData, ThrowOnError>): RequestResult<PostBiorhythmCompatibilityResponses, PostBiorhythmCompatibilityErrors, ThrowOnError>;
|
|
845
869
|
/**
|
|
846
870
|
* Get phase info - Lightweight cycle status for dashboards and widgets
|
|
847
871
|
*
|
|
848
872
|
* Get current phase information for all 10 biorhythm cycles without the full interpretation payload. Returns value, phase name, phase label, day position within cycle, cycle period, days until next critical crossing, and short-term trend for each cycle. Includes a compact summary string. Designed as a lightweight endpoint for dashboards, widgets, status bars, and quick-check interfaces that need biorhythm phase data without editorial text.
|
|
849
873
|
*/
|
|
850
|
-
getPhases<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmPhasesData, ThrowOnError>):
|
|
874
|
+
getPhases<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmPhasesData, ThrowOnError>): RequestResult<PostBiorhythmPhasesResponses, PostBiorhythmPhasesErrors, ThrowOnError>;
|
|
851
875
|
/**
|
|
852
876
|
* Get daily biorhythm - Seeded reading for daily check-in features
|
|
853
877
|
*
|
|
854
878
|
* Get a daily biorhythm reading with seeded randomness for consistent "biorhythm of the day" features. Same seed and same date always produce the same reading, perfect for daily push notifications, morning briefings, and wellness app check-ins. Returns energy rating, overall phase, a spotlight on one featured cycle, quick-read values for all three primary cycles, a daily message, and actionable advice. The spotlight cycle is deterministically selected by the seed, creating variety across users while maintaining consistency for each individual.
|
|
855
879
|
*/
|
|
856
|
-
getDailyBiorhythm<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmDailyData, ThrowOnError>):
|
|
880
|
+
getDailyBiorhythm<ThrowOnError extends boolean = false>(options?: Options<PostBiorhythmDailyData, ThrowOnError>): RequestResult<PostBiorhythmDailyResponses, PostBiorhythmDailyErrors, ThrowOnError>;
|
|
857
881
|
}
|
|
858
882
|
export declare class Iching extends HeyApiClient {
|
|
859
883
|
/**
|
|
@@ -861,55 +885,55 @@ export declare class Iching extends HeyApiClient {
|
|
|
861
885
|
*
|
|
862
886
|
* Receive a daily I-Ching hexagram for guidance and reflection. This endpoint uses seeded randomness to ensure the same seed gets the same hexagram on the same day - perfect for "Hexagram of the Day" features in oracle apps, meditation platforms, and daily wisdom tools. Returns the hexagram with judgment, image, and interpretations for love, career, decisions, and practical advice based on ancient Chinese wisdom from the Book of Changes.
|
|
863
887
|
*/
|
|
864
|
-
getDailyHexagram<ThrowOnError extends boolean = false>(options?: Options<PostIchingDailyData, ThrowOnError>):
|
|
888
|
+
getDailyHexagram<ThrowOnError extends boolean = false>(options?: Options<PostIchingDailyData, ThrowOnError>): RequestResult<PostIchingDailyResponses, PostIchingDailyErrors, ThrowOnError>;
|
|
865
889
|
/**
|
|
866
890
|
* Cast daily I-Ching reading with changing lines
|
|
867
891
|
*
|
|
868
892
|
* Cast a complete daily I-Ching reading using the traditional three-coin method with seeded randomness. Unlike the simple daily hexagram, this provides the full casting experience with line values (6-9), changing line positions, and the resulting hexagram if transformation occurs. Same seed + same date = same casting result. Perfect for I-Ching divination apps requiring authentic oracle experience with daily consistency.
|
|
869
893
|
*/
|
|
870
|
-
castDailyReading<ThrowOnError extends boolean = false>(options?: Options<PostIchingDailyCastData, ThrowOnError>):
|
|
894
|
+
castDailyReading<ThrowOnError extends boolean = false>(options?: Options<PostIchingDailyCastData, ThrowOnError>): RequestResult<PostIchingDailyCastResponses, PostIchingDailyCastErrors, ThrowOnError>;
|
|
871
895
|
/**
|
|
872
896
|
* List all 64 hexagrams
|
|
873
897
|
*
|
|
874
898
|
* Browse all 64 I-Ching hexagrams from the Book of Changes with their Chinese names, English translations, and trigram compositions. The hexagrams are ordered by the traditional King Wen sequence used in I-Ching divination for 3,000 years. Each hexagram represents a unique life situation combining two trigrams (Heaven, Earth, Thunder, Wind, Water, Fire, Mountain, Lake) into profound wisdom for decision-making and self-understanding.
|
|
875
899
|
*/
|
|
876
|
-
listHexagrams<ThrowOnError extends boolean = false>(options?: Options<GetIchingHexagramsData, ThrowOnError>):
|
|
900
|
+
listHexagrams<ThrowOnError extends boolean = false>(options?: Options<GetIchingHexagramsData, ThrowOnError>): RequestResult<GetIchingHexagramsResponses, GetIchingHexagramsErrors, ThrowOnError>;
|
|
877
901
|
/**
|
|
878
902
|
* Get a random hexagram
|
|
879
903
|
*
|
|
880
904
|
* Receive a random I-Ching hexagram with full interpretation. Perfect for daily oracle features, meditation prompts, or exploring the Book of Changes. Returns complete hexagram data including judgment, image, interpretations for love/career/decisions, and all six changing line meanings.
|
|
881
905
|
*/
|
|
882
|
-
getRandomHexagram<ThrowOnError extends boolean = false>(options?: Options<GetIchingHexagramsRandomData, ThrowOnError>):
|
|
906
|
+
getRandomHexagram<ThrowOnError extends boolean = false>(options?: Options<GetIchingHexagramsRandomData, ThrowOnError>): RequestResult<GetIchingHexagramsRandomResponses, GetIchingHexagramsRandomErrors, ThrowOnError>;
|
|
883
907
|
/**
|
|
884
908
|
* Lookup hexagram by line pattern
|
|
885
909
|
*
|
|
886
910
|
* Find an I-Ching hexagram by its binary line pattern. Provide 6 digits (0 or 1) representing broken (yin) and solid (yang) lines from bottom to top. Use this for custom divination interfaces where users input their own line configurations, or to find hexagrams matching specific trigram combinations. Example: "111111" returns Hexagram 1 (The Creative), "000000" returns Hexagram 2 (The Receptive).
|
|
887
911
|
*/
|
|
888
|
-
lookupHexagram<ThrowOnError extends boolean = false>(options: Options<GetIchingHexagramsLookupData, ThrowOnError>):
|
|
912
|
+
lookupHexagram<ThrowOnError extends boolean = false>(options: Options<GetIchingHexagramsLookupData, ThrowOnError>): RequestResult<GetIchingHexagramsLookupResponses, GetIchingHexagramsLookupErrors, ThrowOnError>;
|
|
889
913
|
/**
|
|
890
914
|
* Get hexagram by number
|
|
891
915
|
*
|
|
892
916
|
* Retrieve complete I-Ching hexagram details by King Wen sequence number (1-64). Returns the full hexagram with Chinese name, English translation, judgment text, image text, modern interpretations for general situations, love, career, and decision-making, plus all six changing line meanings. Use this to display detailed hexagram information after casting or for educational reference.
|
|
893
917
|
*/
|
|
894
|
-
getHexagram<ThrowOnError extends boolean = false>(options: Options<GetIchingHexagramsByNumberData, ThrowOnError>):
|
|
918
|
+
getHexagram<ThrowOnError extends boolean = false>(options: Options<GetIchingHexagramsByNumberData, ThrowOnError>): RequestResult<GetIchingHexagramsByNumberResponses, GetIchingHexagramsByNumberErrors, ThrowOnError>;
|
|
895
919
|
/**
|
|
896
920
|
* Cast an I-Ching reading
|
|
897
921
|
*
|
|
898
922
|
* Generate an authentic I-Ching reading using the traditional three-coin casting method. Each of the six lines is determined by virtually tossing three coins, producing values 6-9 where 6 (old yin) and 9 (old yang) are changing lines. Returns the primary hexagram with full interpretation, the line values showing which lines are changing, and if any lines change, the resulting hexagram that the primary transforms into. Optionally provide a seed for reproducible castings. Perfect for divination apps, oracle features, and decision-making tools.
|
|
899
923
|
*/
|
|
900
|
-
castReading<ThrowOnError extends boolean = false>(options?: Options<GetIchingCastData, ThrowOnError>):
|
|
924
|
+
castReading<ThrowOnError extends boolean = false>(options?: Options<GetIchingCastData, ThrowOnError>): RequestResult<GetIchingCastResponses, GetIchingCastErrors, ThrowOnError>;
|
|
901
925
|
/**
|
|
902
926
|
* List all 8 trigrams
|
|
903
927
|
*
|
|
904
928
|
* Retrieve all 8 I-Ching trigrams (bagua) - the fundamental building blocks of hexagrams. Each trigram consists of three lines and represents a primal force of nature: Heaven (Qian), Earth (Kun), Thunder (Zhen), Wind (Xun), Water (Kan), Fire (Li), Mountain (Gen), and Lake (Dui). Understanding trigrams is essential for interpreting hexagram meanings, as each hexagram combines an upper and lower trigram.
|
|
905
929
|
*/
|
|
906
|
-
listTrigrams<ThrowOnError extends boolean = false>(options?: Options<GetIchingTrigramsData, ThrowOnError>):
|
|
930
|
+
listTrigrams<ThrowOnError extends boolean = false>(options?: Options<GetIchingTrigramsData, ThrowOnError>): RequestResult<GetIchingTrigramsResponses, GetIchingTrigramsErrors, ThrowOnError>;
|
|
907
931
|
/**
|
|
908
932
|
* Get trigram by number or name
|
|
909
933
|
*
|
|
910
934
|
* Retrieve a specific I-Ching trigram by its number (1-8) or English name (Heaven, Earth, Thunder, Wind, Water, Fire, Mountain, Lake). Returns complete trigram information including Chinese name, pinyin, element associations, core attributes, and symbolic meaning. Use this to understand the component trigrams of any hexagram.
|
|
911
935
|
*/
|
|
912
|
-
getTrigram<ThrowOnError extends boolean = false>(options: Options<GetIchingTrigramsByIdData, ThrowOnError>):
|
|
936
|
+
getTrigram<ThrowOnError extends boolean = false>(options: Options<GetIchingTrigramsByIdData, ThrowOnError>): RequestResult<GetIchingTrigramsByIdResponses, GetIchingTrigramsByIdErrors, ThrowOnError>;
|
|
913
937
|
}
|
|
914
938
|
export declare class Crystals extends HeyApiClient {
|
|
915
939
|
/**
|
|
@@ -917,73 +941,73 @@ export declare class Crystals extends HeyApiClient {
|
|
|
917
941
|
*
|
|
918
942
|
* Get healing crystals and gemstones associated with a specific zodiac sign. Returns summary data for each crystal. Use the /crystals/:id detail endpoint for full healing properties. Supports all 12 zodiac signs from Aries through Pisces. Perfect for personalized crystal recommendations based on astrological birth chart data.
|
|
919
943
|
*/
|
|
920
|
-
getCrystalsByZodiac<ThrowOnError extends boolean = false>(options: Options<GetCrystalsZodiacBySignData, ThrowOnError>):
|
|
944
|
+
getCrystalsByZodiac<ThrowOnError extends boolean = false>(options: Options<GetCrystalsZodiacBySignData, ThrowOnError>): RequestResult<GetCrystalsZodiacBySignResponses, GetCrystalsZodiacBySignErrors, ThrowOnError>;
|
|
921
945
|
/**
|
|
922
946
|
* Crystals by Chakra
|
|
923
947
|
*
|
|
924
948
|
* Get healing crystals and gemstones that resonate with a specific chakra energy center. Returns summary data for each crystal. Use the /crystals/:id detail endpoint for full healing properties. Supports all 7 primary chakras: Root, Sacral, Solar Plexus, Heart, Throat, Third Eye, and Crown. Essential for crystal grid building, chakra balancing, and energy healing applications.
|
|
925
949
|
*/
|
|
926
|
-
getCrystalsByChakra<ThrowOnError extends boolean = false>(options: Options<GetCrystalsChakraByChakraData, ThrowOnError>):
|
|
950
|
+
getCrystalsByChakra<ThrowOnError extends boolean = false>(options: Options<GetCrystalsChakraByChakraData, ThrowOnError>): RequestResult<GetCrystalsChakraByChakraResponses, GetCrystalsChakraByChakraErrors, ThrowOnError>;
|
|
927
951
|
/**
|
|
928
952
|
* Crystals by Element
|
|
929
953
|
*
|
|
930
954
|
* Get healing crystals and gemstones associated with a specific natural element. Returns summary data for each crystal. Use the /crystals/:id detail endpoint for full healing properties. Supports five elements: Earth, Water, Fire, Air, and Storm. Essential for elemental crystal selection, nature-based healing, and element-themed crystal grid applications.
|
|
931
955
|
*/
|
|
932
|
-
getCrystalsByElement<ThrowOnError extends boolean = false>(options: Options<GetCrystalsElementByElementData, ThrowOnError>):
|
|
956
|
+
getCrystalsByElement<ThrowOnError extends boolean = false>(options: Options<GetCrystalsElementByElementData, ThrowOnError>): RequestResult<GetCrystalsElementByElementResponses, GetCrystalsElementByElementErrors, ThrowOnError>;
|
|
933
957
|
/**
|
|
934
958
|
* Birthstone Crystals by Month
|
|
935
959
|
*
|
|
936
960
|
* Get the traditional birthstone crystals for a given birth month. Returns summary data for each crystal. Use the /crystals/:id detail endpoint for full healing properties. Based on GIA-authoritative birthstone assignments. Perfect for birthday gift recommendations, personalized crystal suggestions, and birthstone jewelry applications.
|
|
937
961
|
*/
|
|
938
|
-
getBirthstones<ThrowOnError extends boolean = false>(options: Options<GetCrystalsBirthstoneByMonthData, ThrowOnError>):
|
|
962
|
+
getBirthstones<ThrowOnError extends boolean = false>(options: Options<GetCrystalsBirthstoneByMonthData, ThrowOnError>): RequestResult<GetCrystalsBirthstoneByMonthResponses, GetCrystalsBirthstoneByMonthErrors, ThrowOnError>;
|
|
939
963
|
/**
|
|
940
964
|
* Search Crystals
|
|
941
965
|
*
|
|
942
966
|
* Search for healing crystals by keyword or name. Matches against crystal names, healing keywords, descriptions, and spiritual/emotional/physical meaning fields. Returns summary data for each crystal. Use the /crystals/:id detail endpoint for full healing properties. Useful for building crystal search bars, keyword-based recommendation features, and healing property lookups.
|
|
943
967
|
*/
|
|
944
|
-
searchCrystals<ThrowOnError extends boolean = false>(options: Options<GetCrystalsSearchData, ThrowOnError>):
|
|
968
|
+
searchCrystals<ThrowOnError extends boolean = false>(options: Options<GetCrystalsSearchData, ThrowOnError>): RequestResult<GetCrystalsSearchResponses, GetCrystalsSearchErrors, ThrowOnError>;
|
|
945
969
|
/**
|
|
946
970
|
* Crystal Pairings
|
|
947
971
|
*
|
|
948
972
|
* Get crystals that pair well with a given crystal for enhanced healing combinations. Returns the source crystal along with its recommended companion stones and their properties. Essential for crystal grid building, healing combination recommendations, and crystal shop cross-sell features.
|
|
949
973
|
*/
|
|
950
|
-
getCrystalPairings<ThrowOnError extends boolean = false>(options: Options<GetCrystalsPairingsByIdData, ThrowOnError>):
|
|
974
|
+
getCrystalPairings<ThrowOnError extends boolean = false>(options: Options<GetCrystalsPairingsByIdData, ThrowOnError>): RequestResult<GetCrystalsPairingsByIdResponses, GetCrystalsPairingsByIdErrors, ThrowOnError>;
|
|
951
975
|
/**
|
|
952
976
|
* Daily Crystal
|
|
953
977
|
*
|
|
954
978
|
* Get the crystal of the day as a discovery teaser. Returns a deterministic crystal based on the current date (or a provided seed date), ensuring all users see the same crystal for any given day. Use the /crystals/:id detail endpoint for complete spiritual, emotional, and physical healing properties. Perfect for daily guidance features, push notifications, wellness app widgets, and crystal journal integrations.
|
|
955
979
|
*/
|
|
956
|
-
getDailyCrystal<ThrowOnError extends boolean = false>(options?: Options<PostCrystalsDailyData, ThrowOnError>):
|
|
980
|
+
getDailyCrystal<ThrowOnError extends boolean = false>(options?: Options<PostCrystalsDailyData, ThrowOnError>): RequestResult<PostCrystalsDailyResponses, PostCrystalsDailyErrors, ThrowOnError>;
|
|
957
981
|
/**
|
|
958
982
|
* Random Crystal
|
|
959
983
|
*
|
|
960
984
|
* Get a randomly selected healing crystal as a discovery teaser. Returns a different crystal on each request (non-deterministic). Use the /crystals/:id detail endpoint for complete spiritual, emotional, and physical healing properties. Perfect for crystal discovery features, surprise crystal picks, crystal roulette games, and exploration widgets. For a deterministic daily crystal that is the same for all users on a given date, use the /daily endpoint instead.
|
|
961
985
|
*/
|
|
962
|
-
getRandomCrystal<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsRandomData, ThrowOnError>):
|
|
986
|
+
getRandomCrystal<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsRandomData, ThrowOnError>): RequestResult<GetCrystalsRandomResponses, GetCrystalsRandomErrors, ThrowOnError>;
|
|
963
987
|
/**
|
|
964
988
|
* List Crystal Colors
|
|
965
989
|
*
|
|
966
990
|
* List all unique crystal colors available in the database. Use these values with the color filter on GET /crystals to find crystals by color. Essential reference endpoint for building color-based crystal browsing, visual crystal pickers, and filtering UI.
|
|
967
991
|
*/
|
|
968
|
-
listCrystalColors<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsColorsData, ThrowOnError>):
|
|
992
|
+
listCrystalColors<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsColorsData, ThrowOnError>): RequestResult<GetCrystalsColorsResponses, GetCrystalsColorsErrors, ThrowOnError>;
|
|
969
993
|
/**
|
|
970
994
|
* List Crystal Planets
|
|
971
995
|
*
|
|
972
996
|
* List all unique planetary associations available in the database. Use these values with the planet filter on GET /crystals to find crystals by ruling planet. Essential reference endpoint for astrology app builders who want to recommend crystals based on planetary placements in a birth chart.
|
|
973
997
|
*/
|
|
974
|
-
listCrystalPlanets<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsPlanetsData, ThrowOnError>):
|
|
998
|
+
listCrystalPlanets<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsPlanetsData, ThrowOnError>): RequestResult<GetCrystalsPlanetsResponses, GetCrystalsPlanetsErrors, ThrowOnError>;
|
|
975
999
|
/**
|
|
976
1000
|
* List All Crystals
|
|
977
1001
|
*
|
|
978
1002
|
* Retrieve healing crystals and gemstones with pagination. Supports optional filtering by chakra, zodiac sign, element, color, or planet. Returns minimal summary fields per crystal. Use the detail endpoint for full healing properties. Perfect for building crystal explorer apps, healing stone guides, and personalized crystal recommendation engines.
|
|
979
1003
|
*/
|
|
980
|
-
listCrystals<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsData, ThrowOnError>):
|
|
1004
|
+
listCrystals<ThrowOnError extends boolean = false>(options?: Options<GetCrystalsData, ThrowOnError>): RequestResult<GetCrystalsResponses, GetCrystalsErrors, ThrowOnError>;
|
|
981
1005
|
/**
|
|
982
1006
|
* Get Crystal Healing Properties
|
|
983
1007
|
*
|
|
984
1008
|
* Get complete healing properties and metaphysical data for a specific crystal or gemstone. Returns spiritual, emotional, and physical healing interpretations along with chakra associations, zodiac connections, elemental properties, and crystal pairing recommendations. Authoritative interpretations covering all major healing crystals.
|
|
985
1009
|
*/
|
|
986
|
-
getCrystal<ThrowOnError extends boolean = false>(options: Options<GetCrystalsByIdData, ThrowOnError>):
|
|
1010
|
+
getCrystal<ThrowOnError extends boolean = false>(options: Options<GetCrystalsByIdData, ThrowOnError>): RequestResult<GetCrystalsByIdResponses, GetCrystalsByIdErrors, ThrowOnError>;
|
|
987
1011
|
}
|
|
988
1012
|
export declare class Dreams extends HeyApiClient {
|
|
989
1013
|
/**
|
|
@@ -991,31 +1015,31 @@ export declare class Dreams extends HeyApiClient {
|
|
|
991
1015
|
*
|
|
992
1016
|
* Browse and search our complete dream interpretation dictionary containing 2,000+ dream symbols with psychological meanings. Find dream meanings for animals (snake dreams, spider dreams, dog dreams), common scenarios (falling dreams, flying dreams, being chased, drowning), people (dreams about mother, father, baby, ex), objects (car, house, water, fire), emotions (fear, anxiety, love), body parts (teeth falling out, hair, eyes), colors, numbers, and abstract concepts. Filter by starting letter for A-Z navigation or search by keyword to find what your dreams mean.
|
|
993
1017
|
*/
|
|
994
|
-
searchDreamSymbols<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsData, ThrowOnError>):
|
|
1018
|
+
searchDreamSymbols<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsData, ThrowOnError>): RequestResult<GetDreamsSymbolsResponses, GetDreamsSymbolsErrors, ThrowOnError>;
|
|
995
1019
|
/**
|
|
996
1020
|
* Get random dream symbols
|
|
997
1021
|
*
|
|
998
1022
|
* Discover random dream symbols and their interpretations for daily dream insights and exploration. Each request returns different symbols from the 2,000+ dream meaning database - perfect for dream of the day features, dream journaling prompts, meditation on subconscious themes, or exploring what different dreams mean. Get one or multiple random dream interpretations with full psychological meanings.
|
|
999
1023
|
*/
|
|
1000
|
-
getRandomSymbols<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsRandomData, ThrowOnError>):
|
|
1024
|
+
getRandomSymbols<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsRandomData, ThrowOnError>): RequestResult<GetDreamsSymbolsRandomResponses, GetDreamsSymbolsRandomErrors, ThrowOnError>;
|
|
1001
1025
|
/**
|
|
1002
1026
|
* Get symbol counts by letter
|
|
1003
1027
|
*
|
|
1004
1028
|
* Get the count of dream symbols available for each letter A-Z. Build alphabetical dream dictionary navigation to help users browse dream interpretations by letter - from abandonment dreams to zodiac dreams. See how many dream meanings exist for each starting letter.
|
|
1005
1029
|
*/
|
|
1006
|
-
getSymbolLetterCounts<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsLettersData, ThrowOnError>):
|
|
1030
|
+
getSymbolLetterCounts<ThrowOnError extends boolean = false>(options?: Options<GetDreamsSymbolsLettersData, ThrowOnError>): RequestResult<GetDreamsSymbolsLettersResponses, GetDreamsSymbolsLettersErrors, ThrowOnError>;
|
|
1007
1031
|
/**
|
|
1008
1032
|
* Get dream symbol details
|
|
1009
1033
|
*
|
|
1010
1034
|
* Get the complete dream interpretation for a specific symbol. Understand what your dream means with detailed psychological analysis covering subconscious symbolism, emotional significance, and connections to your waking life. Covers all major dream themes: snake dreams (hidden fears, transformation), falling dreams (loss of control, anxiety), water dreams (emotions, cleansing), death dreams (endings, transformation), teeth falling out (self-image, communication anxiety), being chased (avoidance, confronting fears), flying dreams (freedom, ambition), and thousands more dream meanings.
|
|
1011
1035
|
*/
|
|
1012
|
-
getDreamSymbol<ThrowOnError extends boolean = false>(options: Options<GetDreamsSymbolsByIdData, ThrowOnError>):
|
|
1036
|
+
getDreamSymbol<ThrowOnError extends boolean = false>(options: Options<GetDreamsSymbolsByIdData, ThrowOnError>): RequestResult<GetDreamsSymbolsByIdResponses, GetDreamsSymbolsByIdErrors, ThrowOnError>;
|
|
1013
1037
|
/**
|
|
1014
1038
|
* Get daily dream symbol
|
|
1015
1039
|
*
|
|
1016
1040
|
* Receive a single dream symbol for daily reflection and subconscious exploration. Uses seeded randomness so the same seed gets the same symbol on the same day, perfect for "Dream Symbol of the Day" features. Provide a seed (userId, email hash, session token) for reproducible consistency, or omit for date-based daily symbols. Returns the symbol with full psychological interpretation. Great for dream journal apps, wellness platforms, morning ritual apps, and meditation tools.
|
|
1017
1041
|
*/
|
|
1018
|
-
getDailyDreamSymbol<ThrowOnError extends boolean = false>(options?: Options<PostDreamsDailyData, ThrowOnError>):
|
|
1042
|
+
getDailyDreamSymbol<ThrowOnError extends boolean = false>(options?: Options<PostDreamsDailyData, ThrowOnError>): RequestResult<PostDreamsDailyResponses, PostDreamsDailyErrors, ThrowOnError>;
|
|
1019
1043
|
}
|
|
1020
1044
|
export declare class AngelNumbers extends HeyApiClient {
|
|
1021
1045
|
/**
|
|
@@ -1023,25 +1047,25 @@ export declare class AngelNumbers extends HeyApiClient {
|
|
|
1023
1047
|
*
|
|
1024
1048
|
* Retrieve the complete database of angel numbers with summary information. Returns 75+ angel numbers covering root digits (0-9), master numbers (11, 22, 33), double digits (44-99), triple repeating (111-999), quad repeating (1111-9999), the mirror families (X0X like 101-909, X1X, four-digit mirrors like 1212-2121), palindromes (1221, 1331), compound sequences (911, 1122), and sequential numbers (123, 1234). Supports optional type filtering. Perfect for building angel number explorer apps, reference guides, and spiritual databases.
|
|
1025
1049
|
*/
|
|
1026
|
-
listAngelNumbers<ThrowOnError extends boolean = false>(options?: Options<GetAngelNumbersNumbersData, ThrowOnError>):
|
|
1050
|
+
listAngelNumbers<ThrowOnError extends boolean = false>(options?: Options<GetAngelNumbersNumbersData, ThrowOnError>): RequestResult<GetAngelNumbersNumbersResponses, GetAngelNumbersNumbersErrors, ThrowOnError>;
|
|
1027
1051
|
/**
|
|
1028
1052
|
* Get Angel Number Meaning
|
|
1029
1053
|
*
|
|
1030
1054
|
* Get the complete, authoritative meaning and interpretation for a specific angel number. Returns detailed spiritual, love, career, money, and twin flame interpretations, plus a biblical perspective and a shadow reading, along with keywords, affirmation, and actionable steps. Covers 75+ angel numbers including 111, 222, 333, 444, 555, 666, 777, 888, 999, 1111, 1212, 1234, and more. Authoritative interpretations covering all major angel number patterns.
|
|
1031
1055
|
*/
|
|
1032
|
-
getAngelNumber<ThrowOnError extends boolean = false>(options: Options<GetAngelNumbersNumbersByNumberData, ThrowOnError>):
|
|
1056
|
+
getAngelNumber<ThrowOnError extends boolean = false>(options: Options<GetAngelNumbersNumbersByNumberData, ThrowOnError>): RequestResult<GetAngelNumbersNumbersByNumberResponses, GetAngelNumbersNumbersByNumberErrors, ThrowOnError>;
|
|
1033
1057
|
/**
|
|
1034
1058
|
* Analyze Any Number Sequence
|
|
1035
1059
|
*
|
|
1036
1060
|
* Smart angel number analysis that works for ANY number sequence, not just known angel numbers. Automatically classifies the pattern type (repeating, sequential, mirror, master, root, compound), calculates the numerology digit root, checks the database for a known meaning, and provides the foundational digit root interpretation (with full spiritual, love, career, money, and twin flame guidance) as a fallback. An optional context parameter adds a note tailored to where the number was seen. Perfect for synchronicity tracking apps where users enter arbitrary number sequences they encounter.
|
|
1037
1061
|
*/
|
|
1038
|
-
analyzeNumberSequence<ThrowOnError extends boolean = false>(options: Options<GetAngelNumbersLookupData, ThrowOnError>):
|
|
1062
|
+
analyzeNumberSequence<ThrowOnError extends boolean = false>(options: Options<GetAngelNumbersLookupData, ThrowOnError>): RequestResult<GetAngelNumbersLookupResponses, GetAngelNumbersLookupErrors, ThrowOnError>;
|
|
1039
1063
|
/**
|
|
1040
1064
|
* Daily Angel Number
|
|
1041
1065
|
*
|
|
1042
1066
|
* Get the angel number of the day with full meaning and interpretation. Returns a deterministic angel number based on the current date (or a provided seed date), ensuring all users see the same number for any given day. Includes complete spiritual, love, career, money, and twin flame interpretations plus a biblical perspective and a shadow reading. Perfect for daily guidance features, push notifications, content generation, and angel number widget integrations.
|
|
1043
1067
|
*/
|
|
1044
|
-
getDailyAngelNumber<ThrowOnError extends boolean = false>(options?: Options<PostAngelNumbersDailyData, ThrowOnError>):
|
|
1068
|
+
getDailyAngelNumber<ThrowOnError extends boolean = false>(options?: Options<PostAngelNumbersDailyData, ThrowOnError>): RequestResult<PostAngelNumbersDailyResponses, PostAngelNumbersDailyErrors, ThrowOnError>;
|
|
1045
1069
|
}
|
|
1046
1070
|
export declare class Location extends HeyApiClient {
|
|
1047
1071
|
/**
|
|
@@ -1049,19 +1073,19 @@ export declare class Location extends HeyApiClient {
|
|
|
1049
1073
|
*
|
|
1050
1074
|
* City autocomplete and geocoding search across 23,000+ locations in 240+ countries, including deep coverage of Indian tier-2 and tier-3 cities. Returns geographic coordinates (latitude, longitude), IANA timezone, and DST-aware UTC offset for each match. Built for birth chart location pickers, horoscope apps, event scheduling, and any feature requiring place-to-coordinates resolution. Partial name matching with intelligent ranking: exact prefix matches first, then sorted by population for relevance. Common alternate names like Bombay, Calcutta, Madras, and Banaras transparently resolve to their canonical entries.
|
|
1051
1075
|
*/
|
|
1052
|
-
searchCities<ThrowOnError extends boolean = false>(options: Options<GetLocationSearchData, ThrowOnError>):
|
|
1076
|
+
searchCities<ThrowOnError extends boolean = false>(options: Options<GetLocationSearchData, ThrowOnError>): RequestResult<GetLocationSearchResponses, GetLocationSearchErrors, ThrowOnError>;
|
|
1053
1077
|
/**
|
|
1054
1078
|
* List all countries - ISO codes and city coverage
|
|
1055
1079
|
*
|
|
1056
1080
|
* Returns every country with ISO 3166-1 alpha-2 and alpha-3 codes, plus the number of searchable cities per country. Use this endpoint to build country dropdown menus, regional filters, or to check city coverage before querying. Sorted alphabetically by country name. Covers Europe, Americas, Asia, Middle East, Africa, and Oceania.
|
|
1057
1081
|
*/
|
|
1058
|
-
listCountries<ThrowOnError extends boolean = false>(options?: Options<GetLocationCountriesData, ThrowOnError>):
|
|
1082
|
+
listCountries<ThrowOnError extends boolean = false>(options?: Options<GetLocationCountriesData, ThrowOnError>): RequestResult<GetLocationCountriesResponses, GetLocationCountriesErrors, ThrowOnError>;
|
|
1059
1083
|
/**
|
|
1060
1084
|
* Get cities in a country - Geocoding directory sorted by population
|
|
1061
1085
|
*
|
|
1062
1086
|
* Returns all cities for a specific country, identified by ISO 3166-1 alpha-2 code (e.g. DE for Germany, FR for France, GB for United Kingdom, US for United States). Each city includes geographic coordinates, IANA timezone, and DST-aware UTC offset for direct use in astrology birth chart, horoscope, transit, and panchang calculations. Cities sorted by population with the largest metropolitan areas first.
|
|
1063
1087
|
*/
|
|
1064
|
-
getCitiesByCountry<ThrowOnError extends boolean = false>(options: Options<GetLocationCountriesByIso2Data, ThrowOnError>):
|
|
1088
|
+
getCitiesByCountry<ThrowOnError extends boolean = false>(options: Options<GetLocationCountriesByIso2Data, ThrowOnError>): RequestResult<GetLocationCountriesByIso2Responses, GetLocationCountriesByIso2Errors, ThrowOnError>;
|
|
1065
1089
|
}
|
|
1066
1090
|
export declare class Usage extends HeyApiClient {
|
|
1067
1091
|
/**
|
|
@@ -1069,7 +1093,7 @@ export declare class Usage extends HeyApiClient {
|
|
|
1069
1093
|
*
|
|
1070
1094
|
* Returns current usage and plan limits for your subscription.
|
|
1071
1095
|
*/
|
|
1072
|
-
getUsageStats<ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>):
|
|
1096
|
+
getUsageStats<ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>): RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError>;
|
|
1073
1097
|
}
|
|
1074
1098
|
export declare class Languages extends HeyApiClient {
|
|
1075
1099
|
/**
|
|
@@ -1077,7 +1101,7 @@ export declare class Languages extends HeyApiClient {
|
|
|
1077
1101
|
*
|
|
1078
1102
|
* Returns the language codes accepted by the `lang` query parameter on every i18n-aware endpoint. Use this to populate language pickers, validate user input before calling chart or reading endpoints, or auto-detect available locales in agent integrations. Codes follow ISO 639-1. Endpoints without a translation for the requested language fall back to English silently.
|
|
1079
1103
|
*/
|
|
1080
|
-
listLanguages<ThrowOnError extends boolean = false>(options?: Options<GetLanguagesData, ThrowOnError>):
|
|
1104
|
+
listLanguages<ThrowOnError extends boolean = false>(options?: Options<GetLanguagesData, ThrowOnError>): RequestResult<GetLanguagesResponses, GetLanguagesErrors, ThrowOnError>;
|
|
1081
1105
|
}
|
|
1082
1106
|
export declare class Roxy extends HeyApiClient {
|
|
1083
1107
|
static readonly __registry: HeyApiRegistry<Roxy>;
|