Skip to content

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

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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
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": {
  
  
  
  
"additionalProperties": 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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
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": {
  
  
  
  
"additionalProperties": 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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
Required

Responses​

Delete one content item

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "content",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"urn": "string",
  
  
  
"title": "string",
  
  
  
"body": "string",
  
  
  
"metadata": {
  
  
  
  
"additionalProperties": 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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

horoscopeType*
Type
string
Required
contentType*
Type
string
Required

Responses​

Retrieve content items

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "content",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"urn": "string",
  
  
  
"title": "string",
  
  
  
"body": "string",
  
  
  
"metadata": {
  
  
  
  
"additionalProperties": 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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

horoscopeType*
Type
string
Required
contentType*
Type
string
Required

Responses​

Create content item

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "content",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"urn": "string",
  
  
  
"title": "string",
  
  
  
"body": "string",
  
  
  
"metadata": {
  
  
  
  
"additionalProperties": 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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
Required
horoscopeType*
Type
string
Required
contentType*
Type
string
Required

Responses​

Retrieve one content item

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "content",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"urn": "string",
  
  
  
"title": "string",
  
  
  
"body": "string",
  
  
  
"metadata": {
  
  
  
  
"additionalProperties": 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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
Required
horoscopeType*
Type
string
Required
contentType*
Type
string
Required

Responses​

Delete one content item

Playground​

Authorization
Variables
Key
Value

Samples​


Update Content​

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

Update the title, body or metadata of a content item.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
Required
horoscopeType*
Type
string
Required
contentType*
Type
string
Required

Responses​

Update one content item

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "content",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"urn": "string",
  
  
  
"title": "string",
  
  
  
"body": "string",
  
  
  
"metadata": {
  
  
  
  
"additionalProperties": 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​


Calculations​


Natal Chart​

POST
/api/calc/natal

Calculate a natal (birth) chart with planetary positions, house cusps, and aspects. By default the Moon is topocentric (parallax-corrected for the birth location); set moonCenter to geocentric for Earth-center Moon positions.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"dateTime": "string",
  
"location": {
  
  
"longitude": 0,
  
  
"latitude": 0,
  
  
"timezone": "string"
  
},
  
"houseSystem": "placidus",
  
"moonCenter": "topocentric",
  
"language": "en",
  
"includeText": false,
  
"includeReadableEntities": false,
  
"points": [
  
  
"string"
  
],
  
"orbs": {
  
  
"additionalProperties": 0
  
},
  
"include": [
  
  
"string"
  
],
  
"traditional": {
  
  
"sectMethod": "string",
  
  
"horizon": "string",
  
  
"reverseLotsByNight": true,
  
  
"lots": [
  
  
  
"string"
  
  
],
  
  
"bounds": "string",
  
  
"triplicity": "string",
  
  
"antisciaOrb": 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": {
  
  
  
  
"pointId": "string",
  
  
  
  
"longitude": 0,
  
  
  
  
"speedLongitude": 0,
  
  
  
  
"speedLatitude": 0,
  
  
  
  
"speedDistance": 0,
  
  
  
  
"retrograde": true,
  
  
  
  
"houseId": "string",
  
  
  
  
"houseNumber": 0,
  
  
  
  
"degreesInSign": 0,
  
  
  
  
"degreesInSignDms": [
  
  
  
  
  
0
  
  
  
  
],
  
  
  
  
"sign": "string",
  
  
  
  
"declination": 0,
  
  
  
  
"outOfBounds": true
  
  
  
}
  
  
},
  
  
"angles": {
  
  
  
"additionalProperties": {
  
  
  
  
"pointId": "string",
  
  
  
  
"longitude": 0,
  
  
  
  
"degreesInSign": 0,
  
  
  
  
"degreesInSignDms": [
  
  
  
  
  
0
  
  
  
  
],
  
  
  
  
"sign": "string"
  
  
  
}
  
  
},
  
  
"houses": {
  
  
  
"cusps": [
  
  
  
  
{
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
"longitudeDms": {
  
  
  
  
  
  
"degrees": 0,
  
  
  
  
  
  
"minutes": 0,
  
  
  
  
  
  
"seconds": 0
  
  
  
  
  
},
  
  
  
  
  
"sign": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"ascmc": [
  
  
  
  
{
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
"longitudeDms": {
  
  
  
  
  
  
"degrees": 0,
  
  
  
  
  
  
"minutes": 0,
  
  
  
  
  
  
"seconds": 0
  
  
  
  
  
},
  
  
  
  
  
"sign": "string"
  
  
  
  
}
  
  
  
]
  
  
},
  
  
"chart": {
  
  
  
"url": "string"
  
  
},
  
  
"traditional": {
  
  
  
"sect": {
  
  
  
  
"isDay": true,
  
  
  
  
"sect": "string",
  
  
  
  
"method": "string",
  
  
  
  
"degreesFromBoundary": 0,
  
  
  
  
"sunAltitude": 0,
  
  
  
  
"sectLight": "string",
  
  
  
  
"maleficOfSect": "string",
  
  
  
  
"beneficOfSect": "string",
  
  
  
  
"methodsDisagree": true
  
  
  
},
  
  
  
"lots": [
  
  
  
  
{
  
  
  
  
  
"id": "string",
  
  
  
  
  
"label": "string",
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
"sign": "string",
  
  
  
  
  
"degreesInSign": 0,
  
  
  
  
  
"house": 0,
  
  
  
  
  
"quadrantHouse": 0,
  
  
  
  
  
"ruler": "string",
  
  
  
  
  
"rulerPosition": {
  
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
  
"sign": "string",
  
  
  
  
  
  
"house": 0,
  
  
  
  
  
  
"quadrantHouse": 0,
  
  
  
  
  
  
"signsFromLot": 0
  
  
  
  
  
},
  
  
  
  
  
"formula": "string",
  
  
  
  
  
"reversed": true
  
  
  
  
}
  
  
  
],
  
  
  
"dignities": [
  
  
  
  
{
  
  
  
  
  
"pointId": "string",
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
"sign": "string",
  
  
  
  
  
"essential": {
  
  
  
  
  
  
"dignities": [
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
],
  
  
  
  
  
  
"debilities": [
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
],
  
  
  
  
  
  
"score": 0,
  
  
  
  
  
  
"rulers": {
  
  
  
  
  
  
  
"domicile": "string",
  
  
  
  
  
  
  
"exaltation": "string",
  
  
  
  
  
  
  
"triplicity": "string",
  
  
  
  
  
  
  
"bound": "string",
  
  
  
  
  
  
  
"face": "string"
  
  
  
  
  
  
},
  
  
  
  
  
  
"exactExaltation": true
  
  
  
  
  
},
  
  
  
  
  
"accidental": {
  
  
  
  
  
  
"house": 0,
  
  
  
  
  
  
"quadrantHouse": 0,
  
  
  
  
  
  
"angularity": "string",
  
  
  
  
  
  
"quadrantAngularity": "string",
  
  
  
  
  
  
"inJoy": true,
  
  
  
  
  
  
"retrograde": true,
  
  
  
  
  
  
"solarPhase": "string",
  
  
  
  
  
  
"distanceFromSun": 0,
  
  
  
  
  
  
"orientality": "string",
  
  
  
  
  
  
"overcomeBy": [
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
],
  
  
  
  
  
  
"overcomes": [
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
],
  
  
  
  
  
  
"enclosure": {
  
  
  
  
  
  
  
"kind": "string",
  
  
  
  
  
  
  
"before": "string",
  
  
  
  
  
  
  
"after": "string"
  
  
  
  
  
  
}
  
  
  
  
  
}
  
  
  
  
}
  
  
  
],
  
  
  
"antiscia": [
  
  
  
  
{
  
  
  
  
  
"pointId": "string",
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
"antiscion": {
  
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
  
"sign": "string",
  
  
  
  
  
  
"degreesInSign": 0,
  
  
  
  
  
  
"house": 0,
  
  
  
  
  
  
"quadrantHouse": 0
  
  
  
  
  
},
  
  
  
  
  
"contraAntiscion": {
  
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
  
"sign": "string",
  
  
  
  
  
  
"degreesInSign": 0,
  
  
  
  
  
  
"house": 0,
  
  
  
  
  
  
"quadrantHouse": 0
  
  
  
  
  
},
  
  
  
  
  
"contacts": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"pointId": "string",
  
  
  
  
  
  
  
"kind": "string",
  
  
  
  
  
  
  
"orb": 0
  
  
  
  
  
  
}
  
  
  
  
  
]
  
  
  
  
}
  
  
  
],
  
  
  
"triplicity": {
  
  
  
  
"scheme": "string",
  
  
  
  
"sectLight": {
  
  
  
  
  
"pointId": "string",
  
  
  
  
  
"sign": "string",
  
  
  
  
  
"element": "string",
  
  
  
  
  
"ruler": "string",
  
  
  
  
  
"day": "string",
  
  
  
  
  
"night": "string",
  
  
  
  
  
"participating": "string"
  
  
  
  
}
  
  
  
},
  
  
  
"applied": {
  
  
  
  
"sectMethod": "string",
  
  
  
  
"horizonAltitude": 0,
  
  
  
  
"reverseLotsByNight": true,
  
  
  
  
"lots": [
  
  
  
  
  
"string"
  
  
  
  
],
  
  
  
  
"bounds": "string",
  
  
  
  
"triplicity": "string",
  
  
  
  
"antisciaOrb": 0
  
  
  
}
  
  
}
  
}
}

Playground​

Authorization
Body

Samples​


AI Summary (natal)​

GET
/api/calc/natal/summary

Generate a short narrative summary of what this horoscope means, written from the strongest placements and aspects of the chart. Open the signed summary.url returned by the matching calculation endpoint — it carries the whole request, so no body is needed. Generating a summary counts as 10 API requests and takes several seconds; a summary that was generated before is served from cache and counts as one. Requires the AI Summary module (included in the Premium and Deluxe plans) plus the interpretation texts of this horoscope type.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Responses​

The generated summary

application/vnd.api+json
JSON
{
  
"data": {
  
  
"horoscopeType": "string",
  
  
"language": "string",
  
  
"summary": "string",
  
  
"cached": true,
  
  
"generatedAt": "string",
  
  
"highlights": [
  
  
  
{
  
  
  
  
"kind": "string",
  
  
  
  
"label": "string"
  
  
  
}
  
  
]
  
}
}

Playground​

Authorization

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.

Type
API 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": {
  
  
  
  
"title": "string",
  
  
  
  
"description": "string",
  
  
  
  
"url": "string"
  
  
  
}
  
  
}
  
}
}

Playground​

Authorization
Body

Samples​


AI Summary (synastry)​

GET
/api/calc/synastry/summary

Generate a short narrative summary of what this horoscope means, written from the strongest placements and aspects of the chart. Open the signed summary.url returned by the matching calculation endpoint — it carries the whole request, so no body is needed. Generating a summary counts as 10 API requests and takes several seconds; a summary that was generated before is served from cache and counts as one. Requires the AI Summary module (included in the Premium and Deluxe plans) plus the interpretation texts of this horoscope type.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Responses​

The generated summary

application/vnd.api+json
JSON
{
  
"data": {
  
  
"horoscopeType": "string",
  
  
"language": "string",
  
  
"summary": "string",
  
  
"cached": true,
  
  
"generatedAt": "string",
  
  
"highlights": [
  
  
  
{
  
  
  
  
"kind": "string",
  
  
  
  
"label": "string"
  
  
  
}
  
  
]
  
}
}

Playground​

Authorization

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.

Type
API 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": {
  
  
  
  
"pointId": "string",
  
  
  
  
"longitude": 0,
  
  
  
  
"speedLongitude": 0,
  
  
  
  
"speedLatitude": 0,
  
  
  
  
"speedDistance": 0,
  
  
  
  
"retrograde": true,
  
  
  
  
"houseId": "string",
  
  
  
  
"houseNumber": 0,
  
  
  
  
"degreesInSign": 0,
  
  
  
  
"degreesInSignDms": [
  
  
  
  
  
0
  
  
  
  
],
  
  
  
  
"sign": "string",
  
  
  
  
"declination": 0,
  
  
  
  
"outOfBounds": true
  
  
  
}
  
  
},
  
  
"aspects": [
  
  
  
{
  
  
  
  
"pointA": "string",
  
  
  
  
"pointB": "string",
  
  
  
  
"aspect": "string",
  
  
  
  
"angle": 0,
  
  
  
  
"orb": 0,
  
  
  
  
"applying": true,
  
  
  
  
"text": "string"
  
  
  
}
  
  
],
  
  
"charts": {
  
  
  
"additionalProperties": {
  
  
  
  
"title": "string",
  
  
  
  
"description": "string",
  
  
  
  
"url": "string"
  
  
  
}
  
  
}
  
}
}

Playground​

Authorization
Body

Samples​


AI Summary (composite)​

GET
/api/calc/composite/summary

Generate a short narrative summary of what this horoscope means, written from the strongest placements and aspects of the chart. Open the signed summary.url returned by the matching calculation endpoint — it carries the whole request, so no body is needed. Generating a summary counts as 10 API requests and takes several seconds; a summary that was generated before is served from cache and counts as one. Requires the AI Summary module (included in the Premium and Deluxe plans) plus the interpretation texts of this horoscope type.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Responses​

The generated summary

application/vnd.api+json
JSON
{
  
"data": {
  
  
"horoscopeType": "string",
  
  
"language": "string",
  
  
"summary": "string",
  
  
"cached": true,
  
  
"generatedAt": "string",
  
  
"highlights": [
  
  
  
{
  
  
  
  
"kind": "string",
  
  
  
  
"label": "string"
  
  
  
}
  
  
]
  
}
}

Playground​

Authorization

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.

Type
API 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​


AI Summary (transit)​

GET
/api/calc/transit/summary

Generate a short narrative summary of what this horoscope means, written from the strongest placements and aspects of the chart. Open the signed summary.url returned by the matching calculation endpoint — it carries the whole request, so no body is needed. Generating a summary counts as 10 API requests and takes several seconds; a summary that was generated before is served from cache and counts as one. Requires the AI Summary module (included in the Premium and Deluxe plans) plus the interpretation texts of this horoscope type.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Responses​

