AstroAPI

Appearance

API Reference ​

Welcome to the AstroAPI Reference documentation. This section provides detailed information about all available endpoints.

OpenAPI Specification ​

The complete API is documented using the OpenAPI 3.1 specification. Use the sidebar to browse available endpoints organized by category.

Base URL ​

https://api.astroapi.cloud

Authentication ​

All API requests require authentication via:

  • API Key: X-Api-Key header

See the Authentication Guide for details.

Response Format ​

All responses follow the JSON:API specification:

json
{
  "data": {
    "type": "resource-type",
    "id": "resource-id",
    "attributes": { ... }
  }
}

Error Responses ​

Errors follow JSON:API error format:

json
{
  "errors": [{
    "status": "400",
    "title": "Bad Request",
    "detail": "Detailed error message"
  }]
}

Common HTTP Status Codes ​

CodeDescription
200Success
201Created
400Bad Request - Invalid parameters
401Unauthorized - Missing or invalid authentication
403Forbidden - Insufficient permissions or module access
404Not Found
429Too Many Requests - Rate limit exceeded
500Internal Server Error
v25.12.4

AstroAPI​

Download OpenAPI Document

Professional astrology API for natal charts, transits, synastry, and interpretations

Servers​

https://api.astroapi.cloudProduction

Create Custom Copy​

POST
/api/content/{id}/create-custom-copy

Create an organization-specific copy of system content for customization.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Responses​

Create a custom copy of system content

