Western Bulk Match API
AvailableOne person scored against many candidates, paged: score, verdict and aspect counts per candidate; candidates without a birth time are marked approximate.
Call it with POST /v1/western/synastry-bulk. Input: specific input. Output: JSON, as a direct response. Each successful call costs 3 credits.
- Endpoint
- POST /v1/western/synastry-bulk
- Input
- Specific input
- Output
- JSON
- Delivery
- Direct response
- Cost
- 3 credits
- Compute class
- Heavy
Example response
Fields in data (inferred from the example)
name· stringcandidates_submitted· integerscored· integerfailed· integererrors· arraypage· integerpage_size· integerpages· integerhas_more· booleanapproximate_rows· integerresults· array of object
Example response
Captured from the live engine with a sandbox key (so credits_used is 0) and trimmed: long arrays keep their first items and images are replaced by a placeholder.
Loading the example…
Request schema and every field: the Western astrology reference.
Western Bulk Match API: common questions
What does the Western Bulk Match API return?
One person scored against many candidates, paged: score, verdict and aspect counts per candidate; candidates without a birth time are marked approximate. The response's data object includes name, candidates_submitted, scored, failed, errors, page, page_size and pages. See the reference for an example response.
What input does Western Bulk Match need?
Specific input.
How much does a Western Bulk Match call cost?
3 credits per successful call; a failed call is not charged. Plans and top-ups are on the pricing page.
Can I try it before paying?
Yes. Every account gets sandbox keys and trial credits, so you can call it from your own code before choosing a plan.