The generated summary

application/vnd.api+json
JSON
{
  
"data": {
  
  
"horoscopeType": "string",
  
  
"language": "string",
  
  
"summary": "string",
  
  
"cached": true,
  
  
"generatedAt": "string",
  
  
"highlights": [
  
  
  
{
  
  
  
  
"kind": "string",
  
  
  
  
"label": "string"
  
  
  
}
  
  
]
  
}
}

Playground​

Authorization

Samples​


Transit iCal Export​

POST
/api/calc/transit/ical

Generate an iCal (.ics) file containing transit aspects as calendar events.

Authorizations​

ApiKeyAuth

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

Type
API 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",
  
"points": [
  
  
"string"
  
],
  
"orbs": {
  
  
"additionalProperties": 0
  
},
  
"aspects": [
  
  
"string"
  
]
}

Responses​

iCal file with transit aspects

text/calendar

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.

Type
API 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.

Type
API 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": {
  
  
  
  
"pointId": "string",
  
  
  
  
"longitude": 0,
  
  
  
  
"speedLongitude": 0,
  
  
  
  
"speedLatitude": 0,
  
  
  
  
"speedDistance": 0,
  
  
  
  
"retrograde": true,
  
  
  
  
"houseId": "string",
  
  
  
  
"houseNumber": 0,
  
  
  
  
"degreesInSign": 0,
  
  
  
  
"degreesInSignDms": [
  
  
  
  
  
0
  
  
  
  
],
  
  
  
  
"sign": "string",
  
  
  
  
"declination": 0,
  
  
  
  
"outOfBounds": true
  
  
  
}
  
  
},
  
  
"angles": {
  
  
  
"additionalProperties": {
  
  
  
  
"pointId": "string",
  
  
  
  
"longitude": 0,
  
  
  
  
"degreesInSign": 0,
  
  
  
  
"degreesInSignDms": [
  
  
  
  
  
0
  
  
  
  
],
  
  
  
  
"sign": "string"
  
  
  
}
  
  
},
  
  
"houses": {
  
  
  
"cusps": [
  
  
  
  
{
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
"longitudeDms": {
  
  
  
  
  
  
"degrees": 0,
  
  
  
  
  
  
"minutes": 0,
  
  
  
  
  
  
"seconds": 0
  
  
  
  
  
},
  
  
  
  
  
"sign": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"ascmc": [
  
  
  
  
{
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
"longitudeDms": {
  
  
  
  
  
  
"degrees": 0,
  
  
  
  
  
  
"minutes": 0,
  
  
  
  
  
  
"seconds": 0
  
  
  
  
  
},
  
  
  
  
  
"sign": "string"
  
  
  
  
}
  
  
  
]
  
  
},
  
  
"charts": {
  
  
  
"additionalProperties": {
  
  
  
  
"title": "string",
  
  
  
  
"description": "string",
  
  
  
  
"url": "string"
  
  
  
}
  
  
}
  
}
}

Playground​

Authorization
Body

Samples​


AI Summary (solar)​

GET
/api/calc/solar-return/summary

Generate a short narrative summary of what this horoscope means, written from the strongest placements and aspects of the chart. Open the signed summary.url returned by the matching calculation endpoint — it carries the whole request, so no body is needed. Generating a summary counts as 10 API requests and takes several seconds; a summary that was generated before is served from cache and counts as one. Requires the AI Summary module (included in the Premium and Deluxe plans) plus the interpretation texts of this horoscope type.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Responses​

The generated summary

application/vnd.api+json
JSON
{
  
"data": {
  
  
"horoscopeType": "string",
  
  
"language": "string",
  
  
"summary": "string",
  
  
"cached": true,
  
  
"generatedAt": "string",
  
  
"highlights": [
  
  
  
{
  
  
  
  
"kind": "string",
  
  
  
  
"label": "string"
  
  
  
}
  
  
]
  
}
}

Playground​

Authorization

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.

Type
API 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": {
  
  
  
  
"pointId": "string",
  
  
  
  
"longitude": 0,
  
  
  
  
"speedLongitude": 0,
  
  
  
  
"speedLatitude": 0,
  
  
  
  
"speedDistance": 0,
  
  
  
  
"retrograde": true,
  
  
  
  
"houseId": "string",
  
  
  
  
"houseNumber": 0,
  
  
  
  
"degreesInSign": 0,
  
  
  
  
"degreesInSignDms": [
  
  
  
  
  
0
  
  
  
  
],
  
  
  
  
"sign": "string",
  
  
  
  
"declination": 0,
  
  
  
  
"outOfBounds": true
  
  
  
}
  
  
},
  
  
"angles": {
  
  
  
"additionalProperties": {
  
  
  
  
"pointId": "string",
  
  
  
  
"longitude": 0,
  
  
  
  
"degreesInSign": 0,
  
  
  
  
"degreesInSignDms": [
  
  
  
  
  
0
  
  
  
  
],
  
  
  
  
"sign": "string"
  
  
  
}
  
  
},
  
  
"houses": {
  
  
  
"cusps": [
  
  
  
  
{
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
"longitudeDms": {
  
  
  
  
  
  
"degrees": 0,
  
  
  
  
  
  
"minutes": 0,
  
  
  
  
  
  
"seconds": 0
  
  
  
  
  
},
  
  
  
  
  
"sign": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"ascmc": [
  
  
  
  
{
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
"longitudeDms": {
  
  
  
  
  
  
"degrees": 0,
  
  
  
  
  
  
"minutes": 0,
  
  
  
  
  
  
"seconds": 0
  
  
  
  
  
},
  
  
  
  
  
"sign": "string"
  
  
  
  
}
  
  
  
]
  
  
},
  
  
"charts": {
  
  
  
"additionalProperties": {
  
  
  
  
"title": "string",
  
  
  
  
"description": "string",
  
  
  
  
"url": "string"
  
  
  
}
  
  
}
  
}
}

Playground​

Authorization
Body

Samples​


AI Summary (lunar)​

GET
/api/calc/lunar-return/summary

Generate a short narrative summary of what this horoscope means, written from the strongest placements and aspects of the chart. Open the signed summary.url returned by the matching calculation endpoint — it carries the whole request, so no body is needed. Generating a summary counts as 10 API requests and takes several seconds; a summary that was generated before is served from cache and counts as one. Requires the AI Summary module (included in the Premium and Deluxe plans) plus the interpretation texts of this horoscope type.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Responses​

The generated summary

application/vnd.api+json
JSON
{
  
"data": {
  
  
"horoscopeType": "string",
  
  
"language": "string",
  
  
"summary": "string",
  
  
"cached": true,
  
  
"generatedAt": "string",
  
  
"highlights": [
  
  
  
{
  
  
  
  
"kind": "string",
  
  
  
  
"label": "string"
  
  
  
}
  
  
]
  
}
}

Playground​

Authorization

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.

Type
API 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": {
  
  
  
  
"pointId": "string",
  
  
  
  
"longitude": 0,
  
  
  
  
"speedLongitude": 0,
  
  
  
  
"speedLatitude": 0,
  
  
  
  
"speedDistance": 0,
  
  
  
  
"retrograde": true,
  
  
  
  
"houseId": "string",
  
  
  
  
"houseNumber": 0,
  
  
  
  
"degreesInSign": 0,
  
  
  
  
"degreesInSignDms": [
  
  
  
  
  
0
  
  
  
  
],
  
  
  
  
"sign": "string",
  
  
  
  
"declination": 0,
  
  
  
  
"outOfBounds": true
  
  
  
}
  
  
},
  
  
"angles": {
  
  
  
"additionalProperties": {
  
  
  
  
"pointId": "string",
  
  
  
  
"longitude": 0,
  
  
  
  
"degreesInSign": 0,
  
  
  
  
"degreesInSignDms": [
  
  
  
  
  
0
  
  
  
  
],
  
  
  
  
"sign": "string"
  
  
  
}
  
  
},
  
  
"natalPoints": {
  
  
  
"additionalProperties": {
  
  
  
  
"pointId": "string",
  
  
  
  
"longitude": 0,
  
  
  
  
"speedLongitude": 0,
  
  
  
  
"speedLatitude": 0,
  
  
  
  
"speedDistance": 0,
  
  
  
  
"retrograde": true,
  
  
  
  
"houseId": "string",
  
  
  
  
"houseNumber": 0,
  
  
  
  
"degreesInSign": 0,
  
  
  
  
"degreesInSignDms": [
  
  
  
  
  
0
  
  
  
  
],
  
  
  
  
"sign": "string",
  
  
  
  
"declination": 0,
  
  
  
  
"outOfBounds": true
  
  
  
}
  
  
},
  
  
"natalAngles": {
  
  
  
"additionalProperties": {
  
  
  
  
"pointId": "string",
  
  
  
  
"longitude": 0,
  
  
  
  
"degreesInSign": 0,
  
  
  
  
"degreesInSignDms": [
  
  
  
  
  
0
  
  
  
  
],
  
  
  
  
"sign": "string"
  
  
  
}
  
  
},
  
  
"houses": {
  
  
  
"cusps": [
  
  
  
  
{
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
"longitudeDms": {
  
  
  
  
  
  
"degrees": 0,
  
  
  
  
  
  
"minutes": 0,
  
  
  
  
  
  
"seconds": 0
  
  
  
  
  
},
  
  
  
  
  
"sign": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"ascmc": [
  
  
  
  
{
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
"longitudeDms": {
  
  
  
  
  
  
"degrees": 0,
  
  
  
  
  
  
"minutes": 0,
  
  
  
  
  
  
"seconds": 0
  
  
  
  
  
},
  
  
  
  
  
"sign": "string"
  
  
  
  
}
  
  
  
]
  
  
},
  
  
"charts": {
  
  
  
"additionalProperties": {
  
  
  
  
"title": "string",
  
  
  
  
"description": "string",
  
  
  
  
"url": "string"
  
  
  
}
  
  
}
  
}
}

Playground​

Authorization
Body

Samples​


AI Summary (progressions)​

GET
/api/calc/progressions/summary

Generate a short narrative summary of what this horoscope means, written from the strongest placements and aspects of the chart. Open the signed summary.url returned by the matching calculation endpoint — it carries the whole request, so no body is needed. Generating a summary counts as 10 API requests and takes several seconds; a summary that was generated before is served from cache and counts as one. Requires the AI Summary module (included in the Premium and Deluxe plans) plus the interpretation texts of this horoscope type.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Responses​

The generated summary

application/vnd.api+json
JSON
{
  
"data": {
  
  
"horoscopeType": "string",
  
  
"language": "string",
  
  
"summary": "string",
  
  
"cached": true,
  
  
"generatedAt": "string",
  
  
"highlights": [
  
  
  
{
  
  
  
  
"kind": "string",
  
  
  
  
"label": "string"
  
  
  
}
  
  
]
  
}
}

Playground​

Authorization

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.

Type
API 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.

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"dateTime": "string",
  
"location": {
  
  
"longitude": 0,
  
  
"latitude": 0,
  
  
"timezone": "string"
  
},
  
"aspects": [
  
  
[
  
  
  
"conjunction",
  
  
  
"sextile",
  
  
  
"square",
  
  
  
"trine",
  
  
  
"opposition"
  
  
]
  
]
}

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.

Type
API Key (header: X-Api-Key)

Request Body​

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

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.

Type
API 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": [
  
  
  
  
{
  
  
  
  
  
"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
  
  
  
  
  
}
  
  
  
  
}
  
  
  
]
  
  
},
  
  
"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​


Declinations​

POST
/api/calc/declination

Declinations, parallels and out-of-bounds flags for one moment.

A horoscope is a projection onto the ecliptic, and that projection throws away the north-south
axis. Two bodies with no zodiacal aspect between them can share a declination — a parallel,
which behaves like a conjunction. The same distance from the equator on opposite sides is a
contraparallel, which behaves like an opposition. Both are measured with a much tighter orb
than a longitude aspect; 1° is the convention and the default.

Out of bounds is a body past the Sun's own maximum declination. The Moon is out of bounds a
few days a month around a major lunar standstill; Mercury, Venus, Mars and Pluto go there at
intervals. The flag is judged against the true obliquity of the requested date, which is returned
alongside it as obliquity.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"dateTime": "string",
  
"location": {
  
  
"longitude": 0,
  
  
"latitude": 0,
  
  
"timezone": "string"
  
},
  
"points": [
  
  
"string"
  
],
  
"orb": 1,
  
"moonCenter": "topocentric",
  
"language": "en",
  
"includeText": false,
  
"includeReadableEntities": false
}

Responses​

Declinations, parallels and out-of-bounds flags

application/vnd.api+json
JSON
{
  
"data": {
  
  
"dateTime": "string",
  
  
"points": {
  
  
  
"additionalProperties": {
  
  
  
  
"pointId": "string",
  
  
  
  
"declination": 0,
  
  
  
  
"declinationDms": [
  
  
  
  
  
0
  
  
  
  
],
  
  
  
  
"rightAscension": 0,
  
  
  
  
"latitude": 0,
  
  
  
  
"speedDeclination": 0,
  
  
  
  
"outOfBounds": true,
  
  
  
  
"hemisphere": "string"
  
  
  
}
  
  
},
  
  
"aspects": [
  
  
  
{
  
  
  
  
"pointA": "string",
  
  
  
  
"pointB": "string",
  
  
  
  
"aspect": "string",
  
  
  
  
"orb": 0,
  
  
  
  
"applying": true,
  
  
  
  
"declinationA": 0,
  
  
  
  
"declinationB": 0,
  
  
  
  
"text": "string"
  
  
  
}
  
  
],
  
  
"extremes": {
  
  
  
"northernmost": "string",
  
  
  
"southernmost": "string",
  
  
  
"outOfBoundsCount": 0
  
  
},
  
  
"obliquity": 0
  
}
}

Playground​

Authorization
Body

Samples​


Declination Series​

POST
/api/calc/declination/series

Declination over a period, plus the dates each body crosses the out-of-bounds limit.