application/vnd.api+json
JSON
{
"data": {
"type": "content",
"id": "string",
"attributes": {
"urn": "string",
"title": "string",
"body": "string",
"metadata": null,
"owner_type": "string",
"owner_id": "string",
"base_content_id": "string",
"created_at": "string",
"updated_at": "string"
},
"links": {
"self": "string"
}
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Restore Content​

POST
/api/content/{id}/restore

Restore custom content to match the original system content.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Responses​

Restore custom content to match system content

application/vnd.api+json
JSON
{
"data": {
"type": "content",
"id": "string",
"attributes": {
"urn": "string",
"title": "string",
"body": "string",
"metadata": null,
"owner_type": "string",
"owner_id": "string",
"base_content_id": "string",
"created_at": "string",
"updated_at": "string"
},
"links": {
"self": "string"
}
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Delete Content by ID​

DELETE
/api/content/{id}

Delete a content item by its ID.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Responses​

Delete one content item

application/vnd.api+json
JSON
{
"data": {
"type": "content",
"id": "string",
"attributes": {
"urn": "string",
"title": "string",
"body": "string",
"metadata": null,
"owner_type": "string",
"owner_id": "string",
"base_content_id": "string",
"created_at": "string",
"updated_at": "string"
},
"links": {
"self": "string"
}
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

List Content​

GET
/api/content/{horoscopeType}/{contentType}

Retrieve a paginated list of content items filtered by horoscope and content type.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

horoscopeType*
Typestring
Required
contentType*
Typestring
Required

Responses​

Retrieve content items

application/vnd.api+json
JSON
{
"data": {
"type": "content",
"id": "string",
"attributes": {
"urn": "string",
"title": "string",
"body": "string",
"metadata": null,
"owner_type": "string",
"owner_id": "string",
"base_content_id": "string",
"created_at": "string",
"updated_at": "string"
},
"links": {
"self": "string"
}
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Create Content​

POST
/api/content/{horoscopeType}/{contentType}

Create a new content item for a specific horoscope and content type.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

horoscopeType*
Typestring
Required
contentType*
Typestring
Required

Responses​

Create content item

application/vnd.api+json
JSON
{
"data": {
"type": "content",
"id": "string",
"attributes": {
"urn": "string",
"title": "string",
"body": "string",
"metadata": null,
"owner_type": "string",
"owner_id": "string",
"base_content_id": "string",
"created_at": "string",
"updated_at": "string"
},
"links": {
"self": "string"
}
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Get Content​

GET
/api/content/{horoscopeType}/{contentType}/{id}

Retrieve a single content item by its ID.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required
horoscopeType*
Typestring
Required
contentType*
Typestring
Required

Responses​

Retrieve one content item

application/vnd.api+json
JSON
{
"data": {
"type": "content",
"id": "string",
"attributes": {
"urn": "string",
"title": "string",
"body": "string",
"metadata": null,
"owner_type": "string",
"owner_id": "string",
"base_content_id": "string",
"created_at": "string",
"updated_at": "string"
},
"links": {
"self": "string"
}
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Delete Content​

DELETE
/api/content/{horoscopeType}/{contentType}/{id}

Delete a content item by horoscope type, content type, and ID.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required
horoscopeType*
Typestring
Required
contentType*
Typestring
Required

Responses​

Delete one content item

Playground​

Authorization
Variables
Key
Value

Samples​

Natal Chart​

POST
/api/calc/natal

Calculate a natal (birth) chart with planetary positions, house cusps, and aspects.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"dateTime": "string",
"location": {
"longitude": 0,
"latitude": 0,
"timezone": "string"
},
"houseSystem": "placidus",
"language": "en",
"includeText": false,
"includeReadableEntities": false,
"points": [
"string"
],
"orbs": {
"additionalProperties": 0
}
}

Responses​

Calculate natal chart

application/vnd.api+json
JSON
{
"data": {
"dateTime": "string",
"aspects": [
{
"pointA": "string",
"pointB": "string",
"aspect": "string",
"angle": 0,
"orb": 0,
"applying": true,
"text": "string"
}
],
"points": {
"additionalProperties": {
}
},
"houses": {
"cusps": [
0
],
"ascmc": [
0
]
},
"chart": {
"url": "string"
}
}
}

Playground​

Authorization
Body

Samples​

Synastry Chart​

POST
/api/calc/synastry

Calculate synastry aspects between two birth charts for relationship analysis.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"dateTime1": "string",
"location1": {
"longitude": 0,
"latitude": 0,
"timezone": "string"
},
"dateTime2": "string",
"location2": {
"longitude": 0,
"latitude": 0,
"timezone": "string"
},
"houseSystem": "placidus",
"language": "en",
"includeText": false,
"includeReadableEntities": false,
"points": [
"string"
],
"orbs": {
"additionalProperties": 0
}
}

Responses​

Calculate synastry chart

application/vnd.api+json
JSON
{
"data": {
"aspects1to2": [
{
"pointA": "string",
"pointB": "string",
"aspect": "string",
"angle": 0,
"orb": 0,
"applying": true,
"text": "string"
}
],
"aspects2to1": [
{
"pointA": "string",
"pointB": "string",
"aspect": "string",
"angle": 0,
"orb": 0,
"applying": true,
"text": "string"
}
],
"charts": {
"additionalProperties": {
}
}
}
}

Playground​

Authorization
Body

Samples​

Composite Chart​

POST
/api/calc/composite

Calculate a composite chart by combining midpoints of two birth charts.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"dateTime1": "string",
"location1": {
"longitude": 0,
"latitude": 0,
"timezone": "string"
},
"dateTime2": "string",
"location2": {
"longitude": 0,
"latitude": 0,
"timezone": "string"
},
"houseSystem": "placidus",
"language": "en",
"includeText": false,
"includeReadableEntities": false,
"points": [
"string"
],
"orbs": {
"additionalProperties": 0
}
}

Responses​

Calculate composite chart

application/vnd.api+json
JSON
{
"data": {
"points": {
"additionalProperties": {
}
},
"aspects": [
{
"pointA": "string",
"pointB": "string",
"aspect": "string",
"angle": 0,
"orb": 0,
"applying": true,
"text": "string"
}
],
"charts": {
"additionalProperties": {
}
}
}
}

Playground​

Authorization
Body

Samples​

Transit Chart​

POST
/api/calc/transit

Calculate planetary transits over a natal chart for a specified time period.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"birthDate": "string",
"birthLocation": {
"longitude": 0,
"latitude": 0,
"timezone": "string"
},
"transitDateStart": "string",
"transitDateEnd": "string",
"transitLocation": {
"longitude": 0,
"latitude": 0,
"timezone": "string"
},
"houseSystem": "placidus",
"language": "en",
"includeText": false,
"includeReadableEntities": false,
"points": [
"string"
],
"orbs": {
"additionalProperties": 0
}
}

Responses​

Calculate transits chart

application/vnd.api+json
JSON
{
"data": {
"crossings": {
"additionalProperties": [
]
},
"aspects": [
]
}
}

Playground​

Authorization
Body

Samples​

Compatibility Analysis​

POST
/api/calc/compatibility

Calculate sun sign compatibility between two people with interpretation text.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"dateTime1": "string",
"location1": {
"longitude": 0,
"latitude": 0,
"timezone": "string"
},
"dateTime2": "string",
"location2": {
"longitude": 0,
"latitude": 0,
"timezone": "string"
},
"language": "en",
"includeText": false,
"includeReadableEntities": false
}

Responses​

Calculate compatibility between two birth charts

application/vnd.api+json
JSON
{
"data": {
"sign1": "string",
"sign2": "string",
"scoreBasedOnElement": 0,
"scoreBasedOnSunAspect": 0,
"text": "string"
}
}

Playground​

Authorization
Body

Samples​

Solar Return​

POST
/api/calc/solar-return

Calculate the solar return chart for a specific year (birthday chart).

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"birthDateTime": "string",
"birthLocation": {
"longitude": 0,
"latitude": 0,
"timezone": "string"
},
"returnYear": 0,
"houseSystem": "placidus",
"language": "en",
"includeText": false,
"includeReadableEntities": false,
"points": [
"string"
],
"orbs": {
"additionalProperties": 0
}
}

Responses​

Calculate solar return chart

application/vnd.api+json
JSON
{
"data": {
"returnYear": 0,
"returnDate": "string",
"aspects": [
{
"pointA": "string",
"pointB": "string",
"aspect": "string",
"angle": 0,
"orb": 0,
"applying": true,
"text": "string"
}
],
"points": {
"additionalProperties": {
}
},
"houses": {
"cusps": [
0
],
"ascmc": [
0
]
},
"charts": {
"additionalProperties": {
}
}
}
}

Playground​

Authorization
Body

Samples​

Lunar Return​

POST
/api/calc/lunar-return

Calculate the lunar return chart when the Moon returns to its natal position.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"birthDateTime": "string",
"birthLocation": {
"longitude": 0,
"latitude": 0,
"timezone": "string"
},
"returnDate": "string",
"houseSystem": "placidus",
"language": "en",
"includeText": false,
"includeReadableEntities": false,
"points": [
"string"
],
"orbs": {
"additionalProperties": 0
}
}

Responses​

Calculate lunar return chart

application/vnd.api+json
JSON
{
"data": {
"returnDate": "string",
"aspects": [
{
"pointA": "string",
"pointB": "string",
"aspect": "string",
"angle": 0,
"orb": 0,
"applying": true,
"text": "string"
}
],
"points": {
"additionalProperties": {
}
},
"houses": {
"cusps": [
0
],
"ascmc": [
0
]
},
"charts": {
"additionalProperties": {
}
}
}
}

Playground​

Authorization
Body

Samples​

Secondary Progressions​

POST
/api/calc/progressions

Calculate secondary progressions chart using the day-for-a-year method. Returns progressed planet positions and aspects to both progressed and natal planets.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"birthDateTime": "string",
"birthLocation": {
"longitude": 0,
"latitude": 0,
"timezone": "string"
},
"targetDate": "string",
"houseSystem": "placidus",
"language": "en",
"includeText": false,
"includeReadableEntities": false,
"points": [
"string"
],
"orbs": {
"additionalProperties": 0
}
}

Responses​

Calculate secondary progressions chart

application/vnd.api+json
JSON
{
"data": {
"progressedDate": "string",
"natalDate": "string",
"targetDate": "string",
"aspects": [
{
"pointA": "string",
"pointB": "string",
"aspect": "string",
"angle": 0,
"orb": 0,
"applying": true,
"text": "string"
}
],
"aspectsToNatal": [
{
"pointA": "string",
"pointB": "string",
"aspect": "string",
"angle": 0,
"orb": 0,
"applying": true,
"text": "string"
}
],
"points": {
"additionalProperties": {
}
},
"natalPoints": {
"additionalProperties": {
}
},
"houses": {
"cusps": [
0
],
"ascmc": [
0
]
},
"charts": {
"additionalProperties": {
}
}
}
}

Playground​

Authorization
Body

Samples​

Moon & Sun Info​

POST
/api/calc/moon-sun

Get Moon and Sun information for a specific place and time. Includes moon phase, illumination, distance, and sun rise/set/twilight times.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"dateTime": "string",
"location": {
"longitude": 0,
"latitude": 0,
"timezone": "string"
}
}

Responses​

Moon and Sun information

application/vnd.api+json
JSON
{
"data": {
"moon": {
"phaseName": "string",
"phase": 0,
"illumination": 0,
"age": 0,
"distance": 0,
"diameterDegrees": 0,
"rise": "string",
"set": "string"
},
"sun": {
"rise": "string",
"set": "string",
"transit": "string",
"distance": 0,
"diameterDegrees": 0,
"twilight": {
"civil": {
"begin": "string",
"end": "string"
},
"nautical": {
"begin": "string",
"end": "string"
},
"astronomical": {
"begin": "string",
"end": "string"
}
}
}
}
}

Playground​

Authorization
Body

Samples​

Moon Calendar Day​

POST
/api/calc/moon-calendar/day

Get detailed moon calendar information for a single day, including void of course periods, moon phase, sign transits, and upcoming aspects.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"dateTime": "string",
"location": {
"longitude": 0,
"latitude": 0,
"timezone": "string"
},
"aspects": [
]
}

Responses​

Moon calendar day information

application/vnd.api+json
JSON
{
"data": {
"date": "string",
"moon": {
"sign": "string",
"signEntry": "string",
"signExit": "string",
"phase": {
"name": "string",
"illumination": 0,
"age": 0
},
"rise": "string",
"set": "string"
},
"voidOfCourse": {
"isVoid": true,
"start": "string",
"end": "string",
"durationMinutes": 0,
"lastAspect": {
"planet": "string",
"aspect": "string",
"exactTime": "string"
},
"nextSign": "string"
},
"upcomingAspects": [
{
"planet": "string",
"aspect": "string",
"exactTime": "string",
"applying": true
}
]
}
}

Playground​

Authorization
Body

Samples​

Moon Calendar Range​

POST
/api/calc/moon-calendar/range

Get moon calendar information for a date range (max 31 days), including all void of course periods, major lunar phases, and sign transits.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"startDate": "string",
"endDate": "string",
"location": {
"longitude": 0,
"latitude": 0,
"timezone": "string"
},
"aspects": [
]
}

Responses​

Moon calendar range information

application/vnd.api+json
JSON
{
"data": {
"startDate": "string",
"endDate": "string",
"phases": [
{
"type": "string",
"date": "string",
"sign": "string"
}
],
"signTransits": [
{
"sign": "string",
"entry": "string",
"exit": "string"
}
],
"voidPeriods": [
{
"start": "string",
"end": "string",
"durationMinutes": 0,
"lastAspect": {
"planet": "string",
"aspect": "string",
"exactTime": "string"
},
"fromSign": "string",
"toSign": "string"
}
]
}
}

Playground​

Authorization
Body

Samples​

Retrograde Planets Calendar​

POST
/api/calc/retrograde

Calculate retrograde periods for planets within a date range. Returns station dates (when planets turn retrograde/direct), shadow periods, signs traversed, and duration for each retrograde period.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"startDate": "string",
"endDate": "string",
"points": [
"string"
]
}

