White-label

Preview White-label Report

Changed on

Render a sample natal report PDF using the authenticated user's white-label configuration (colours, font, footer, logo). Pass chart to use your own birth data; omit to use the bundled Kyiv 1990 sample.

post/whitelabel/preview

Request

  • Base URL: https://api.astroway.info/v1
  • URL: https://api.astroway.info/v1/whitelabel/preview
  • Auth: API key in header X-Api-Key

Query parameters

fieldsstring

Comma-separated dotted paths, relative to data, to keep in the response. A path is applied to every element of an array, so planets.name means the name of each planet. Paths that match nothing come back in _fields_unmatched; a list where nothing matches at all is a 400, because an empty object would be a confident wrong answer.

precisioninteger

Round every non-integer number in the response to this many decimal places. Integers are left alone, because an id is not a measurement. Ecliptic longitudes ship with fourteen decimals by default; 2 is about a tenth of an arcminute.

Request body

chartunknown
language'uk' | 'en' | 'de' | 'ru' | 'pl' | 'es' | 'pt' | 'hi' | 'fr' | 'ko' | 'it' | 'ja' | 'id' | 'tr' | 'nl' | 'ro' | 'cs' | 'vi' | 'ar' | 'el' | 'hu'

Response

Successful calculation

okboolean

Example response

{
  "ok": true
}

Changes

  • b64222844186Revision changes
    • info

      added the new optional query request parameter fields

    • info

      added the new optional query request parameter precision