The crossings are the point of this endpoint. A graph is pleasant; the dates the Moon goes out of
bounds are what an astrologer writes down. They are searched on a finer grid than the one the
series is sampled at, so a coarse stepDays costs resolution in the curve but not in the dates.

The series is capped at 400 points. A year at a daily step is 365; a
longer range needs a wider step.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

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

Responses​

Declination series and out-of-bounds crossings

application/vnd.api+json
JSON
{
  
"data": {
  
  
"startDate": "string",
  
  
"endDate": "string",
  
  
"stepDays": 0,
  
  
"points": [
  
  
  
"string"
  
  
],
  
  
"series": {
  
  
  
"additionalProperties": [
  
  
  
  
[
  
  
  
  
]
  
  
  
]
  
  
},
  
  
"crossings": [
  
  
  
{
  
  
  
  
"pointId": "string",
  
  
  
  
"date": "string",
  
  
  
  
"direction": "string",
  
  
  
  
"declination": 0
  
  
  
}
  
  
]
  
}
}

Playground​

Authorization
Body

Samples​


Event Search​

POST
/api/calc/events

Find every date in a window on which something happens: aspect crossings to the natal chart,
retrograde and direct stations, lunations and eclipses, sign ingresses and natal house ingresses.

Ask for as many of the five kinds as you like — they share one ephemeris load, so a second kind is nearly free, and a
kind that is not in kinds is not searched and costs nothing.

Every event comes back in the same envelope: kind, exactAt, window, label, strength and a per-kind
details. For an aspect, details.pass and details.ofPasses mark the passes of a retrograde series, so a triple
Saturn square reads as one stretch rather than three unrelated rows.

Window limits. The Moon covers 13° a day and has to be sampled many times a day; Pluto gets away with weeks. So how
long a window may be depends on what is in it:

Bodies being scanned Maximum window
Slow bodies only 25 years
Including Mercury, Venus or the Sun 5 years
Including the Moon 1 year

A lunation search does not count as a Moon search: phases are reached by estimate and refinement, not by a fine grid.

limit defaults to 100 and caps at 500. Paging is on time, not on an offset: pass
the nextCursor you were given back as cursor. truncated says there was more inside the window than fitted.

Cost. This counts for more than one request, because it is honestly more than one calculation:
1 + ceil(windowDays / 365) × (1 + number of fast transiting bodies), capped at 50. A repeated query is served from
cache and counts as one — events never change, so the answer never goes stale.

Set ical: true to get icalUrl alongside the events: a signed, subscribable calendar feed of this exact query that
needs no API key, so it can be pasted straight into a calendar application.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"subject": {
  
  
"dateTime": "string",
  
  
"location": {
  
  
  
"longitude": 0,
  
  
  
"latitude": 0,
  
  
  
"timezone": "string"
  
  
}
  
},
  
"window": {
  
  
"from": "string",
  
  
"to": "string"
  
},
  
"kinds": [
  
  
"string"
  
],
  
"aspect": {
  
  
"transiting": [
  
  
  
"string"
  
  
],
  
  
"natal": [
  
  
  
"string"
  
  
],
  
  
"aspects": [
  
  
  
"string"
  
  
],
  
  
"orb": 0,
  
  
"minStrength": 0
  
},
  
"station": {
  
  
"points": [
  
  
  
"string"
  
  
]
  
},
  
"lunation": {
  
  
"phases": [
  
  
  
"string"
  
  
]
  
},
  
"ingress": {
  
  
"points": [
  
  
  
"string"
  
  
],
  
  
"signs": [
  
  
  
"string"
  
  
]
  
},
  
"houseIngress": {
  
  
"points": [
  
  
  
"string"
  
  
],
  
  
"houses": [
  
  
  
0
  
  
],
  
  
"houseSystem": "placidus"
  
},
  
"profection": {
  
  
"from": "string",
  
  
"includeMonths": true
  
},
  
"zodiacalReleasing": {
  
  
"from": "string",
  
  
"levels": 0,
  
  
"peaksOnly": true
  
},
  
"firdaria": {
  
  
"includeNodes": true,
  
  
"includeSubPeriods": true
  
},
  
"limit": 0,
  
"cursor": "string",
  
"ical": true
}

Responses​

The events found in the window

application/vnd.api+json
JSON
{
  
"data": {
  
  
"events": [
  
  
  
{
  
  
  
  
"kind": "string",
  
  
  
  
"exactAt": "string",
  
  
  
  
"window": {
  
  
  
  
  
"start": "string",
  
  
  
  
  
"end": "string"
  
  
  
  
},
  
  
  
  
"label": "string",
  
  
  
  
"strength": 0,
  
  
  
  
"details": {
  
  
  
  
  
"additionalProperties": null
  
  
  
  
}
  
  
  
}
  
  
],
  
  
"truncated": true,
  
  
"nextCursor": "string",
  
  
"window": {
  
  
  
"from": "string",
  
  
  
"to": "string"
  
  
},
  
  
"kinds": [
  
  
  
"string"
  
  
],
  
  
"icalUrl": "string"
  
}
}

Playground​

Authorization
Body

Samples​


Event Calendar Feed​

GET
/api/calc/events/ical

The signed calendar feed of an event search, as an .ics file.

Get the URL from icalUrl on a POST /api/calc/events with ical: true, then paste it into a calendar
application as a subscription. It carries its own signature, so it needs no API key and no session — the same mechanism
as a signed chart image URL — and for the same reason it does not count against the request quota. The search that
produced the URL was charged when it ran.

The signature covers the path and every query parameter, so a feed URL can be neither pointed at another endpoint nor
edited into a different query. It is valid for thirty days.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Responses​

iCal file with the events

text/calendar

Playground​

Authorization

Samples​


Annual, Monthly and Daily Profections​

POST
/api/calc/profections

Annual profections: one whole sign per year of life from a natal place, with the ruler of the sign arrived at as the Lord of the Year, plus the monthly and daily subdivisions.

The year turns on the solar return, not on the calendar birthday — the Sun comes back to its natal degree up to a day either side, and a year that starts on the wrong day puts the wrong lord in charge at both ends. Each year in the window therefore costs one solar return to find its boundary, which is why years is capped at 30.

from chooses the place profected. The Ascendant is the standard and the default; Valens also profects the Moon, the Sun, the Lot of Fortune and the Midheaven, each answering a different question.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"dateTime": "string",
  
"location": {
  
  
"longitude": 0,
  
  
"latitude": 0,
  
  
"timezone": "string"
  
},
  
"houseSystem": "placidus",
  
"from": "ascendant",
  
"startAge": 0,
  
"years": 1,
  
"includeMonths": true,
  
"includeDays": false,
  
"traditional": {
  
  
"sectMethod": "string",
  
  
"horizon": "string",
  
  
"reverseLotsByNight": true,
  
  
"lots": [
  
  
  
"string"
  
  
],
  
  
"bounds": "string",
  
  
"triplicity": "string",
  
  
"antisciaOrb": 0
  
}
}

Responses​

Profections over the requested window

application/vnd.api+json
JSON
{
  
"data": {
  
  
"from": "string",
  
  
"fromLongitude": 0,
  
  
"fromSign": "string",
  
  
"sect": "string",
  
  
"years": [
  
  
  
{
  
  
  
  
"level": "string",
  
  
  
  
"age": 0,
  
  
  
  
"index": 0,
  
  
  
  
"start": "string",
  
  
  
  
"end": "string",
  
  
  
  
"sign": "string",
  
  
  
  
"signsFromNatal": 0,
  
  
  
  
"house": 0,
  
  
  
  
"houseFromAscendant": 0,
  
  
  
  
"lord": "string",
  
  
  
  
"lordPosition": {
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
"sign": "string",
  
  
  
  
  
"house": 0,
  
  
  
  
  
"quadrantHouse": 0
  
  
  
  
},
  
  
  
  
"months": [
  
  
  
  
  
{
  
  
  
  
  
  
"level": "string",
  
  
  
  
  
  
"age": 0,
  
  
  
  
  
  
"index": 0,
  
  
  
  
  
  
"start": "string",
  
  
  
  
  
  
"end": "string",
  
  
  
  
  
  
"sign": "string",
  
  
  
  
  
  
"signsFromNatal": 0,
  
  
  
  
  
  
"house": 0,
  
  
  
  
  
  
"houseFromAscendant": 0,
  
  
  
  
  
  
"lord": "string",
  
  
  
  
  
  
"lordPosition": {
  
  
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
  
  
"sign": "string",
  
  
  
  
  
  
  
"house": 0,
  
  
  
  
  
  
  
"quadrantHouse": 0
  
  
  
  
  
  
},
  
  
  
  
  
  
"months": [
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
}
  
  
  
  
  
  
],
  
  
  
  
  
  
"days": [
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
}
  
  
  
  
  
  
]
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"days": [
  
  
  
  
  
{
  
  
  
  
  
  
"level": "string",
  
  
  
  
  
  
"age": 0,
  
  
  
  
  
  
"index": 0,
  
  
  
  
  
  
"start": "string",
  
  
  
  
  
  
"end": "string",
  
  
  
  
  
  
"sign": "string",
  
  
  
  
  
  
"signsFromNatal": 0,
  
  
  
  
  
  
"house": 0,
  
  
  
  
  
  
"houseFromAscendant": 0,
  
  
  
  
  
  
"lord": "string",
  
  
  
  
  
  
"lordPosition": {
  
  
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
  
  
"sign": "string",
  
  
  
  
  
  
  
"house": 0,
  
  
  
  
  
  
  
"quadrantHouse": 0
  
  
  
  
  
  
},
  
  
  
  
  
  
"months": [
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
}
  
  
  
  
  
  
],
  
  
  
  
  
  
"days": [
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
}
  
  
  
  
  
  
]
  
  
  
  
  
}
  
  
  
  
]
  
  
  
}
  
  
]
  
}
}

Playground​

Authorization
Body

Samples​


Zodiacal Releasing​

POST
/api/calc/zodiacal-releasing

Zodiacal releasing from the Lot of Spirit or the Lot of Fortune, after Valens, Anthology Book IV. Periods released in zodiacal order from the sign of the lot, each as long as the planetary years of that sign's ruler, subdivided one twelfth at a time.

Loosing of the bond is applied by default: when the sequence arrives at Cancer or Capricorn the next period is the opposite sign rather than the next one, after which it carries on in order. Omitting it leaves the first two or three decades correct and everything after them wrong, so it is on unless you switch it off to match software that lacks it.

Peak periods are the ones reaching the angles of the lot. Valens measures the angular triad from the Lot of Fortune even when releasing from Spirit, so peakFrom defaults to fortune; peakSigns says which of the angles is the peak, the tenth by default.

Levels 3 and 4 are only expanded inside detailWindow — the unit shrinks twelvefold per level, and a fourth level over a lifetime is tens of thousands of periods.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"dateTime": "string",
  
"location": {
  
  
"longitude": 0,
  
  
"latitude": 0,
  
  
"timezone": "string"
  
},
  
"houseSystem": "placidus",
  
"from": "spirit",
  
"levels": 2,
  
"years": 100,
  
"detailWindow": {
  
  
"start": "string",
  
  
"end": "string"
  
},
  
"loosingOfTheBond": true,
  
"peakFrom": "fortune",
  
"peakSigns": [
  
  
0
  
],
  
"traditional": {
  
  
"sectMethod": "string",
  
  
"horizon": "string",
  
  
"reverseLotsByNight": true,
  
  
"lots": [
  
  
  
"string"
  
  
],
  
  
"bounds": "string",
  
  
"triplicity": "string",
  
  
"antisciaOrb": 0
  
}
}

Responses​

The releasing tree

application/vnd.api+json
JSON
{
  
"data": {
  
  
"from": "string",
  
  
"lotLongitude": 0,
  
  
"lotSign": "string",
  
  
"peakFrom": "string",
  
  
"peakLotLongitude": 0,
  
  
"peakSigns": [
  
  
  
0
  
  
],
  
  
"loosingOfTheBond": true,
  
  
"levels": 0,
  
  
"sect": "string",
  
  
"limitReached": true,
  
  
"periods": [
  
  
  
{
  
  
  
  
"level": 0,
  
  
  
  
"sign": "string",
  
  
  
  
"ruler": "string",
  
  
  
  
"start": "string",
  
  
  
  
"end": "string",
  
  
  
  
"lengthUnits": 0,
  
  
  
  
"durationDays": 0,
  
  
  
  
"truncated": true,
  
  
  
  
"loosingOfTheBond": true,
  
  
  
  
"signsFromLot": 0,
  
  
  
  
"signsFromPeakLot": 0,
  
  
  
  
"angularTriad": true,
  
  
  
  
"peak": true,
  
  
  
  
"children": [
  
  
  
  
  
{
  
  
  
  
  
  
"level": 0,
  
  
  
  
  
  
"sign": "string",
  
  
  
  
  
  
"ruler": "string",
  
  
  
  
  
  
"start": "string",
  
  
  
  
  
  
"end": "string",
  
  
  
  
  
  
"lengthUnits": 0,
  
  
  
  
  
  
"durationDays": 0,
  
  
  
  
  
  
"truncated": true,
  
  
  
  
  
  
"loosingOfTheBond": true,
  
  
  
  
  
  
"signsFromLot": 0,
  
  
  
  
  
  
"signsFromPeakLot": 0,
  
  
  
  
  
  
"angularTriad": true,
  
  
  
  
  
  
"peak": true,
  
  
  
  
  
  
"children": [
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
}
  
  
  
  
  
  
]
  
  
  
  
  
}
  
  
  
  
]
  
  
  
}
  
  
]
  
}
}

Playground​

Authorization
Body

Samples​


Firdaria​

POST
/api/calc/firdaria

The Persian system of planetary periods, from Abu Ma'shar and Bonatti. Seven main periods of fixed length, each divided into seven sub-periods, the cycle closing after seventy-five years.

The sequence starts with the Sun in a day chart and with the Moon in a night chart — the same seven-planet cycle, rotated. The sect is resolved from the chart, with the same traditional.sectMethod parameter every other traditional endpoint takes.