Responses​

Retrograde calendar data

application/vnd.api+json
JSON
{
"data": {
"dateRange": {
"startDate": "string",
"endDate": "string"
},
"periodsByPoint": {
"additionalProperties": [
]
},
"periods": [
{
"point": "string",
"retrogradeStation": {
"date": "string",
"longitude": 0,
"sign": "string",
"degreesInSign": 0,
"degreesInSignDms": [
0
]
},
"directStation": {
"date": "string",
"longitude": 0,
"sign": "string",
"degreesInSign": 0,
"degreesInSignDms": [
0
]
},
"durationDays": 0,
"signsTraversed": [
"string"
],
"preRetrogradeShadow": {
"startDate": "string",
"endDate": "string",
"durationDays": 0
},
"postRetrogradeShadow": {
"startDate": "string",
"endDate": "string",
"durationDays": 0
}
}
]
}
}

Playground​

Authorization
Body

Samples​

Chinese Zodiac Sign​

POST
/api/calc/chinese-horoscope

Calculate the Chinese zodiac sign and element based on birth year.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"birthDate": "string",
"language": "en",
"includeText": false,
"includeReadableEntities": false
}

Responses​

Calculate Chinese horoscope sign

application/vnd.api+json
JSON
{
"data": {
"sign": "string",
"element": "string",
"year": 0,
"text": "string"
}
}

Playground​

Authorization
Body

Samples​

Chinese Zodiac Forecast​

POST
/api/calc/chinese-forecast

Get Chinese zodiac forecast for a specific year with category breakdowns.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"birthDate": "string",
"forecastYear": 0,
"language": "en",
"includeText": false,
"includeReadableEntities": false
}

Responses​

Calculate Chinese horoscope forecast

application/vnd.api+json
JSON
{
"data": {
"sign": "string",
"year": 0,
"text": "string",
"categories": {
"additionalProperties": "string"
}
}
}

Playground​

Authorization
Body

Samples​

Render Chart (SVG)​

GET
/api/chart/image.svg

Render an astrological chart as SVG image.

Required parameters:

  • width, height: Chart dimensions
  • dateTime: Natal date/time (YYYY-MM-DDTHH:mm)
  • location.longitude, location.latitude, location.timezone: Natal location

Optional transit parameters (for bi-wheel chart):

  • transit.dateTime: Transit date/time (YYYY-MM-DDTHH:mm)
  • transit.timezone: Transit timezone
  • transit.longitude, transit.latitude: Transit location (defaults to natal location)

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Chart rendered successfully

image/svg+xml
JSON
[
]

Playground​

Authorization

Samples​

Render Chart (PNG)​

GET
/api/chart/image.png

Render an astrological chart as PNG image. Requires query parameters: width, height, dateTime, location.longitude, location.latitude, location.timezone

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Chart rendered successfully

image/png
JSON
[
]

Playground​

Authorization

Samples​

Render Composite Chart (SVG)​

GET
/api/chart/composite.svg

Render a composite chart (midpoints of two natal charts) as SVG image.

Required parameters:

  • width, height: Chart dimensions
  • person1.dateTime: Person 1 date/time (YYYY-MM-DDTHH:mm)
  • person1.timezone: Person 1 timezone
  • person1.longitude, person1.latitude: Person 1 location
  • person2.dateTime: Person 2 date/time (YYYY-MM-DDTHH:mm)
  • person2.timezone: Person 2 timezone
  • person2.longitude, person2.latitude: Person 2 location

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Composite chart rendered successfully

image/svg+xml
JSON
[
]

Playground​

Authorization

Samples​

Render Composite Chart (PNG)​

GET
/api/chart/composite.png

Render a composite chart (midpoints of two natal charts) as PNG image.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Composite chart rendered successfully

image/png
JSON
[
]

Playground​

Authorization

Samples​

Render Natal Chart (SVG) - v2​

GET
/api/chart2/natal.svg

Render a natal chart using the new Chart2 engine as SVG.

Required parameters:

  • width, height: Chart dimensions
  • dateTime: Birth date/time (YYYY-MM-DDTHH:mm)
  • location.longitude, location.latitude, location.timezone: Birth location

Theme presets:
Use ?theme=<preset> to select a theme:

  • default: Classic white background with colored elements
  • classic: Traditional astrology chart look
  • dark: Modern dark theme with vibrant colors
  • minimal: Clean, less visual noise
  • colorful: Vibrant planet colors
  • nextgen: Modern design with curved aspect lines, glow effects, and gradients
  • vintage: Old parchment/manuscript style with sepia tones
  • neon: Cyberpunk style with bright neon colors on black
  • pastel: Soft, calming pastel colors
  • print: High contrast black/white optimized for printing

Optional theme overrides:

  • theme.background: Background color
  • theme.foreground: Text color
  • theme.strokeOnly: Render stroke only (true/false)
  • theme.symbolScale: Symbol scale factor
  • theme.showDegrees: Show degree labels (true/false)
  • theme.showHouseNumbers: Show house numbers (true/false)

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Chart rendered successfully

image/svg+xml
JSON
[
]

Playground​

Authorization

Samples​

Render Natal Chart (PNG) - v2​

GET
/api/chart2/natal.png

Render a natal chart using the new Chart2 engine as PNG.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Chart rendered successfully

image/png
JSON
[
]

Playground​

Authorization

Samples​

Render Transit Chart (SVG) - v2​

GET
/api/chart2/transit.svg

