- Docs
- Getting Started
- Introduction
Astrology API docs, from first call to a shipped app
You send a birth date, a name, a question or a place. You get structured JSON back, ready to render, from astrology, Vedic astrology, human design, forecast, tarot, numerology and the rest of the catalog, on one key. No domain expertise needed on your side. Every calculation and interpretation happens on ours.
Pick the path that matches how you build. Each one is a short sequence, and every step links to a page that does exactly that step.
- I build with an AI agent, in Claude Code, Codex, Cursor, Lovable or a chat model.
- I build without code, on WordPress, Wix, Squarespace, Shopify, Bubble or an automation tool.
- I write the code, in TypeScript, Python, PHP, C#, Go or plain HTTP.
Then what to build and the reference layer sit below, whichever path you took.
Build with an AI agent
Give your agent the truth about this API before it writes a line, and it will write correct calls the first time.
- Connect the docs server. One command adds a documentation MCP server to Claude Code, Codex or Cursor. It needs no key, so the agent can search the docs from the first prompt. The MCP setup page covers every other client.
- Point it at the playbook. AGENTS.md is the execution playbook written for coding agents: base URL, auth, the request shapes that trip agents, and the rules that do not bend. For a tool with no MCP support, llms.txt is the same truth as one file it can fetch.
- Paste a prompt. AI prompts carries one self-contained prompt per app, starting with the most common job, adding RoxyAPI to an app you already have.
- Let the agent draw the answer. AI chat widgets shows how a chat model calls a tool and the reply renders as a real chart, kundli or spread instead of a paragraph.
- Or clone something that already works. The open source templates include a stateless astrology chatbot and a companion with memory, both MIT, both a few minutes from a first reply.
Also for agents: Antigravity, Windsurf, GitHub Copilot, Gemini CLI, Replit, and function calling for OpenAI and Claude tool use in your own backend.
Build without code
Put a live reading on a page you already own. Nothing to install on a server, nothing to build.
- Paste a widget. Copy-paste widgets are one snippet each: a daily horoscope, a natal chart, a tarot draw, a kundli. They fetch their own data with a browser-safe key, so they work on any HTML surface, including Notion and Linktree.
- On WordPress, install the plugin. The WordPress plugin adds blocks and shortcodes for every reading, with settings in the admin menu and no code at all.
- On a site builder, embed. Wix, Squarespace and Shopify each have a page with the exact steps for that editor.
- In a no-code app builder, connect the API. Bubble, FlutterFlow, Lovable and Bolt show where the key goes and which call to make first.
- In an automation tool, add a step. Zapier, Make, n8n and Dify turn a reading into a workflow: a daily message on WhatsApp, Telegram or Slack.
Every widget, block and workflow runs on your own key. Plans are flat and every domain is included, see pricing.
Write the code
Four steps from an empty file to a typed integration, in the order you will actually do them.
- Make one call. The quickstart is a single request and the JSON that comes back, in curl and in JavaScript, then a working page a few minutes later.
- Understand the key. Authentication covers the header, the two key types, the error shapes and the rate limit headers, in one page.
- Install the SDK. The SDK page has TypeScript, Python, PHP, C# and Go, generated from the spec so autocomplete knows every endpoint and field, and new ones appear without an upgrade on your side.
- Render it. UI components are open source web components that draw a natal wheel, a kundli, a panchang, a bodygraph or a spread straight from the response. No design work, no chart maths, any framework or none.
When you want the whole surface: the API reference lets you try every endpoint live, and the OpenAPI spec is the same contract as one document, for codegen, Postman and Bruno, or your own tooling. Next.js has its own page, and caching and localization are the two guides worth reading before launch.
What to build
Tutorials are complete products, one page each, with the endpoints in the order you call them.
- Complete birth profile, every chart one person can have, from one form.
- Dating compatibility app, synastry scoring and match screens.
- Daily horoscope widget, for any website.
- Tarot reading app, spreads with card imagery.
- AI astrology chatbot and AI companion with memory, the two flagship templates, explained.
- Personalized daily tracker and Vastu property report.
Domain guides explain one system each in plain language, then the endpoints that matter for it: start with Western astrology, Vedic astrology, forecast, human design or tarot, and find the rest in the sidebar.
Reference
The pages an agent or a senior engineer keeps open.
- Agent task cheatsheet, every common job mapped to the exact calls.
- Common mistakes, domain gotchas and field formats, the three pages that stop hallucinated fields and wrong timezones.
- Coverage and scope, what is served, what is not, and why.
- Calculation engine, how positions are computed and how you can verify them against the methodology.
- Data protection, where data lives and what is never stored.
Next step
Take the first step of your path above. If you are undecided, the quickstart is the shortest one, and everything else on this page still works afterwards.