includeNodes (default true) gives the Head and Tail of the Dragon their three and two years at the end of the cycle, the majority reading; without them the cycle is seventy years. The node periods run whole unless subdivideNodes is set.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"dateTime": "string",
  
"location": {
  
  
"longitude": 0,
  
  
"latitude": 0,
  
  
"timezone": "string"
  
},
  
"houseSystem": "placidus",
  
"years": 100,
  
"includeNodes": true,
  
"subdivideNodes": false,
  
"traditional": {
  
  
"sectMethod": "string",
  
  
"horizon": "string",
  
  
"reverseLotsByNight": true,
  
  
"lots": [
  
  
  
"string"
  
  
],
  
  
"bounds": "string",
  
  
"triplicity": "string",
  
  
"antisciaOrb": 0
  
}
}

Responses​

Main periods and sub-periods

application/vnd.api+json
JSON
{
  
"data": {
  
  
"sect": "string",
  
  
"includeNodes": true,
  
  
"order": [
  
  
  
"string"
  
  
],
  
  
"periods": [
  
  
  
{
  
  
  
  
"ruler": "string",
  
  
  
  
"start": "string",
  
  
  
  
"end": "string",
  
  
  
  
"durationDays": 0,
  
  
  
  
"cycle": 0,
  
  
  
  
"subPeriods": [
  
  
  
  
  
{
  
  
  
  
  
  
"ruler": "string",
  
  
  
  
  
  
"mainRuler": "string",
  
  
  
  
  
  
"start": "string",
  
  
  
  
  
  
"end": "string",
  
  
  
  
  
  
"durationDays": 0
  
  
  
  
  
}
  
  
  
  
]
  
  
  
}
  
  
]
  
}
}

Playground​

Authorization
Body

Samples​


Solar Arc Directions​

POST
/api/calc/solar-arc

Every point in the chart, the angles included, moved forward by the arc the Sun has travelled since birth, and read against the natal positions.

Three keys. true (the default) uses the arc the Sun actually travelled to the secondary-progressed date, which is what "solar arc" means without qualification and what the progression calculation already produces. naibod advances 0.9856262833° per year, the Sun's mean daily motion, and does not depend on the season of birth. ptolemy advances exactly one degree a year.

Directions to the Midheaven and Ascendant are included by default: they are the contacts that date an event most sharply, and the measurement rectification reads.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"dateTime": "string",
  
"location": {
  
  
"longitude": 0,
  
  
"latitude": 0,
  
  
"timezone": "string"
  
},
  
"houseSystem": "placidus",
  
"targetDate": "string",
  
"key": "true",
  
"points": [
  
  
"string"
  
],
  
"includeAngles": true,
  
"orb": 1,
  
"traditional": {
  
  
"sectMethod": "string",
  
  
"horizon": "string",
  
  
"reverseLotsByNight": true,
  
  
"lots": [
  
  
  
"string"
  
  
],
  
  
"bounds": "string",
  
  
"triplicity": "string",
  
  
"antisciaOrb": 0
  
}
}

Responses​

Directed positions and their contacts with the natal chart

application/vnd.api+json
JSON
{
  
"data": {
  
  
"key": "string",
  
  
"arc": 0,
  
  
"years": 0,
  
  
"targetDate": "string",
  
  
"directed": [
  
  
  
{
  
  
  
  
"pointId": "string",
  
  
  
  
"natalLongitude": 0,
  
  
  
  
"directedLongitude": 0,
  
  
  
  
"sign": "string",
  
  
  
  
"degreesInSign": 0,
  
  
  
  
"house": 0,
  
  
  
  
"quadrantHouse": 0
  
  
  
}
  
  
],
  
  
"contacts": [
  
  
  
{
  
  
  
  
"directedPoint": "string",
  
  
  
  
"natalPoint": "string",
  
  
  
  
"aspect": "string",
  
  
  
  
"orb": 0,
  
  
  
  
"yearsToExact": 0
  
  
  
}
  
  
]
  
}
}

Playground​

Authorization
Body

Samples​


Birth Time Rectification​

POST
/api/calc/rectification

Rank candidate birth times against dated life events.

This is not an oracle, and the response says so itself. There is no validated ground truth
for rectification: no astrological technique is known to recover a birth time. What this
endpoint does is rank the candidate times in a window by how well each fits the rules you
turned on
, and show per candidate what produced its score. It is a structured way of working
that replaces hours of doing the same comparison by hand — not a claim to have found anything.

Three things follow, and they are part of the contract:

  1. There is never one answer. candidates is a ranking with scores, always several.
  2. The reasoning comes with it. Every candidate lists what each rule contributed and why,
    so you can read the ranking and reject it.
  3. Flatness is reported. discrimination is the normalized entropy of the ranking. At
    verdict: "none" the evidence separated nothing and the order is arbitrary — say that to
    whoever is reading it rather than presenting the accidental winner.

What moves with the birth time

Almost nothing does, and that is what makes the search possible. The ascendant and the
midheaven move 1° every four minutes, the houses follow them, the Moon covers 0.55° an hour,
and everything derived from the ascendant moves with it. A planet-to-planet aspect is the same
for the whole window, so a rule that looks at one contributes nothing and only dilutes what the
others found. Every rule here is angle-sensitive.

The rules

Rule What it looks for
transit-to-angle A transiting body on an angle on the event date. The sharpest rule: a 1° orb pins the time to about eight minutes.
house-placement A transiting body in a house the event type is about. Coarse — a house is 30° — but it keeps scoring when nothing lands on an angle.
solar-arc-to-angle A solar arc direction reaching an angle, either way round. As sharp as a transit contact.
progressed-moon The secondary-progressed Moon on an angle or in a matching house. A weak signal, weighted as one.
stated-time The time you gave, as a normal prior with spread sigmaMinutes. Leave it on: without it a single lucky transit six hours away wins.
profection Annual profections and zodiacal releasing. Declared but not yet available; it is reported as available: false rather than quietly scoring zero.

The event taxonomy

A fixed list, not free text. A description interpreted by a model would make the same request
answer differently on two days, and reproducibility is what this endpoint has to offer. Your own
wording goes in description and is carried into the evidence lines untouched.

Type Subject Houses (weight)
marriage marriage or committed partnership 7 (1), 5 (0.4), 1 (0.3)
separation separation or divorce 7 (1), 8 (0.5), 12 (0.3)
child-born birth of a child 5 (1), 4 (0.4), 11 (0.2)
relocation move of home 4 (1), 3 (0.4)
emigration emigration or long stay abroad 9 (1), 4 (0.6), 3 (0.3)
career-change change of career or standing 10 (1), 6 (0.5), 2 (0.3)
job-loss loss of work 6 (1), 10 (0.6), 12 (0.3)
education start of a course of study 9 (1), 3 (0.5)
illness illness 6 (1), 12 (0.6), 8 (0.3)
surgery surgery 8 (1), 6 (0.8), 12 (0.4)
accident accident or injury 6 (0.8), 8 (0.8), 1 (0.6)
bereavement death of someone close 8 (1), 4 (0.4), 12 (0.3)
financial-gain windfall or substantial gain 2 (1), 11 (0.5), 8 (0.4)
financial-loss substantial financial loss 2 (1), 8 (0.8), 12 (0.4)
public-recognition public recognition 10 (1), 11 (0.6), 1 (0.3)
other unclassified —

Limits and what it costs

The window is at most ±720 minutes, the resolution at least 1 minute, the candidates at most
1441, and the events at most 25. Past any of
those the request is a 400 with the reason — never a silently truncated search.

This is the most expensive route on the API and it is priced accordingly:

cost = 5 + events + ceil(candidates / 60)     capped at 60

An everyday question — ±2 hours at one minute, 8 events — costs 18. The largest possible one
costs 55. A request that fails costs nothing. The answer reports what it charged in
method.requestCost.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"dateTime": "string",
  
"location": {
  
  
"longitude": 0,
  
  
"latitude": 0,
  
  
"timezone": "string"
  
},
  
"windowMinutes": 120,
  
"resolutionMinutes": 1,
  
"events": [
  
  
{
  
  
  
"date": "string",
  
  
  
"type": "string",
  
  
  
"description": "string",
  
  
  
"weight": 1
  
  
}
  
],
  
"rules": [
  
  
"string"
  
],
  
"sigmaMinutes": 60,
  
"orbDegrees": 1,
  
"transitingPoints": [
  
  
"string"
  
],
  
"maxCandidates": 20,
  
"houseSystem": "placidus"
}

Responses​

A ranking of candidate birth times, with the contribution of each rule and how much the evidence discriminated

application/vnd.api+json
JSON
{
  
"data": {
  
  
"statedDateTime": "string",
  
  
"candidates": [
  
  
  
{
  
  
  
  
"dateTime": "string",
  
  
  
  
"localDateTime": "string",
  
  
  
  
"time": "string",
  
  
  
  
"offsetMinutes": 0,
  
  
  
  
"score": 0,
  
  
  
  
"logScore": 0,
  
  
  
  
"ascendant": 0,
  
  
  
  
"midheaven": 0,
  
  
  
  
"rules": [
  
  
  
  
  
{
  
  
  
  
  
  
"rule": "string",
  
  
  
  
  
  
"contribution": 0,
  
  
  
  
  
  
"evidence": "string"
  
  
  
  
  
}
  
  
  
  
]
  
  
  
}
  
  
],
  
  
"discrimination": {
  
  
  
"entropy": 0,
  
  
  
"effectiveCandidates": 0,
  
  
  
"verdict": "string",
  
  
  
"message": "string"
  
  
},
  
  
"method": {
  
  
  
"rules": [
  
  
  
  
{
  
  
  
  
  
"rule": "string",
  
  
  
  
  
"weight": 0,
  
  
  
  
  
"available": true
  
  
  
  
}
  
  
  
],
  
  
  
"resolutionMinutes": 0,
  
  
  
"window": {
  
  
  
  
"start": "string",
  
  
  
  
"end": "string"
  
  
  
},
  
  
  
"candidates": 0,
  
  
  
"events": 0,
  
  
  
"houseSystem": "string",
  
  
  
"orbDegrees": 0,
  
  
  
"sigmaMinutes": 0,
  
  
  
"transitingPoints": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"requestCost": 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.

Type
API 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.

Type
API 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.

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

width*
Type
string
Required
height*
Type
string
Required
dateTime*
Type
string
Required
location.longitude*
Type
string
Required
location.latitude*
Type
string
Required
location.timezone*
Type
string
Required
transit.dateTime
Type
string
transit.timezone
Type
string
transit.longitude
Type
string
transit.latitude
Type
string

Responses​

Chart rendered successfully

image/svg+xml
JSON
[
]

Playground​

Authorization
Variables
Key
Value

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.

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

width*
Type
string
Required
height*
Type
string
Required
dateTime*
Type
string
Required
location.longitude*
Type
string
Required
location.latitude*
Type
string
Required
location.timezone*
Type
string
Required
transit.dateTime
Type
string
transit.timezone
Type
string
transit.longitude
Type
string
transit.latitude
Type
string

Responses​

Chart rendered successfully

image/png
JSON
[
]

Playground​

Authorization
Variables
Key
Value

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.

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

width*
Type
string
Required
height*
Type
string
Required
person1.dateTime*
Type
string
Required
person1.timezone*
Type
string
Required
person1.longitude*
Type
string
Required
person1.latitude*
Type
string
Required
person2.dateTime*
Type
string
Required
person2.timezone*
Type
string
Required
person2.longitude*
Type
string
Required
person2.latitude*
Type
string
Required

Responses​

Composite chart rendered successfully

image/svg+xml
JSON
[
]

Playground​

Authorization
Variables
Key
Value

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.

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

width*
Type
string
Required
height*
Type
string
Required
person1.dateTime*
Type
string
Required
person1.timezone*
Type
string
Required
person1.longitude*
Type
string
Required
person1.latitude*
Type
string
Required
person2.dateTime*
Type
string
Required
person2.timezone*
Type
string
Required
person2.longitude*
Type
string
Required
person2.latitude*
Type
string
Required

Responses​

Composite chart rendered successfully

image/png
JSON
[
]

Playground​

Authorization
Variables
Key
Value

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.

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

width*
Type
string
Required
height*
Type
string
Required
location.longitude*
Type
string
Required
location.latitude*
Type
string
Required
location.timezone*
Type
string
Required
dateTime*
Type
string
Required

Responses​

Chart rendered successfully

image/svg+xml
JSON
[
]

Playground​

Authorization
Variables
Key
Value

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.

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

width*
Type
string
Required
height*
Type
string
Required
location.longitude*
Type
string
Required
location.latitude*
Type
string
Required
location.timezone*
Type
string
Required
dateTime*
Type
string
Required

Responses​

Chart rendered successfully

image/png
JSON
[
]

Playground​

Authorization
Variables
Key
Value

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.

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

width*
Type
string
Required
height*
Type
string
Required
location.longitude*
Type
string
Required
location.latitude*
Type
string
Required
location.timezone*
Type
string
Required
dateTime*
Type
string
Required
transit.dateTime*
Type
string
Required
transit.timezone
Type
string
transit.longitude
Type
string
transit.latitude
Type
string

Responses​

Chart rendered successfully

image/svg+xml
JSON
[
]

Playground​

Authorization
Variables
Key
Value

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.

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

width*
Type
string
Required
height*
Type
string
Required
location.longitude*
Type
string
Required
location.latitude*
Type
string
Required
location.timezone*
Type
string
Required
dateTime*
Type
string
Required
transit.dateTime*
Type
string
Required
transit.timezone
Type
string
transit.longitude
Type
string
transit.latitude
Type
string

Responses​

Chart rendered successfully

image/png
JSON
[
]

Playground​

Authorization
Variables
Key
Value

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.

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

width*
Type
string
Required
height*
Type
string
Required
person1.dateTime*
Type
string
Required
person1.timezone*
Type
string
Required
person1.longitude*
Type
string
Required
person1.latitude*
Type
string
Required
person2.dateTime*
Type
string
Required
person2.timezone*
Type
string
Required
person2.longitude*
Type
string
Required
person2.latitude*
Type
string
Required

Responses​

Chart rendered successfully

image/svg+xml
JSON
[
]

Playground​

Authorization
Variables
Key
Value

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.

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

width*
Type
string
Required
height*
Type
string
Required
person1.dateTime*
Type
string
Required
person1.timezone*
Type
string
Required
person1.longitude*
Type
string
Required
person1.latitude*
Type
string
Required
person2.dateTime*
Type
string
Required
person2.timezone*
Type
string
Required
person2.longitude*
Type
string
Required
person2.latitude*
Type
string
Required

Responses​

Chart rendered successfully

image/png
JSON
[
]

Playground​

Authorization
Variables
Key
Value

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.

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

width*
Type
string
Required
height*
Type
string
Required
person1.dateTime*
Type
string
Required
person1.timezone*
Type
string
Required
person1.longitude*
Type
string
Required
person1.latitude*
Type
string
Required
person2.dateTime*
Type
string
Required
person2.timezone*
Type
string
Required
person2.longitude*
Type
string
Required
person2.latitude*
Type
string
Required

Responses​

Chart rendered successfully

image/svg+xml
JSON
[
]

Playground​

Authorization
Variables
Key
Value

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.

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

width*
Type
string
Required
height*
Type
string
Required
person1.dateTime*
Type
string
Required
person1.timezone*
Type
string
Required
person1.longitude*
Type
string
Required
person1.latitude*
Type
string
Required
person2.dateTime*
Type
string
Required
person2.timezone*
Type
string
Required
person2.longitude*
Type
string
Required
person2.latitude*
Type
string
Required

Responses​

Chart rendered successfully

image/png
JSON
[
]

Playground​

Authorization
Variables
Key
Value

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.

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

width*
Type
string
Required
height*
Type
string
Required
location.longitude*
Type
string
Required
location.latitude*
Type
string
Required
location.timezone*
Type
string
Required
dateTime*
Type
string
Required
transit.dateTime*
Type
string
Required
transit.timezone
Type
string
transit.longitude
Type
string
transit.latitude
Type
string
animation.duration*
Type
string
Required
animation.easing
Type
string
Valid values
"linear""easeIn""easeOut""easeInOut""bounce"
animation.loop
Type
string
target.dateTime*
Type
string
Required
target.timezone
Type
string

Responses​

Animated chart rendered successfully

image/svg+xml
JSON
[
]

Playground​

Authorization
Variables
Key
Value

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.

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"data": {
  
  
"type": "organizations",
  
  
"attributes": {
  
  
  
"name": "string",
  
  
  
"organizationType": "individual",
  
  
  
"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.

Type
API 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.

Type
API 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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

memberId*
Type
string
Required
Min Length
1

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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

memberId*
Type
string
Required
Min Length
1

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​


Get Overage Setting​

GET
/api/org/overage

Get the current overage billing setting for the organization.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Responses​

Overage setting

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "organizations",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"allowOverage": true
  
  
}
  
}
}

Playground​

Authorization

Samples​


Toggle Overage Billing​

PATCH
/api/org/overage

Enable or disable overage billing for the current organization.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"data": {
  
  
"type": "organizations",
  
  
"attributes": {
  
  
  
"allowOverage": true
  
  
}
  
}
}

Responses​

Overage setting updated

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "organizations",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"allowOverage": true
  
  
}
  
}
}