Render a transit bi-wheel chart using the new Chart2 engine as SVG.

Required parameters:

  • width, height: Chart dimensions
  • dateTime: Natal date/time (YYYY-MM-DDTHH:mm)
  • location.longitude, location.latitude, location.timezone: Natal location
  • transit.dateTime: Transit date/time (YYYY-MM-DDTHH:mm)

Optional parameters:

  • transit.timezone: Transit timezone (defaults to natal timezone)
  • transit.longitude, transit.latitude: Transit location (defaults to natal location)

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Chart rendered successfully

image/svg+xml
JSON
[
]

Playground​

Authorization

Samples​

Render Transit Chart (PNG) - v2​

GET
/api/chart2/transit.png

Render a transit bi-wheel chart using the new Chart2 engine as PNG.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Chart rendered successfully

image/png
JSON
[
]

Playground​

Authorization

Samples​

Render Synastry Chart (SVG) - v2​

GET
/api/chart2/synastry.svg

Render a synastry comparison chart using the new Chart2 engine as SVG.

Required parameters:

  • width, height: Chart dimensions
  • person1.dateTime, person1.timezone: Person 1 birth date/time
  • person1.longitude, person1.latitude: Person 1 birth location
  • person2.dateTime, person2.timezone: Person 2 birth date/time
  • person2.longitude, person2.latitude: Person 2 birth location

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Chart rendered successfully

image/svg+xml
JSON
[
]

Playground​

Authorization

Samples​

Render Synastry Chart (PNG) - v2​

GET
/api/chart2/synastry.png

Render a synastry comparison chart using the new Chart2 engine as PNG.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Chart rendered successfully

image/png
JSON
[
]

Playground​

Authorization

Samples​

Render Composite Chart (SVG) - v2​

GET
/api/chart2/composite.svg

Render a composite midpoint chart using the new Chart2 engine as SVG.

Required parameters:

  • width, height: Chart dimensions
  • person1.dateTime, person1.timezone: Person 1 birth date/time
  • person1.longitude, person1.latitude: Person 1 birth location
  • person2.dateTime, person2.timezone: Person 2 birth date/time
  • person2.longitude, person2.latitude: Person 2 birth location

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Chart rendered successfully

image/svg+xml
JSON
[
]

Playground​

Authorization

Samples​

Render Composite Chart (PNG) - v2​

GET
/api/chart2/composite.png

Render a composite midpoint chart using the new Chart2 engine as PNG.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Chart rendered successfully

image/png
JSON
[
]

Playground​

Authorization

Samples​

Render Animated Transit Chart (SVG) - v2​

GET
/api/chart2/animated-transit.svg

Render an animated transit chart with CSS keyframe animations.

Required parameters:

  • width, height: Chart dimensions
  • dateTime: Natal date/time (YYYY-MM-DDTHH:mm)
  • location.longitude, location.latitude, location.timezone: Natal location
  • transit.dateTime: Start transit date/time
  • target.dateTime: End transit date/time (animation target)
  • animation.duration: Animation duration in milliseconds

Optional parameters:

  • animation.easing: Easing function (linear, easeIn, easeOut, easeInOut, bounce)
  • animation.loop: Loop animation (true/false)

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Animated chart rendered successfully

image/svg+xml
JSON
[
]

Playground​

Authorization

Samples​

Create Organization​

POST
/api/org

Create a new organization with Stripe billing setup.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"data": {
"type": "organizations",
"attributes": {
"name": "string",
"billingName": "string",
"billingEmail": "string",
"billingCountry": "string",
"billingCity": "string",
"billingLine1": "string",
"billingLine2": "string",
"billingPostalCode": "string",
"billingState": "string",
"vatNumber": "string"
}
}
}

Responses​

Create organization

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Body

Samples​

List Members​

GET
/api/org/users

Get a paginated list of organization members.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

List organization users

application/vnd.api+json
JSON
{
"links": {
"self": "string",
"next": "string"
},
"data": [
{
"id": "string",
"type": "user",
"attributes": {
"email": "string",
"name": "string",
"role": "string"
}
}
],
"meta": {
"count": 0
}
}

Playground​

Authorization

Samples​

Add Member​

POST
/api/org/users

Add or invite a new member to the organization.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"data": {
"type": "members",
"attributes": {
"email": "string",
"name": "string",
"role": "string"
}
}
}

Responses​

Member toegevoegd/uitgenodigd

application/vnd.api+json
JSON
{
"data": {
"memberId": "string",
"userId": "string",
"role": "string"
}
}

Playground​

Authorization
Body

Samples​

Remove Member​

DELETE
/api/org/users/{memberId}

Remove a member from the organization.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

memberId*
Typestring
Required
Min Length1

Responses​

Member verwijderd

Playground​

Authorization
Variables
Key
Value

Samples​

Update Member​

PATCH
/api/org/users/{memberId}

Update an organization member's role.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

memberId*
Typestring
Required
Min Length1

Request Body​

application/json
JSON
{
"data": {
"type": "members",
"id": "string",
"attributes": {
"role": "string"
}
}
}

Responses​

Member geüpdatet

