API


Compatibility

Compatibility text between 2 Zodiac Signs (e.g. Text about compatibility between Aries and Taurus)

Basic Flow

To generate a Compatibility Match from the AstroAPI, the system (your implementation) makes a POST-request to the /api/signtosign endpoint with the necessary parameters. With correct parameters the AstroAPI will provide a Compatibility Match in JSON-format.

Generating Compatibility

POST /api/signtosign

Header Value
Accept-Encoding application/json
Content-Type application/json
Authorization Bearer [accessToken]


body

{
    "sign1_id": 2,
    "sign2_id": 5
}


Params explanation

Header Value
sign1_id Sign ID for the first person
sign2_id Sign ID for the second person

Response

Example response


{
    "sign1Id": 2,
    "sign1Name": "Gemini",
    "sign2Id": 5,
    "sign2Name": "Virgo",
    "text": {
        "user_id": 3,
        "horo_type_id": 6,
        "signs1_id": 2,
        "signs2_id": 5,
        "planet1_id": null,
        "planet2_id": null,
        "house1_id": null,
        "house2_id": null,
        "aspect_id": null,
        "zodiacpoints": null,
        "intro": "Gemini & Virgo",
        "text": "...",
        "strength": 0,
        "lang": "en",
        "horo_texts_types_id": 1,
        "team_id": 1,
        "lang_id": 1
    }
}