Playground​

Authorization
Body

Samples​


Choose Language​

PATCH
/api/org/language

Gold plan users choose their one extra language.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"data": {
  
  
"type": "organizations",
  
  
"attributes": {
  
  
  
"language": "string"
  
  
}
  
}
}

Responses​

Language updated

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "organizations",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"languages": [
  
  
  
  
"string"
  
  
  
]
  
  
}
  
}
}

Playground​

Authorization
Body

Samples​


Get Pinned API Version​

GET
/api/org/api-version

Get the API compatibility date this organization is pinned to. A null pin means requests without an X-Api-Version header get the baseline version.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Responses​

Pinned API version

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "organizations",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"apiVersion": "string",
  
  
  
"effectiveApiVersion": "string",
  
  
  
"baselineApiVersion": "string",
  
  
  
"latestApiVersion": "string"
  
  
}
  
}
}

Playground​

Authorization

Samples​


Pin API Version​

PATCH
/api/org/api-version

Pin the organization to an API compatibility date, or send null to fall back to the baseline version.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"data": {
  
  
"type": "organizations",
  
  
"attributes": {
  
  
  
"apiVersion": "string"
  
  
}
  
}
}

Responses​

Pinned API version updated

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "organizations",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"apiVersion": "string"
  
  
}
  
}
}

Playground​

Authorization
Body

Samples​


Modules​


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.

Type
API 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,
  
  
  
"requiresModules": [
  
  
  
  
"string"
  
  
  
]
  
  
}
  
]
}

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.

Type
API 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.

Type
API 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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

moduleId*
Type
string
Required

Responses​

Check module access

application/json
JSON
{
  
"hasAccess": true
}

Playground​

Authorization
Variables
Key
Value

Samples​


List Available Modules​

GET
/api/public/modules

Get all available modules with pricing information. No authentication required.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Responses​

List of all available modules

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

Playground​

Authorization

Samples​


List Subscription Plans​

GET
/api/public/modules/plans

Get all available subscription plans with included modules and pricing. No authentication required.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Responses​

List of all subscription plans

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

Playground​

Authorization

Samples​


Calculate Custom Price​

POST
/api/public/modules/calculate-price

Calculate the total price for a custom selection of modules. No authentication required.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Responses​

Calculated price information

application/json
JSON
{
  
"moduleIds": [
  
  
"string"
  
],
  
"totalPriceCents": 0,
  
"modules": [
  
  
{
  
  
  
"id": "string",
  
  
  
"name": "string",
  
  
  
"priceCents": 0
  
  
}
  
]
}

Playground​

Authorization

Samples​


Get Invitation Details​

GET
/api/public/invitations/{id}

Look up a pending organization invitation by id. Used by the accept-invitation page to render the form before the invitee has signed up.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
Required

Responses​

Invitation details

application/json
JSON
{
  
"data": {
  
  
"id": "string",
  
  
"email": "string",
  
  
"role": "string",
  
  
"status": "string",
  
  
"expiresAt": "string",
  
  
"organization": {
  
  
  
"id": "string",
  
  
  
"name": "string"
  
  
},
  
  
"inviter": {
  
  
  
"name": "string",
  
  
  
"email": "string"
  
  
}
  
}
}

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.

Type
API 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.

Type
API 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 feature permissions for configuring API keys.

Authorizations​

ApiKeyAuth

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

Type
API 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.

Type
API 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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
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}

Delete an API key and revoke it. The key disappears from the API immediately; tokens already issued for it stop working within a few minutes, once the revocation list has been refreshed.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
Required

Responses​

API key deleted

Playground​

Authorization
Variables
Key
Value

Samples​


Update API Key​

PATCH
/api/api-keys/{id}

Update an API key's settings. The key is rotated: a new key with a new id is returned once, and the previous key is revoked.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
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 and regenerated

application/json
JSON
{
  
"data": {
  
  
"id": "string",
  
  
"key": "string",
  
  
"name": "string",
  
  
"prefix": "string",
  
  
"organizationId": "string",
  
  
"permissions": [
  
  
  
"string"
  
  
],
  
  
"modules": [
  
  
  
"string"
  
  
],
  
  
"expiresAt": "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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

date*
Type
string
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": {
  
  
  
  
  
"sign": "string",
  
  
  
  
  
"title": "string",
  
  
  
  
  
"body": "string",
  
  
  
  
  
"metadata": {
  
  
  
  
  
  
"additionalProperties": null
  
  
  
  
  
}
  
  
  
  
}
  
  
  
}
  
  
}
  
}
}

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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

year*
Type
string
Required
Pattern
"^\\d{4}$"
week*
Type
string
Required
Pattern
"^(0[1-9]|[1-4]\\d|5[0-3])$"
zodiacSign*
Type
string
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": {
  
  
  
  
"additionalProperties": 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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

year*
Type
string
Required
Pattern
"^\\d{4}$"
zodiacSign*
Type
string
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": {
  
  
  
  
"additionalProperties": 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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

year*
Type
string
Required
Pattern
"^\\d{4}$"
zodiacSign*
Type
string
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": {
  
  
  
  
"additionalProperties": 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.

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"dateTime": "string",
  
"fullName": "string",
  
"language": "en",
  
"includeText": false
}

Responses​

Complete numerology profile