application/vnd.api+json
JSON
{
"data": {
"memberId": "string",
"role": "string"
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Modules​

Module access and subscription management

Operations​

GET/api/modulesGET/api/modules/organizationGET/api/modules/plansGET/api/modules/check/{moduleId}

List Modules​

GET
/api/modules

Get all available modules with pricing information.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

List all available modules

application/json
JSON
{
"data": [
{
"id": "string",
"name": "string",
"description": "string",
"category": "string",
"horoscopeType": "string",
"contentType": "string",
"priceCents": 0
}
]
}

Playground​

Authorization

Samples​

Organization Modules​

GET
/api/modules/organization

Get the list of modules the current organization has access to.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

List modules for current organization

application/json
JSON
{
"data": [
"string"
]
}

Playground​

Authorization

Samples​

Subscription Plans​

GET
/api/modules/plans

Get all available subscription plans with included modules and pricing.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

List all subscription plans

application/json
JSON
{
"data": [
{
"id": "string",
"name": "string",
"description": "string",
"modules": [
"string"
],
"discountPercentage": 0,
"priceCents": 0,
"stripePriceId": "string"
}
]
}

Playground​

Authorization

Samples​

Check Module Access​

GET
/api/modules/check/{moduleId}

Check if the current organization has access to a specific module.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

moduleId*
Typestring
Required

Responses​

Check module access

application/json
JSON
{
"hasAccess": true
}

Playground​

Authorization
Variables
Key
Value

Samples​

List API Keys​

GET
/api/api-keys

Get all API keys owned by the current user.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

List of API keys

application/json
JSON
{
"data": [
{
"id": "string",
"name": "string",
"prefix": "string",
"start": "string",
"organizationId": "string",
"enabled": true,
"permissions": [
"string"
],
"modules": [
"string"
],
"allowedDomains": [
"string"
],
"expiresAt": "string",
"createdAt": "string",
"updatedAt": "string",
"rateLimitEnabled": true,
"rateLimitTimeWindow": 0,
"rateLimitMax": 0,
"requestCount": 0,
"lastRequest": "string"
}
]
}

Playground​

Authorization

Samples​

Create API Key​

POST
/api/api-keys

Create a new API key with optional permission and module restrictions.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"data": {
"type": "api-keys",
"attributes": {
"name": "string",
"organizationId": "string",
"permissions": [
"string"
],
"modules": [
"string"
],
"allowedDomains": [
"string"
],
"expiresIn": 0
}
}
}

Responses​

API key created

application/json
JSON
{
"data": {
"id": "string",
"key": "string",
"name": "string",
"prefix": "string",
"organizationId": "string",
"permissions": [
"string"
],
"modules": [
"string"
],
"expiresAt": "string"
}
}

Playground​

Authorization
Body

Samples​

Available Options​

GET
/api/api-keys/available-options

Get available permissions and modules for configuring API keys.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Available options

application/json
JSON
{
"permissions": [
{
"id": "string",
"description": "string"
}
],
"modules": [
{
"id": "string",
"name": "string"
}
],
"userRole": "string",
"rolePermissions": [
"string"
]
}

Playground​

Authorization

Samples​

API Key Usage Statistics​

GET
/api/api-keys/usage

Get aggregate usage statistics across all API keys for the current user.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Usage statistics

application/json
JSON
{
"data": {
"type": "api-key-usage",
"id": "aggregate",
"attributes": {
"period": "string",
"startDate": "string",
"endDate": "string",
"summary": {
"totalRequests": 0,
"avgLatencyMs": 0,
"errorRate": 0,
"uniqueEndpoints": 0
},
"timeSeries": {
"labels": [
"string"
],
"requests": [
0
],
"avgLatency": [
0
]
},
"byEndpoint": [
{
"endpoint": "string",
"requests": 0,
"avgLatencyMs": 0
}
],
"byApiKey": [
{
"apiKeyId": "string",
"apiKeyName": "string",
"requests": 0,
"avgLatencyMs": 0,
"lastRequest": "string"
}
]
}
}
}

Playground​

Authorization

Samples​

Get API Key​

GET
/api/api-keys/{id}

Get details of a specific API key.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Responses​

API key details

application/json
JSON
{
"data": {
"id": "string",
"name": "string",
"prefix": "string",
"start": "string",
"organizationId": "string",
"enabled": true,
"permissions": [
"string"
],
"modules": [
"string"
],
"allowedDomains": [
"string"
],
"expiresAt": "string",
"createdAt": "string",
"updatedAt": "string",
"rateLimitEnabled": true,
"rateLimitTimeWindow": 0,
"rateLimitMax": 0,
"requestCount": 0,
"lastRequest": "string"
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Delete API Key​

DELETE
/api/api-keys/{id}

Permanently delete an API key.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Responses​

API key deleted

Playground​

Authorization
Variables
Key
Value

Samples​

Update API Key​

PATCH
/api/api-keys/{id}

Update an API key's name, status, permissions, or modules.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Request Body​

application/json
JSON
{
"data": {
"type": "api-keys",
"attributes": {
"name": "string",
"enabled": true,
"permissions": [
"string"
],
"modules": [
"string"
],
"allowedDomains": [
"string"
]
}
}
}

Responses​

API key updated

application/json
JSON
{
"data": {
"id": "string",
"name": "string",
"prefix": "string",
"start": "string",
"organizationId": "string",
"enabled": true,
"permissions": [
"string"
],
"modules": [
"string"
],
"allowedDomains": [
"string"
],
"expiresAt": "string",
"createdAt": "string",
"updatedAt": "string",
"rateLimitEnabled": true,
"rateLimitTimeWindow": 0,
"rateLimitMax": 0,
"requestCount": 0,
"lastRequest": "string"
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Get Daily Horoscopes​

GET
/api/horoscope/daily/{date}

Retrieve daily horoscopes for all zodiac signs for a specific date.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

date*
Typestring
Required
Pattern"^\\d{4}-\\d{2}-\\d{2}$"

Responses​

Daily horoscopes for all zodiac signs

application/vnd.api+json
JSON
{
"data": {
"type": "daily-horoscope",
"attributes": {
"date": "string",
"language": "string",
"horoscopes": {
"additionalProperties": {
}
}
}
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Get Weekly Horoscope Report​

GET
/api/horoscope/weekly/{year}/{week}/{zodiacSign}

Retrieve weekly horoscope report for a specific zodiac sign and week.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

year*
Typestring
Required
Pattern"^\\d{4}$"
week*
Typestring
Required
Pattern"^(0[1-9]|[1-4]\\d|5[0-3])$"
zodiacSign*
Typestring
Required

Responses​

Weekly horoscope report

application/vnd.api+json
JSON
{
"data": {
"type": "string",
"attributes": {
"reportType": "string",
"zodiacSign": "string",
"period": {
"year": "string",
"week": "string"
},
"language": "string",
"title": "string",
"body": "string",
"metadata": null
}
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Get Yearly Horoscope Report​

GET
/api/horoscope/yearly/{year}/{zodiacSign}

Retrieve yearly horoscope report for a specific zodiac sign and year.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

year*
Typestring
Required
Pattern"^\\d{4}$"
zodiacSign*
Typestring
Required

Responses​

Yearly horoscope report

application/vnd.api+json
JSON
{
"data": {
"type": "string",
"attributes": {
"reportType": "string",
"zodiacSign": "string",
"period": {
"year": "string",
"week": "string"
},
"language": "string",
"title": "string",
"body": "string",
"metadata": null
}
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Get Yearly Ascendant Horoscope Report​

GET
/api/horoscope/yearly-ascendant/{year}/{zodiacSign}

Retrieve yearly horoscope report for a specific ascendant sign and year.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

year*
Typestring
Required
Pattern"^\\d{4}$"
zodiacSign*
Typestring
Required

Responses​

Yearly ascendant horoscope report

application/vnd.api+json
JSON
{
"data": {
"type": "string",
"attributes": {
"reportType": "string",
"zodiacSign": "string",
"period": {
"year": "string",
"week": "string"
},
"language": "string",
"title": "string",
"body": "string",
"metadata": null
}
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Full Numerology Profile​

POST
/api/numerology/profile

Calculate a complete numerology profile including Life Path, Expression, Soul Urge, Personality, Birthday numbers, Personal Cycles, and identify Master/Karmic numbers.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"dateTime": "string",
"fullName": "string"
}

Responses​

Complete numerology profile

application/vnd.api+json
JSON
{
"data": {
"lifePathNumber": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
},
"expressionNumber": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
},
"soulUrgeNumber": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
},
"personalityNumber": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
},
"birthdayNumber": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
},
"personalYear": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
},
"personalMonth": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
},
"personalDay": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
},
"karmicDebtNumbers": [
0
],
"masterNumbers": [
0
]
}
}

Playground​

Authorization
Body

Samples​

Life Path Number​

POST
/api/numerology/life-path

Calculate the Life Path Number from birth date. This is the most important number in numerology, representing your life's purpose.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"dateTime": "string"
}

Responses​

Life Path number calculation

application/vnd.api+json
JSON
{
"data": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
}
}

Playground​

Authorization
Body

Samples​

Expression Number​

POST
/api/numerology/expression

Calculate the Expression (Destiny) Number from full name. This number reveals your natural talents and abilities.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"fullName": "string"
}

Responses​

Expression number calculation

application/vnd.api+json
JSON
{
"data": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
}
}

