API Documentation
Star Sign Compatibility Report PDF API
The Star Sign Compatibility Report API generates a PDF report that explores compatibility factors between star signs.
It is referenced in the Western Astrology PDF Postman collection, dashboard analytics, and PDF credit configuration. The report supports white-label branding details and returns a PDF URL for download or delivery.
It is referenced in the Western Astrology PDF Postman collection, dashboard analytics, and PDF credit configuration. The report supports white-label branding details and returns a PDF URL for download or delivery.
POST
https://pdf.astrologyapi.com/v1/star_sign_compatibility_reportParameters
| Parameter | Type | Description |
|---|---|---|
| namerequired | string | Name of the user. |
| dayrequired | number | Birth day (1-31). |
| monthrequired | number | Birth month (1-12). |
| yearrequired | number | Birth year. |
| hourrequired | number | Birth hour (0-23). |
| minuterequired | number | Birth minute (0-59). |
| latituderequired | number | Latitude of birth location. |
| longituderequired | number | Longitude of birth location. |
| timezonerequired | number | Timezone offset from UTC in hours. |
| placerequired | string | Birth place. |
| languagerequired | string | PDF language. |
| footer_linkrequired | string | Footer/domain link. |
| logo_urlrequired | string | Company logo URL. |
| company_namerequired | string | Company name. |
| company_inforequired | string | Company information. Should be less than 500 characters. |
| domain_urlrequired | string | Full company domain URL. |
| company_emailrequired | string | Company email. |
| company_landlinerequired | string | Company landline number. |
| company_mobilerequired | string | Company mobile number. |
Sample PDFs
Star Sign Compatibility PDF Samples
Following are the PDF report samples you can download. These generated PDFs are using AstrologyAPI branding and everything can be customised to suit your company branding and style.
Supported Languages
en
Request
{
"name": "Linda Ray",
"day": 6,
"month": 10,
"year": 2001,
"hour": 7,
"minute": 45,
"latitude": 19.2,
"longitude": 25.2,
"timezone": 5.5,
"place": "Mumbai, Maharashtra, India",
"language": "en",
"footer_link": "astrologyapi.com",
"logo_url": "",
"company_name": "astrologyapi",
"company_info": "this is astrologyapi",
"domain_url": "astrologyapi.com",
"company_email": "[email protected]",
"company_landline": "+91- 221232 22",
"company_mobile": "+91 1212 1212 12"
}Code samples
curl --location 'https://pdf.astrologyapi.com/v1/star_sign_compatibility_report' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic <YOUR_API_KEY>' \
--data 'name=Linda%20Ray&day=6&month=10&year=2001&hour=7&minute=45&latitude=19.2&longitude=25.2&timezone=5.5&place=Mumbai%2C%20Maharashtra%2C%20India&language=en&footer_link=astrologyapi.com&logo_url=&company_name=astrologyapi&company_info=this%20is%20astrologyapi&domain_url=astrologyapi.com&company_email=mail%40astrologyapi.com&company_landline=%2B91-%20221232%2022&company_mobile=%2B91%201212%201212%2012'
Response
{
"status": true,
"pdf_url": "https://s3.amazonaws.com/astrologyapi-pdfs/star_sign_compatibility_report_sample.pdf"
}