application/vnd.api+json
JSON
{
  
"data": {
  
  
"lifePathNumber": {
  
  
  
"value": 0,
  
  
  
"isMasterNumber": true,
  
  
  
"isKarmicDebt": true,
  
  
  
"reducedFrom": 0,
  
  
  
"calculation": "string",
  
  
  
"text": {
  
  
  
  
"title": "string",
  
  
  
  
"body": "string"
  
  
  
}
  
  
},
  
  
"expressionNumber": {
  
  
  
"value": 0,
  
  
  
"isMasterNumber": true,
  
  
  
"isKarmicDebt": true,
  
  
  
"reducedFrom": 0,
  
  
  
"calculation": "string",
  
  
  
"text": {
  
  
  
  
"title": "string",
  
  
  
  
"body": "string"
  
  
  
}
  
  
},
  
  
"soulUrgeNumber": {
  
  
  
"value": 0,
  
  
  
"isMasterNumber": true,
  
  
  
"isKarmicDebt": true,
  
  
  
"reducedFrom": 0,
  
  
  
"calculation": "string",
  
  
  
"text": {
  
  
  
  
"title": "string",
  
  
  
  
"body": "string"
  
  
  
}
  
  
},
  
  
"personalityNumber": {
  
  
  
"value": 0,
  
  
  
"isMasterNumber": true,
  
  
  
"isKarmicDebt": true,
  
  
  
"reducedFrom": 0,
  
  
  
"calculation": "string",
  
  
  
"text": {
  
  
  
  
"title": "string",
  
  
  
  
"body": "string"
  
  
  
}
  
  
},
  
  
"birthdayNumber": {
  
  
  
"value": 0,
  
  
  
"isMasterNumber": true,
  
  
  
"isKarmicDebt": true,
  
  
  
"reducedFrom": 0,
  
  
  
"calculation": "string",
  
  
  
"text": {
  
  
  
  
"title": "string",
  
  
  
  
"body": "string"
  
  
  
}
  
  
},
  
  
"personalYear": {
  
  
  
"value": 0,
  
  
  
"isMasterNumber": true,
  
  
  
"isKarmicDebt": true,
  
  
  
"reducedFrom": 0,
  
  
  
"calculation": "string",
  
  
  
"text": {
  
  
  
  
"title": "string",
  
  
  
  
"body": "string"
  
  
  
}
  
  
},
  
  
"personalMonth": {
  
  
  
"value": 0,
  
  
  
"isMasterNumber": true,
  
  
  
"isKarmicDebt": true,
  
  
  
"reducedFrom": 0,
  
  
  
"calculation": "string",
  
  
  
"text": {
  
  
  
  
"title": "string",
  
  
  
  
"body": "string"
  
  
  
}
  
  
},
  
  
"personalDay": {
  
  
  
"value": 0,
  
  
  
"isMasterNumber": true,
  
  
  
"isKarmicDebt": true,
  
  
  
"reducedFrom": 0,
  
  
  
"calculation": "string",
  
  
  
"text": {
  
  
  
  
"title": "string",
  
  
  
  
"body": "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.

Type
API Key (header: X-Api-Key)

Request Body​

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

Responses​

Life Path number calculation

application/vnd.api+json
JSON
{
  
"data": {
  
  
"value": 0,
  
  
"isMasterNumber": true,
  
  
"isKarmicDebt": true,
  
  
"reducedFrom": 0,
  
  
"calculation": "string",
  
  
"text": {
  
  
  
"title": "string",
  
  
  
"body": "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.

Type
API Key (header: X-Api-Key)

Request Body​

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

Responses​

Expression number calculation

application/vnd.api+json
JSON
{
  
"data": {
  
  
"value": 0,
  
  
"isMasterNumber": true,
  
  
"isKarmicDebt": true,
  
  
"reducedFrom": 0,
  
  
"calculation": "string",
  
  
"text": {
  
  
  
"title": "string",
  
  
  
"body": "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.

Type
API Key (header: X-Api-Key)

Request Body​

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

Responses​

Soul Urge number calculation

application/vnd.api+json
JSON
{
  
"data": {
  
  
"value": 0,
  
  
"isMasterNumber": true,
  
  
"isKarmicDebt": true,
  
  
"reducedFrom": 0,
  
  
"calculation": "string",
  
  
"text": {
  
  
  
"title": "string",
  
  
  
"body": "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.

Type
API Key (header: X-Api-Key)

Request Body​

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

Responses​

Personality number calculation

application/vnd.api+json
JSON
{
  
"data": {
  
  
"value": 0,
  
  
"isMasterNumber": true,
  
  
"isKarmicDebt": true,
  
  
"reducedFrom": 0,
  
  
"calculation": "string",
  
  
"text": {
  
  
  
"title": "string",
  
  
  
"body": "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.

Type
API Key (header: X-Api-Key)

Request Body​

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

Responses​

Birthday number calculation

application/vnd.api+json
JSON
{
  
"data": {
  
  
"value": 0,
  
  
"isMasterNumber": true,
  
  
"isKarmicDebt": true,
  
  
"reducedFrom": 0,
  
  
"calculation": "string",
  
  
"text": {
  
  
  
"title": "string",
  
  
  
"body": "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.

Type
API 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",
  
  
  
"text": {
  
  
  
  
"title": "string",
  
  
  
  
"body": "string"
  
  
  
}
  
  
},
  
  
"personalMonth": {
  
  
  
"value": 0,
  
  
  
"isMasterNumber": true,
  
  
  
"isKarmicDebt": true,
  
  
  
"reducedFrom": 0,
  
  
  
"calculation": "string",
  
  
  
"text": {
  
  
  
  
"title": "string",
  
  
  
  
"body": "string"
  
  
  
}
  
  
},
  
  
"personalDay": {
  
  
  
"value": 0,
  
  
  
"isMasterNumber": true,
  
  
  
"isKarmicDebt": true,
  
  
  
"reducedFrom": 0,
  
  
  
"calculation": "string",
  
  
  
"text": {
  
  
  
  
"title": "string",
  
  
  
  
"body": "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.

Type
API 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",
  
  
  
"text": {
  
  
  
  
"title": "string",
  
  
  
  
"body": "string"
  
  
  
}
  
  
},
  
  
"person2LifePath": {
  
  
  
"value": 0,
  
  
  
"isMasterNumber": true,
  
  
  
"isKarmicDebt": true,
  
  
  
"reducedFrom": 0,
  
  
  
"calculation": "string",
  
  
  
"text": {
  
  
  
  
"title": "string",
  
  
  
  
"body": "string"
  
  
  
}
  
  
},
  
  
"compatibilityScore": 0,
  
  
"relationship": "string",
  
  
"description": "string"
  
}
}

Playground​

Authorization
Body

Samples​


Human Design Chart​

POST
/api/human-design/chart

Calculate a complete Human Design bodygraph chart including Type, Strategy, Authority, Profile, Definition, gate activations, channels, and centers.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

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

Responses​

Complete Human Design chart

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "string",
  
  
"strategy": "string",
  
  
"authority": "string",
  
  
"profile": {
  
  
  
"conscious": 0,
  
  
  
"unconscious": 0,
  
  
  
"name": "string"
  
  
},
  
  
"definition": "string",
  
  
"signature": "string",
  
  
"notSelfTheme": "string",
  
  
"incarnationCross": {
  
  
  
"angle": "string",
  
  
  
"name": "string",
  
  
  
"fullName": "string",
  
  
  
"gates": {
  
  
  
  
"personalitySun": 0,
  
  
  
  
"personalityEarth": 0,
  
  
  
  
"designSun": 0,
  
  
  
  
"designEarth": 0
  
  
  
},
  
  
  
"notation": "string"
  
  
},
  
  
"variables": {
  
  
  
"digestion": {
  
  
  
  
"value": "string",
  
  
  
  
"key": "string",
  
  
  
  
"category": "string",
  
  
  
  
"color": 0,
  
  
  
  
"tone": 0,
  
  
  
  
"orientation": "string"
  
  
  
},
  
  
  
"environment": {
  
  
  
  
"value": "string",
  
  
  
  
"key": "string",
  
  
  
  
"category": "string",
  
  
  
  
"color": 0,
  
  
  
  
"tone": 0,
  
  
  
  
"orientation": "string"
  
  
  
},
  
  
  
"motivation": {
  
  
  
  
"value": "string",
  
  
  
  
"key": "string",
  
  
  
  
"category": "string",
  
  
  
  
"color": 0,
  
  
  
  
"tone": 0,
  
  
  
  
"orientation": "string"
  
  
  
},
  
  
  
"perspective": {
  
  
  
  
"value": "string",
  
  
  
  
"key": "string",
  
  
  
  
"category": "string",
  
  
  
  
"color": 0,
  
  
  
  
"tone": 0,
  
  
  
  
"orientation": "string"
  
  
  
},
  
  
  
"designSense": {
  
  
  
  
"value": "string",
  
  
  
  
"key": "string",
  
  
  
  
"category": "string",
  
  
  
  
"color": 0,
  
  
  
  
"tone": 0,
  
  
  
  
"orientation": "string"
  
  
  
}
  
  
},
  
  
"birthDate": "string",
  
  
"designDate": "string",
  
  
"personality": [
  
  
  
{
  
  
  
  
"planet": "string",
  
  
  
  
"gate": 0,
  
  
  
  
"line": 0,
  
  
  
  
"color": 0,
  
  
  
  
"tone": 0,
  
  
  
  
"base": 0,
  
  
  
  
"longitude": 0,
  
  
  
  
"retrograde": true
  
  
  
}
  
  
],
  
  
"design": [
  
  
  
{
  
  
  
  
"planet": "string",
  
  
  
  
"gate": 0,
  
  
  
  
"line": 0,
  
  
  
  
"color": 0,
  
  
  
  
"tone": 0,
  
  
  
  
"base": 0,
  
  
  
  
"longitude": 0,
  
  
  
  
"retrograde": true
  
  
  
}
  
  
],
  
  
"centers": {
  
  
  
"additionalProperties": {
  
  
  
  
"status": "string",
  
  
  
  
"gates": [
  
  
  
  
  
0
  
  
  
  
]
  
  
  
}
  
  
},
  
  
"definedChannels": [
  
  
  
{
  
  
  
  
"gate1": 0,
  
  
  
  
"gate2": 0,
  
  
  
  
"center1": "string",
  
  
  
  
"center2": "string",
  
  
  
  
"name": "string",
  
  
  
  
"personality": true,
  
  
  
  
"design": true
  
  
  
}
  
  
],
  
  
"activatedGates": [
  
  
  
0
  
  
],
  
  
"texts": {
  
  
  
"type": {
  
  
  
  
"urn": "string",
  
  
  
  
"title": "string",
  
  
  
  
"body": "string"
  
  
  
},
  
  
  
"strategy": {
  
  
  
  
"urn": "string",
  
  
  
  
"title": "string",
  
  
  
  
"body": "string"
  
  
  
},
  
  
  
"authority": {
  
  
  
  
"urn": "string",
  
  
  
  
"title": "string",
  
  
  
  
"body": "string"
  
  
  
},
  
  
  
"profile": {
  
  
  
  
"urn": "string",
  
  
  
  
"title": "string",
  
  
  
  
"body": "string"
  
  
  
},
  
  
  
"definition": {
  
  
  
  
"urn": "string",
  
  
  
  
"title": "string",
  
  
  
  
"body": "string"
  
  
  
},
  
  
  
"centers": {
  
  
  
  
"additionalProperties": {
  
  
  
  
  
"urn": "string",
  
  
  
  
  
"title": "string",
  
  
  
  
  
"body": "string"
  
  
  
  
}
  
  
  
},
  
  
  
"channels": {
  
  
  
  
"additionalProperties": {
  
  
  
  
  
"urn": "string",
  
  
  
  
  
"title": "string",
  
  
  
  
  
"body": "string"
  
  
  
  
}
  
  
  
},
  
  
  
"gates": {
  
  
  
  
"additionalProperties": {
  
  
  
  
  
"urn": "string",
  
  
  
  
  
"title": "string",
  
  
  
  
  
"body": "string"
  
  
  
  
}
  
  
  
}
  
  
}
  
}
}

Playground​

Authorization
Body

Samples​


Render Bodygraph (SVG)​

GET
/api/human-design/chart.svg

Render a Human Design bodygraph chart as SVG.

Required parameters:

  • dateTime: Birth date/time (YYYY-MM-DDTHH:mm, local time)
  • latitude, longitude: Birth location
  • timezone: IANA timezone identifier

Theme presets:
Use ?theme=<preset> to select a theme: default, dark, classic, minimal

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

dateTime*

Birth date and time in YYYY-MM-DDTHH:mm format (local time)

Type
string
Required
latitude*

Birth latitude

Type
number
Required
Minimum
-90
Maximum
90
longitude*

Birth longitude

Type
number
Required
Minimum
-180
Maximum
180
timezone*

IANA timezone identifier (e.g. "Europe/Amsterdam")

Type
string
Required
width
Type
number
Minimum
100
Maximum
2000
Default
"576"
height
Type
number
Minimum
100
Maximum
2000
Default
"480"
theme

Theme preset: default, dark, classic, minimal

Type
string
showPlanets

Render Design/Personality planet columns (default true)

Type
string
Default
"true"

Responses​

Bodygraph SVG

image/svg+xml
JSON
[
]

Playground​

Authorization
Variables
Key
Value

Samples​


Render Bodygraph (PNG)​

GET
/api/human-design/chart.png

Render a Human Design bodygraph chart as PNG.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

dateTime*

Birth date and time in YYYY-MM-DDTHH:mm format (local time)

Type
string
Required
latitude*

Birth latitude

Type
number
Required
Minimum
-90
Maximum
90
longitude*

Birth longitude

Type
number
Required
Minimum
-180
Maximum
180
timezone*

IANA timezone identifier (e.g. "Europe/Amsterdam")

Type
string
Required
width
Type
number
Minimum
100
Maximum
2000
Default
"576"
height
Type
number
Minimum
100
Maximum
2000
Default
"480"
theme

Theme preset: default, dark, classic, minimal

Type
string
showPlanets

Render Design/Personality planet columns (default true)

Type
string
Default
"true"

Responses​

Bodygraph PNG

image/png
JSON
[
]

Playground​

Authorization
Variables
Key
Value

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.

Type
API 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.

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"data": {
  
  
"type": "chatbots",
  
  
"attributes": {
  
  
  
"name": "string",
  
  
  
"description": "string",
  
  
  
"enabledPlugins": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"settings": {
  
  
  
  
"fasterResponse": true
  
  
  
},
  
  
  
"widgetConfig": {
  
  
  
  
"additionalProperties": null
  
  
  
},
  
  
  
"allowedDomains": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"ipRateLimitMax": 0,
  
  
  
"ipRateLimitWindow": 0
  
  
}
  
}
}

Responses​

Created chatbot

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Body

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.

Type
API Key (header: X-Api-Key)

Responses​

List of plugins

application/vnd.api+json
JSON
[
]

Playground​

Authorization

Samples​


List Available Plugins for Organization​

GET
/api/chatbots/available-plugins

List chatbot plugins available to the current organization based on their subscribed modules

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Responses​

List of available plugins

application/vnd.api+json
JSON
[
]

Playground​

Authorization

Samples​


Get Monthly Chatbot Usage​

GET
/api/chatbots/usage/monthly

Get chatbot usage statistics per month for the current organization

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Responses​

Monthly usage statistics

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.

Type
API Key (header: X-Api-Key)

Responses​

Usage statistics

application/vnd.api+json
JSON
[
]

Playground​

Authorization

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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
Required

Request Body​

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

Responses​

Updated chatbot

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Get Chatbot Usage Statistics​

GET
/api/chatbots/{id}/usage

Get usage statistics for a specific chatbot in the current month

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
Required

Responses​

Usage statistics

application/vnd.api+json
JSON
[
]

Playground​

Authorization
Variables
Key
Value

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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
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": null
  
  
  
}
  
  
}
  
}
}

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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
Required
profileId*
Type
string
Required

Responses​

Profile deleted

Playground​

Authorization
Variables
Key
Value

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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

chatbotId*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

chatbotId*
Type
string
Required
profileId*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

chatbotId*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

chatbotId*
Type
string
Required
conversationId*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

chatbotId*
Type
string
Required
conversationId*
Type
string
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). Pagination is opt-in: pass page[size] and/or page[number] (zero-based) to receive a slice with meta.page, meta.pageSize and links.next. Without them the full list is returned.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

page[size]

Templates per page (default 10, max 100). Enables pagination.

Type
integer
Minimum
1
Maximum
100
page[number]

Zero-based page number (default 0). Enables pagination.

Type
integer
Minimum
0

Responses​

List of PDF templates

application/vnd.api+json
JSON
{
  
"data": [
  
  
{
  
  
  
"type": "pdf-template",
  
  
  
"id": "string",
  
  
  
"attributes": {
  
  
  
  
"organizationId": "string",
  
  
  
  
"name": "string",
  
  
  
  
"description": "string",
  
  
  
  
"reportType": "string",
  
  
  
  
"editorConfig": {
  
  
  
  
  
"additionalProperties": null
  
  
  
  
},
  
  
  
  
"pageSettings": {
  
  
  
  
  
"additionalProperties": null
  
  
  
  
},
  
  
  
  
"customCss": "string",
  
  
  
  
"isDefault": true,
  
  
  
  
"isActive": true,
  
  
  
  
"version": 0,
  
  
  
  
"createdAt": "string",
  
  
  
  
"updatedAt": "string"
  
  
  
}
  
  
}
  
],
  
"meta": {
  
  
"count": 0,
  
  
"total": 0,
  
  
"page": 0,
  
  
"pageSize": 0
  
},
  
"links": {
  
  
"next": "string"
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​


Create PDF Template​

POST
/api/pdf-reports/templates

Create a new PDF template for the organization. Global admins can pass isGlobal: true to create a global template shared by all organizations.

Authorizations​

ApiKeyAuth

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

Type
API 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,
  
  
  
"isGlobal": true
  
  
}
  
}
}

Responses​

Created PDF template

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "pdf-template",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"organizationId": "string",
  
  
  
"name": "string",
  
  
  
"description": "string",
  
  
  
"reportType": "string",
  
  
  
"editorConfig": {
  
  
  
  
"additionalProperties": null
  
  
  
},
  
  
  
"pageSettings": {
  
  
  
  
"additionalProperties": null
  
  
  
},
  
  
  
"customCss": "string",
  
  
  
"isDefault": true,
  
  
  
"isActive": true,
  
  
  
"version": 0,
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string"
  
  
}
  
}
}

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.

Type
API Key (header: X-Api-Key)

Responses​

List of global PDF templates

application/vnd.api+json
JSON
{
  
"data": [
  
  
{
  
  
  
"type": "pdf-template",
  
  
  
"id": "string",
  
  
  
"attributes": {
  
  
  
  
"organizationId": "string",
  
  
  
  
"name": "string",
  
  
  
  
"description": "string",
  
  
  
  
"reportType": "string",
  
  
  
  
"editorConfig": {
  
  
  
  
  
"additionalProperties": null
  
  
  
  
},
  
  
  
  
"pageSettings": {
  
  
  
  
  
"additionalProperties": null
  
  
  
  
},
  
  
  
  
"customCss": "string",
  
  
  
  
"isDefault": true,
  
  
  
  
"isActive": true,
  
  
  
  
"version": 0,
  
  
  
  
"createdAt": "string",
  
  
  
  
"updatedAt": "string"
  
  
  
}
  
  
}
  
],
  
"meta": {
  
  
"count": 0,
  
  
"total": 0,
  
  
"page": 0,
  
  
"pageSize": 0
  
},
  
"links": {
  
  
"next": "string"
  
}
}

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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
Required

Responses​

PDF template details

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "pdf-template",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"organizationId": "string",
  
  
  
"name": "string",
  
  
  
"description": "string",
  
  
  
"reportType": "string",
  
  
  
"editorConfig": {
  
  
  
  
"additionalProperties": null
  
  
  
},
  
  
  
"pageSettings": {
  
  
  
  
"additionalProperties": null
  
  
  
},
  
  
  
"customCss": "string",
  
  
  
"isDefault": true,
  
  
  
"isActive": true,
  
  
  
"version": 0,
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string"
  
  
}
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​


Delete PDF Template​

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

Delete a PDF template. Global templates can only be deleted by global admins.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
Required

Responses​

Template deleted

Playground​

Authorization
Variables
Key
Value

Samples​


Update PDF Template​

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

Update an existing PDF template. The report type is fixed after creation. Global templates can only be updated by global admins.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
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
{
  
"data": {
  
  
"type": "pdf-template",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"organizationId": "string",
  
  
  
"name": "string",
  
  
  
"description": "string",
  
  
  
"reportType": "string",
  
  
  
"editorConfig": {
  
  
  
  
"additionalProperties": null
  
  
  
},
  
  
  
"pageSettings": {
  
  
  
  
"additionalProperties": null
  
  
  
},
  
  
  
"customCss": "string",
  
  
  
"isDefault": true,
  
  
  
"isActive": true,
  
  
  
"version": 0,
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string"
  
  
}
  
}
}

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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
Required

Responses​

Duplicated PDF template

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "pdf-template",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"organizationId": "string",
  
  
  
"name": "string",
  
  
  
"description": "string",
  
  
  
"reportType": "string",
  
  
  
"editorConfig": {
  
  
  
  
"additionalProperties": null
  
  
  
},
  
  
  
"pageSettings": {
  
  
  
  
"additionalProperties": null
  
  
  
},
  
  
  
"customCss": "string",
  
  
  
"isDefault": true,
  
  
  
"isActive": true,
  
  
  
"version": 0,
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string"
  
  
}
  
}
}

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. Global admins can also set a global template as the global default.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
Required