Playground​

Authorization
Body

Samples​

Soul Urge Number​

POST
/api/numerology/soul-urge

Calculate the Soul Urge (Heart's Desire) Number from vowels in the name. This number reveals your inner motivations.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"fullName": "string"
}

Responses​

Soul Urge number calculation

application/vnd.api+json
JSON
{
"data": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
}
}

Playground​

Authorization
Body

Samples​

Personality Number​

POST
/api/numerology/personality

Calculate the Personality Number from consonants in the name. This number reveals how others perceive you.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"fullName": "string"
}

Responses​

Personality number calculation

application/vnd.api+json
JSON
{
"data": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
}
}

Playground​

Authorization
Body

Samples​

Birthday Number​

POST
/api/numerology/birthday

Calculate the Birthday Number from the day of birth. This number represents a special talent you possess.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"dateTime": "string"
}

Responses​

Birthday number calculation

application/vnd.api+json
JSON
{
"data": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
}
}

Playground​

Authorization
Body

Samples​

Personal Cycles​

POST
/api/numerology/personal-cycles

Calculate Personal Year, Month, and Day numbers. These reveal the current energetic influences in your life.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"dateTime": "string",
"currentDate": "string"
}

Responses​

Personal cycles calculation

application/vnd.api+json
JSON
{
"data": {
"personalYear": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
},
"personalMonth": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
},
"personalDay": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
}
}
}

Playground​

Authorization
Body

Samples​

Numerology Compatibility​

POST
/api/numerology/compatibility

Calculate compatibility between two people based on their Life Path numbers.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"dateTime1": "string",
"dateTime2": "string"
}

Responses​

Compatibility calculation

application/vnd.api+json
JSON
{
"data": {
"person1LifePath": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
},
"person2LifePath": {
"value": 0,
"isMasterNumber": true,
"isKarmicDebt": true,
"reducedFrom": 0,
"calculation": "string"
},
"compatibilityScore": 0,
"relationship": "string",
"description": "string"
}
}

Playground​

Authorization
Body

Samples​

List Chatbots​

GET
/api/chatbots

List all chatbots for the current organization

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

List of chatbots

application/vnd.api+json
JSON
[
]

Playground​

Authorization

Samples​

Create Chatbot​

POST
/api/chatbots

Create a new chatbot for the organization

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"data": {
"type": "chatbots",
"attributes": {
"name": "string",
"description": "string",
"enabledPlugins": [
"string"
],
"settings": {
"additionalProperties": "string"
},
"widgetConfig": {
"additionalProperties": "string"
},
"allowedDomains": [
"string"
]
}
}
}

Responses​

Created chatbot

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Body

Samples​

Get Chatbot​

GET
/api/chatbots/{id}

Get a specific chatbot by ID

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Responses​

Chatbot details

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Variables
Key
Value

Samples​

Delete Chatbot​

DELETE
/api/chatbots/{id}

Delete a chatbot

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Responses​

Chatbot deleted

Playground​

Authorization
Variables
Key
Value

Samples​

Update Chatbot​

PATCH
/api/chatbots/{id}

Update an existing chatbot

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Request Body​

application/json
JSON
{
"data": {
"type": "chatbots",
"id": "string",
"attributes": {
"name": "string",
"description": "string",
"enabledPlugins": [
"string"
],
"settings": {
"additionalProperties": "string"
},
"widgetConfig": {
"additionalProperties": "string"
},
"allowedDomains": [
"string"
]
}
}
}

Responses​

Updated chatbot

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Variables
Key
Value
Body

Samples​

List Chat Profiles​

GET
/api/chatbots/{id}/profiles

List all chat profiles for a chatbot

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Responses​

List of profiles

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Variables
Key
Value

Samples​

Create Chat Profile​

POST
/api/chatbots/{id}/profiles

Create a pre-configured chat profile with birth data

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Request Body​

application/json
JSON
{
"data": {
"type": "chat-profile",
"attributes": {
"externalUserId": "string",
"birthDate": "string",
"birthTime": "string",
"birthPlaceLat": 0,
"birthPlaceLng": 0,
"birthPlaceName": "string",
"timezone": "string",
"metadata": {
"additionalProperties": "string"
}
}
}
}

Responses​

Created profile

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Delete Chat Profile​

DELETE
/api/chatbots/{id}/profiles/{profileId}

Delete a chat profile

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required
profileId*
Typestring
Required

Responses​

Profile deleted

Playground​

Authorization
Variables
Key
Value

Samples​

List Available Plugins​

GET
/api/chatbots/plugins

List all available chatbot plugins

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

List of plugins

application/vnd.api+json
JSON
[
]

Playground​

Authorization

Samples​

Get Chatbot Usage​

GET
/api/chatbots/usage

Get chatbot usage statistics for the current organization

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Usage statistics

application/vnd.api+json
JSON
[
]

Playground​

Authorization

Samples​

Chat with Chatbot​

POST
/api/chat/{chatbotId}

Send a message to a chatbot and receive a streaming response via SSE

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

chatbotId*
Typestring
Required

Request Body​

application/json
JSON
{
"message": "string",
"conversationId": "string"
}

Responses​

SSE stream with chat response

text/event-stream
JSON
[
]

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Chat with Profile​

POST
/api/chat/{chatbotId}/profile/{profileId}

Send a message using a pre-configured user profile

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

chatbotId*
Typestring
Required
profileId*
Typestring
Required

Request Body​

application/json
JSON
{
"message": "string",
"conversationId": "string"
}

Responses​

SSE stream with chat response

text/event-stream
JSON
[
]

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Chat with Birth Data​

POST
/api/chat/{chatbotId}/direct

Send a message with inline birth data (no profile needed)

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

chatbotId*
Typestring
Required

Request Body​

application/json
JSON
{
"message": "string",
"conversationId": "string",
"birthData": {
"date": "string",
"time": "string",
"latitude": 0,
"longitude": 0,
"placeName": "string",
"timezone": "string"
}
}

Responses​

SSE stream with chat response

text/event-stream
JSON
[
]

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Get Conversation​

GET
/api/chat/{chatbotId}/conversation/{conversationId}

Retrieve conversation history

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

chatbotId*
Typestring
Required
conversationId*
Typestring
Required

Responses​

Conversation data

Playground​

Authorization
Variables
Key
Value

Samples​

Delete Conversation​

DELETE
/api/chat/{chatbotId}/conversation/{conversationId}

Delete a conversation and its history

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

chatbotId*
Typestring
Required
conversationId*
Typestring
Required

Responses​

Conversation deleted

Playground​

Authorization
Variables
Key
Value

Samples​

List PDF Templates​

GET
/api/pdf-reports/templates

List all PDF templates available to the current organization (org-specific + global)

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

