@roxyapi/sdk 1.2.31 → 1.2.32
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/AGENTS.md +2 -2
- package/README.md +2 -2
- package/dist/factory.cjs +65 -1
- package/dist/factory.js +65 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/sdk.gen.d.ts +25 -1
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/types.gen.d.ts +1241 -64
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/docs/llms-full.txt +59 -0
- package/package.json +1 -1
- package/src/index.ts +1 -1
- package/src/sdk.gen.ts +69 -1
- package/src/types.gen.ts +1256 -59
- package/src/version.ts +1 -1
package/src/types.gen.ts
CHANGED
|
@@ -22980,7 +22980,7 @@ export type PostHumanDesignBodygraphResponses = {
|
|
|
22980
22980
|
*/
|
|
22981
22981
|
angleCode: string;
|
|
22982
22982
|
/**
|
|
22983
|
-
*
|
|
22983
|
+
* Canonical published name of the incarnation cross, determined by the Personality Sun gate and the angle. Falls back to a name composed from the angle and the four gates if no canonical name exists.
|
|
22984
22984
|
*/
|
|
22985
22985
|
name: string;
|
|
22986
22986
|
};
|
|
@@ -23349,6 +23349,245 @@ export type PostHumanDesignConnectionResponses = {
|
|
|
23349
23349
|
|
|
23350
23350
|
export type PostHumanDesignConnectionResponse = PostHumanDesignConnectionResponses[keyof PostHumanDesignConnectionResponses];
|
|
23351
23351
|
|
|
23352
|
+
export type PostHumanDesignPentaData = {
|
|
23353
|
+
body?: {
|
|
23354
|
+
/**
|
|
23355
|
+
* Birth moments of the three to five people in the group. Below three no Penta forms; above five a second Penta emerges.
|
|
23356
|
+
*/
|
|
23357
|
+
members: Array<{
|
|
23358
|
+
/**
|
|
23359
|
+
* Birth date in YYYY-MM-DD format. The anchor for both the Personality activations at birth and the Design activations 88 degrees of solar arc earlier.
|
|
23360
|
+
*/
|
|
23361
|
+
date: string;
|
|
23362
|
+
/**
|
|
23363
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters: the profile lines and gate boundaries shift with the exact minute of birth.
|
|
23364
|
+
*/
|
|
23365
|
+
time: string;
|
|
23366
|
+
/**
|
|
23367
|
+
* Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
|
|
23368
|
+
*/
|
|
23369
|
+
timezone: number | string;
|
|
23370
|
+
/**
|
|
23371
|
+
* Birth latitude in decimal degrees. Optional and does not affect the bodygraph, which depends only on ecliptic longitudes. Defaults to 0.
|
|
23372
|
+
*/
|
|
23373
|
+
latitude?: number;
|
|
23374
|
+
/**
|
|
23375
|
+
* Birth longitude in decimal degrees. Optional and does not affect the bodygraph. Defaults to 0.
|
|
23376
|
+
*/
|
|
23377
|
+
longitude?: number;
|
|
23378
|
+
}>;
|
|
23379
|
+
};
|
|
23380
|
+
path?: never;
|
|
23381
|
+
query?: {
|
|
23382
|
+
/**
|
|
23383
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
23384
|
+
*/
|
|
23385
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
23386
|
+
};
|
|
23387
|
+
url: '/human-design/penta';
|
|
23388
|
+
};
|
|
23389
|
+
|
|
23390
|
+
export type PostHumanDesignPentaErrors = {
|
|
23391
|
+
/**
|
|
23392
|
+
* Validation error. `issues[]` lists every failed field.
|
|
23393
|
+
*/
|
|
23394
|
+
400: {
|
|
23395
|
+
/**
|
|
23396
|
+
* First issue summary.
|
|
23397
|
+
*/
|
|
23398
|
+
error: string;
|
|
23399
|
+
code: 'validation_error';
|
|
23400
|
+
/**
|
|
23401
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
23402
|
+
*/
|
|
23403
|
+
issues: Array<{
|
|
23404
|
+
/**
|
|
23405
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
23406
|
+
*/
|
|
23407
|
+
path: string;
|
|
23408
|
+
message: string;
|
|
23409
|
+
/**
|
|
23410
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
23411
|
+
*/
|
|
23412
|
+
code?: string;
|
|
23413
|
+
/**
|
|
23414
|
+
* Expected type for invalid_type.
|
|
23415
|
+
*/
|
|
23416
|
+
expected?: string;
|
|
23417
|
+
/**
|
|
23418
|
+
* Minimum bound for too_small issues.
|
|
23419
|
+
*/
|
|
23420
|
+
minimum?: number | string;
|
|
23421
|
+
/**
|
|
23422
|
+
* Maximum bound for too_big issues.
|
|
23423
|
+
*/
|
|
23424
|
+
maximum?: number | string;
|
|
23425
|
+
inclusive?: boolean;
|
|
23426
|
+
/**
|
|
23427
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
23428
|
+
*/
|
|
23429
|
+
format?: string;
|
|
23430
|
+
/**
|
|
23431
|
+
* Regex pattern when format is regex.
|
|
23432
|
+
*/
|
|
23433
|
+
pattern?: string;
|
|
23434
|
+
}>;
|
|
23435
|
+
};
|
|
23436
|
+
/**
|
|
23437
|
+
* Invalid or missing API key
|
|
23438
|
+
*/
|
|
23439
|
+
401: {
|
|
23440
|
+
/**
|
|
23441
|
+
* Human-readable error message. May change wording.
|
|
23442
|
+
*/
|
|
23443
|
+
error: string;
|
|
23444
|
+
/**
|
|
23445
|
+
* Machine-readable error code. Stable identifier.
|
|
23446
|
+
*/
|
|
23447
|
+
code: string;
|
|
23448
|
+
};
|
|
23449
|
+
/**
|
|
23450
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
23451
|
+
*/
|
|
23452
|
+
405: {
|
|
23453
|
+
error: string;
|
|
23454
|
+
code: 'method_not_allowed';
|
|
23455
|
+
/**
|
|
23456
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
23457
|
+
*/
|
|
23458
|
+
allow: Array<string>;
|
|
23459
|
+
/**
|
|
23460
|
+
* Link to the product page for this domain.
|
|
23461
|
+
*/
|
|
23462
|
+
docs?: string;
|
|
23463
|
+
};
|
|
23464
|
+
/**
|
|
23465
|
+
* Monthly rate limit exceeded
|
|
23466
|
+
*/
|
|
23467
|
+
429: {
|
|
23468
|
+
/**
|
|
23469
|
+
* Human-readable error message. May change wording.
|
|
23470
|
+
*/
|
|
23471
|
+
error: string;
|
|
23472
|
+
/**
|
|
23473
|
+
* Machine-readable error code. Stable identifier.
|
|
23474
|
+
*/
|
|
23475
|
+
code: string;
|
|
23476
|
+
};
|
|
23477
|
+
/**
|
|
23478
|
+
* Internal server error
|
|
23479
|
+
*/
|
|
23480
|
+
500: {
|
|
23481
|
+
/**
|
|
23482
|
+
* Human-readable error message. May change wording.
|
|
23483
|
+
*/
|
|
23484
|
+
error: string;
|
|
23485
|
+
/**
|
|
23486
|
+
* Machine-readable error code. Stable identifier.
|
|
23487
|
+
*/
|
|
23488
|
+
code: string;
|
|
23489
|
+
};
|
|
23490
|
+
};
|
|
23491
|
+
|
|
23492
|
+
export type PostHumanDesignPentaError = PostHumanDesignPentaErrors[keyof PostHumanDesignPentaErrors];
|
|
23493
|
+
|
|
23494
|
+
export type PostHumanDesignPentaResponses = {
|
|
23495
|
+
/**
|
|
23496
|
+
* Penta chart with per-channel Strengths, per-gate fill state, and a group summary
|
|
23497
|
+
*/
|
|
23498
|
+
200: {
|
|
23499
|
+
/**
|
|
23500
|
+
* Number of people in the group, always between 3 and 5.
|
|
23501
|
+
*/
|
|
23502
|
+
memberCount: number;
|
|
23503
|
+
/**
|
|
23504
|
+
* The six channels of the Penta with their defined Strength state and which members supply each gate. Three upper channels run G to Throat (The Alpha, Inspiration, The Prodigal); three lower channels run G to Sacral (Rhythm, The Beat, Discovery).
|
|
23505
|
+
*/
|
|
23506
|
+
channels: Array<{
|
|
23507
|
+
/**
|
|
23508
|
+
* First gate of the Penta channel.
|
|
23509
|
+
*/
|
|
23510
|
+
gateA: number;
|
|
23511
|
+
/**
|
|
23512
|
+
* Second gate of the Penta channel.
|
|
23513
|
+
*/
|
|
23514
|
+
gateB: number;
|
|
23515
|
+
/**
|
|
23516
|
+
* Name of the Penta channel. One of The Alpha, Inspiration, The Prodigal, Rhythm, The Beat, Discovery.
|
|
23517
|
+
*/
|
|
23518
|
+
name: string;
|
|
23519
|
+
/**
|
|
23520
|
+
* Circuit family of the channel. One of Individual, Collective, Tribal.
|
|
23521
|
+
*/
|
|
23522
|
+
circuit: string;
|
|
23523
|
+
/**
|
|
23524
|
+
* Position of the channel in the Penta. upper channels run from the G Center to the Throat and carry the leadership and how-the-group-presents roles. lower channels run from the G Center to the Sacral and carry the managed, generative, resource roles.
|
|
23525
|
+
*/
|
|
23526
|
+
position: string;
|
|
23527
|
+
/**
|
|
23528
|
+
* Whether this is the 2/14 Channel of the Beat, the material core of the Penta vortex: gate 2 the direction for resources, gate 14 the resources themselves.
|
|
23529
|
+
*/
|
|
23530
|
+
isCore: boolean;
|
|
23531
|
+
/**
|
|
23532
|
+
* Whether the channel is a defined Strength: both of its gates are present somewhere in the group, so the function it governs has no gap.
|
|
23533
|
+
*/
|
|
23534
|
+
defined: boolean;
|
|
23535
|
+
/**
|
|
23536
|
+
* Zero-based indices of the members whose chart holds gate A, in member order.
|
|
23537
|
+
*/
|
|
23538
|
+
gateAHeldBy: Array<number>;
|
|
23539
|
+
/**
|
|
23540
|
+
* Zero-based indices of the members whose chart holds gate B, in member order.
|
|
23541
|
+
*/
|
|
23542
|
+
gateBHeldBy: Array<number>;
|
|
23543
|
+
}>;
|
|
23544
|
+
/**
|
|
23545
|
+
* The twelve Penta gates with their filled state and which members hold each.
|
|
23546
|
+
*/
|
|
23547
|
+
gates: Array<{
|
|
23548
|
+
/**
|
|
23549
|
+
* Penta gate number. One of 1, 2, 5, 7, 8, 13, 14, 15, 29, 31, 33, 46.
|
|
23550
|
+
*/
|
|
23551
|
+
gate: number;
|
|
23552
|
+
/**
|
|
23553
|
+
* Human Design keynote name of the gate, describing the role it brings to the group.
|
|
23554
|
+
*/
|
|
23555
|
+
gateName: string;
|
|
23556
|
+
/**
|
|
23557
|
+
* Whether at least one member holds this gate. A gate held by nobody is a gap that conditions the group to compensate for the missing role.
|
|
23558
|
+
*/
|
|
23559
|
+
filled: boolean;
|
|
23560
|
+
/**
|
|
23561
|
+
* Zero-based indices of the members whose chart holds this gate. Empty when the gate is a gap.
|
|
23562
|
+
*/
|
|
23563
|
+
heldBy: Array<number>;
|
|
23564
|
+
}>;
|
|
23565
|
+
/**
|
|
23566
|
+
* Group-level rollup of the Penta channels and gates.
|
|
23567
|
+
*/
|
|
23568
|
+
summary: {
|
|
23569
|
+
/**
|
|
23570
|
+
* Count of the six Penta channels that are defined Strengths in the group.
|
|
23571
|
+
*/
|
|
23572
|
+
definedChannels: number;
|
|
23573
|
+
/**
|
|
23574
|
+
* Count of the twelve Penta gates filled by at least one member.
|
|
23575
|
+
*/
|
|
23576
|
+
filledGates: number;
|
|
23577
|
+
/**
|
|
23578
|
+
* Penta gates held by no member. A non-empty list flags the functional gaps in the group.
|
|
23579
|
+
*/
|
|
23580
|
+
gapGates: Array<number>;
|
|
23581
|
+
/**
|
|
23582
|
+
* Whether the 2/14 Channel of the Beat, the material core of the Penta, is defined across the group.
|
|
23583
|
+
*/
|
|
23584
|
+
coreDefined: boolean;
|
|
23585
|
+
};
|
|
23586
|
+
};
|
|
23587
|
+
};
|
|
23588
|
+
|
|
23589
|
+
export type PostHumanDesignPentaResponse = PostHumanDesignPentaResponses[keyof PostHumanDesignPentaResponses];
|
|
23590
|
+
|
|
23352
23591
|
export type PostHumanDesignTransitData = {
|
|
23353
23592
|
body?: {
|
|
23354
23593
|
/**
|
|
@@ -24879,49 +25118,28 @@ export type PostHumanDesignProfileResponses = {
|
|
|
24879
25118
|
|
|
24880
25119
|
export type PostHumanDesignProfileResponse = PostHumanDesignProfileResponses[keyof PostHumanDesignProfileResponses];
|
|
24881
25120
|
|
|
24882
|
-
export type
|
|
25121
|
+
export type PostHumanDesignVariablesData = {
|
|
24883
25122
|
body?: {
|
|
24884
25123
|
/**
|
|
24885
|
-
* The
|
|
25124
|
+
* Birth date in YYYY-MM-DD format. The anchor for both the Personality activations at birth and the Design activations 88 degrees of solar arc earlier.
|
|
24886
25125
|
*/
|
|
24887
|
-
|
|
24888
|
-
/**
|
|
24889
|
-
* Birth date in YYYY-MM-DD format. Anchors the natal chart and the Vimshottari dasha sequence.
|
|
24890
|
-
*/
|
|
24891
|
-
date: string;
|
|
24892
|
-
/**
|
|
24893
|
-
* Birth time in 24-hour HH:MM:SS format. Precision matters for the natal positions the transit aspects are measured against.
|
|
24894
|
-
*/
|
|
24895
|
-
time: string;
|
|
24896
|
-
/**
|
|
24897
|
-
* Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
|
|
24898
|
-
*/
|
|
24899
|
-
timezone: number | string;
|
|
24900
|
-
/**
|
|
24901
|
-
* Birth latitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
24902
|
-
*/
|
|
24903
|
-
latitude?: number;
|
|
24904
|
-
/**
|
|
24905
|
-
* Birth longitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
24906
|
-
*/
|
|
24907
|
-
longitude?: number;
|
|
24908
|
-
};
|
|
25126
|
+
date: string;
|
|
24909
25127
|
/**
|
|
24910
|
-
*
|
|
25128
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters: the profile lines and gate boundaries shift with the exact minute of birth.
|
|
24911
25129
|
*/
|
|
24912
|
-
|
|
25130
|
+
time: string;
|
|
24913
25131
|
/**
|
|
24914
|
-
*
|
|
25132
|
+
* Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
|
|
24915
25133
|
*/
|
|
24916
|
-
|
|
25134
|
+
timezone: number | string;
|
|
24917
25135
|
/**
|
|
24918
|
-
*
|
|
25136
|
+
* Birth latitude in decimal degrees. Optional and does not affect the bodygraph, which depends only on ecliptic longitudes. Defaults to 0.
|
|
24919
25137
|
*/
|
|
24920
|
-
|
|
25138
|
+
latitude?: number;
|
|
24921
25139
|
/**
|
|
24922
|
-
*
|
|
25140
|
+
* Birth longitude in decimal degrees. Optional and does not affect the bodygraph. Defaults to 0.
|
|
24923
25141
|
*/
|
|
24924
|
-
|
|
25142
|
+
longitude?: number;
|
|
24925
25143
|
};
|
|
24926
25144
|
path?: never;
|
|
24927
25145
|
query?: {
|
|
@@ -24930,10 +25148,10 @@ export type PostForecastTimelineData = {
|
|
|
24930
25148
|
*/
|
|
24931
25149
|
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
24932
25150
|
};
|
|
24933
|
-
url: '/
|
|
25151
|
+
url: '/human-design/variables';
|
|
24934
25152
|
};
|
|
24935
25153
|
|
|
24936
|
-
export type
|
|
25154
|
+
export type PostHumanDesignVariablesErrors = {
|
|
24937
25155
|
/**
|
|
24938
25156
|
* Validation error. `issues[]` lists every failed field.
|
|
24939
25157
|
*/
|
|
@@ -25035,31 +25253,286 @@ export type PostForecastTimelineErrors = {
|
|
|
25035
25253
|
};
|
|
25036
25254
|
};
|
|
25037
25255
|
|
|
25038
|
-
export type
|
|
25256
|
+
export type PostHumanDesignVariablesError = PostHumanDesignVariablesErrors[keyof PostHumanDesignVariablesErrors];
|
|
25039
25257
|
|
|
25040
|
-
export type
|
|
25258
|
+
export type PostHumanDesignVariablesResponses = {
|
|
25041
25259
|
/**
|
|
25042
|
-
*
|
|
25260
|
+
* The four Variable arrows with substructure numbers, labels, and confidence flags
|
|
25043
25261
|
*/
|
|
25044
25262
|
200: {
|
|
25045
25263
|
/**
|
|
25046
|
-
*
|
|
25264
|
+
* The four Variable arrows: Determination and Environment from the design side, Perspective and Motivation from the personality side. Together they form the Rave Variables / Primary Health System layer that sits beneath Type, Strategy, Authority, and Profile.
|
|
25047
25265
|
*/
|
|
25048
|
-
|
|
25266
|
+
arrows: Array<{
|
|
25049
25267
|
/**
|
|
25050
|
-
*
|
|
25268
|
+
* Stable arrow identifier. One of determination, environment, perspective, motivation.
|
|
25051
25269
|
*/
|
|
25052
|
-
|
|
25270
|
+
key: string;
|
|
25053
25271
|
/**
|
|
25054
|
-
*
|
|
25272
|
+
* Arrow name. Determination is the top-left arrow governing the Primary Health System and digestion, Environment the bottom-left arrow, Perspective the bottom-right arrow also called View, and Motivation the top-right arrow.
|
|
25055
25273
|
*/
|
|
25056
|
-
|
|
25274
|
+
name: string;
|
|
25057
25275
|
/**
|
|
25058
|
-
*
|
|
25276
|
+
* Which half of the advanced layer the arrow belongs to. Primary Health System covers the body-side Determination and Environment arrows, Rave Psychology covers the mind-side Perspective and Motivation arrows.
|
|
25059
25277
|
*/
|
|
25060
|
-
|
|
25278
|
+
layer: string;
|
|
25061
25279
|
/**
|
|
25062
|
-
*
|
|
25280
|
+
* Position of the arrow at the head of the bodygraph. One of Top left, Bottom left, Top right, Bottom right.
|
|
25281
|
+
*/
|
|
25282
|
+
position: string;
|
|
25283
|
+
/**
|
|
25284
|
+
* The single activation, body and chart side, that this arrow is derived from.
|
|
25285
|
+
*/
|
|
25286
|
+
activation: {
|
|
25287
|
+
/**
|
|
25288
|
+
* Activating body whose substructure feeds this arrow. Determination and Motivation come from the Sun, Environment and Perspective from the North Node.
|
|
25289
|
+
*/
|
|
25290
|
+
planet: string;
|
|
25291
|
+
/**
|
|
25292
|
+
* Chart side of the activation. Determination and Environment come from the design side, Perspective and Motivation from the personality side.
|
|
25293
|
+
*/
|
|
25294
|
+
side: string;
|
|
25295
|
+
};
|
|
25296
|
+
/**
|
|
25297
|
+
* Color number from 1 to 6, the substructure level one octave finer than the line. Color selects the arrow theme, for example the determination family or the motivation.
|
|
25298
|
+
*/
|
|
25299
|
+
color: number;
|
|
25300
|
+
/**
|
|
25301
|
+
* Tone number from 1 to 6, the substructure level beneath Color. Tone sets the arrow direction: tones 1 to 3 face left, tones 4 to 6 face right.
|
|
25302
|
+
*/
|
|
25303
|
+
tone: number;
|
|
25304
|
+
/**
|
|
25305
|
+
* Base number from 1 to 5, the finest published subdivision of the wheel. Returned for completeness but treated as informational, since it is finer than most birth times can resolve.
|
|
25306
|
+
*/
|
|
25307
|
+
base: number;
|
|
25308
|
+
/**
|
|
25309
|
+
* Arrow direction derived from the Tone. left for tones 1 to 3, right for tones 4 to 6.
|
|
25310
|
+
*/
|
|
25311
|
+
direction: string;
|
|
25312
|
+
/**
|
|
25313
|
+
* Name of the Color theme for this arrow, for example a determination family such as Touch, an environment such as Mountains, a perspective such as Personal, or a motivation such as Hope.
|
|
25314
|
+
*/
|
|
25315
|
+
colorLabel: string;
|
|
25316
|
+
/**
|
|
25317
|
+
* Keynote of the arrow direction for this arrow, for example Active or Passive for Determination, Focused or Peripheral for Perspective.
|
|
25318
|
+
*/
|
|
25319
|
+
directionLabel: string;
|
|
25320
|
+
/**
|
|
25321
|
+
* Whether this arrow is far enough from a Color or Tone boundary to be reliable. When false the activation sits on a knife edge where the Color label or the arrow direction could flip with a more precise birth time, and the arrow should not be presented as fact.
|
|
25322
|
+
*/
|
|
25323
|
+
confident: boolean;
|
|
25324
|
+
}>;
|
|
25325
|
+
/**
|
|
25326
|
+
* True only when all four arrows are confident. A single knife-edge arrow makes the whole configuration uncertain.
|
|
25327
|
+
*/
|
|
25328
|
+
confident: boolean;
|
|
25329
|
+
/**
|
|
25330
|
+
* Boundary margin in degrees of ecliptic longitude used for the per-arrow confidence flag, the solar arc over a few minutes of clock time. An activation within this distance of a Color or Tone boundary is flagged low-confidence.
|
|
25331
|
+
*/
|
|
25332
|
+
confidenceMarginDeg: number;
|
|
25333
|
+
};
|
|
25334
|
+
};
|
|
25335
|
+
|
|
25336
|
+
export type PostHumanDesignVariablesResponse = PostHumanDesignVariablesResponses[keyof PostHumanDesignVariablesResponses];
|
|
25337
|
+
|
|
25338
|
+
export type PostForecastTimelineData = {
|
|
25339
|
+
body?: {
|
|
25340
|
+
/**
|
|
25341
|
+
* The single birth subject this forecast is built for. One object only, never an array.
|
|
25342
|
+
*/
|
|
25343
|
+
birthData: {
|
|
25344
|
+
/**
|
|
25345
|
+
* Birth date in YYYY-MM-DD format. Anchors the natal chart and the Vimshottari dasha sequence.
|
|
25346
|
+
*/
|
|
25347
|
+
date: string;
|
|
25348
|
+
/**
|
|
25349
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters for the natal positions the transit aspects are measured against.
|
|
25350
|
+
*/
|
|
25351
|
+
time: string;
|
|
25352
|
+
/**
|
|
25353
|
+
* Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
|
|
25354
|
+
*/
|
|
25355
|
+
timezone: number | string;
|
|
25356
|
+
/**
|
|
25357
|
+
* Birth latitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
25358
|
+
*/
|
|
25359
|
+
latitude?: number;
|
|
25360
|
+
/**
|
|
25361
|
+
* Birth longitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
25362
|
+
*/
|
|
25363
|
+
longitude?: number;
|
|
25364
|
+
};
|
|
25365
|
+
/**
|
|
25366
|
+
* First day of the forecast window in YYYY-MM-DD format. Defaults to today in UTC.
|
|
25367
|
+
*/
|
|
25368
|
+
startDate?: string;
|
|
25369
|
+
/**
|
|
25370
|
+
* Last day of the forecast window in YYYY-MM-DD format. Defaults to startDate plus 30 days. The window is clamped to a maximum of 90 days from startDate.
|
|
25371
|
+
*/
|
|
25372
|
+
endDate?: string;
|
|
25373
|
+
/**
|
|
25374
|
+
* Which forecast domains to include. Defaults to all three. Pass a subset to scope the timeline to one or two engines.
|
|
25375
|
+
*/
|
|
25376
|
+
domains?: Array<'western' | 'vedic' | 'biorhythm'>;
|
|
25377
|
+
/**
|
|
25378
|
+
* Drop events scoring below this significance threshold from 0 to 100. Defaults to 0, keeping all events.
|
|
25379
|
+
*/
|
|
25380
|
+
minSignificance?: number;
|
|
25381
|
+
/**
|
|
25382
|
+
* Per-domain significance multipliers applied before the significance floor and event cap. Bias which domains survive filtering and the cap. Omitted domains default to a weight of 1. Valid keys are western, vedic, and biorhythm.
|
|
25383
|
+
*/
|
|
25384
|
+
domainWeights?: {
|
|
25385
|
+
/**
|
|
25386
|
+
* Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
|
|
25387
|
+
*/
|
|
25388
|
+
western?: number;
|
|
25389
|
+
/**
|
|
25390
|
+
* Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
|
|
25391
|
+
*/
|
|
25392
|
+
vedic?: number;
|
|
25393
|
+
/**
|
|
25394
|
+
* Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
|
|
25395
|
+
*/
|
|
25396
|
+
biorhythm?: number;
|
|
25397
|
+
};
|
|
25398
|
+
};
|
|
25399
|
+
path?: never;
|
|
25400
|
+
query?: {
|
|
25401
|
+
/**
|
|
25402
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
25403
|
+
*/
|
|
25404
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
25405
|
+
};
|
|
25406
|
+
url: '/forecast/timeline';
|
|
25407
|
+
};
|
|
25408
|
+
|
|
25409
|
+
export type PostForecastTimelineErrors = {
|
|
25410
|
+
/**
|
|
25411
|
+
* Validation error. `issues[]` lists every failed field.
|
|
25412
|
+
*/
|
|
25413
|
+
400: {
|
|
25414
|
+
/**
|
|
25415
|
+
* First issue summary.
|
|
25416
|
+
*/
|
|
25417
|
+
error: string;
|
|
25418
|
+
code: 'validation_error';
|
|
25419
|
+
/**
|
|
25420
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
25421
|
+
*/
|
|
25422
|
+
issues: Array<{
|
|
25423
|
+
/**
|
|
25424
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
25425
|
+
*/
|
|
25426
|
+
path: string;
|
|
25427
|
+
message: string;
|
|
25428
|
+
/**
|
|
25429
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
25430
|
+
*/
|
|
25431
|
+
code?: string;
|
|
25432
|
+
/**
|
|
25433
|
+
* Expected type for invalid_type.
|
|
25434
|
+
*/
|
|
25435
|
+
expected?: string;
|
|
25436
|
+
/**
|
|
25437
|
+
* Minimum bound for too_small issues.
|
|
25438
|
+
*/
|
|
25439
|
+
minimum?: number | string;
|
|
25440
|
+
/**
|
|
25441
|
+
* Maximum bound for too_big issues.
|
|
25442
|
+
*/
|
|
25443
|
+
maximum?: number | string;
|
|
25444
|
+
inclusive?: boolean;
|
|
25445
|
+
/**
|
|
25446
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
25447
|
+
*/
|
|
25448
|
+
format?: string;
|
|
25449
|
+
/**
|
|
25450
|
+
* Regex pattern when format is regex.
|
|
25451
|
+
*/
|
|
25452
|
+
pattern?: string;
|
|
25453
|
+
}>;
|
|
25454
|
+
};
|
|
25455
|
+
/**
|
|
25456
|
+
* Invalid or missing API key
|
|
25457
|
+
*/
|
|
25458
|
+
401: {
|
|
25459
|
+
/**
|
|
25460
|
+
* Human-readable error message. May change wording.
|
|
25461
|
+
*/
|
|
25462
|
+
error: string;
|
|
25463
|
+
/**
|
|
25464
|
+
* Machine-readable error code. Stable identifier.
|
|
25465
|
+
*/
|
|
25466
|
+
code: string;
|
|
25467
|
+
};
|
|
25468
|
+
/**
|
|
25469
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
25470
|
+
*/
|
|
25471
|
+
405: {
|
|
25472
|
+
error: string;
|
|
25473
|
+
code: 'method_not_allowed';
|
|
25474
|
+
/**
|
|
25475
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
25476
|
+
*/
|
|
25477
|
+
allow: Array<string>;
|
|
25478
|
+
/**
|
|
25479
|
+
* Link to the product page for this domain.
|
|
25480
|
+
*/
|
|
25481
|
+
docs?: string;
|
|
25482
|
+
};
|
|
25483
|
+
/**
|
|
25484
|
+
* Monthly rate limit exceeded
|
|
25485
|
+
*/
|
|
25486
|
+
429: {
|
|
25487
|
+
/**
|
|
25488
|
+
* Human-readable error message. May change wording.
|
|
25489
|
+
*/
|
|
25490
|
+
error: string;
|
|
25491
|
+
/**
|
|
25492
|
+
* Machine-readable error code. Stable identifier.
|
|
25493
|
+
*/
|
|
25494
|
+
code: string;
|
|
25495
|
+
};
|
|
25496
|
+
/**
|
|
25497
|
+
* Internal server error
|
|
25498
|
+
*/
|
|
25499
|
+
500: {
|
|
25500
|
+
/**
|
|
25501
|
+
* Human-readable error message. May change wording.
|
|
25502
|
+
*/
|
|
25503
|
+
error: string;
|
|
25504
|
+
/**
|
|
25505
|
+
* Machine-readable error code. Stable identifier.
|
|
25506
|
+
*/
|
|
25507
|
+
code: string;
|
|
25508
|
+
};
|
|
25509
|
+
};
|
|
25510
|
+
|
|
25511
|
+
export type PostForecastTimelineError = PostForecastTimelineErrors[keyof PostForecastTimelineErrors];
|
|
25512
|
+
|
|
25513
|
+
export type PostForecastTimelineResponses = {
|
|
25514
|
+
/**
|
|
25515
|
+
* Merged forecast timeline with time-ordered events across the requested domains
|
|
25516
|
+
*/
|
|
25517
|
+
200: {
|
|
25518
|
+
/**
|
|
25519
|
+
* Echo of the birth subject this forecast was built for.
|
|
25520
|
+
*/
|
|
25521
|
+
birthData: {
|
|
25522
|
+
/**
|
|
25523
|
+
* Birth date in YYYY-MM-DD format. Anchors the natal chart and the Vimshottari dasha sequence.
|
|
25524
|
+
*/
|
|
25525
|
+
date: string;
|
|
25526
|
+
/**
|
|
25527
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters for the natal positions the transit aspects are measured against.
|
|
25528
|
+
*/
|
|
25529
|
+
time: string;
|
|
25530
|
+
/**
|
|
25531
|
+
* Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
|
|
25532
|
+
*/
|
|
25533
|
+
timezone: number | string;
|
|
25534
|
+
/**
|
|
25535
|
+
* Birth latitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
25063
25536
|
*/
|
|
25064
25537
|
latitude?: number;
|
|
25065
25538
|
/**
|
|
@@ -25096,11 +25569,11 @@ export type PostForecastTimelineResponses = {
|
|
|
25096
25569
|
*/
|
|
25097
25570
|
domain: 'western' | 'vedic' | 'biorhythm';
|
|
25098
25571
|
/**
|
|
25099
|
-
* Event kind. transit-aspect, sign-ingress,
|
|
25572
|
+
* Event kind. transit-aspect, sign-ingress, retrograde-station, and eclipse are western, dasha-change is vedic Vimshottari, critical-day is biorhythm. A stable machine value, never localized, so consumers can branch on it under any language.
|
|
25100
25573
|
*/
|
|
25101
|
-
type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'dasha-change' | 'critical-day';
|
|
25574
|
+
type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'eclipse' | 'dasha-change' | 'critical-day';
|
|
25102
25575
|
/**
|
|
25103
|
-
* Primary subject of the event. A transiting planet for western events, a mahadasha or antardasha label for dasha changes, or the critical cycle for biorhythm days.
|
|
25576
|
+
* Primary subject of the event. A transiting planet for western events, Sun for a solar eclipse or Moon for a lunar eclipse, a mahadasha or antardasha label for dasha changes, or the critical cycle for biorhythm days.
|
|
25104
25577
|
*/
|
|
25105
25578
|
body: string;
|
|
25106
25579
|
/**
|
|
@@ -25119,12 +25592,20 @@ export type PostForecastTimelineResponses = {
|
|
|
25119
25592
|
* For a retrograde-station, whether the planet turns retrograde or direct. A stable machine value, never localized. Absent for other event types.
|
|
25120
25593
|
*/
|
|
25121
25594
|
station?: 'retrograde' | 'direct';
|
|
25595
|
+
/**
|
|
25596
|
+
* For an eclipse, its classification. total and penumbral apply to lunar eclipses, partial applies to both, annular and total apply to solar eclipses. A stable machine value, never localized. Absent for other event types.
|
|
25597
|
+
*/
|
|
25598
|
+
kind?: 'penumbral' | 'partial' | 'annular' | 'total';
|
|
25599
|
+
/**
|
|
25600
|
+
* For a lunar eclipse, the peak fraction from 0 to 1 of the Moon disc covered by Earth umbra. 1 for a total lunar eclipse, between 0 and 1 for a partial, 0 for a penumbral. Absent for solar eclipses and other event types.
|
|
25601
|
+
*/
|
|
25602
|
+
obscuration?: number;
|
|
25122
25603
|
/**
|
|
25123
25604
|
* Plain-language summary of the event, suitable for direct display. The only localized field: when lang is set this sentence, and the body, target, and aspect names within it, render in the requested language while the structured fields stay English.
|
|
25124
25605
|
*/
|
|
25125
25606
|
description: string;
|
|
25126
25607
|
/**
|
|
25127
|
-
* Importance score from 0 to 100. Outer-planet exact transit aspects and mahadasha changes score highest; fast Moon events and biorhythm critical days score lower.
|
|
25608
|
+
* Importance score from 0 to 100. Outer-planet exact transit aspects and mahadasha changes score highest; fast Moon events and biorhythm critical days score lower. When domainWeights is supplied this is the weighted score, rounded and clamped to 0 to 100, which is the same value the significance floor and the event cap acted on.
|
|
25128
25609
|
*/
|
|
25129
25610
|
significance: number;
|
|
25130
25611
|
}>;
|
|
@@ -25346,11 +25827,11 @@ export type PostForecastTransitsResponses = {
|
|
|
25346
25827
|
*/
|
|
25347
25828
|
domain: 'western' | 'vedic' | 'biorhythm';
|
|
25348
25829
|
/**
|
|
25349
|
-
* Event kind. transit-aspect, sign-ingress,
|
|
25830
|
+
* Event kind. transit-aspect, sign-ingress, retrograde-station, and eclipse are western, dasha-change is vedic Vimshottari, critical-day is biorhythm. A stable machine value, never localized, so consumers can branch on it under any language.
|
|
25350
25831
|
*/
|
|
25351
|
-
type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'dasha-change' | 'critical-day';
|
|
25832
|
+
type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'eclipse' | 'dasha-change' | 'critical-day';
|
|
25352
25833
|
/**
|
|
25353
|
-
* Primary subject of the event. A transiting planet for western events, a mahadasha or antardasha label for dasha changes, or the critical cycle for biorhythm days.
|
|
25834
|
+
* Primary subject of the event. A transiting planet for western events, Sun for a solar eclipse or Moon for a lunar eclipse, a mahadasha or antardasha label for dasha changes, or the critical cycle for biorhythm days.
|
|
25354
25835
|
*/
|
|
25355
25836
|
body: string;
|
|
25356
25837
|
/**
|
|
@@ -25369,12 +25850,20 @@ export type PostForecastTransitsResponses = {
|
|
|
25369
25850
|
* For a retrograde-station, whether the planet turns retrograde or direct. A stable machine value, never localized. Absent for other event types.
|
|
25370
25851
|
*/
|
|
25371
25852
|
station?: 'retrograde' | 'direct';
|
|
25853
|
+
/**
|
|
25854
|
+
* For an eclipse, its classification. total and penumbral apply to lunar eclipses, partial applies to both, annular and total apply to solar eclipses. A stable machine value, never localized. Absent for other event types.
|
|
25855
|
+
*/
|
|
25856
|
+
kind?: 'penumbral' | 'partial' | 'annular' | 'total';
|
|
25857
|
+
/**
|
|
25858
|
+
* For a lunar eclipse, the peak fraction from 0 to 1 of the Moon disc covered by Earth umbra. 1 for a total lunar eclipse, between 0 and 1 for a partial, 0 for a penumbral. Absent for solar eclipses and other event types.
|
|
25859
|
+
*/
|
|
25860
|
+
obscuration?: number;
|
|
25372
25861
|
/**
|
|
25373
25862
|
* Plain-language summary of the event, suitable for direct display. The only localized field: when lang is set this sentence, and the body, target, and aspect names within it, render in the requested language while the structured fields stay English.
|
|
25374
25863
|
*/
|
|
25375
25864
|
description: string;
|
|
25376
25865
|
/**
|
|
25377
|
-
* Importance score from 0 to 100. Outer-planet exact transit aspects and mahadasha changes score highest; fast Moon events and biorhythm critical days score lower.
|
|
25866
|
+
* Importance score from 0 to 100. Outer-planet exact transit aspects and mahadasha changes score highest; fast Moon events and biorhythm critical days score lower. When domainWeights is supplied this is the weighted score, rounded and clamped to 0 to 100, which is the same value the significance floor and the event cap acted on.
|
|
25378
25867
|
*/
|
|
25379
25868
|
significance: number;
|
|
25380
25869
|
}>;
|
|
@@ -25426,6 +25915,23 @@ export type PostForecastSignificantDatesData = {
|
|
|
25426
25915
|
* Significance floor from 0 to 100 for what counts as a significant date. Defaults to 70.
|
|
25427
25916
|
*/
|
|
25428
25917
|
minSignificance?: number;
|
|
25918
|
+
/**
|
|
25919
|
+
* Per-domain significance multipliers applied before the significance floor and event cap. Bias which domains survive filtering and the cap. Omitted domains default to a weight of 1. Valid keys are western, vedic, and biorhythm.
|
|
25920
|
+
*/
|
|
25921
|
+
domainWeights?: {
|
|
25922
|
+
/**
|
|
25923
|
+
* Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
|
|
25924
|
+
*/
|
|
25925
|
+
western?: number;
|
|
25926
|
+
/**
|
|
25927
|
+
* Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
|
|
25928
|
+
*/
|
|
25929
|
+
vedic?: number;
|
|
25930
|
+
/**
|
|
25931
|
+
* Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
|
|
25932
|
+
*/
|
|
25933
|
+
biorhythm?: number;
|
|
25934
|
+
};
|
|
25429
25935
|
};
|
|
25430
25936
|
path?: never;
|
|
25431
25937
|
query?: {
|
|
@@ -25600,11 +26106,11 @@ export type PostForecastSignificantDatesResponses = {
|
|
|
25600
26106
|
*/
|
|
25601
26107
|
domain: 'western' | 'vedic' | 'biorhythm';
|
|
25602
26108
|
/**
|
|
25603
|
-
* Event kind. transit-aspect, sign-ingress,
|
|
26109
|
+
* Event kind. transit-aspect, sign-ingress, retrograde-station, and eclipse are western, dasha-change is vedic Vimshottari, critical-day is biorhythm. A stable machine value, never localized, so consumers can branch on it under any language.
|
|
25604
26110
|
*/
|
|
25605
|
-
type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'dasha-change' | 'critical-day';
|
|
26111
|
+
type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'eclipse' | 'dasha-change' | 'critical-day';
|
|
25606
26112
|
/**
|
|
25607
|
-
* Primary subject of the event. A transiting planet for western events, a mahadasha or antardasha label for dasha changes, or the critical cycle for biorhythm days.
|
|
26113
|
+
* Primary subject of the event. A transiting planet for western events, Sun for a solar eclipse or Moon for a lunar eclipse, a mahadasha or antardasha label for dasha changes, or the critical cycle for biorhythm days.
|
|
25608
26114
|
*/
|
|
25609
26115
|
body: string;
|
|
25610
26116
|
/**
|
|
@@ -25623,12 +26129,20 @@ export type PostForecastSignificantDatesResponses = {
|
|
|
25623
26129
|
* For a retrograde-station, whether the planet turns retrograde or direct. A stable machine value, never localized. Absent for other event types.
|
|
25624
26130
|
*/
|
|
25625
26131
|
station?: 'retrograde' | 'direct';
|
|
26132
|
+
/**
|
|
26133
|
+
* For an eclipse, its classification. total and penumbral apply to lunar eclipses, partial applies to both, annular and total apply to solar eclipses. A stable machine value, never localized. Absent for other event types.
|
|
26134
|
+
*/
|
|
26135
|
+
kind?: 'penumbral' | 'partial' | 'annular' | 'total';
|
|
26136
|
+
/**
|
|
26137
|
+
* For a lunar eclipse, the peak fraction from 0 to 1 of the Moon disc covered by Earth umbra. 1 for a total lunar eclipse, between 0 and 1 for a partial, 0 for a penumbral. Absent for solar eclipses and other event types.
|
|
26138
|
+
*/
|
|
26139
|
+
obscuration?: number;
|
|
25626
26140
|
/**
|
|
25627
26141
|
* Plain-language summary of the event, suitable for direct display. The only localized field: when lang is set this sentence, and the body, target, and aspect names within it, render in the requested language while the structured fields stay English.
|
|
25628
26142
|
*/
|
|
25629
26143
|
description: string;
|
|
25630
26144
|
/**
|
|
25631
|
-
* Importance score from 0 to 100. Outer-planet exact transit aspects and mahadasha changes score highest; fast Moon events and biorhythm critical days score lower.
|
|
26145
|
+
* Importance score from 0 to 100. Outer-planet exact transit aspects and mahadasha changes score highest; fast Moon events and biorhythm critical days score lower. When domainWeights is supplied this is the weighted score, rounded and clamped to 0 to 100, which is the same value the significance floor and the event cap acted on.
|
|
25632
26146
|
*/
|
|
25633
26147
|
significance: number;
|
|
25634
26148
|
}>;
|
|
@@ -25637,6 +26151,689 @@ export type PostForecastSignificantDatesResponses = {
|
|
|
25637
26151
|
|
|
25638
26152
|
export type PostForecastSignificantDatesResponse = PostForecastSignificantDatesResponses[keyof PostForecastSignificantDatesResponses];
|
|
25639
26153
|
|
|
26154
|
+
export type PostForecastDigestData = {
|
|
26155
|
+
body?: {
|
|
26156
|
+
/**
|
|
26157
|
+
* The single birth subject this digest is built for. One object only, never an array.
|
|
26158
|
+
*/
|
|
26159
|
+
birthData: {
|
|
26160
|
+
/**
|
|
26161
|
+
* Birth date in YYYY-MM-DD format. Anchors the natal chart and the Vimshottari dasha sequence.
|
|
26162
|
+
*/
|
|
26163
|
+
date: string;
|
|
26164
|
+
/**
|
|
26165
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters for the natal positions the transit aspects are measured against.
|
|
26166
|
+
*/
|
|
26167
|
+
time: string;
|
|
26168
|
+
/**
|
|
26169
|
+
* Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
|
|
26170
|
+
*/
|
|
26171
|
+
timezone: number | string;
|
|
26172
|
+
/**
|
|
26173
|
+
* Birth latitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
26174
|
+
*/
|
|
26175
|
+
latitude?: number;
|
|
26176
|
+
/**
|
|
26177
|
+
* Birth longitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
26178
|
+
*/
|
|
26179
|
+
longitude?: number;
|
|
26180
|
+
};
|
|
26181
|
+
/**
|
|
26182
|
+
* Start anchor for every window in YYYY-MM-DD format. The next 24h, 7d, 30d, and 90d windows are measured forward from this date at 00:00:00 UTC. Defaults to today in UTC.
|
|
26183
|
+
*/
|
|
26184
|
+
startDate?: string;
|
|
26185
|
+
/**
|
|
26186
|
+
* Which forecast domains to include before rolling up the windows. Defaults to all three.
|
|
26187
|
+
*/
|
|
26188
|
+
domains?: Array<'western' | 'vedic' | 'biorhythm'>;
|
|
26189
|
+
/**
|
|
26190
|
+
* Drop events scoring below this significance threshold from 0 to 100 before the rollup. Defaults to 0.
|
|
26191
|
+
*/
|
|
26192
|
+
minSignificance?: number;
|
|
26193
|
+
/**
|
|
26194
|
+
* Per-domain significance multipliers applied before the significance floor and event cap. Bias which domains survive filtering and the cap. Omitted domains default to a weight of 1. Valid keys are western, vedic, and biorhythm.
|
|
26195
|
+
*/
|
|
26196
|
+
domainWeights?: {
|
|
26197
|
+
/**
|
|
26198
|
+
* Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
|
|
26199
|
+
*/
|
|
26200
|
+
western?: number;
|
|
26201
|
+
/**
|
|
26202
|
+
* Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
|
|
26203
|
+
*/
|
|
26204
|
+
vedic?: number;
|
|
26205
|
+
/**
|
|
26206
|
+
* Multiplier for this domain significance. 1 leaves it unchanged, above 1 promotes the domain, below 1 demotes it.
|
|
26207
|
+
*/
|
|
26208
|
+
biorhythm?: number;
|
|
26209
|
+
};
|
|
26210
|
+
/**
|
|
26211
|
+
* Number of highest-significance events to surface per window. Defaults to 3, capped at 20.
|
|
26212
|
+
*/
|
|
26213
|
+
top?: number;
|
|
26214
|
+
};
|
|
26215
|
+
path?: never;
|
|
26216
|
+
query?: {
|
|
26217
|
+
/**
|
|
26218
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
26219
|
+
*/
|
|
26220
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
26221
|
+
};
|
|
26222
|
+
url: '/forecast/digest';
|
|
26223
|
+
};
|
|
26224
|
+
|
|
26225
|
+
export type PostForecastDigestErrors = {
|
|
26226
|
+
/**
|
|
26227
|
+
* Validation error. `issues[]` lists every failed field.
|
|
26228
|
+
*/
|
|
26229
|
+
400: {
|
|
26230
|
+
/**
|
|
26231
|
+
* First issue summary.
|
|
26232
|
+
*/
|
|
26233
|
+
error: string;
|
|
26234
|
+
code: 'validation_error';
|
|
26235
|
+
/**
|
|
26236
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
26237
|
+
*/
|
|
26238
|
+
issues: Array<{
|
|
26239
|
+
/**
|
|
26240
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
26241
|
+
*/
|
|
26242
|
+
path: string;
|
|
26243
|
+
message: string;
|
|
26244
|
+
/**
|
|
26245
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
26246
|
+
*/
|
|
26247
|
+
code?: string;
|
|
26248
|
+
/**
|
|
26249
|
+
* Expected type for invalid_type.
|
|
26250
|
+
*/
|
|
26251
|
+
expected?: string;
|
|
26252
|
+
/**
|
|
26253
|
+
* Minimum bound for too_small issues.
|
|
26254
|
+
*/
|
|
26255
|
+
minimum?: number | string;
|
|
26256
|
+
/**
|
|
26257
|
+
* Maximum bound for too_big issues.
|
|
26258
|
+
*/
|
|
26259
|
+
maximum?: number | string;
|
|
26260
|
+
inclusive?: boolean;
|
|
26261
|
+
/**
|
|
26262
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
26263
|
+
*/
|
|
26264
|
+
format?: string;
|
|
26265
|
+
/**
|
|
26266
|
+
* Regex pattern when format is regex.
|
|
26267
|
+
*/
|
|
26268
|
+
pattern?: string;
|
|
26269
|
+
}>;
|
|
26270
|
+
};
|
|
26271
|
+
/**
|
|
26272
|
+
* Invalid or missing API key
|
|
26273
|
+
*/
|
|
26274
|
+
401: {
|
|
26275
|
+
/**
|
|
26276
|
+
* Human-readable error message. May change wording.
|
|
26277
|
+
*/
|
|
26278
|
+
error: string;
|
|
26279
|
+
/**
|
|
26280
|
+
* Machine-readable error code. Stable identifier.
|
|
26281
|
+
*/
|
|
26282
|
+
code: string;
|
|
26283
|
+
};
|
|
26284
|
+
/**
|
|
26285
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
26286
|
+
*/
|
|
26287
|
+
405: {
|
|
26288
|
+
error: string;
|
|
26289
|
+
code: 'method_not_allowed';
|
|
26290
|
+
/**
|
|
26291
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
26292
|
+
*/
|
|
26293
|
+
allow: Array<string>;
|
|
26294
|
+
/**
|
|
26295
|
+
* Link to the product page for this domain.
|
|
26296
|
+
*/
|
|
26297
|
+
docs?: string;
|
|
26298
|
+
};
|
|
26299
|
+
/**
|
|
26300
|
+
* Monthly rate limit exceeded
|
|
26301
|
+
*/
|
|
26302
|
+
429: {
|
|
26303
|
+
/**
|
|
26304
|
+
* Human-readable error message. May change wording.
|
|
26305
|
+
*/
|
|
26306
|
+
error: string;
|
|
26307
|
+
/**
|
|
26308
|
+
* Machine-readable error code. Stable identifier.
|
|
26309
|
+
*/
|
|
26310
|
+
code: string;
|
|
26311
|
+
};
|
|
26312
|
+
/**
|
|
26313
|
+
* Internal server error
|
|
26314
|
+
*/
|
|
26315
|
+
500: {
|
|
26316
|
+
/**
|
|
26317
|
+
* Human-readable error message. May change wording.
|
|
26318
|
+
*/
|
|
26319
|
+
error: string;
|
|
26320
|
+
/**
|
|
26321
|
+
* Machine-readable error code. Stable identifier.
|
|
26322
|
+
*/
|
|
26323
|
+
code: string;
|
|
26324
|
+
};
|
|
26325
|
+
};
|
|
26326
|
+
|
|
26327
|
+
export type PostForecastDigestError = PostForecastDigestErrors[keyof PostForecastDigestErrors];
|
|
26328
|
+
|
|
26329
|
+
export type PostForecastDigestResponses = {
|
|
26330
|
+
/**
|
|
26331
|
+
* Pre-summarized forecast windows: next 24h, 7d, 30d, and 90d rollups
|
|
26332
|
+
*/
|
|
26333
|
+
200: {
|
|
26334
|
+
/**
|
|
26335
|
+
* Echo of the birth subject this digest was built for.
|
|
26336
|
+
*/
|
|
26337
|
+
birthData: {
|
|
26338
|
+
/**
|
|
26339
|
+
* Birth date in YYYY-MM-DD format. Anchors the natal chart and the Vimshottari dasha sequence.
|
|
26340
|
+
*/
|
|
26341
|
+
date: string;
|
|
26342
|
+
/**
|
|
26343
|
+
* Birth time in 24-hour HH:MM:SS format. Precision matters for the natal positions the transit aspects are measured against.
|
|
26344
|
+
*/
|
|
26345
|
+
time: string;
|
|
26346
|
+
/**
|
|
26347
|
+
* Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
|
|
26348
|
+
*/
|
|
26349
|
+
timezone: number | string;
|
|
26350
|
+
/**
|
|
26351
|
+
* Birth latitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
26352
|
+
*/
|
|
26353
|
+
latitude?: number;
|
|
26354
|
+
/**
|
|
26355
|
+
* Birth longitude in decimal degrees. Optional and does not affect the timeline. Defaults to 0.
|
|
26356
|
+
*/
|
|
26357
|
+
longitude?: number;
|
|
26358
|
+
};
|
|
26359
|
+
/**
|
|
26360
|
+
* Start anchor every window is measured from.
|
|
26361
|
+
*/
|
|
26362
|
+
startDate: string;
|
|
26363
|
+
/**
|
|
26364
|
+
* Last day of the resolved 90 day horizon the timeline was built over before slicing.
|
|
26365
|
+
*/
|
|
26366
|
+
endDate: string;
|
|
26367
|
+
/**
|
|
26368
|
+
* The four rollups in ascending window length: next 24h, 7d, 30d, and 90d from the start anchor.
|
|
26369
|
+
*/
|
|
26370
|
+
windows: Array<{
|
|
26371
|
+
/**
|
|
26372
|
+
* Length of this window in days forward from the start anchor. One of 1, 7, 30, 90.
|
|
26373
|
+
*/
|
|
26374
|
+
days: number;
|
|
26375
|
+
/**
|
|
26376
|
+
* Inclusive lower bound of the window as an ISO-8601 UTC datetime, the start anchor.
|
|
26377
|
+
*/
|
|
26378
|
+
from: string;
|
|
26379
|
+
/**
|
|
26380
|
+
* Exclusive upper bound of the window as an ISO-8601 UTC datetime, the start anchor plus the window length.
|
|
26381
|
+
*/
|
|
26382
|
+
to: string;
|
|
26383
|
+
/**
|
|
26384
|
+
* Number of events whose datetime falls inside this window.
|
|
26385
|
+
*/
|
|
26386
|
+
count: number;
|
|
26387
|
+
/**
|
|
26388
|
+
* Count of events in this window broken down by domain. Only domains with at least one event in the window are present. The values sum to count.
|
|
26389
|
+
*/
|
|
26390
|
+
byDomain: {
|
|
26391
|
+
western?: number;
|
|
26392
|
+
vedic?: number;
|
|
26393
|
+
biorhythm?: number;
|
|
26394
|
+
};
|
|
26395
|
+
/**
|
|
26396
|
+
* Count of events in this window broken down by event type. Only types with at least one event in the window are present. The values sum to count.
|
|
26397
|
+
*/
|
|
26398
|
+
byType: {
|
|
26399
|
+
'transit-aspect'?: number;
|
|
26400
|
+
'sign-ingress'?: number;
|
|
26401
|
+
'retrograde-station'?: number;
|
|
26402
|
+
eclipse?: number;
|
|
26403
|
+
'dasha-change'?: number;
|
|
26404
|
+
'critical-day'?: number;
|
|
26405
|
+
};
|
|
26406
|
+
/**
|
|
26407
|
+
* The highest-significance events in this window, most significant first, up to the requested top count. The same TimelineEvent shape as the timeline endpoints.
|
|
26408
|
+
*/
|
|
26409
|
+
top: Array<{
|
|
26410
|
+
/**
|
|
26411
|
+
* Calendar date of the event in YYYY-MM-DD (UTC).
|
|
26412
|
+
*/
|
|
26413
|
+
date: string;
|
|
26414
|
+
/**
|
|
26415
|
+
* Exact instant of the event as an ISO-8601 UTC datetime. Astronomical events are refined to this instant by search, not reported at a daily sample point.
|
|
26416
|
+
*/
|
|
26417
|
+
datetime: string;
|
|
26418
|
+
/**
|
|
26419
|
+
* Forecast domain. western covers transit aspects, sign ingresses, and retrograde stations. vedic covers Vimshottari mahadasha and antardasha boundaries. biorhythm covers critical days. A stable machine value, never localized, so consumers can branch on it under any language.
|
|
26420
|
+
*/
|
|
26421
|
+
domain: 'western' | 'vedic' | 'biorhythm';
|
|
26422
|
+
/**
|
|
26423
|
+
* Event kind. transit-aspect, sign-ingress, retrograde-station, and eclipse are western, dasha-change is vedic Vimshottari, critical-day is biorhythm. A stable machine value, never localized, so consumers can branch on it under any language.
|
|
26424
|
+
*/
|
|
26425
|
+
type: 'transit-aspect' | 'sign-ingress' | 'retrograde-station' | 'eclipse' | 'dasha-change' | 'critical-day';
|
|
26426
|
+
/**
|
|
26427
|
+
* Primary subject of the event. A transiting planet for western events, Sun for a solar eclipse or Moon for a lunar eclipse, a mahadasha or antardasha label for dasha changes, or the critical cycle for biorhythm days.
|
|
26428
|
+
*/
|
|
26429
|
+
body: string;
|
|
26430
|
+
/**
|
|
26431
|
+
* For a transit-aspect, the natal body the transit aspects. For a sign-ingress, the zodiac sign entered. Absent for other event types.
|
|
26432
|
+
*/
|
|
26433
|
+
target?: string;
|
|
26434
|
+
/**
|
|
26435
|
+
* For a transit-aspect, the angular relationship. One of conjunction, sextile, square, trine, opposition. Absent for other event types.
|
|
26436
|
+
*/
|
|
26437
|
+
aspect?: string;
|
|
26438
|
+
/**
|
|
26439
|
+
* For a transit-aspect, the separation in degrees from the exact aspect at the reported instant. Tighter orb means a more exact and significant aspect.
|
|
26440
|
+
*/
|
|
26441
|
+
orb?: number;
|
|
26442
|
+
/**
|
|
26443
|
+
* For a retrograde-station, whether the planet turns retrograde or direct. A stable machine value, never localized. Absent for other event types.
|
|
26444
|
+
*/
|
|
26445
|
+
station?: 'retrograde' | 'direct';
|
|
26446
|
+
/**
|
|
26447
|
+
* For an eclipse, its classification. total and penumbral apply to lunar eclipses, partial applies to both, annular and total apply to solar eclipses. A stable machine value, never localized. Absent for other event types.
|
|
26448
|
+
*/
|
|
26449
|
+
kind?: 'penumbral' | 'partial' | 'annular' | 'total';
|
|
26450
|
+
/**
|
|
26451
|
+
* For a lunar eclipse, the peak fraction from 0 to 1 of the Moon disc covered by Earth umbra. 1 for a total lunar eclipse, between 0 and 1 for a partial, 0 for a penumbral. Absent for solar eclipses and other event types.
|
|
26452
|
+
*/
|
|
26453
|
+
obscuration?: number;
|
|
26454
|
+
/**
|
|
26455
|
+
* Plain-language summary of the event, suitable for direct display. The only localized field: when lang is set this sentence, and the body, target, and aspect names within it, render in the requested language while the structured fields stay English.
|
|
26456
|
+
*/
|
|
26457
|
+
description: string;
|
|
26458
|
+
/**
|
|
26459
|
+
* Importance score from 0 to 100. Outer-planet exact transit aspects and mahadasha changes score highest; fast Moon events and biorhythm critical days score lower. When domainWeights is supplied this is the weighted score, rounded and clamped to 0 to 100, which is the same value the significance floor and the event cap acted on.
|
|
26460
|
+
*/
|
|
26461
|
+
significance: number;
|
|
26462
|
+
}>;
|
|
26463
|
+
}>;
|
|
26464
|
+
};
|
|
26465
|
+
};
|
|
26466
|
+
|
|
26467
|
+
export type PostForecastDigestResponse = PostForecastDigestResponses[keyof PostForecastDigestResponses];
|
|
26468
|
+
|
|
26469
|
+
export type PostForecastSolarReturnData = {
|
|
26470
|
+
body?: {
|
|
26471
|
+
/**
|
|
26472
|
+
* Birth date in YYYY-MM-DD format. Anchors the natal Sun longitude the transiting Sun returns to each year.
|
|
26473
|
+
*/
|
|
26474
|
+
date: string;
|
|
26475
|
+
/**
|
|
26476
|
+
* Birth time in 24-hour HH:MM:SS format. Pins the exact natal Sun position that defines the solar return moment.
|
|
26477
|
+
*/
|
|
26478
|
+
time: string;
|
|
26479
|
+
/**
|
|
26480
|
+
* Year to cast the solar return for. The chart is erected for the moment in this year when the transiting Sun returns to the natal Sun longitude, on or within a day of the birthday.
|
|
26481
|
+
*/
|
|
26482
|
+
year: number;
|
|
26483
|
+
/**
|
|
26484
|
+
* Latitude of the solar return location in decimal degrees. The solar return is location-sensitive: use the birthplace to anchor the chart to natal geography, or the current city for a relocated solar return.
|
|
26485
|
+
*/
|
|
26486
|
+
latitude: number;
|
|
26487
|
+
/**
|
|
26488
|
+
* Longitude of the solar return location in decimal degrees. Sets the local sidereal time, so it drives the Ascendant, Midheaven, and house cusps of the return chart.
|
|
26489
|
+
*/
|
|
26490
|
+
longitude: number;
|
|
26491
|
+
/**
|
|
26492
|
+
* Decimal hours (e.g. 5.5 for IST, -5 for EST) OR IANA name (e.g. "America/New_York", "UTC"). IANA is resolved to the DST-correct offset for the request date. Invalid timezones return 400 with a validation error.
|
|
26493
|
+
*/
|
|
26494
|
+
timezone: number | string;
|
|
26495
|
+
/**
|
|
26496
|
+
* House system for the return chart. placidus is the Western default. whole-sign, equal, and koch are also supported.
|
|
26497
|
+
*/
|
|
26498
|
+
houseSystem?: 'placidus' | 'whole-sign' | 'equal' | 'koch';
|
|
26499
|
+
};
|
|
26500
|
+
path?: never;
|
|
26501
|
+
query?: {
|
|
26502
|
+
/**
|
|
26503
|
+
* Response language (ISO 639-1). Supported: en, tr, de, es, hi, pt, fr, ru. Defaults to en. Languages without translations yet return English.
|
|
26504
|
+
*/
|
|
26505
|
+
lang?: 'en' | 'tr' | 'de' | 'es' | 'hi' | 'pt' | 'fr' | 'ru';
|
|
26506
|
+
};
|
|
26507
|
+
url: '/forecast/solar-return';
|
|
26508
|
+
};
|
|
26509
|
+
|
|
26510
|
+
export type PostForecastSolarReturnErrors = {
|
|
26511
|
+
/**
|
|
26512
|
+
* Validation error. `issues[]` lists every failed field.
|
|
26513
|
+
*/
|
|
26514
|
+
400: {
|
|
26515
|
+
/**
|
|
26516
|
+
* First issue summary.
|
|
26517
|
+
*/
|
|
26518
|
+
error: string;
|
|
26519
|
+
code: 'validation_error';
|
|
26520
|
+
/**
|
|
26521
|
+
* Every validation failure. Use this to rebuild a valid request.
|
|
26522
|
+
*/
|
|
26523
|
+
issues: Array<{
|
|
26524
|
+
/**
|
|
26525
|
+
* Dot-separated field path, or "(root)" for top-level.
|
|
26526
|
+
*/
|
|
26527
|
+
path: string;
|
|
26528
|
+
message: string;
|
|
26529
|
+
/**
|
|
26530
|
+
* Zod issue code (invalid_type, too_small, too_big, invalid_string, ...).
|
|
26531
|
+
*/
|
|
26532
|
+
code?: string;
|
|
26533
|
+
/**
|
|
26534
|
+
* Expected type for invalid_type.
|
|
26535
|
+
*/
|
|
26536
|
+
expected?: string;
|
|
26537
|
+
/**
|
|
26538
|
+
* Minimum bound for too_small issues.
|
|
26539
|
+
*/
|
|
26540
|
+
minimum?: number | string;
|
|
26541
|
+
/**
|
|
26542
|
+
* Maximum bound for too_big issues.
|
|
26543
|
+
*/
|
|
26544
|
+
maximum?: number | string;
|
|
26545
|
+
inclusive?: boolean;
|
|
26546
|
+
/**
|
|
26547
|
+
* Format name for string issues (regex, email, url, uuid).
|
|
26548
|
+
*/
|
|
26549
|
+
format?: string;
|
|
26550
|
+
/**
|
|
26551
|
+
* Regex pattern when format is regex.
|
|
26552
|
+
*/
|
|
26553
|
+
pattern?: string;
|
|
26554
|
+
}>;
|
|
26555
|
+
};
|
|
26556
|
+
/**
|
|
26557
|
+
* Invalid or missing API key
|
|
26558
|
+
*/
|
|
26559
|
+
401: {
|
|
26560
|
+
/**
|
|
26561
|
+
* Human-readable error message. May change wording.
|
|
26562
|
+
*/
|
|
26563
|
+
error: string;
|
|
26564
|
+
/**
|
|
26565
|
+
* Machine-readable error code. Stable identifier.
|
|
26566
|
+
*/
|
|
26567
|
+
code: string;
|
|
26568
|
+
};
|
|
26569
|
+
/**
|
|
26570
|
+
* Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
|
|
26571
|
+
*/
|
|
26572
|
+
405: {
|
|
26573
|
+
error: string;
|
|
26574
|
+
code: 'method_not_allowed';
|
|
26575
|
+
/**
|
|
26576
|
+
* Allowed HTTP methods for this path. Mirrors the Allow response header.
|
|
26577
|
+
*/
|
|
26578
|
+
allow: Array<string>;
|
|
26579
|
+
/**
|
|
26580
|
+
* Link to the product page for this domain.
|
|
26581
|
+
*/
|
|
26582
|
+
docs?: string;
|
|
26583
|
+
};
|
|
26584
|
+
/**
|
|
26585
|
+
* Monthly rate limit exceeded
|
|
26586
|
+
*/
|
|
26587
|
+
429: {
|
|
26588
|
+
/**
|
|
26589
|
+
* Human-readable error message. May change wording.
|
|
26590
|
+
*/
|
|
26591
|
+
error: string;
|
|
26592
|
+
/**
|
|
26593
|
+
* Machine-readable error code. Stable identifier.
|
|
26594
|
+
*/
|
|
26595
|
+
code: string;
|
|
26596
|
+
};
|
|
26597
|
+
/**
|
|
26598
|
+
* Internal server error
|
|
26599
|
+
*/
|
|
26600
|
+
500: {
|
|
26601
|
+
/**
|
|
26602
|
+
* Human-readable error message. May change wording.
|
|
26603
|
+
*/
|
|
26604
|
+
error: string;
|
|
26605
|
+
/**
|
|
26606
|
+
* Machine-readable error code. Stable identifier.
|
|
26607
|
+
*/
|
|
26608
|
+
code: string;
|
|
26609
|
+
};
|
|
26610
|
+
};
|
|
26611
|
+
|
|
26612
|
+
export type PostForecastSolarReturnError = PostForecastSolarReturnErrors[keyof PostForecastSolarReturnErrors];
|
|
26613
|
+
|
|
26614
|
+
export type PostForecastSolarReturnResponses = {
|
|
26615
|
+
/**
|
|
26616
|
+
* Solar return chart cast for the requested year and location
|
|
26617
|
+
*/
|
|
26618
|
+
200: {
|
|
26619
|
+
/**
|
|
26620
|
+
* Echo of the birth date used to find the natal Sun longitude.
|
|
26621
|
+
*/
|
|
26622
|
+
birthDate: string;
|
|
26623
|
+
/**
|
|
26624
|
+
* Exact solar return moment, when the transiting Sun returns to the natal Sun longitude, formatted in the requested timezone. The astrological birthday for the year.
|
|
26625
|
+
*/
|
|
26626
|
+
solarReturnDate: string;
|
|
26627
|
+
/**
|
|
26628
|
+
* Year of this solar return. The chart covers the period to the next birthday.
|
|
26629
|
+
*/
|
|
26630
|
+
solarReturnYear: number;
|
|
26631
|
+
/**
|
|
26632
|
+
* Location the return chart was cast for. The Ascendant and house cusps change with this location, the basis of the relocated solar return technique.
|
|
26633
|
+
*/
|
|
26634
|
+
location: {
|
|
26635
|
+
/**
|
|
26636
|
+
* Latitude used for the return chart house cusps and Ascendant.
|
|
26637
|
+
*/
|
|
26638
|
+
latitude: number;
|
|
26639
|
+
/**
|
|
26640
|
+
* Longitude used for local sidereal time and the Midheaven.
|
|
26641
|
+
*/
|
|
26642
|
+
longitude: number;
|
|
26643
|
+
/**
|
|
26644
|
+
* Decimal timezone offset applied to the output datetime.
|
|
26645
|
+
*/
|
|
26646
|
+
timezone: number;
|
|
26647
|
+
};
|
|
26648
|
+
/**
|
|
26649
|
+
* The natal Sun position whose annual return defines this chart.
|
|
26650
|
+
*/
|
|
26651
|
+
natalSunPosition: {
|
|
26652
|
+
/**
|
|
26653
|
+
* Natal Sun ecliptic longitude in degrees from 0 to 360 that the Sun returns to.
|
|
26654
|
+
*/
|
|
26655
|
+
longitude: number;
|
|
26656
|
+
/**
|
|
26657
|
+
* Tropical zodiac sign of the natal Sun.
|
|
26658
|
+
*/
|
|
26659
|
+
sign: string;
|
|
26660
|
+
/**
|
|
26661
|
+
* Degree within the sign from 0 to 29.999 that the Sun returns to.
|
|
26662
|
+
*/
|
|
26663
|
+
degree: number;
|
|
26664
|
+
};
|
|
26665
|
+
/**
|
|
26666
|
+
* Full chart erected for the solar return moment: all bodies with house placements, the 12 house cusps, aspects, Part of Fortune, and Vertex in the tropical zodiac.
|
|
26667
|
+
*/
|
|
26668
|
+
chart: {
|
|
26669
|
+
/**
|
|
26670
|
+
* Birth details used to generate this chart.
|
|
26671
|
+
*/
|
|
26672
|
+
birthDetails: {
|
|
26673
|
+
/**
|
|
26674
|
+
* Birth date in YYYY-MM-DD format. Determines planetary positions for the specific calendar day.
|
|
26675
|
+
*/
|
|
26676
|
+
date: string;
|
|
26677
|
+
/**
|
|
26678
|
+
* Birth time in 24-hour HH:MM:SS format. Determines the Ascendant (rising sign) and house cusps. Use 12:00:00 if unknown.
|
|
26679
|
+
*/
|
|
26680
|
+
time: string;
|
|
26681
|
+
/**
|
|
26682
|
+
* Birth location latitude in decimal degrees (-90 to 90). Positive = North, negative = South.
|
|
26683
|
+
*/
|
|
26684
|
+
latitude: number;
|
|
26685
|
+
/**
|
|
26686
|
+
* Birth location longitude in decimal degrees (-180 to 180). Positive = East, negative = West.
|
|
26687
|
+
*/
|
|
26688
|
+
longitude: number;
|
|
26689
|
+
/**
|
|
26690
|
+
* Timezone offset from UTC in decimal hours. Examples: New York = -5, London = 0, India = 5.5, Tokyo = 9.
|
|
26691
|
+
*/
|
|
26692
|
+
timezone: number;
|
|
26693
|
+
};
|
|
26694
|
+
/**
|
|
26695
|
+
* All 14 celestial bodies in the tropical zodiac with house placements: the 10 classical planets (Sun through Pluto), the lunar nodes (North Node, South Node), Chiron, and Black Moon Lilith.
|
|
26696
|
+
*/
|
|
26697
|
+
planets: Array<{
|
|
26698
|
+
/**
|
|
26699
|
+
* Body name. One of the 10 classical planets (Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto), the lunar nodes (North Node, South Node), Chiron, or Black Moon Lilith (the mean lunar apogee).
|
|
26700
|
+
*/
|
|
26701
|
+
name: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
26702
|
+
/**
|
|
26703
|
+
* Tropical ecliptic longitude in degrees (0-360). Primary coordinate for zodiac sign and aspect calculations.
|
|
26704
|
+
*/
|
|
26705
|
+
longitude: number;
|
|
26706
|
+
/**
|
|
26707
|
+
* Ecliptic latitude in degrees. Near zero for most planets, varies for the Moon and Pluto, and reaches up to about 5 degrees for Black Moon Lilith (projected from the inclined mean lunar orbit).
|
|
26708
|
+
*/
|
|
26709
|
+
latitude: number;
|
|
26710
|
+
/**
|
|
26711
|
+
* Tropical zodiac sign this planet occupies. Determined by 30-degree divisions of ecliptic longitude.
|
|
26712
|
+
*/
|
|
26713
|
+
sign: string;
|
|
26714
|
+
/**
|
|
26715
|
+
* Degree within the zodiac sign (0-29.999). Indicates how far the planet has progressed through the sign.
|
|
26716
|
+
*/
|
|
26717
|
+
degree: number;
|
|
26718
|
+
/**
|
|
26719
|
+
* House placement (1-12). Determined by the selected house system and birth location.
|
|
26720
|
+
*/
|
|
26721
|
+
house: number;
|
|
26722
|
+
/**
|
|
26723
|
+
* Daily motion in degrees per day. Negative values indicate retrograde motion.
|
|
26724
|
+
*/
|
|
26725
|
+
speed: number;
|
|
26726
|
+
/**
|
|
26727
|
+
* Whether the planet appears to move backward from Earth perspective. Retrograde periods signal review and introspection.
|
|
26728
|
+
*/
|
|
26729
|
+
isRetrograde: boolean;
|
|
26730
|
+
}>;
|
|
26731
|
+
/**
|
|
26732
|
+
* All 12 house cusps calculated using the selected house system.
|
|
26733
|
+
*/
|
|
26734
|
+
houses: Array<{
|
|
26735
|
+
/**
|
|
26736
|
+
* House number (1-12). Each house governs specific life themes in Western astrology.
|
|
26737
|
+
*/
|
|
26738
|
+
number: number;
|
|
26739
|
+
/**
|
|
26740
|
+
* Ecliptic longitude of this house cusp in degrees (0-360).
|
|
26741
|
+
*/
|
|
26742
|
+
longitude: number;
|
|
26743
|
+
/**
|
|
26744
|
+
* Zodiac sign on this house cusp. Colors the themes of this life area.
|
|
26745
|
+
*/
|
|
26746
|
+
sign: string;
|
|
26747
|
+
/**
|
|
26748
|
+
* Degree within the zodiac sign on this cusp (0-29.999).
|
|
26749
|
+
*/
|
|
26750
|
+
degree: number;
|
|
26751
|
+
}>;
|
|
26752
|
+
/**
|
|
26753
|
+
* House system used for this chart (placidus, whole-sign, equal, or koch).
|
|
26754
|
+
*/
|
|
26755
|
+
houseSystem: 'placidus' | 'whole-sign' | 'equal' | 'koch';
|
|
26756
|
+
/**
|
|
26757
|
+
* All planetary aspects found in this chart with orbs, strength, and applying/separating status.
|
|
26758
|
+
*/
|
|
26759
|
+
aspects: Array<{
|
|
26760
|
+
/**
|
|
26761
|
+
* First planet in the aspect pair.
|
|
26762
|
+
*/
|
|
26763
|
+
planet1: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
26764
|
+
/**
|
|
26765
|
+
* Second planet in the aspect pair.
|
|
26766
|
+
*/
|
|
26767
|
+
planet2: 'Sun' | 'Moon' | 'Mercury' | 'Venus' | 'Mars' | 'Jupiter' | 'Saturn' | 'Uranus' | 'Neptune' | 'Pluto' | 'North Node' | 'South Node' | 'Chiron' | 'Black Moon Lilith';
|
|
26768
|
+
/**
|
|
26769
|
+
* Aspect type. Major: conjunction (0), opposition (180), trine (120), square (90), sextile (60). Minor: semi-sextile, quincunx, semi-square, sesquiquadrate.
|
|
26770
|
+
*/
|
|
26771
|
+
type: 'CONJUNCTION' | 'OPPOSITION' | 'TRINE' | 'SQUARE' | 'SEXTILE' | 'SEMI_SEXTILE' | 'QUINCUNX' | 'SEMI_SQUARE' | 'SESQUIQUADRATE';
|
|
26772
|
+
/**
|
|
26773
|
+
* Exact angular separation that defines this aspect type in degrees.
|
|
26774
|
+
*/
|
|
26775
|
+
angle: number;
|
|
26776
|
+
/**
|
|
26777
|
+
* Deviation from exact aspect in degrees. Tighter orb means stronger influence.
|
|
26778
|
+
*/
|
|
26779
|
+
orb: number;
|
|
26780
|
+
/**
|
|
26781
|
+
* Whether the aspect is applying (planets moving toward exact) or separating (moving apart). Applying aspects grow stronger.
|
|
26782
|
+
*/
|
|
26783
|
+
isApplying: boolean;
|
|
26784
|
+
/**
|
|
26785
|
+
* Aspect strength percentage (0-100). Based on orb tightness relative to the allowed maximum.
|
|
26786
|
+
*/
|
|
26787
|
+
strength: number;
|
|
26788
|
+
/**
|
|
26789
|
+
* Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
|
|
26790
|
+
*/
|
|
26791
|
+
interpretation: 'harmonious' | 'challenging' | 'neutral';
|
|
26792
|
+
}>;
|
|
26793
|
+
/**
|
|
26794
|
+
* Part of Fortune (Lot of Fortune). A point derived from the Ascendant and the two luminaries that marks an area of ease, vitality, and material wellbeing in the chart.
|
|
26795
|
+
*/
|
|
26796
|
+
partOfFortune: {
|
|
26797
|
+
/**
|
|
26798
|
+
* Zodiac sign holding the Part of Fortune.
|
|
26799
|
+
*/
|
|
26800
|
+
sign: string;
|
|
26801
|
+
/**
|
|
26802
|
+
* Degree within the Part of Fortune sign (0-29.999).
|
|
26803
|
+
*/
|
|
26804
|
+
degree: number;
|
|
26805
|
+
/**
|
|
26806
|
+
* Absolute ecliptic longitude of the Part of Fortune (0-360).
|
|
26807
|
+
*/
|
|
26808
|
+
longitude: number;
|
|
26809
|
+
/**
|
|
26810
|
+
* Chart sect used for the calculation. Day (diurnal) when the Sun is above the horizon, night (nocturnal) when below. Day charts use Ascendant plus Moon minus Sun, night charts use Ascendant plus Sun minus Moon.
|
|
26811
|
+
*/
|
|
26812
|
+
sect: 'day' | 'night';
|
|
26813
|
+
};
|
|
26814
|
+
/**
|
|
26815
|
+
* Vertex. The western intersection of the prime vertical with the ecliptic, often read as a point of fated encounters and turning-point relationships. The opposite point is the Anti-Vertex.
|
|
26816
|
+
*/
|
|
26817
|
+
vertex: {
|
|
26818
|
+
/**
|
|
26819
|
+
* Zodiac sign holding the Vertex.
|
|
26820
|
+
*/
|
|
26821
|
+
sign: string;
|
|
26822
|
+
/**
|
|
26823
|
+
* Degree within the Vertex sign (0-29.999).
|
|
26824
|
+
*/
|
|
26825
|
+
degree: number;
|
|
26826
|
+
/**
|
|
26827
|
+
* Absolute ecliptic longitude of the Vertex (0-360).
|
|
26828
|
+
*/
|
|
26829
|
+
longitude: number;
|
|
26830
|
+
};
|
|
26831
|
+
};
|
|
26832
|
+
};
|
|
26833
|
+
};
|
|
26834
|
+
|
|
26835
|
+
export type PostForecastSolarReturnResponse = PostForecastSolarReturnResponses[keyof PostForecastSolarReturnResponses];
|
|
26836
|
+
|
|
25640
26837
|
export type PostBiorhythmReadingData = {
|
|
25641
26838
|
body?: {
|
|
25642
26839
|
/**
|