Responses​

Template set as default

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "pdf-template",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"organizationId": "string",
  
  
  
"name": "string",
  
  
  
"description": "string",
  
  
  
"reportType": "string",
  
  
  
"editorConfig": {
  
  
  
  
"additionalProperties": null
  
  
  
},
  
  
  
"pageSettings": {
  
  
  
  
"additionalProperties": null
  
  
  
},
  
  
  
"customCss": "string",
  
  
  
"isDefault": true,
  
  
  
"isActive": true,
  
  
  
"version": 0,
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string"
  
  
}
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​


Generate PDF Report​

POST
/api/pdf-reports/generate

Generate a PDF report based on astrology calculations. transitDate (alias: targetDate) selects the date for transit, return and progression reports.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"reportType": "string",
  
"templateId": "string",
  
"language": "en",
  
"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
  
},
  
"targetDate": {
  
  
"year": 0,
  
  
"month": 0,
  
  
"day": 0,
  
  
"hour": 0,
  
  
"minute": 0
  
},
  
"options": {
  
  
"houseSystem": "string",
  
  
"pointsToCalculate": [
  
  
  
"string"
  
  
]
  
}
}

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. Pass either templateId for a saved template or draft for an unsaved one (exactly one of the two).

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"templateId": "string",
  
"draft": {
  
  
"reportType": "string",
  
  
"editorConfig": "string",
  
  
"pageSettings": "string",
  
  
"customCss": "string"
  
},
  
"sampleData": {
  
  
"additionalProperties": 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.

Type
API 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.

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"data": {
  
  
"type": "widgets",
  
  
"attributes": {
  
  
  
"name": "string",
  
  
  
"widgetType": "string",
  
  
  
"customization": {
  
  
  
  
"colors": {
  
  
  
  
  
"primary": "string",
  
  
  
  
  
"secondary": "string",
  
  
  
  
  
"background": "string",
  
  
  
  
  
"surface": "string",
  
  
  
  
  
"text": "string",
  
  
  
  
  
"textSecondary": "string",
  
  
  
  
  
"border": "string",
  
  
  
  
  
"error": "string",
  
  
  
  
  
"success": "string",
  
  
  
  
  
"accent": "string"
  
  
  
  
},
  
  
  
  
"fonts": {
  
  
  
  
  
"family": "string",
  
  
  
  
  
"sizeBase": 0,
  
  
  
  
  
"sizeScale": 0,
  
  
  
  
  
"sizeHeading": 0,
  
  
  
  
  
"sizeSmall": 0,
  
  
  
  
  
"weightNormal": 0,
  
  
  
  
  
"weightBold": 0
  
  
  
  
},
  
  
  
  
"borders": {
  
  
  
  
  
"radius": 0,
  
  
  
  
  
"width": 0,
  
  
  
  
  
"style": "string"
  
  
  
  
},
  
  
  
  
"spacing": {
  
  
  
  
  
"padding": 0,
  
  
  
  
  
"margin": 0
  
  
  
  
},
  
  
  
  
"shadows": {
  
  
  
  
  
"preset": "string",
  
  
  
  
  
"custom": "string"
  
  
  
  
},
  
  
  
  
"layout": {
  
  
  
  
  
"variant": "string"
  
  
  
  
},
  
  
  
  
"interaction": {
  
  
  
  
  
"tooltipEnabled": true,
  
  
  
  
  
"animationsEnabled": true,
  
  
  
  
  
"clickThroughEnabled": true,
  
  
  
  
  
"clickThroughUrl": "string"
  
  
  
  
},
  
  
  
  
"chartSettings": {
  
  
  
  
  
"additionalProperties": null
  
  
  
  
},
  
  
  
  
"labels": {
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
},
  
  
  
  
"language": "string",
  
  
  
  
"branding": {
  
  
  
  
  
"showPoweredBy": true,
  
  
  
  
  
"logoUrl": "string",
  
  
  
  
  
"companyName": "string"
  
  
  
  
},
  
  
  
  
"customCss": "string",
  
  
  
  
"widgetOptions": {
  
  
  
  
  
"showAspects": true,
  
  
  
  
  
"showPoints": true,
  
  
  
  
  
"showHouses": true,
  
  
  
  
  
"chartSize": "string",
  
  
  
  
  
"theme": "string"
  
  
  
  
},
  
  
  
  
"numerologyOptions": {
  
  
  
  
  
"showLifePath": true,
  
  
  
  
  
"showExpression": true,
  
  
  
  
  
"showSoulUrge": true,
  
  
  
  
  
"showPersonality": true,
  
  
  
  
  
"showBirthday": true,
  
  
  
  
  
"showPersonalCycles": true
  
  
  
  
},
  
  
  
  
"dailyHoroscopeOptions": {
  
  
  
  
  
"autoRefresh": true
  
  
  
  
},
  
  
  
  
"moonCalendarOptions": {
  
  
  
  
  
"showMoonrise": true,
  
  
  
  
  
"showMoonset": true,
  
  
  
  
  
"showIllumination": true,
  
  
  
  
  
"showPhaseEmoji": true,
  
  
  
  
  
"highlightFullMoon": true,
  
  
  
  
  
"highlightNewMoon": true
  
  
  
  
},
  
  
  
  
"compatibilityOptions": {
  
  
  
  
  
"showScore": true,
  
  
  
  
  
"showDescription": true,
  
  
  
  
  
"showLifePaths": true
  
  
  
  
}
  
  
  
},
  
  
  
"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.

Type
API 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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
Required

Request Body​

application/json
JSON
{
  
"data": {
  
  
"type": "widgets",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"name": "string",
  
  
  
"customization": {
  
  
  
  
"colors": {
  
  
  
  
  
"primary": "string",
  
  
  
  
  
"secondary": "string",
  
  
  
  
  
"background": "string",
  
  
  
  
  
"surface": "string",
  
  
  
  
  
"text": "string",
  
  
  
  
  
"textSecondary": "string",
  
  
  
  
  
"border": "string",
  
  
  
  
  
"error": "string",
  
  
  
  
  
"success": "string",
  
  
  
  
  
"accent": "string"
  
  
  
  
},
  
  
  
  
"fonts": {
  
  
  
  
  
"family": "string",
  
  
  
  
  
"sizeBase": 0,
  
  
  
  
  
"sizeScale": 0,
  
  
  
  
  
"sizeHeading": 0,
  
  
  
  
  
"sizeSmall": 0,
  
  
  
  
  
"weightNormal": 0,
  
  
  
  
  
"weightBold": 0
  
  
  
  
},
  
  
  
  
"borders": {
  
  
  
  
  
"radius": 0,
  
  
  
  
  
"width": 0,
  
  
  
  
  
"style": "string"
  
  
  
  
},
  
  
  
  
"spacing": {
  
  
  
  
  
"padding": 0,
  
  
  
  
  
"margin": 0
  
  
  
  
},
  
  
  
  
"shadows": {
  
  
  
  
  
"preset": "string",
  
  
  
  
  
"custom": "string"
  
  
  
  
},
  
  
  
  
"layout": {
  
  
  
  
  
"variant": "string"
  
  
  
  
},
  
  
  
  
"interaction": {
  
  
  
  
  
"tooltipEnabled": true,
  
  
  
  
  
"animationsEnabled": true,
  
  
  
  
  
"clickThroughEnabled": true,
  
  
  
  
  
"clickThroughUrl": "string"
  
  
  
  
},
  
  
  
  
"chartSettings": {
  
  
  
  
  
"additionalProperties": null
  
  
  
  
},
  
  
  
  
"labels": {
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
},
  
  
  
  
"language": "string",
  
  
  
  
"branding": {
  
  
  
  
  
"showPoweredBy": true,
  
  
  
  
  
"logoUrl": "string",
  
  
  
  
  
"companyName": "string"
  
  
  
  
},
  
  
  
  
"customCss": "string",
  
  
  
  
"widgetOptions": {
  
  
  
  
  
"showAspects": true,
  
  
  
  
  
"showPoints": true,
  
  
  
  
  
"showHouses": true,
  
  
  
  
  
"chartSize": "string",
  
  
  
  
  
"theme": "string"
  
  
  
  
},
  
  
  
  
"numerologyOptions": {
  
  
  
  
  
"showLifePath": true,
  
  
  
  
  
"showExpression": true,
  
  
  
  
  
"showSoulUrge": true,
  
  
  
  
  
"showPersonality": true,
  
  
  
  
  
"showBirthday": true,
  
  
  
  
  
"showPersonalCycles": true
  
  
  
  
},
  
  
  
  
"dailyHoroscopeOptions": {
  
  
  
  
  
"autoRefresh": true
  
  
  
  
},
  
  
  
  
"moonCalendarOptions": {
  
  
  
  
  
"showMoonrise": true,
  
  
  
  
  
"showMoonset": true,
  
  
  
  
  
"showIllumination": true,
  
  
  
  
  
"showPhaseEmoji": true,
  
  
  
  
  
"highlightFullMoon": true,
  
  
  
  
  
"highlightNewMoon": true
  
  
  
  
},
  
  
  
  
"compatibilityOptions": {
  
  
  
  
  
"showScore": true,
  
  
  
  
  
"showDescription": true,
  
  
  
  
  
"showLifePaths": true
  
  
  
  
}
  
  
  
},
  
  
  
"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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Type
string
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 Daily Horoscope​

POST
/api/widget-api/daily-horoscope/{widgetId}

Get daily horoscope for a zodiac sign via embedded widget

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Type
string
Required

Request Body​

application/json
JSON
{
  
"zodiacSign": "string",
  
"date": "string"
}

Responses​

Daily horoscope data

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Calculate Numerology​

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

Calculate numerology profile via embedded widget

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Type
string
Required

Request Body​

application/json
JSON
{
  
"fullName": "string",
  
"birthYear": 0,
  
"birthMonth": 0,
  
"birthDay": 0
}

Responses​

Numerology data

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Calculate Compatibility​

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

Calculate numerology-based compatibility via embedded widget

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Type
string
Required

Request Body​

application/json
JSON
{
  
"person1": {
  
  
"fullName": "string",
  
  
"birthYear": 0,
  
  
"birthMonth": 0,
  
  
"birthDay": 0
  
},
  
"person2": {
  
  
"fullName": "string",
  
  
"birthYear": 0,
  
  
"birthMonth": 0,
  
  
"birthDay": 0
  
}
}

Responses​

Compatibility data

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Get Moon Calendar​

POST
/api/widget-api/moon-calendar/{widgetId}

Get moon phase data for a full month via embedded widget

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Type
string
Required

Request Body​

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

Responses​

Moon calendar data

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Chart as Sound​

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

Render a birth chart as audio for an embedded player.

Answers with a signed audio URL and the time axis of the piece, not with bytes — the widget
puts the URL in an <audio src> and the browser fetches it without any header. That keeps
the embed to one counted request and keeps the mapping, which is the part worth protecting,
out of the page entirely.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Type
string
Required

Request Body​

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

Responses​

Signed audio URL and marker timeline

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Search Places​

GET
/api/widget-api/geocoding/search/{widgetId}

Search for places by name via embedded widget. Returns coordinates and timezone.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

widgetId*
Type
string
Required

Query Parameters

q*
Type
string
Required
Min Length
2
Max Length
100
limit
Type
string
lang
Type
string

Responses​

List of matching places

Playground​

Authorization
Variables
Key
Value

Samples​


Get Widget Configuration​

GET
/widget/config/{chatbotId}

Get the widget configuration for embedding

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

chatbotId*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

chatbotId*
Type
string
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.

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

chatbotId*
Type
string
Required
externalUserId*
Type
string
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​


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.

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

q*
Type
string
Required
Min Length
2
Max Length
100
limit
Type
string
lang
Type
string
api
Type
string

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",
  
  
  
"timezone": "string",
  
  
  
"city": "string"
  
  
}
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​


Render Astrocartography Map (SVG)​

GET
/api/astrocartography/map.svg

Render an astrocartography world map showing planetary lines for a birth moment.

Each line shows where a planet is angular (conjunct an angle) at that moment:

  • MC lines (solid vertical): Where the planet culminates (on the Midheaven)
  • IC lines (dashed vertical): Where the planet is at the lowest point (Imum Coeli)
  • ASC lines (solid curved): Where the planet is rising (on the Ascendant)
  • DSC lines (dashed curved): Where the planet is setting (on the Descendant)

Required parameters:

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

Optional parameters:

  • width, height: Map dimensions (default: 1200x600)
  • projection: Map projection (equirectangular, naturalEarth1, mercator)
  • showLabels, showLegend, showGraticule: Toggle map features (true/false)
  • backgroundColor, landColor, oceanColor, borderColor, graticuleColor: Custom colors (hex)
  • lineWidth: Line thickness in pixels

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

dateTime*

Birth date/time (YYYY-MM-DDTHH:mm)

Type
string
Required
location.longitude*

Birth longitude in decimal degrees

Type
string
Required
location.latitude*

Birth latitude in decimal degrees

Type
string
Required
location.timezone*

IANA timezone identifier

Type
string
Required
width

Map width in pixels

Type
string
Default
"1200"
height

Map height in pixels

Type
string
Default
"600"
projection

Map projection type

Type
string
Valid values
"equirectangular""naturalEarth1""mercator"
Default
"equirectangular"
showLabels

Show planet line labels

Type
string
Default
"true"
showLegend

Show planet legend

Type
string
Default
"true"
showGraticule

Show grid lines

Type
string
Default
"true"
backgroundColor

Background color (hex)

Type
string
landColor

Land color (hex)

Type
string
oceanColor

Ocean color (hex)

Type
string
borderColor

Country border color (hex)

Type
string
graticuleColor

Graticule grid line color (hex)

Type
string
lineWidth

Line width in pixels

Type
string

Responses​

Astrocartography map rendered successfully

image/svg+xml
JSON
[
]

Playground​

Authorization
Variables
Key
Value

Samples​


Render Astrocartography Map (PNG)​

GET
/api/astrocartography/map.png

Render an astrocartography world map showing planetary lines for a birth moment.

Each line shows where a planet is angular (conjunct an angle) at that moment:

  • MC lines (solid vertical): Where the planet culminates (on the Midheaven)
  • IC lines (dashed vertical): Where the planet is at the lowest point (Imum Coeli)
  • ASC lines (solid curved): Where the planet is rising (on the Ascendant)
  • DSC lines (dashed curved): Where the planet is setting (on the Descendant)

Required parameters:

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

Optional parameters:

  • width, height: Map dimensions (default: 1200x600)
  • projection: Map projection (equirectangular, naturalEarth1, mercator)
  • showLabels, showLegend, showGraticule: Toggle map features (true/false)
  • backgroundColor, landColor, oceanColor, borderColor, graticuleColor: Custom colors (hex)
  • lineWidth: Line thickness in pixels

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

dateTime*

Birth date/time (YYYY-MM-DDTHH:mm)

Type
string
Required
location.longitude*

Birth longitude in decimal degrees

Type
string
Required
location.latitude*

Birth latitude in decimal degrees

Type
string
Required
location.timezone*

IANA timezone identifier

Type
string
Required
width

Map width in pixels

Type
string
Default
"1200"
height

Map height in pixels

Type
string
Default
"600"
projection

Map projection type

Type
string
Valid values
"equirectangular""naturalEarth1""mercator"
Default
"equirectangular"
showLabels

Show planet line labels

Type
string
Default
"true"
showLegend

Show planet legend

Type
string
Default
"true"
showGraticule

Show grid lines

Type
string
Default
"true"
backgroundColor

Background color (hex)

Type
string
landColor

Land color (hex)

Type
string
oceanColor

Ocean color (hex)

Type
string
borderColor

Country border color (hex)

Type
string
graticuleColor

Graticule grid line color (hex)

Type
string
lineWidth

Line width in pixels

Type
string

Responses​

Astrocartography map rendered successfully

image/png
JSON
[
]

Playground​

Authorization
Variables
Key
Value

Samples​


Calculate Astrocartography Lines (JSON)​

GET
/api/astrocartography/lines

Calculate astrocartography line data without rendering.
Returns the raw line coordinates for each planet and angle type,
useful for custom rendering or integration with mapping libraries.

Required parameters:

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

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

dateTime*

Birth date/time (YYYY-MM-DDTHH:mm)

Type
string
Required
location.longitude*

Birth longitude in decimal degrees

Type
string
Required
location.latitude*

Birth latitude in decimal degrees

Type
string
Required
location.timezone*

IANA timezone identifier

Type
string
Required
width

Map width in pixels

Type
string
Default
"1200"
height

Map height in pixels

Type
string
Default
"600"
projection

Map projection type

Type
string
Valid values
"equirectangular""naturalEarth1""mercator"
Default
"equirectangular"
showLabels

Show planet line labels

Type
string
Default
"true"
showLegend

Show planet legend

Type
string
Default
"true"
showGraticule

Show grid lines

Type
string
Default
"true"
backgroundColor

Background color (hex)

Type
string
landColor

Land color (hex)

Type
string
oceanColor

Ocean color (hex)

Type
string
borderColor

Country border color (hex)

Type
string
graticuleColor

Graticule grid line color (hex)

Type
string
lineWidth

Line width in pixels

Type
string

Responses​

Astrocartography lines calculated successfully

application/json
JSON
{
  
"data": {
  
  
"lines": [
  
  
  
{
  
  
  
  
"planetId": "string",
  
  
  
  
"angleType": "string",
  
  
  
  
"points": [
  
  
  
  
  
[
  
  
  
  
  
]
  
  
  
  
]
  
  
  
}
  
  
]
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​


Natal Chart as Sound (signed URL)​

GET
/api/sound/natal

The same audio as the POST, addressable from an <audio src>.

The URL carries an HMAC over its path and query plus an expiry, so it needs no API key header
— which is the only way this works inside a widget, an email or a page the caller does not
control. Mint one with /api/sound/natal/timeline.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

dateTime*
Type
string
Required
Pattern
"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}$"
location.longitude*
Type
string
Required
location.latitude*
Type
string
Required
location.timezone*
Type
string
Required
houseSystem
Type
string
length
Type
string
q
Type
string
duration
Type
string
p
Type
string
format
Type
string
m
Type
string
expires
Type
string
sig
Type
string

Responses​

The chart, rendered

audio/mpeg
JSON
[
]

Playground​

Authorization
Variables
Key
Value

Samples​


Natal Chart as Sound​

POST
/api/sound/natal

A birth chart rendered as sound.

The chart is turned into a score by a deterministic procedure and synthesised server-side.
What comes back is audio, 45 seconds by default, walking the chart once
from the Ascendant.

It is deterministic. The same birth moment always produces the same file, and no model is
involved at any point.

profile picks how it is rendered: kepler (default) or aurora, a warmer version of
the same chart. length is full (default) or short, and skipSilence cuts the
passages where nothing sounds — the piece is then shorter than the length you asked for.

The sound is not a contract: a better mapping changes what this endpoint returns. The
X-Sound-Mapping response header carries the version that produced the bytes.

For a player that highlights the wheel in step with the audio, use /api/sound/natal/timeline,
which answers with a signed audio URL and the marker timeline in one call.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"dateTime": "string",
  
"location": {
  
  
"longitude": 0,
  
  
"latitude": 0,
  
  
"timezone": "string"
  
},
  
"houseSystem": "placidus",
  
"points": [
  
  
"string"
  
],
  
"length": "full",
  
"duration": 0,
  
"profile": "kepler",
  
"skipSilence": false,
  
"format": "mp3"
}

Responses​

The chart, rendered

audio/mpeg
JSON
[
]

Playground​

Authorization
Body

Samples​


Natal Sound: player payload​

POST
/api/sound/natal/timeline

Everything a player needs in one call: a signed URL an <audio> element can load without headers, and the time axis of the piece.

The markers say when each point sounds and which aspects sound with it — enough to light up
a wheel in step with the audio, and deliberately not enough to reconstruct the mapping. No
frequencies, levels, timbres or ratios appear here.

One counted request, not two: the audio URL is signed, so fetching the bytes is free.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

application/json
JSON
{
  
"dateTime": "string",
  
"location": {
  
  
"longitude": 0,
  
  
"latitude": 0,
  
  
"timezone": "string"
  
},
  
"houseSystem": "placidus",
  
"points": [
  
  
"string"
  
],
  
"length": "full",
  
"duration": 0,
  
"profile": "kepler",
  
"skipSilence": false,
  
"format": "mp3"
}

Responses​

Signed audio URL and marker timeline

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "sound-timeline",
  
  
"attributes": {
  
  
  
"audioUrl": "string",
  
  
  
"format": "string",
  
  
  
"profile": "string",
  
  
  
"duration": 0,
  
  
  
"mappingVersion": 0,
  
  
  
"markers": [
  
  
  
  
{
  
  
  
  
  
"pointId": "string",
  
  
  
  
  
"onset": 0,
  
  
  
  
  
"duration": 0,
  
  
  
  
  
"longitude": 0,
  
  
  
  
  
"aspects": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"partnerId": "string",
  
  
  
  
  
  
  
"aspect": "string"
  
  
  
  
  
  
}
  
  
  
  
  
]
  
  
  
  
}
  
  
  
]
  
  
}
  
}
}

Playground​

Authorization
Body

Samples​


Transits as Sound​

POST
/api/sound/transit

A period of transits over a birth chart, as one piece.

The natal chart is a chord held underneath; every contact a transiting body makes enters wide,
closes to a pure interval on the day it is exact, and opens again. A year becomes a couple of
minutes in which the tension arc of the year is the tension arc of the piece.

One calculation and one render, whatever the length of the period — not one per day. The piece
is capped at 300 seconds and costs a single request, the same as any
other calculation.

Authorizations​

ApiKeyAuth

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

Type
API 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",
  
"points": [
  
  
"string"
  
],
  
"length": "full",
  
"duration": 0,
  
"profile": "kepler",
  
"format": "mp3"
}