List of PDF templates

application/vnd.api+json
JSON
[
]

Playground​

Authorization

Samples​

Create PDF Template​

POST
/api/pdf-reports/templates

Create a new PDF template for the organization

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"data": {
"type": "templates",
"attributes": {
"name": "string",
"description": "string",
"reportType": "string",
"editorConfig": "string",
"pageSettings": "string",
"customCss": "string",
"isDefault": true,
"isActive": true
}
}
}

Responses​

Created PDF template

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Body

Samples​

List Global PDF Templates​

GET
/api/pdf-reports/templates/global

List all global (shared) PDF templates

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

List of global PDF templates

application/vnd.api+json
JSON
[
]

Playground​

Authorization

Samples​

Get PDF Template​

GET
/api/pdf-reports/templates/{id}

Get a specific PDF template by ID

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Responses​

PDF template details

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Variables
Key
Value

Samples​

Delete PDF Template​

DELETE
/api/pdf-reports/templates/{id}

Delete a PDF template

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Responses​

Template deleted

Playground​

Authorization
Variables
Key
Value

Samples​

Update PDF Template​

PATCH
/api/pdf-reports/templates/{id}

Update an existing PDF template

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Request Body​

application/json
JSON
{
"data": {
"type": "templates",
"id": "string",
"attributes": {
"name": "string",
"description": "string",
"editorConfig": "string",
"pageSettings": "string",
"customCss": "string",
"isDefault": true,
"isActive": true
}
}
}

Responses​

Updated PDF template

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Duplicate PDF Template​

POST
/api/pdf-reports/templates/{id}/duplicate

Duplicate a template (global or own) to the organization

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Responses​

Duplicated PDF template

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Variables
Key
Value

Samples​

Set Default PDF Template​

POST
/api/pdf-reports/templates/{id}/set-default

Set a template as the default for its report type within the organization

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Responses​

Template set as default

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Variables
Key
Value

Samples​

Generate PDF Report​

POST
/api/pdf-reports/generate

Generate a PDF report based on astrology calculations

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"reportType": "string",
"templateId": "string",
"subject": {
"name": "string",
"birthDate": {
"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0
},
"birthPlace": {
"name": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string"
}
},
"partner": {
"name": "string",
"birthDate": {
"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0
},
"birthPlace": {
"name": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string"
}
},
"transitDate": {
"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0
}
}

Responses​

Generated PDF file

application/pdf

Playground​

Authorization
Body

Samples​

Preview PDF Template​

POST
/api/pdf-reports/preview

Preview a PDF template as HTML with sample data

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"templateId": "string",
"sampleData": null
}

Responses​

HTML preview

text/html
JSON
"string"

Playground​

Authorization
Body

Samples​

List Widgets​

GET
/api/widgets

List all embeddable widgets for the current organization

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

List of widgets

application/vnd.api+json
JSON
[
]

Playground​

Authorization

Samples​

Create Widget​

POST
/api/widgets

Create a new embeddable widget with auto-generated API key

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"data": {
"type": "widgets",
"attributes": {
"name": "string",
"widgetType": "string",
"mode": "string",
"staticConfig": {
"dateTime": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string",
"placeName": "string",
"person2": {
"dateTime": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string",
"placeName": "string"
},
"transitDateTime": "string"
},
"customization": {
"colors": {
"primary": "string",
"secondary": "string",
"background": "string",
"surface": "string",
"text": "string",
"textSecondary": "string",
"border": "string",
"error": "string",
"success": "string"
},
"fonts": {
"family": "string",
"sizeBase": 0,
"sizeScale": 0
},
"chartSettings": {
"additionalProperties": "string"
},
"labels": {
"additionalProperties": "string"
},
"language": "string",
"branding": {
"showPoweredBy": true,
"logoUrl": "string",
"companyName": "string"
},
"customCss": "string",
"widgetOptions": {
"showAspects": true,
"showPoints": true,
"showHouses": true,
"chartSize": 0,
"theme": "string"
}
},
"allowedDomains": [
"string"
],
"enabled": true
}
}
}

Responses​

Created widget with API key

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Body

Samples​

Get Widget Options​

GET
/api/widgets/options

Get available widget types and features based on organization modules

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

Widget options

Playground​

Authorization

Samples​

Get Widget​

GET
/api/widgets/{id}

Get a specific widget by ID

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Responses​

Widget details

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Variables
Key
Value

Samples​

Delete Widget​

DELETE
/api/widgets/{id}

Delete a widget and its associated API key

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Responses​

Widget deleted

Playground​

Authorization
Variables
Key
Value

Samples​

Update Widget​

PATCH
/api/widgets/{id}

Update an existing widget configuration

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Request Body​

application/json
JSON
{
"data": {
"type": "widgets",
"id": "string",
"attributes": {
"name": "string",
"staticConfig": {
"dateTime": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string",
"placeName": "string",
"person2": {
"dateTime": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string",
"placeName": "string"
},
"transitDateTime": "string"
},
"customization": {
"colors": {
"primary": "string",
"secondary": "string",
"background": "string",
"surface": "string",
"text": "string",
"textSecondary": "string",
"border": "string",
"error": "string",
"success": "string"
},
"fonts": {
"family": "string",
"sizeBase": 0,
"sizeScale": 0
},
"chartSettings": {
"additionalProperties": "string"
},
"labels": {
"additionalProperties": "string"
},
"language": "string",
"branding": {
"showPoweredBy": true,
"logoUrl": "string",
"companyName": "string"
},
"customCss": "string",
"widgetOptions": {
"showAspects": true,
"showPoints": true,
"showHouses": true,
"chartSize": 0,
"theme": "string"
}
},
"allowedDomains": [
"string"
],
"enabled": true
}
}
}

Responses​

Updated widget

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Regenerate API Key​

POST
/api/widgets/{id}/regenerate-key

Generate a new API key for the widget (invalidates the old one)

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Typestring
Required

Responses​

New API key generated

Playground​

Authorization
Variables
Key
Value

Samples​

Get Widget Configuration​

GET
/api/widget-api/config/{widgetId}

Get widget configuration for embedding (public endpoint)

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Typestring
Required

Responses​

Widget configuration

Playground​

Authorization
Variables
Key
Value

Samples​

Calculate Natal Chart​

POST
/api/widget-api/natal/{widgetId}

Calculate natal chart via embedded widget

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Typestring
Required

Request Body​

application/json
JSON
{
"birthData": {
"dateTime": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string",
"placeName": "string"
}
}

Responses​

Natal chart data

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Calculate Synastry Chart​

POST
/api/widget-api/synastry/{widgetId}

Calculate synastry chart via embedded widget

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Typestring
Required

Request Body​

application/json
JSON
{
"person1": {
"dateTime": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string",
"placeName": "string"
},
"person2": {
"dateTime": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string",
"placeName": "string"
}
}

Responses​

Synastry chart data

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Calculate Transit Chart​

POST
/api/widget-api/transit/{widgetId}

Calculate transit chart via embedded widget

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Typestring
Required

Request Body​

