{"openapi":"3.1.0","info":{"title":"Numerology API","version":"0.1.0","description":"The Numerology API works out Indian and Western numerology over HTTPS. It returns the mulank (birth day number), the bhagyank (destiny number), the name number and the Lo Shu grid. It also returns life path and the other Western numbers, checks for names and numbers, compatibility, good dates and a printable report. You send a name and a birth date as JSON and get JSON back.\n\n**Base URL:** `https://apiforastrology.com/api/numerology`. Every path in this reference starts with `/v1`. It is the same key and the same plan as the Astrology API.\n\n**Authentication:** send your API key in the `Authorization: Bearer ` header or the `X-API-Key: ` header. Create and revoke keys on the [API keys page](https://apiforastrology.com/account/keys) of your account. Keep the key on your server; do not put it in a web page or app.\n\n**Credits:** every numerology answer is a written reading, so it uses reading credits on live keys, never calls ([pricing](https://apiforastrology.com/pricing)). The language and the length do not change the price. Test keys are never billed and have their own free allowance: 10 calls a minute per key and 1,000 calls a month for all of them. They answer only for the sample people (John Doe, born Aug 15, 1990, and Jane Doe, born Mar 22, 1992), for today or the dates in the docs examples.\n\n**Errors:** every error is JSON in the same shape: `{\"error\": {\"code\": \"...\", \"message\": \"...\", \"field\": \"...\"}}`. `field` is there when one input caused the error.\n\n**Names and dates:** write names in English letters (A to Z); the spelling changes the number, so the API never guesses one. The birth date is the calendar date as it is. Names are read in the Chaldean system, with the Pythagorean numbers beside them. Add `lang` for readings in another language (for example `lang=hi`; `GET /v1/meta` lists every language) and `detail=expanded` for longer ones.\n\n**Reading credits:** each route's price is on its description. Credits are the same in every language, and for standard or longer text. Errors and `GET /v1/health` are free. See [what credits buy](https://apiforastrology.com/pricing#reading-credits)."},"paths":{"/v1/health":{"get":{"tags":["meta"],"summary":"Health check","description":"Returns `{\"status\": \"ok\"}` while the service is running. The only route that needs no API key.","operationId":"health_v1_numerology_health_get","responses":{"200":{"description":"Successful Response. Example from a real call. Long lists and texts are shortened.","content":{"application/json":{"schema":{},"example":{"status":"ok"}}},"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-Calls-Counted":{"$ref":"#/components/headers/X-Calls-Counted"},"X-Reading-Credits-Counted":{"$ref":"#/components/headers/X-Reading-Credits-Counted"},"X-Reading-Credits-Remaining":{"$ref":"#/components/headers/X-Reading-Credits-Remaining"}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/v1/profile":{"post":{"tags":["core"],"summary":"Core numbers and Lo Shu grid","description":"The core numbers for one person, each with a short reading. The **mulank** (birth day number) comes from the day of birth. The **bhagyank** (destiny number) comes from the full date. The **name number** is given in Chaldean (read) and Pythagorean (numbers only, `read: false`). The lucky day, colors and friendly numbers come from the mulank's planet. The **Lo Shu grid** comes with its missing and repeated numbers and its full or empty lines. `loshu.basis` says which digits were placed. `not_included` names what is not computed yet.\n\n**Uses 3 reading credits.** On live keys a successful response uses them from your monthly reading credits, and no calls. Test keys answer for the sample people only, and it counts as 1 test call. [What reading credits buy](https://apiforastrology.com/pricing#reading-credits).","operationId":"profile_v1_numerology_profile_post","parameters":[{"name":"lang","in":"query","required":false,"schema":{"type":"string","pattern":"^(en|hi)$","description":"Language of the readings and names: `en`, `hi`. Codes stay in English.","default":"en","title":"Lang"},"description":"Language of the readings and names: `en`, `hi`. Codes stay in English."},{"name":"detail","in":"query","required":false,"schema":{"type":"string","pattern":"^(standard|expanded)$","description":"Length of the readings: `standard` (the default, short, for app cards) or `expanded` (about three times longer, for reading in full). A passage with no long form yet comes back at standard length and is listed in `localization.fell_back_to_standard`.","default":"standard","title":"Detail"},"description":"Length of the readings: `standard` (the default, short, for app cards) or `expanded` (about three times longer, for reading in full). A passage with no long form yet comes back at standard length and is listed in `localization.fell_back_to_standard`."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Person"},"examples":{"john":{"summary":"John Doe, Aug 15, 1990","value":{"name":"John Doe","birth_date":"1990-08-15"}}}}}},"responses":{"200":{"description":"Successful Response. Example from a real call for John Doe, born Aug 15, 1990. Long lists and texts are shortened.","content":{"application/json":{"schema":{},"example":{"input":{"name":"John Doe","birth_date":"1990-08-15"},"mulank":{"number":6,"planet":"Venus","planet_name":"Venus","about":"Your mulank (birth day number) comes from the day you were born. It shows how you act day to day and how people first see you.","reading":"You care about home, family and things that look good. People feel welcome around you. Watch for spending too much on comfort.","topics":[{"facet":"nature","title":"Nature","text":"Mulank 6 is ruled by Venus. You care about home, family and things that look good. People feel welcome around you, and you often keep peace in a group. You…"},{"facet":"career","title":"Career","text":"You tend to work best in a pleasant place where you can make things better for people. You often have taste and a gift for making people feel at ease. Harsh or…"}]},"bhagyank":{"number":6,"total":33,"master":true,"planet":"Venus","planet_name":"Venus","about":"Your bhagyank (destiny number) comes from your full birth date. It shows the direction your life tends to take as you grow older.","reading":"Your life tends to center on family, love and responsibility. Work linked to beauty, art, care or comfort often suits this path.","topics":[{"facet":"nature","title":"Nature","text":"With Venus behind your bhagyank, care for family and a love of beauty tend to grow with age. You often become the one who brings people together and makes a…"},{"facet":"career","title":"Career","text":"Your path tends to grow around beauty, care and comfort. You often do well in work that makes people's lives nicer or easier. Fields that tend to suit you…"}]},"name_number":{"default_system":"chaldean","chaldean":{"system":"chaldean","name":"John Doe","total":34,"compound":34,"number":7,"master":false,"words":[{"word":"John","total":18,"number":9},{"word":"Doe","total":16,"number":7}],"system_name":"Chaldean","planet":"Ketu","planet_name":"Ketu","about":"Your name number comes from the letters of your name. It shows how your name shapes the way people take you.","reading":"Your name gives a quiet, thoughtful feel. People may see you as private or deep."},"pythagorean":{"system":"pythagorean","name":"John Doe","total":35,"compound":35,"number":8,"master":false,"words":[{"word":"John","total":20,"number":2},{"word":"Doe","total":15,"number":6}],"system_name":"Pythagorean","read":false}},"lucky":{"from":"mulank","planet":"Venus","planet_name":"Venus","day":"Friday","day_name":"Friday","day_via":null,"colors":[{"color":"white","name":"white"},{"color":"pastel pink","name":"pastel pink"}],"numbers":{"friendly":[4,5],"neutral":[3,7],"unfriendly":[1,2]},"dates":[4,5],"dates_about":"Dates of the month that add up to a number friendly to your mulank. They tend to suit starting things."},"remedies":{"from":"mulank","planet":"Venus","planet_name":"Venus","direction":"south-east","direction_name":"South-east","direction_about":"The direction linked to your ruling planet. Facing it for work or study is a common practice.","deity":"Lakshmi","deity_name":"Lakshmi","deity_about":"The deity often worshipped for your ruling planet. Families and regions may follow other customs.","fast_day":"Friday","fast_day_name":"Friday","fast_about":"The weekday of your ruling planet. People who fast for this planet usually keep this day.","gemstone":{"stone":"diamond","metal":"silver or platinum","finger":"middle","caution":null,"stone_name":"Diamond (heera)","metal_name":"silver or platinum","finger_name":"middle finger","about":"The stone linked to your ruling planet. Numbers alone cannot say whether you should wear it, so check your birth chart with an astrologer first."},"mantra":{"key":"venus:beeja","text":"ॐ द्रां द्रीं द्रौं सः शुक्राय नमः","latin":"Om Draam Dreem Draum Sah Shukraya Namah","audio":"shukra-beej-mantra.mp3","daily":108,"japa":16000,"japa_sources":[],"about":"The beej mantra (short seed mantra) of your ruling planet. One round is 108 times. The full count is for a complete practice.","japa_note":null}},"loshu":{"cells":[[{"number":4,"count":0},{"number":9,"count":2}],[{"number":3,"count":0},{"number":5,"count":1}]],"placed":[{"number":1,"from":"date","from_name":"birth date"},{"number":5,"from":"date","from_name":"birth date"}],"missing":[{"number":2,"reading":"2 is missing. You may not always notice how others feel. Slowing down to listen helps."},{"number":3,"reading":"3 is missing. Planning ahead may not come easily. Writing your plans down can help."}],"repeated":[{"number":1,"count":2,"reading":"1 appears more than once. Your self-belief is strong. Too much of it can come across as pride."},{"number":6,"count":2,"reading":"6 appears more than once. You care a lot for home and family. Do not carry everyone's load alone."}],"planes":[{"id":"practical","numbers":[8,1],"state":"full","name":"Practical line","reading":"The practical line is full. You tend to be good with hands-on work and money matters."},{"id":"will","numbers":[9,5],"state":"full","name":"Willpower line","reading":"The willpower line is full. Once you decide, you tend to see it through."}],"basis":"Non-zero digits of the birth date (DD MM YYYY), plus the bhagyank, plus the mulank when the day has two digits. Zero has no cell.","about":"The Lo Shu grid is a 3 by 3 square of the numbers 1 to 9. The digits of your birth date are placed in it. Numbers that are missing or repeated show what comes…","summary":{"strong":[{"from":"number","number":1,"area":"self-belief"},{"from":"number","number":6,"area":"caring for family"}],"effort":[{"from":"number","number":2,"area":"noticing how others feel"},{"from":"number","number":3,"area":"planning ahead"}],"text":"Comes easily to you: self-belief, caring for family, drive, hands-on work and money and seeing things through. Needs more effort: noticing how others feel,…"},"number_tip":{"digits":[2,3],"text":"Many people choose a mobile or vehicle number that has their missing numbers (2, 3, 4 and 7). This is a popular belief, not a promise."},"birth_only":"Your grid comes only from your birth date. Changing your name does not change it."},"not_included":{"compound_meanings":"The compound number (10 to 52) is returned, but not read: its meanings wait for the astrologer.","western_numbers":"Life path, expression, soul urge, pinnacles, life cycles and the personal year come from the western route."},"not_claimed":"Numbers describe tendencies, not fixed events. Use them as a guide, not a rule.","localization":{"lang":"en","detail":"standard","fell_back_to_en":[],"fell_back_to_standard":[]}}}},"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-Calls-Counted":{"$ref":"#/components/headers/X-Calls-Counted"},"X-Reading-Credits-Counted":{"$ref":"#/components/headers/X-Reading-Credits-Counted"},"X-Reading-Credits-Remaining":{"$ref":"#/components/headers/X-Reading-Credits-Remaining"}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"description":"The request is not valid, for example a required field is missing or a date is out of range. `field` names the input to fix.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/v1/name":{"post":{"tags":["names"],"summary":"Name checker","description":"Reads a name, and up to 10 other spellings of it, against the person's mulank and bhagyank. Each spelling gets its Chaldean and Pythagorean numbers and a `fit`: `good`, `neutral`, `mixed` or `difficult`, with the one-sided relation behind it. The rule: a friend and no enemy is good; an enemy and no friend is difficult; one of each is mixed; neither is neutral. Spellings come back in the order sent and are **never ranked**.\n\n**Uses 1 reading credit.** On live keys a successful response uses them from your monthly reading credits, and no calls. Test keys answer for the sample people only, and it counts as 1 test call. [What reading credits buy](https://apiforastrology.com/pricing#reading-credits).","operationId":"name_check_v1_numerology_name_post","parameters":[{"name":"lang","in":"query","required":false,"schema":{"type":"string","pattern":"^(en|hi)$","description":"Language of the readings and names: `en`, `hi`. Codes stay in English.","default":"en","title":"Lang"},"description":"Language of the readings and names: `en`, `hi`. Codes stay in English."},{"name":"detail","in":"query","required":false,"schema":{"type":"string","pattern":"^(standard|expanded)$","description":"Length of the readings: `standard` (the default, short, for app cards) or `expanded` (about three times longer, for reading in full). A passage with no long form yet comes back at standard length and is listed in `localization.fell_back_to_standard`.","default":"standard","title":"Detail"},"description":"Length of the readings: `standard` (the default, short, for app cards) or `expanded` (about three times longer, for reading in full). A passage with no long form yet comes back at standard length and is listed in `localization.fell_back_to_standard`."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NameCheckRequest"},"examples":{"spellings":{"summary":"John Doe and two other spellings","value":{"name":"John Doe","birth_date":"1990-08-15","variants":["Jon Doe","John Dow"]}}}}}},"responses":{"200":{"description":"Successful Response. Example from a real call for John Doe, born Aug 15, 1990, with two other spellings. Long lists and texts are shortened.","content":{"application/json":{"schema":{},"example":{"person":{"birth_date":"1990-08-15","mulank":6,"bhagyank":6},"system":"chaldean","about":"A name is read from its letters.","spellings":[{"name":"John Doe","chaldean":{"total":34,"compound":34,"number":7,"master":false,"words":[{"word":"John","total":18,"number":9},{"word":"Doe","total":16,"number":7}]},"pythagorean":{"total":35,"number":8,"master":false},"planet":"Ketu","planet_name":"Ketu","fit":{"number":7,"links":[{"from":"mulank","from_number":6,"to_number":7,"relation":"neutral","via":["Ketu"],"from_name":"mulank","relation_name":"neutral"},{"from":"bhagyank","from_number":6,"to_number":7,"relation":"neutral","via":["Ketu"],"from_name":"bhagyank","relation_name":"neutral"}],"outcome":"neutral","outcome_name":"Neutral","reading":"This number is neutral to your own numbers. It neither helps nor gets in the way much."}},{"name":"Jon Doe","chaldean":{"total":29,"compound":29,"number":2,"master":true,"words":[{"word":"Jon","total":13,"number":4},{"word":"Doe","total":16,"number":7}]},"pythagorean":{"total":27,"number":9,"master":false},"planet":"Moon","planet_name":"Moon","fit":{"number":2,"links":[{"from":"mulank","from_number":6,"to_number":2,"relation":"enemy","via":[],"from_name":"mulank","relation_name":"unfriendly"},{"from":"bhagyank","from_number":6,"to_number":2,"relation":"enemy","via":[],"from_name":"bhagyank","relation_name":"unfriendly"}],"outcome":"difficult","outcome_name":"Not a good fit","reading":"This number does not get along with your own numbers. It may get in your way more than it helps."}}],"ranked":false,"not_claimed":"Numbers describe tendencies, not fixed events. Use them as a guide, not a rule.","localization":{"lang":"en","detail":"standard","fell_back_to_en":[],"fell_back_to_standard":[]}}}},"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-Calls-Counted":{"$ref":"#/components/headers/X-Calls-Counted"},"X-Reading-Credits-Counted":{"$ref":"#/components/headers/X-Reading-Credits-Counted"},"X-Reading-Credits-Remaining":{"$ref":"#/components/headers/X-Reading-Credits-Remaining"}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"description":"The request is not valid, for example a required field is missing or a date is out of range. `field` names the input to fix.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/v1/name/suggest":{"post":{"tags":["names"],"summary":"Name spelling suggestions","description":"Spellings of one word of the name (`part`, default the first name) that sound the same. Each gives a Chaldean name number in `targets` (default: every number whose `fit` with the person is `good`). Only common spelling habits are tried, at most two at a time. They are `a`/`aa`, `i`/`ee`, `u`/`oo`, `v`/`w` (not as the first letter) and `ph`/`f`, plus a doubled last consonant and a silent `h` after a final `a`. Each suggestion lists its `changes`. Suggestions come in a fixed order (fewer changes first, then A to Z) and are **never ranked**. `found` counts every match before `limit`; `none` is a sentence when there is no match.\n\n**Uses 1 reading credit.** On live keys a successful response uses them from your monthly reading credits, and no calls. Test keys answer for the sample people only, and it counts as 1 test call. [What reading credits buy](https://apiforastrology.com/pricing#reading-credits).","operationId":"name_suggest_v1_numerology_name_suggest_post","parameters":[{"name":"lang","in":"query","required":false,"schema":{"type":"string","pattern":"^(en|hi)$","description":"Language of the readings and names: `en`, `hi`. Codes stay in English.","default":"en","title":"Lang"},"description":"Language of the readings and names: `en`, `hi`. Codes stay in English."},{"name":"detail","in":"query","required":false,"schema":{"type":"string","pattern":"^(standard|expanded)$","description":"Length of the readings: `standard` (the default, short, for app cards) or `expanded` (about three times longer, for reading in full). A passage with no long form yet comes back at standard length and is listed in `localization.fell_back_to_standard`.","default":"standard","title":"Detail"},"description":"Length of the readings: `standard` (the default, short, for app cards) or `expanded` (about three times longer, for reading in full). A passage with no long form yet comes back at standard length and is listed in `localization.fell_back_to_standard`."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestRequest"},"examples":{"first_name":{"summary":"Spellings of the first name","value":{"name":"John Doe","birth_date":"1990-08-15"}}}}}},"responses":{"200":{"description":"Successful Response. Example from a real call for John Doe, born Aug 15, 1990. Long lists and texts are shortened.","content":{"application/json":{"schema":{},"example":{"name":"John Doe","part":0,"word":"John","current":{"total":34,"compound":34,"number":7,"planet":"Ketu","planet_name":"Ketu","fit":{"number":7,"links":[{"from":"mulank","from_number":6,"to_number":7,"relation":"neutral","via":["Ketu"],"from_name":"mulank","relation_name":"neutral"},{"from":"bhagyank","from_number":6,"to_number":7,"relation":"neutral","via":["Ketu"],"from_name":"bhagyank","relation_name":"neutral"}],"outcome":"neutral","outcome_name":"Neutral","reading":"This number is neutral to your own numbers. It neither helps nor gets in the way much."}},"targets":[4,5],"tried":1,"found":0,"suggestions":[],"person":{"birth_date":"1990-08-15","mulank":6,"bhagyank":6},"system":"chaldean","about":"These spellings sound the same as your name but add up to a number that suits you. Only small, common spelling changes are tried.","none":"No small spelling change gives a number that suits you. Your current spelling can stay as it is.","ranked":false,"not_claimed_spelling":"A new spelling changes the number of the name, not the person. Choose one only if you are happy to use it every day.","not_claimed":"Numbers describe tendencies, not fixed events. Use them as a guide, not a rule.","localization":{"lang":"en","detail":"standard","fell_back_to_en":[],"fell_back_to_standard":[]}}}},"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-Calls-Counted":{"$ref":"#/components/headers/X-Calls-Counted"},"X-Reading-Credits-Counted":{"$ref":"#/components/headers/X-Reading-Credits-Counted"},"X-Reading-Credits-Remaining":{"$ref":"#/components/headers/X-Reading-Credits-Remaining"}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"description":"The request is not valid, for example a required field is missing or a date is out of range. `field` names the input to fix.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/v1/number":{"post":{"tags":["numbers"],"summary":"Mobile, vehicle, house or business number","description":"Adds up a mobile, vehicle or house number. Only digits count: letters are listed in `ignored_letters` and not counted. A business name is read by its letters instead. Then it gives the `fit` with the owner's mulank and bhagyank, by the same rule as the name checker.\n\n**Uses 1 reading credit.** On live keys a successful response uses them from your monthly reading credits, and no calls. Test keys answer for the sample people only, and it counts as 1 test call. [What reading credits buy](https://apiforastrology.com/pricing#reading-credits).","operationId":"number_check_v1_numerology_number_post","parameters":[{"name":"lang","in":"query","required":false,"schema":{"type":"string","pattern":"^(en|hi)$","description":"Language of the readings and names: `en`, `hi`. Codes stay in English.","default":"en","title":"Lang"},"description":"Language of the readings and names: `en`, `hi`. Codes stay in English."},{"name":"detail","in":"query","required":false,"schema":{"type":"string","pattern":"^(standard|expanded)$","description":"Length of the readings: `standard` (the default, short, for app cards) or `expanded` (about three times longer, for reading in full). A passage with no long form yet comes back at standard length and is listed in `localization.fell_back_to_standard`.","default":"standard","title":"Detail"},"description":"Length of the readings: `standard` (the default, short, for app cards) or `expanded` (about three times longer, for reading in full). A passage with no long form yet comes back at standard length and is listed in `localization.fell_back_to_standard`."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NumberCheckRequest"},"examples":{"mobile":{"summary":"A mobile number","value":{"kind":"mobile","value":"212 555 0147","birth_date":"1990-08-15"}},"vehicle":{"summary":"A vehicle plate","value":{"kind":"vehicle","value":"ABC 4521","birth_date":"1990-08-15"}}}}}},"responses":{"200":{"description":"Successful Response. Example from a real call for A mobile number for John Doe, born Aug 15, 1990. Long lists and texts are shortened.","content":{"application/json":{"schema":{},"example":{"kind":"mobile","kind_name":"Mobile number","about":"A mobile number is read by adding all its digits.","value":"212 555 0147","digits":"2125550147","total":32,"compound":32,"number":5,"ignored_letters":[],"planet":"Mercury","planet_name":"Mercury","person":{"birth_date":"1990-08-15","mulank":6,"bhagyank":6},"fit":{"number":5,"links":[{"from":"mulank","from_number":6,"to_number":5,"relation":"friend","via":[],"from_name":"mulank","relation_name":"friendly"},{"from":"bhagyank","from_number":6,"to_number":5,"relation":"friend","via":[],"from_name":"bhagyank","relation_name":"friendly"}],"outcome":"good","outcome_name":"Good fit","reading":"This number gets along well with your own numbers. It tends to support you."},"not_claimed":"Numbers describe tendencies, not fixed events. Use them as a guide, not a rule.","localization":{"lang":"en","detail":"standard","fell_back_to_en":[],"fell_back_to_standard":[]}}}},"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-Calls-Counted":{"$ref":"#/components/headers/X-Calls-Counted"},"X-Reading-Credits-Counted":{"$ref":"#/components/headers/X-Reading-Credits-Counted"},"X-Reading-Credits-Remaining":{"$ref":"#/components/headers/X-Reading-Credits-Remaining"}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"description":"The request is not valid, for example a required field is missing or a date is out of range. `field` names the input to fix.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/v1/compatibility":{"post":{"tags":["compatibility"],"summary":"Two people","description":"How two people's numbers get along: each one's mulank and bhagyank, read both ways, since the friendship of numbers is one-sided. `outcome` uses the same rule as the name checker over all four relations. Nothing is scored.\n\n**Uses 1 reading credit.** On live keys a successful response uses them from your monthly reading credits, and no calls. Test keys answer for the sample people only, and it counts as 1 test call. [What reading credits buy](https://apiforastrology.com/pricing#reading-credits).","operationId":"compatibility_v1_numerology_compatibility_post","parameters":[{"name":"lang","in":"query","required":false,"schema":{"type":"string","pattern":"^(en|hi)$","description":"Language of the readings and names: `en`, `hi`. Codes stay in English.","default":"en","title":"Lang"},"description":"Language of the readings and names: `en`, `hi`. Codes stay in English."},{"name":"detail","in":"query","required":false,"schema":{"type":"string","pattern":"^(standard|expanded)$","description":"Length of the readings: `standard` (the default, short, for app cards) or `expanded` (about three times longer, for reading in full). A passage with no long form yet comes back at standard length and is listed in `localization.fell_back_to_standard`.","default":"standard","title":"Detail"},"description":"Length of the readings: `standard` (the default, short, for app cards) or `expanded` (about three times longer, for reading in full). A passage with no long form yet comes back at standard length and is listed in `localization.fell_back_to_standard`."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompatibilityRequest"},"examples":{"pair":{"summary":"Two birth dates","value":{"a":{"birth_date":"1990-08-15"},"b":{"birth_date":"1992-03-22"}}}}}}},"responses":{"200":{"description":"Successful Response. Example from a real call for John Doe, born Aug 15, 1990, and Jane Doe, born Mar 22, 1992. Long lists and texts are shortened.","content":{"application/json":{"schema":{},"example":{"a":{"birth_date":"1990-08-15","mulank":6,"bhagyank":6,"mulank_planet":"Venus"},"b":{"birth_date":"1992-03-22","mulank":4,"bhagyank":1,"mulank_planet":"Rahu"},"links":[{"from":"mulank","from_number":6,"to_number":4,"relation":"friend","via":["Rahu"],"who":"a_to_b","from_name":"mulank","relation_name":"friendly"},{"from":"mulank","from_number":4,"to_number":6,"relation":"friend","via":["Rahu"],"who":"b_to_a","from_name":"mulank","relation_name":"friendly"}],"outcome":"mixed","outcome_name":"Mixed","reading":"Your numbers pull both ways. Some things come easily between you and some need patience.","not_claimed":"Numbers describe tendencies, not fixed events. Use them as a guide, not a rule.","localization":{"lang":"en","detail":"standard","fell_back_to_en":[],"fell_back_to_standard":[]}}}},"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-Calls-Counted":{"$ref":"#/components/headers/X-Calls-Counted"},"X-Reading-Credits-Counted":{"$ref":"#/components/headers/X-Reading-Credits-Counted"},"X-Reading-Credits-Remaining":{"$ref":"#/components/headers/X-Reading-Credits-Remaining"}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"description":"The request is not valid, for example a required field is missing or a date is out of range. `field` names the input to fix.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/v1/western":{"post":{"tags":["western"],"summary":"Western numbers","description":"The Western (Pythagorean) numbers: **life path**, **expression**, **soul urge**, **personality**, **maturity** and **birthday**. It also returns karmic debt, karmic lessons, hidden passion and balance. It returns the four **challenges** and the four **pinnacles**, with ages, years and which one is `current`, and the three **life cycles** (early, middle and later years) the same way. It also returns the personal year, month and day. Master numbers 11, 22 and 33 are kept in `number`; `digit` is the same number reduced to 1-9. `basis` states each method where books differ. Use the full name from birth.\n\n**Uses 3 reading credits.** On live keys a successful response uses them from your monthly reading credits, and no calls. Test keys answer for the sample people only, and it counts as 1 test call. [What reading credits buy](https://apiforastrology.com/pricing#reading-credits).","operationId":"western_v1_numerology_western_post","parameters":[{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The date to read the personal year, month and day (and the current pinnacle and life cycle) for, `YYYY-MM-DD`. Defaults to today. Echoed back in `as_of`.","title":"As Of"},"description":"The date to read the personal year, month and day (and the current pinnacle and life cycle) for, `YYYY-MM-DD`. Defaults to today. Echoed back in `as_of`."},{"name":"lang","in":"query","required":false,"schema":{"type":"string","pattern":"^(en|hi)$","description":"Language of the readings and names: `en`, `hi`. Codes stay in English.","default":"en","title":"Lang"},"description":"Language of the readings and names: `en`, `hi`. Codes stay in English."},{"name":"detail","in":"query","required":false,"schema":{"type":"string","pattern":"^(standard|expanded)$","description":"Length of the readings: `standard` (the default, short, for app cards) or `expanded` (about three times longer, for reading in full). A passage with no long form yet comes back at standard length and is listed in `localization.fell_back_to_standard`.","default":"standard","title":"Detail"},"description":"Length of the readings: `standard` (the default, short, for app cards) or `expanded` (about three times longer, for reading in full). A passage with no long form yet comes back at standard length and is listed in `localization.fell_back_to_standard`."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BirthNamePerson"},"examples":{"john":{"summary":"John Doe, Aug 15, 1990","value":{"name":"John Doe","birth_date":"1990-08-15"}}}}}},"responses":{"200":{"description":"Successful Response. Example from a real call for John Doe, born Aug 15, 1990. Long lists and texts are shortened.","content":{"application/json":{"schema":{},"example":{"input":{"name":"John Doe","birth_date":"1990-08-15"},"system":"pythagorean","about":"These are the Western numbers. They use the Pythagorean letter values, where A is 1, B is 2 and so on. The numbers 11, 22 and 33 are master numbers and are…","basis":{"letters":"Pythagorean letter values (A=1 ... I=9, J=1 ...).","masters":"11, 22 and 33 are kept; `digit` is the same number reduced to 1-9.","life_path":"Month, day and year are reduced one by one, then added.","name_numbers":"Each word is reduced, then the words are added.","y":"Y counts as a vowel when neither letter beside it is a vowel.","personal_year":"Counted on the calendar year, from January 1.","pinnacles":"The first ends at age 36 minus the life path digit; each later one lasts nine years, and the fourth for life.","life_cycles":"Month, day and year, each reduced (masters kept). The first cycle ends with the first pinnacle, the second 27 years later, and the third runs for life.","karmic_debt":"Karmic debt is looked for in six numbers: life path, expression, soul urge, personality, maturity and birthday. Pinnacles, challenges and life cycles are not…"},"life_path":{"total":15,"number":6,"digit":6,"karmic_debt":[],"parts":{"month":8,"day":6,"year":1},"about":"Your life path number comes from your full birth date. It shows the main road your life tends to follow.","reading":"Your road tends to center on caring for others. Family, home and community often matter most to you."},"expression":{"total":8,"number":8,"digit":8,"karmic_debt":[],"words":[20,15],"about":"Your expression number comes from every letter of your full name. It shows your natural talents.","reading":"You have a natural gift for business, managing and handling money."},"soul_urge":{"total":17,"number":8,"digit":8,"karmic_debt":[],"words":[6,11],"about":"Your soul urge number comes from the vowels in your name. It shows what you want deep inside.","reading":"Deep inside, you want success and to be respected for what you achieve."},"personality":{"total":9,"number":9,"digit":9,"karmic_debt":[{"number":14,"reading":"14 points to a lesson about balance. Too much of anything, from food to freedom, tends to cost you."}],"words":[14,4],"about":"Your personality number comes from the consonants in your name. It shows how people see you before they know you well.","reading":"People tend to see you as open-hearted and generous."},"maturity":{"total":14,"number":5,"digit":5,"karmic_debt":[{"number":14,"reading":"14 points to a lesson about balance. Too much of anything, from food to freedom, tends to cost you."}],"about":"Your maturity number adds your life path and expression numbers. It shows what tends to grow stronger after about age 35.","reading":"After about age 35, you tend to want more freedom and change. New places, people and ideas often keep you growing."},"birthday":{"day":15,"number":6,"digit":6,"karmic_debt":[],"about":"Your birthday number is the day of the month you were born. It shows one special gift you carry.","reading":"You tend to have a special gift for caring for others. You may be good at looking after people and making any place feel like home."},"karmic_lessons":{"about":"Karmic lessons are the numbers from 1 to 9 that no letter of your name gives. They show skills you may need to build on purpose.","numbers":[{"number":2,"reading":"No letter gives 2. Patience and working closely with others may need practice."},{"number":3,"reading":"No letter gives 3. Sharing your feelings and ideas out loud may need practice."}]},"hidden_passion":{"numbers":[5,6],"count":2,"about":"Your hidden passion is the number that appears most often in the letters of your name. It shows a strong drive you may not talk about.","readings":["5 is about freedom, change, travel and trying new things.","6 is about care, family, home and taking responsibility."]},"balance":{"initials":"JD","total":5,"number":5,"about":"Your balance number comes from the first letter of each part of your name. It shows how you tend to handle hard times.","reading":"5 is about freedom, change, travel and trying new things."},"challenges":{"about":"Your four challenge numbers come from your birth date. Each shows something you may have to work at during part of your life.","items":[{"id":"first","number":2,"name":"First challenge","reading":"Not taking things too personally."},{"id":"second","number":5,"name":"Second challenge","reading":"Handling freedom wisely and not rushing from one thing to the next."}]},"pinnacles":{"about":"Your four pinnacles are long stretches of your life. Each one has its own number and its own focus.","as_of":"2026-10-01","items":[{"id":1,"number":5,"digit":5,"from_age":0,"to_age":30,"from_year":1990,"to_year":2020,"current":false,"reading":"5 is about freedom, change, travel and trying new things."},{"id":2,"number":7,"digit":7,"from_age":31,"to_age":39,"from_year":2021,"to_year":2029,"current":true,"reading":"7 is about study, thinking deeply and looking inward."}]},"life_cycles":{"about":"Your life cycles are three long stages of your life: your early, middle and later years. Each stage has its own number and its own mood.","as_of":"2026-10-01","items":[{"id":"early","number":8,"digit":8,"from_age":0,"to_age":30,"from_year":1990,"to_year":2020,"current":false,"name":"Early years","reading":"8 is about ambition, money, managing people and real results."},{"id":"middle","number":6,"digit":6,"from_age":31,"to_age":57,"from_year":2021,"to_year":2047,"current":true,"name":"Middle years","reading":"6 is about care, family, home and taking responsibility."}]},"personal":{"as_of":"2026-10-01","year":{"number":6,"about":"Your personal year number shows the theme of this year for you. It changes on January 1.","reading":"A year for home, family and duties. People may lean on you.","do":"Give time to your home and family. Help the people who lean on you, and plan what you can do for them. Fix or improve something at home. Spend time with your…","avoid":"Avoid taking on every duty yourself. Try not to give advice or help where it is not wanted. Do not forget your own rest while you care for others. Avoid…"},"month":{"number":7,"about":"Your personal month number shows the theme of this month for you.","reading":"This month tends to favor rest, study and thinking things over. You may want more quiet time than usual. It is a good time to read, plan and look inward,…"},"day":{"number":8,"about":"Your personal day number shows the theme of this day for you.","reading":"Good for work, money and big decisions."}},"not_computed":[],"not_claimed_karmic":"Karmic debt and karmic lessons describe patterns to work on. They are not a claim about a past life.","not_claimed":"Numbers describe tendencies, not fixed events. Use them as a guide, not a rule.","localization":{"lang":"en","detail":"standard","fell_back_to_en":[],"fell_back_to_standard":[]}}}},"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-Calls-Counted":{"$ref":"#/components/headers/X-Calls-Counted"},"X-Reading-Credits-Counted":{"$ref":"#/components/headers/X-Reading-Credits-Counted"},"X-Reading-Credits-Remaining":{"$ref":"#/components/headers/X-Reading-Credits-Remaining"}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"description":"The request is not valid, for example a required field is missing or a date is out of range. `field` names the input to fix.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/v1/cycles":{"post":{"tags":["planning"],"summary":"Personal year, month and day","description":"The personal year, month and day for one date, each with a short reading. Needs only the birth date, so it suits a daily screen. The personal year changes on January 1.\n\n**Uses 2 reading credits.** On live keys a successful response uses them from your monthly reading credits, and no calls. Test keys answer for the sample people only, and it counts as 1 test call. [What reading credits buy](https://apiforastrology.com/pricing#reading-credits).","operationId":"cycles_v1_numerology_cycles_post","parameters":[{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The date to read the personal year, month and day (and the current pinnacle and life cycle) for, `YYYY-MM-DD`. Defaults to today. Echoed back in `as_of`.","title":"As Of"},"description":"The date to read the personal year, month and day (and the current pinnacle and life cycle) for, `YYYY-MM-DD`. Defaults to today. Echoed back in `as_of`."},{"name":"lang","in":"query","required":false,"schema":{"type":"string","pattern":"^(en|hi)$","description":"Language of the readings and names: `en`, `hi`. Codes stay in English.","default":"en","title":"Lang"},"description":"Language of the readings and names: `en`, `hi`. Codes stay in English."},{"name":"detail","in":"query","required":false,"schema":{"type":"string","pattern":"^(standard|expanded)$","description":"Length of the readings: `standard` (the default, short, for app cards) or `expanded` (about three times longer, for reading in full). A passage with no long form yet comes back at standard length and is listed in `localization.fell_back_to_standard`.","default":"standard","title":"Detail"},"description":"Length of the readings: `standard` (the default, short, for app cards) or `expanded` (about three times longer, for reading in full). A passage with no long form yet comes back at standard length and is listed in `localization.fell_back_to_standard`."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BirthOnly"},"examples":{"one":{"summary":"Born Aug 15, 1990","value":{"birth_date":"1990-08-15"}}}}}},"responses":{"200":{"description":"Successful Response. Example from a real call for John Doe, born Aug 15, 1990. Long lists and texts are shortened.","content":{"application/json":{"schema":{},"example":{"birth_date":"1990-08-15","as_of":"2026-10-01","year":{"number":6,"about":"Your personal year number shows the theme of this year for you. It changes on January 1.","reading":"A year for home, family and duties. People may lean on you.","do":"Give time to your home and family. Help the people who lean on you, and plan what you can do for them. Fix or improve something at home. Spend time with your…","avoid":"Avoid taking on every duty yourself. Try not to give advice or help where it is not wanted. Do not forget your own rest while you care for others. Avoid…"},"month":{"number":7,"about":"Your personal month number shows the theme of this month for you.","reading":"This month tends to favor rest, study and thinking things over. You may want more quiet time than usual. It is a good time to read, plan and look inward,…"},"day":{"number":8,"about":"Your personal day number shows the theme of this day for you.","reading":"Good for work, money and big decisions."},"not_claimed":"Numbers describe tendencies, not fixed events. Use them as a guide, not a rule.","localization":{"lang":"en","detail":"standard","fell_back_to_en":[],"fell_back_to_standard":[]}}}},"headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-Calls-Counted":{"$ref":"#/components/headers/X-Calls-Counted"},"X-Reading-Credits-Counted":{"$ref":"#/components/headers/X-Reading-Credits-Counted"},"X-Reading-Credits-Remaining":{"$ref":"#/components/headers/X-Reading-Credits-Remaining"}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"description":"The request is not valid, for example a required field is missing or a date is out of range. `field` names the input to fix.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/v1/report":{"post":{"tags":["core"],"summary":"Numerology report (HTML or JSON)","description":"The whole reading as one printable book. It holds the numbers at a glance, the mulank, bhagyank and name number, and the Lo Shu grid (drawn). It also holds the lucky day and colors, the Western numbers, karmic lessons, challenges and life stages. It also holds the personal year, month and day, and any numbers sent in `numbers`. Every number and paragraph is what the other numerology routes return.\n\n`format=html` (default) returns one self-contained page that fetches nothing and prints to A4. `format=json` returns the same book as data: `chapters[].items[]`. Each item is a `section` (blocks of `title`, `paragraphs`, `note`), a `table` (`columns`, `rows`) or `loshu`. A `loshu` item has `cells` and an `svg` that carries its look as attributes, so it draws anywhere.\n\n**Uses 25 reading credits.** On live keys a successful response uses them from your monthly reading credits, and no calls. Test keys answer for the sample people only, and it counts as 1 test call. [What reading credits buy](https://apiforastrology.com/pricing#reading-credits).","operationId":"numerology_report_v1_numerology_report_post","parameters":[{"name":"format","in":"query","required":false,"schema":{"type":"string","pattern":"^(html|json)$","description":"`html` (default) or `json`.","default":"html","title":"Format"},"description":"`html` (default) or `json`."},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"The date to read the personal year, month and day (and the current pinnacle and life cycle) for, `YYYY-MM-DD`. Defaults to today. Echoed back in `as_of`.","title":"As Of"},"description":"The date to read the personal year, month and day (and the current pinnacle and life cycle) for, `YYYY-MM-DD`. Defaults to today. Echoed back in `as_of`."},{"name":"lang","in":"query","required":false,"schema":{"type":"string","pattern":"^(en|hi)$","description":"Language of the readings and names: `en`, `hi`. Codes stay in English.","default":"en","title":"Lang"},"description":"Language of the readings and names: `en`, `hi`. Codes stay in English."},{"name":"detail","in":"query","required":false,"schema":{"type":"string","pattern":"^(standard|expanded)$","description":"Length of the readings. A report is read in full, so the default is `expanded`; send `standard` for a short version.","default":"expanded","title":"Detail"},"description":"Length of the readings. A report is read in full, so the default is `expanded`; send `standard` for a short version."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportRequest"},"examples":{"john":{"summary":"John Doe, with a mobile and a vehicle","value":{"name":"John Doe","birth_date":"1990-08-15","numbers":[{"kind":"mobile","value":"212 555 0147"},{"kind":"vehicle","value":"ABC 4521"}]}}}}}},"responses":{"200":{"description":"Successful Response. Example from a real call for John Doe, born Aug 15, 1990. Long lists and texts are shortened.","content":{"text/html":{"schema":{"type":"string"}},"application/json":{"example":{"lang":"en","prepared":"2026-11-07","as_of":"2026-10-01","tint":{"planet":"Venus","paper":"#fcf5f8","soft":"#f5e3eb","highlight":"#f0cfdd","strong":"#963a62","mute":"#75606a"},"cover":{"brand":"","kicker":"Numerology report","title":"John Doe","born":"Born August 15, 1990","glance":"Mulank 6 · Bhagyank 6 · Name number 7","promise":"What your birth date and your name say about you, worked out step by step and written in plain words.","wheel_title":"Your numbers on the wheel of nine","wheel_caption":"The ring holds the numbers 1 to 9, each in the color of its planet. Your three numbers are marked. Your Lo Shu grid sits in the middle.","wheel_svg":"`. Get a key on the [API keys page](https://apiforastrology.com/account/keys) of your account."},"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your API key in the X-API-Key header, if you cannot set Authorization. Get a key on the [API keys page](https://apiforastrology.com/account/keys) of your account."}},"responses":{"Unauthorized":{"description":"The key does not work. The `code` says why. `unauthorized`: the key is missing, mistyped or unknown; send your key as `Authorization: Bearer ` or `X-API-Key: `. `key_disabled`: the key is paused; an owner or admin can enable it on the API keys page, or roll it. `key_expired`: the key was rolled more than 24 hours ago; use the new key. `key_revoked`: the key was revoked; create a new key. Do not retry until the key is fixed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"missing":{"value":{"error":{"code":"unauthorized","message":"Provide a key as \"Authorization: Bearer \" or \"X-API-Key: \"."}}},"invalid":{"value":{"error":{"code":"unauthorized","message":"The API key is invalid."}}},"key_disabled":{"value":{"error":{"code":"key_disabled","message":"This API key is paused. An owner or admin of your account can enable it again on the API keys page, or roll it to get a new key."}}},"key_expired":{"value":{"error":{"code":"key_expired","message":"This API key was rolled and its 24-hour grace period is over. Use the new key from the API keys page of your account."}}},"key_revoked":{"value":{"error":{"code":"key_revoked","message":"This API key was revoked and can't be used again. Create a new key on the API keys page of your account."}}}}}}},"Forbidden":{"description":"The `code` says why. `account_suspended`: the account that owns this key is suspended, so none of its keys work; do not retry, and reply to the email we sent if you think we made a mistake. `sample_charts_only`: test keys return numerology only for the sample people in the docs (John Doe, born Aug 15, 1990, and Jane Doe, born Mar 22, 1992), for today or the dates in the docs examples; use a live key for anyone else.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"account_suspended":{"value":{"error":{"code":"account_suspended","message":"This account is suspended, so its keys do not work. Please get in touch through the contact page."}}},"sample_charts_only":{"value":{"error":{"code":"sample_charts_only","message":"Test keys return numerology only for the sample people in the docs: John Doe, born Aug 15, 1990, and Jane Doe, born Mar 22, 1992, for today or the dates in the docs examples. Use a live key for anyone else."}}}}}}},"TooManyRequests":{"description":"Too many requests. The `code` says which limit you hit: `rate_limited` means this key used more calls this minute than it may (each key has its own limit); `quota_exceeded` means your live keys used up the plan's monthly calls; `reading_credits_exceeded` means this reading needs more reading credits than are left this month; `test_quota_exceeded` means your test keys used up the free monthly test allowance. Wait the number of seconds in `Retry-After`, then try again.","headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rate_limited":{"value":{"error":{"code":"rate_limited","message":"Rate limit of 120 calls per minute for this key exceeded. Each key has its own limit."}}},"quota_exceeded":{"value":{"error":{"code":"quota_exceeded","message":"Monthly quota of 100,000 calls used by your live keys. It resets on the 1st (UTC). Upgrade your plan for more."}}},"reading_credits_exceeded":{"value":{"error":{"code":"reading_credits_exceeded","message":"This reading uses 25 reading credits, and only 12 are left this month. Credits reset on the 1st (UTC). Upgrade your plan for more."}}},"test_quota_exceeded":{"value":{"error":{"code":"test_quota_exceeded","message":"Test allowance of 1,000 calls this month used by your test keys. It resets on the 1st (UTC). Live keys are not affected."}}}}}}}},"headers":{"X-RateLimit-Limit":{"description":"How many calls this key may make per minute. Each key has its own limit.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"How many calls this key has left in the current minute.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the current minute ends and your requests are counted from zero again.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before you try again. After the monthly calls, the reading credits or the test allowance run out, this is the time until they reset on the 1st of the month (UTC).","schema":{"type":"integer"}},"X-Calls-Counted":{"description":"Calls this response used: 1 for a successful calculation, 0 for errors and for written readings on live keys (they use reading credits). On test keys every successful call counts as 1.","schema":{"type":"integer"}},"X-Reading-Credits-Counted":{"description":"Reading credits this response used. Only on written readings; 0 on test keys and on failed requests.","schema":{"type":"integer"}},"X-Reading-Credits-Remaining":{"description":"Reading credits left this month for all your live keys. Only on written readings with live keys.","schema":{"type":"integer"}}}},"tags":[{"name":"meta","description":"Service health. No key needed.","x-displayName":"Meta"},{"name":"core","description":"The core numbers for one person: the mulank (birth day number), the bhagyank (destiny number) and the name number, with the Lo Shu grid, lucky day, colors and dates, gemstone and mantra. Also one number on its own, and the whole reading as a printable report.","x-displayName":"Core numbers"},{"name":"names","description":"Names: a name and its spellings against a person's numbers, spellings that sound the same and suit them, and baby names whose number suits a child.","x-displayName":"Names"},{"name":"numbers","description":"Number checks: a mobile, vehicle or house number, several numbers side by side, and a business name with its launch date.","x-displayName":"Number checks"},{"name":"compatibility","description":"Two people's numbers, read both ways.","x-displayName":"Compatibility"},{"name":"western","description":"The Western (Pythagorean) numbers: life path, expression, soul urge, personality, maturity, birthday, karmic debt and lessons, challenges and pinnacles.","x-displayName":"Western numbers"},{"name":"planning","description":"Dates and cycles: the personal year, month and day, the good dates in a month, a calendar year for a mulank, and the number of any day.","x-displayName":"Dates and cycles"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"servers":[{"url":"https://apiforastrology.com/api/numerology","description":"Numerology API"}],"externalDocs":{"description":"Guides: quickstart, authentication and errors","url":"https://apiforastrology.com/numerology/docs"}}