Responses​

The period, rendered

audio/mpeg
JSON
[
]

Playground​

Authorization
Body

Samples​


Legacy Natal Chart​

POST
/api/legacy/natal

Accepts the old Bloom API request format and returns the natal chart in the legacy response format.

Authorizations​

ApiKeyAuth

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

Type
API 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​

Natal chart in legacy format

Playground​

Authorization
Body

Samples​


Legacy Synastry​

POST
/api/legacy/synastry

Accepts the old Bloom API request format and returns the synastry aspects in the legacy response format.

Authorizations​

ApiKeyAuth

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

Type
API 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​

Synastry in legacy format

Playground​

Authorization
Body

Samples​


Legacy Composite Chart​

POST
/api/legacy/composite

Accepts the old Bloom API request format and returns the composite chart in the legacy response format.

Authorizations​

ApiKeyAuth

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

Type
API 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​

Composite chart in legacy format

Playground​

Authorization
Body

Samples​


Legacy Transits​

POST
/api/legacy/transits

Accepts the old Bloom API request format and returns the transits in the legacy response format.

Authorizations​

ApiKeyAuth

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

Type
API 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​

Transits in legacy format

Playground​

Authorization
Body

Samples​


Legacy Progressions​

POST
/api/legacy/progressions

Accepts the old Bloom API request format and returns the progressions in the legacy response format.

Authorizations​

ApiKeyAuth

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

Type
API 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​

Progressions in legacy format

Playground​

Authorization
Body

Samples​


Legacy Solar Return​

POST
/api/legacy/solarreturn

Accepts the old Bloom API request format and returns the solar return chart in the legacy response format.

Authorizations​

ApiKeyAuth

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

Type
API 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​

Solar return chart in legacy format

Playground​

Authorization
Body

Samples​


Legacy Lunar Return​

POST
/api/legacy/lunarreturn

Accepts the old Bloom API request format and returns the lunar return chart in the legacy response format.

Authorizations​

ApiKeyAuth

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

Type
API 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​

Lunar return chart in legacy format

Playground​

Authorization
Body

Samples​


Legacy Chinese Forecasts​

POST
/api/legacy/chinese-forecasts

Accepts the old Bloom API request format and returns the Chinese zodiac forecast in the legacy response format.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

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

Responses​

Chinese forecast in legacy format

Playground​

Authorization
Body

Samples​


Legacy Compatibility​

POST
/api/legacy/compatibility

Accepts the old Bloom API request format and returns the compatibility analysis in the legacy response format.

Authorizations​

ApiKeyAuth

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

Type
API 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​

Compatibility analysis in legacy format

Playground​

Authorization
Body

Samples​


Legacy Planet in Sign​

POST
/api/legacy/planetinsign

Accepts the old Bloom API request format and returns the planet-in-sign interpretation in the legacy response format.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

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

Responses​

Planet-in-sign interpretation in legacy format

Playground​

Authorization
Body

Samples​


Legacy Sign to Sign​

POST
/api/legacy/signtosign

Accepts the old Bloom API request format and returns the sign-to-sign compatibility interpretation in the legacy response format.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

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

Responses​

Sign-to-sign interpretation in legacy format

Playground​

Authorization
Body

Samples​


Legacy Weekly Reports​

POST
/api/legacy/weekly-reports

Accepts the old Bloom API request format and returns weekly horoscope reports in the legacy response format.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

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

Responses​

Weekly reports in legacy format

Playground​

Authorization
Body

Samples​


Legacy Monthly Reports​

POST
/api/legacy/monthly-reports

Accepts the old Bloom API request format and returns monthly horoscope reports in the legacy response format.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

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

Responses​

Monthly reports in legacy format

Playground​

Authorization
Body

Samples​


Legacy Yearly Reports​

POST
/api/legacy/yearly-reports

Accepts the old Bloom API request format and returns yearly horoscope reports in the legacy response format.

Authorizations​

ApiKeyAuth

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

Type
API Key (header: X-Api-Key)

Request Body​

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

Responses​

Yearly reports in legacy format

Playground​

Authorization
Body

Samples​


Health​

Operations​


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.

Type
API Key (header: X-Api-Key)

Responses​

API is healthy

Playground​

Authorization

Samples​


Powered by VitePress OpenAPI

AstroAPI Documentation