application/json
JSON
{
"birthData": {
"dateTime": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string",
"placeName": "string"
},
"transitDateTime": "string",
"transitTimezone": "string"
}

Responses​

Transit chart data

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Calculate Composite Chart​

POST
/api/widget-api/composite/{widgetId}

Calculate composite chart via embedded widget

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Typestring
Required

Request Body​

application/json
JSON
{
"person1": {
"dateTime": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string",
"placeName": "string"
},
"person2": {
"dateTime": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string",
"placeName": "string"
}
}

Responses​

Composite chart data

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Get Moon Phase​

POST
/api/widget-api/moonphase/{widgetId}

Get moon phase information via embedded widget

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Typestring
Required

Request Body​

application/json
JSON
{
"date": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string"
}

Responses​

Moon phase data

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Get Static Widget Data​

GET
/api/widget-api/static/{widgetId}

Get pre-rendered data for static widgets

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Typestring
Required

Responses​

Static widget data

Playground​

Authorization
Variables
Key
Value

Samples​

Get Widget Configuration​

GET
/api/widget-api/config/{widgetId}

Get widget configuration for embedding (public endpoint)

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Typestring
Required

Responses​

Widget configuration

Playground​

Authorization
Variables
Key
Value

Samples​

Widget Chat​

POST
/widget/chat/{chatbotId}

Send a message via widget (SSE streaming response)

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

chatbotId*
Typestring
Required

Request Body​

application/json
JSON
{
"message": "string",
"conversationId": "string",
"birthData": {
"date": "string",
"time": "string",
"latitude": 0,
"longitude": 0,
"placeName": "string",
"timezone": "string"
}
}

Responses​

SSE stream with chat response

text/event-stream
JSON
[
]

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Widget Chat with User Profile​

POST
/widget/chat/{chatbotId}/user/{externalUserId}

Chat using an external user ID (creates profile on first use)

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

chatbotId*
Typestring
Required
externalUserId*
Typestring
Required

Request Body​

application/json
JSON
{
"message": "string",
"conversationId": "string",
"birthData": {
"date": "string",
"time": "string",
"latitude": 0,
"longitude": 0,
"placeName": "string",
"timezone": "string"
}
}

Responses​

SSE stream with chat response

text/event-stream
JSON
[
]

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Geocoding​

Place search and coordinate lookup

Operations​

GET/api/geocoding/search

Search Places​

GET
/api/geocoding/search

Search for cities, towns, and places by name. Returns coordinates and location details for use with calculation endpoints.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

List of matching places with coordinates

application/json
JSON
{
"data": [
{
"id": "string",
"name": "string",
"displayName": "string",
"latitude": 0,
"longitude": 0,
"country": "string",
"countryCode": "string",
"state": "string",
"city": "string"
}
]
}

Playground​

Authorization

Samples​

POST /api/legacy/natal​

POST
/api/legacy/natal

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"name": "string",
"date": "string",
"time": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string",
"lang": "en"
}

Responses​

Playground​

Authorization
Body

Samples​

POST /api/legacy/synastry​

POST
/api/legacy/synastry

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"name1": "string",
"date1": "string",
"time1": "string",
"latitude1": 0,
"longitude1": 0,
"timezone1": "string",
"name2": "string",
"date2": "string",
"time2": "string",
"latitude2": 0,
"longitude2": 0,
"timezone2": "string",
"lang": "en"
}

Responses​

Playground​

Authorization
Body

Samples​

POST /api/legacy/composite​

POST
/api/legacy/composite

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"name1": "string",
"date1": "string",
"time1": "string",
"latitude1": 0,
"longitude1": 0,
"timezone1": "string",
"name2": "string",
"date2": "string",
"time2": "string",
"latitude2": 0,
"longitude2": 0,
"timezone2": "string",
"lang": "en"
}

Responses​

Playground​

Authorization
Body

Samples​

POST /api/legacy/transits​

POST
/api/legacy/transits

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"name": "string",
"birth_date": "string",
"birth_time": "string",
"birth_latitude": 0,
"birth_longitude": 0,
"birth_timezone": "string",
"transit_start": "string",
"transit_end": "string",
"transit_latitude": 0,
"transit_longitude": 0,
"transit_timezone": "string",
"lang": "en"
}

Responses​

Playground​

Authorization
Body

Samples​

POST /api/legacy/progressions​

POST
/api/legacy/progressions

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"name": "string",
"date": "string",
"time": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string",
"add_years": 0,
"lang": "en"
}

Responses​

Playground​

Authorization
Body

Samples​

POST /api/legacy/solarreturn​

POST
/api/legacy/solarreturn

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"name": "string",
"date": "string",
"time": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string",
"year": 0,
"lang": "en"
}

Responses​

Playground​

Authorization
Body

Samples​

POST /api/legacy/lunarreturn​

POST
/api/legacy/lunarreturn

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"name": "string",
"date": "string",
"time": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string",
"return_date": "string",
"lang": "en"
}

Responses​

Playground​

Authorization
Body

Samples​

POST /api/legacy/chinese-forecasts​

POST
/api/legacy/chinese-forecasts

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"name": "string",
"date": "string",
"year": 0,
"lang": "en"
}

Responses​

Playground​

Authorization
Body

Samples​

POST /api/legacy/compatibility​

POST
/api/legacy/compatibility

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"name1": "string",
"date1": "string",
"time1": "string",
"latitude1": 0,
"longitude1": 0,
"timezone1": "string",
"name2": "string",
"date2": "string",
"time2": "string",
"latitude2": 0,
"longitude2": 0,
"timezone2": "string",
"lang": "en"
}

Responses​

Playground​

Authorization
Body

Samples​

POST /api/legacy/planetinsign​

POST
/api/legacy/planetinsign

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"planet_id": "string",
"sign_id": "string",
"lang": "en"
}

Responses​

Playground​

Authorization
Body

Samples​

POST /api/legacy/signtosign​

POST
/api/legacy/signtosign

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"sign1_id": "string",
"sign2_id": "string",
"lang": "en"
}

Responses​

Playground​

Authorization
Body

Samples​

POST /api/legacy/weekly-reports​

POST
/api/legacy/weekly-reports

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"week": 0,
"year": 0,
"sign_id": "string",
"lang": "en"
}

Responses​

Playground​

Authorization
Body

Samples​

POST /api/legacy/monthly-reports​

POST
/api/legacy/monthly-reports

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"month": 0,
"year": 0,
"sign_id": "string",
"lang": "en"
}

Responses​

Playground​

Authorization
Body

Samples​

POST /api/legacy/yearly-reports​

POST
/api/legacy/yearly-reports

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
"year": 0,
"sign_id": "string",
"lang": "en"
}

Responses​

Playground​

Authorization
Body

Samples​

Health​

Operations​

GET/healthz

Health Check​

GET
/healthz

Basic health check endpoint. Returns 200 if the API is running.

Authorizations​

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

TypeAPI Key (header: X-Api-Key)

Responses​

API is healthy

Playground​

Authorization

Samples​

Powered by VitePress OpenAPI

AstroAPI Documentation

Copyright © 2024 AstroAPI